Naar inhoud springen

Module:Arguments

Koppelingen bewerken
Van Wikipedia
🛑
Ipgelet: Ôog risico module!
Dit module wordt gebruukt in systeem-berichtn of ip exôct 0 bloadn (da's oungeveer 0% van oalle artikeln). Een anpassienge an dees code kan d'n uutkyk van de gansche wiki direct verandern. Test anpassiengn êest in e zandbak of discuteer d'rover ip 't overlegblad vôoda je ze definitief bywerkt.

Moduleinfo: Arguments

[brontekst bewerken]

Dit is e Lua-script (meta-module) da 't makkelik makt oem argumentn (parameters) uut #invoke te verwerkn. 't Is gemakt oem te wordn gebruukt deur andere modules, en mag nie direct angereoepn wordn vanuut #invoke. De belangrykste funcsjes zyn:

  • Et makkelik wegsnyen (trimming) van spaties en 't verwydern van lege argumentn.
  • Argumentn kunn teglykertyd wordn deuregegeevn uut et hudige frame én uut 't oofd-frame (parent frame).
  • Argumentn kunn direct wordn deuregegeevn uut een andre Lua-module of uut de debug-console.
  • De mêeste funcsjes kunn wordn anepast noa joun eign wensn.

Boasisgebruuk

[brontekst bewerken]

Êest moe je de module inleezn. 't Bevat êen funcsje, genaamd getArgs. 

local getArgs = require('Module:Arguments').getArgs

In 't mêest simpele scenario ku je getArgs in joun oofdfuncsje gebruukn. De variabele args is e tabelle mèi d' argumentn uut #invoke. 

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- D'echte code van joun module komt ier.
end

return p

Angeroadn praktyk

[brontekst bewerken]

D' angeroadn praktyk is oem een aparte funcsje te gebruukn as ingangspunt vanuut #invoke, allêne moa vo 't verwerkn van d' argumentn. Dit lat andere Lua-modules toe oem joun kern-logica direct an te roepn, wuk dat de prestoasjes verbetert omda je 't frame-object nie iddere kêe moe anspreekn. 

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- D'echte code van joun module komt ier.
end

return p

De maniere oe da dit wordt angereoepn vanuut e patrôon is {{#invoke:Vôorbeeld|main}} (optioneel mèi parameters lik {{#invoke:Vôorbeeld|main|arg1=woarde1|arg2=woarde2}}). De maniere oem dit an te roepn vanuut e module is require('Module:Vôorbeeld')._main({arg1 = 'woarde1', arg2 = woarde2, 'spaced arg3' = 'woarde3'}). Wuk da die twidde maniere doet, is e tabelle moakn mèi d' argumentn d'rin, en gèeft die tabelle toun an de p._main(args) funcsje.

Mêerdere funcsjes

[brontekst bewerken]

O je wilt da mêerdere funcsjes d' argumentn gebruukn, en je wilt ôok da ze toegankelik zyn vanuut #invoke, ku je e wrapper-funcsje gebruukn. 

local getArgs = require('Module:Arguments').getArgs

local p = {}

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Code vo d' êerste funcsje komt ier.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Code vo de twidde funcsje komt ier.
end

return p

Opsjes

[brontekst bewerken]

De volgende opsjes zyn beschikboar. Ze wordn uutgelegd in de stikkn ieroender. 

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Code vo 't verwerkn van êen argument
	end,

	frameOnly = true,
	parentOnly = true,
	parentFirst = true,

	wrappers = {
		'Patrôon:Ne wrapper',
		'Patrôon:Een andre wrapper'
	},

	readOnly = true,
	noOverwrite = true
})
Spaties wegsnyen (Trimming)
[brontekst bewerken]

MediaWiki snydt spaties otematisch weg by benoamde argumentn die uut #invoke of e patrôon kommn, moa lat spaties stoan by positionele (numerieke) argumentn. Standoard ept deze module oem ôok spaties by positionele argumentn weg te snyen. Oem spaties te beoudn, zet je d' opsje trim ip false. 

local args = getArgs(frame, {
	trim = false
})

A je d' opsje valueFunc gebruukt, is de valueFunc funcsje verantwoordelik vo 't wegsnyen van spaties, en eit de trim opsje gèn effect mêer.

Lege argumentn verwydern
[brontekst bewerken]

"Lege argumentn" zyn argumentn uut #invoke of e patrôon die bestoan uut e lege tekst of allêne spaties. Standoard smyt deze module ol die lege argumentn weg. Oem ze te beoudn, zet je d' opsje removeBlanks ip false. 

local args = getArgs(frame, {
	removeBlanks = false
})

A je MediaWiki patrôonn omzet noa Lua, moe je d'r rekening mee oedn dat in Lua, lege tekstn anzien wordn as "woar" (true). O je ier gèn rekening mee oudt, ku je verkêerde resultoatn krygn. As valueFunc actief is, reegelt die funcsje 't verwydern, en eit removeBlanks gèn effect.

Eign opmoak van argumentn (valueFunc)
[brontekst bewerken]

Soms wil je sommigte lege argumentn verwydern moa andere nie, of wil je aolle positionele argumentn omzettn noa klêne letters. Iervôorn ku je d' opsje valueFunc gebruukn. De input moe e funcsje zyn die twêe parameters pakt (key en value) en êen woarde weregèeft.

Klik ier oem de vôorbeeldn mèi valueFunc te tôgen

Vôorbeeld 1: Beoudt spaties vo 't êerste positionele argument, moa snydt ol de reste weg en verwydert lege argumentn. 

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif type(value) == 'string' then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})

Vôorbeeld 2: Verwydert lege argumentn en zet aol d' argumentn in klêne letters, moa snydt gèn spaties weg van positionele parameters. 

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if type(value) == 'string' then
			value = mw.ustring.lower(value)
			if mw.ustring.find(value, '%S') then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})
Frames en oofd-frames (Parent frames)
[brontekst bewerken]

Argumentn in de args tabelle kunn teglykertyd wordn deuregegeevn vanuut et hudige frame of uut 't oofd-frame (parent). Stel da we e module eit die Module:ExampleArgs noemt, die d' êerste twêe argumentn print:

Klik ier oem de code te tôgen
local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local first = args[1] or ''
	local second = args[2] or ''
	return first .. ' ' .. second
end

return p

As Patrôon:ExampleArgs de code {{#invoke:ExampleArgs|main|''firstInvokeArg''}} bevat, kunn we 't gedrag anpassn mèi frameOnly, parentOnly en parentFirst.

  • frameOnly: Pakt allêne argumentn uut et hudige frame (#invoke).
  • parentOnly: Pakt allêne argumentn uut 't oofd-frame (et patrôon zelve).
  • parentFirst: Pakt ze van aolle twêe, moa et patrôon eit vôorrang ip de #invoke argumentn.
Wrappers
[brontekst bewerken]

De wrappers opsje wordt gebruukt oem e bepeirkt antol patrôonn an te duudn as "wrapper patrôonn" (patrôonn woavan 't ênigste doel is oem de module an te roepn). As de module ziet da ze vanuut e wrapper wordt angereoepn, goat ze allêne in 't oofd-frame (parent) kykn achter argumentn. Dit is vele betr vo de prestoasjes.

Wrappers kunn as e tekst of as e lyste van tekstn wordn meegegeevn. 

local args = getArgs(frame, {
	wrappers = {
		'Patrôon:Wrapper 1',
		'Patrôon:Wrapper 2'
	}
})

De module goa ôok otematisch herkenn of 't angeroept wordt uut de /zandbak (sandbox) van e wrapper.

Wegschryvn noa de args-tabelle
[brontekst bewerken]

Soms is 't andig oem nieuwe woardn in de args-tabelle te schryvn. Dit kut mèi de standoard instelliengn van deze module: 

args.foo = 'een extra woarde'

Je kut dit teegnoudn mèi readOnly (gèn inkoamende woardn anpassn) en noOverwrite (nieuwe woardn zyn toegestoan, moa je meugt gèn bestoande argumentn uut #invoke overschryvn).

Ipmerkiengn

[brontekst bewerken]

Ref-tags: Deze module gebruukt Lua-metatabellen oem argumentn ip te aaln. Dit zorgt d'rvoorn da je toegang eit toet aolle argumentn zounder d'n trage pairs() funcsje te gebruukn. Dit is vrêe andig a joun module e <ref>-tag as input krygt, omda MediaWiki ref-tags direct verwerkt zodra ze in Lua wordn angereoepn.

Gekende beperkiengn: 't Gebruuk van metatabellen eit wok zyn noadêeln. De mêeste normoale Lua-tabel funcsjes goan nie tegoei wirkn ip de args-tabelle, woarounder den #-operator, de next() funcsje, en de funcsjes uut de table library.

Broncode & Mêer Info

[brontekst bewerken]

D'originele, vrêe uutgebreide (technische) documentuoasje is te viendn ip de Engelstoalige Wikipedia. 

-- This module provides easy processing of arguments passed to Scribunto from
-- #invoke. It is intended for use by other Lua modules, and should not be
-- called from #invoke directly.

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local arguments = {}

-- Generate four different tidyVal functions, so that we don't have to check the
-- options every time we call it.

local function tidyValDefault(key, val)
	if type(val) == 'string' then
		val = val:match('^%s*(.-)%s*$')
		if val == '' then
			return nil
		else
			return val
		end
	else
		return val
	end
end

local function tidyValTrimOnly(key, val)
	if type(val) == 'string' then
		return val:match('^%s*(.-)%s*$')
	else
		return val
	end
end

local function tidyValRemoveBlanksOnly(key, val)
	if type(val) == 'string' then
		if val:find('%S') then
			return val
		else
			return nil
		end
	else
		return val
	end
end

local function tidyValNoChange(key, val)
	return val
end

local function matchesTitle(given, title)
	local tp = type( given )
	return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
end

local translate_mt = { __index = function(t, k) return k end }

function arguments.getArgs(frame, options)
	checkType('getArgs', 1, frame, 'table', true)
	checkType('getArgs', 2, options, 'table', true)
	frame = frame or {}
	options = options or {}

	--[[
	-- Set up argument translation.
	--]]
	options.translate = options.translate or {}
	if getmetatable(options.translate) == nil then
		setmetatable(options.translate, translate_mt)
	end
	if options.backtranslate == nil then
		options.backtranslate = {}
		for k,v in pairs(options.translate) do
			options.backtranslate[v] = k
		end
	end
	if options.backtranslate and getmetatable(options.backtranslate) == nil then
		setmetatable(options.backtranslate, {
			__index = function(t, k)
				if options.translate[k] ~= k then
					return nil
				else
					return k
				end
			end
		})
	end

	--[[
	-- Get the argument tables. If we were passed a valid frame object, get the
	-- frame arguments (fargs) and the parent frame arguments (pargs), depending
	-- on the options set and on the parent frame's availability. If we weren't
	-- passed a valid frame object, we are being called from another Lua module
	-- or from the debug console, so assume that we were passed a table of args
	-- directly, and assign it to a new variable (luaArgs).
	--]]
	local fargs, pargs, luaArgs
	if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
		if options.wrappers then
			--[[
			-- The wrappers option makes Module:Arguments look up arguments in
			-- either the frame argument table or the parent argument table, but
			-- not both. This means that users can use either the #invoke syntax
			-- or a wrapper template without the loss of performance associated
			-- with looking arguments up in both the frame and the parent frame.
			-- Module:Arguments will look up arguments in the parent frame
			-- if it finds the parent frame's title in options.wrapper;
			-- otherwise it will look up arguments in the frame object passed
			-- to getArgs.
			--]]
			local parent = frame:getParent()
			if not parent then
				fargs = frame.args
			else
				local title = parent:getTitle():gsub('/sandbox$', '')
				local found = false
				if matchesTitle(options.wrappers, title) then
					found = true
				elseif type(options.wrappers) == 'table' then
					for _,v in pairs(options.wrappers) do
						if matchesTitle(v, title) then
							found = true
							break
						end
					end
				end

				-- We test for false specifically here so that nil (the default) acts like true.
				if found or options.frameOnly == false then
					pargs = parent.args
				end
				if not found or options.parentOnly == false then
					fargs = frame.args
				end
			end
		else
			-- options.wrapper isn't set, so check the other options.
			if not options.parentOnly then
				fargs = frame.args
			end
			if not options.frameOnly then
				local parent = frame:getParent()
				pargs = parent and parent.args or nil
			end
		end
		if options.parentFirst then
			fargs, pargs = pargs, fargs
		end
	else
		luaArgs = frame
	end

	-- Set the order of precedence of the argument tables. If the variables are
	-- nil, nothing will be added to the table, which is how we avoid clashes
	-- between the frame/parent args and the Lua args.
	local argTables = {fargs}
	argTables[#argTables + 1] = pargs
	argTables[#argTables + 1] = luaArgs

	--[[
	-- Generate the tidyVal function. If it has been specified by the user, we
	-- use that; if not, we choose one of four functions depending on the
	-- options chosen. This is so that we don't have to call the options table
	-- every time the function is called.
	--]]
	local tidyVal = options.valueFunc
	if tidyVal then
		if type(tidyVal) ~= 'function' then
			error(
				"bad value assigned to option 'valueFunc'"
					.. '(function expected, got '
					.. type(tidyVal)
					.. ')',
				2
			)
		end
	elseif options.trim ~= false then
		if options.removeBlanks ~= false then
			tidyVal = tidyValDefault
		else
			tidyVal = tidyValTrimOnly
		end
	else
		if options.removeBlanks ~= false then
			tidyVal = tidyValRemoveBlanksOnly
		else
			tidyVal = tidyValNoChange
		end
	end

	--[[
	-- Set up the args, metaArgs and nilArgs tables. args will be the one
	-- accessed from functions, and metaArgs will hold the actual arguments. Nil
	-- arguments are memoized in nilArgs, and the metatable connects all of them
	-- together.
	--]]
	local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
	setmetatable(args, metatable)

	local function mergeArgs(tables)
		--[[
		-- Accepts multiple tables as input and merges their keys and values
		-- into one table. If a value is already present it is not overwritten;
		-- tables listed earlier have precedence. We are also memoizing nil
		-- values, which can be overwritten if they are 's' (soft).
		--]]
		for _, t in ipairs(tables) do
			for key, val in pairs(t) do
				if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
					local tidiedVal = tidyVal(key, val)
					if tidiedVal == nil then
						nilArgs[key] = 's'
					else
						metaArgs[key] = tidiedVal
					end
				end
			end
		end
	end

	--[[
	-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
	-- and are only fetched from the argument tables once. Fetching arguments
	-- from the argument tables is the most resource-intensive step in this
	-- module, so we try and avoid it where possible. For this reason, nil
	-- arguments are also memoized, in the nilArgs table. Also, we keep a record
	-- in the metatable of when pairs and ipairs have been called, so we do not
	-- run pairs and ipairs on the argument tables more than once. We also do
	-- not run ipairs on fargs and pargs if pairs has already been run, as all
	-- the arguments will already have been copied over.
	--]]

	metatable.__index = function (t, key)
		--[[
		-- Fetches an argument when the args table is indexed. First we check
		-- to see if the value is memoized, and if not we try and fetch it from
		-- the argument tables. When we check memoization, we need to check
		-- metaArgs before nilArgs, as both can be non-nil at the same time.
		-- If the argument is not present in metaArgs, we also check whether
		-- pairs has been run yet. If pairs has already been run, we return nil.
		-- This is because all the arguments will have already been copied into
		-- metaArgs by the mergeArgs function, meaning that any other arguments
		-- must be nil.
		--]]
		if type(key) == 'string' then
			key = options.translate[key]
		end
		local val = metaArgs[key]
		if val ~= nil then
			return val
		elseif metatable.donePairs or nilArgs[key] then
			return nil
		end
		for _, argTable in ipairs(argTables) do
			local argTableVal = tidyVal(key, argTable[key])
			if argTableVal ~= nil then
				metaArgs[key] = argTableVal
				return argTableVal
			end
		end
		nilArgs[key] = 'h'
		return nil
	end

	metatable.__newindex = function (t, key, val)
		-- This function is called when a module tries to add a new value to the
		-- args table, or tries to change an existing value.
		if type(key) == 'string' then
			key = options.translate[key]
		end
		if options.readOnly then
			error(
				'could not write to argument table key "'
					.. tostring(key)
					.. '"; the table is read-only',
				2
			)
		elseif options.noOverwrite and args[key] ~= nil then
			error(
				'could not write to argument table key "'
					.. tostring(key)
					.. '"; overwriting existing arguments is not permitted',
				2
			)
		elseif val == nil then
			--[[
			-- If the argument is to be overwritten with nil, we need to erase
			-- the value in metaArgs, so that __index, __pairs and __ipairs do
			-- not use a previous existing value, if present; and we also need
			-- to memoize the nil in nilArgs, so that the value isn't looked
			-- up in the argument tables if it is accessed again.
			--]]
			metaArgs[key] = nil
			nilArgs[key] = 'h'
		else
			metaArgs[key] = val
		end
	end

	local function translatenext(invariant)
		local k, v = next(invariant.t, invariant.k)
		invariant.k = k
		if k == nil then
			return nil
		elseif type(k) ~= 'string' or not options.backtranslate then
			return k, v
		else
			local backtranslate = options.backtranslate[k]
			if backtranslate == nil then
				-- Skip this one. This is a tail call, so this won't cause stack overflow
				return translatenext(invariant)
			else
				return backtranslate, v
			end
		end
	end

	metatable.__pairs = function ()
		-- Called when pairs is run on the args table.
		if not metatable.donePairs then
			mergeArgs(argTables)
			metatable.donePairs = true
		end
		return translatenext, { t = metaArgs }
	end

	local function inext(t, i)
		-- This uses our __index metamethod
		local v = t[i + 1]
		if v ~= nil then
			return i + 1, v
		end
	end

	metatable.__ipairs = function (t)
		-- Called when ipairs is run on the args table.
		return inext, t, 0
	end

	return args
end

return arguments
Overgenomen van "https://vls.wikipedia.org/w/index.php?title=Module:Arguments&oldid=323762"