Modulo:Arguments

Da Wikipedia
Sata a-a navegassion Sata a-a serchia

Mòdolo Lua pe-a gestión di argoménti pasæ da #invoke. L'è 'n metamòdolo pensòu pe êse adêuviòu da âtri mòdoli e no dêve êse ciamòu co #invoke. E seu fonçioîn inclùddan:

  • Levâ i spàççi giànchi da-e estremitæ di argoménti e i argoménti vêui.
  • Pasâ i argoménti da-a cornîxe corénte e da quélla moæ contenporaniaménte (véddi chi de sótta pe-i detàli).
  • Pasâ i argoménti diretaménte da 'n âtro mòdolo Lua o da-a consòl de debug.
  • Ricuperâ i argoménti sôlo quànde sèrvan, pe evitâ çèrtidùn problêmi co-o tag <ref>…</ref>
  • Personalizâ vàrie caraterìstiche.

Ûzo de bâze

Prìmma de tùtto se dêve caregâ o mòdolo. Lê u contegne a sôla fonçión ciamâta getArgs.

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

Into câxo de bâze se pœ uzâ getArgs diretaménte inta fonçión prinçipâ. A variàbile args l'è 'na tabélla chi, depoî a ciamâta, contegniâ i argoménti in arîvo da #invoke (véddi chi de sótta pe-i detàli).

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

function p.main(frame)
	local args = getArgs(frame)
	-- Main module code goes here.
end

return p

A ògni mòddo o scistêma mêgio l'è de adêuviâ 'na fonçión dedicaa a procesâ i argoménti de #invoke de mòddo che se o mòdolo l'è ciamòu da un âtro mòdolo Lua, ciufîto che da 'n instruçión #invoke, no dêve avéi 'na cornîxe disponìbile, megioandu coscì a performance.

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

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

function p._main(args)
	-- Main module code goes here.
end

return p

Se se vœ che ciù fonçioîn adêuvian i mæximi argoménti, réndendu lô acescìbili da #invoke, se pœ uzâ 'na fonçión de interfàccia.

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

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

local p = {}

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Code for the first function goes here.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Code for the second function goes here.
end

return p

Inpostaçioîn

Sun disponìbili ste fonçionalitæ èstra chi:

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Code for processing one argument
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Template:A wrapper template',
		'Template:Another wrapper template'
	},
	readOnly = true,
	noOverwrite = true
})

Levâ i spàççi giànchi

I argoménti vêui sun de spésso 'n problêma pe-a conversción de template MediaWiki in Lua: inta scintàsci di template e strìnghe vêue e quélle formæ da spàççi sun conscideræ fâse, pe cóntra in Lua sun conscideræ vêe. Pe evitâ sto problêma chi o mòdolo leva in ötomàtico tùtti i argoménti vêui o formæ sôlo da spàççi.

Quànde sèrvan quèsti argoménti vêui o i spàççi giànchi se pœ impostâ e scèlte trim e removeBlanks a false.

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

Formataçión personalizâ di argoménti

Se se vœ levâ çèrtidùn argoménti vêui, ma no âtri, o se vœ rénde minóscoli tùtti i argoménti poxiçiónali, se pœ adêuviâ a scèlta valueFunc. L'input de sta scèlta chi dêve êse 'na fonçión co doî paràmetri, key e value, e restitoísce 'n valô séncio, restitoîo quànde se acêde a-o cànpo key inta tabèlla args.

Prìmmo ezénpio: sta fonçión chi conserva i spàççi vêui pe-o prìmmo argoménto poxiçiónale, ma o leva da l'inìçio e da-a fìn de tùtti i argoménti e quélli vêui.

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

Segóndo ezénpio: sta fonçión chi leva i argoménti vêui e converte quélli no vêui in minóscolo, ma no leva i spàççi da-i argoménti poxiçiónali.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})

Nòtta: e fonçioîn chi de d’âto faliscian se l'input non l'è do tîpo string ò nil. Quèsto pœ sucêde se l'è adêuviaa a fonçión getArgs inta fonçión prinçipâ do mòdolo e quélla fonçión l'è reciamòu da 'n âtro modulo Lua. Pe evitâ sto problêma chi se dêve adêuvâ 'na fonçión specìfica pe-i argoménti ciamòu da 'n #invoke (ö sæ co 'na fonçioîn p.main e 'na p._main).

Ezénpio 1 e ezénpio 2

Ezénpio 1:

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
})

Ezénpio 2:

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
})

Zaché a fonçión valueFunc l'è ciamâta ciù ò mêno tùtte e vòtte che 'n argoménto vegne domandòu da-a tabélla args bezugna aseghiâse che o seu còdice segge eficénte.

Frame e frame poæ

I argoménti da tabélla args pœan êse passæ contenporaniaménte da-o frame corénte (quéllo ciamòu co #invoke) o da-o seu frame poæ (quéllo chi contegne o #invoke). Se prezénpio emmu 'n mòdolo ciamòu Module:ExampleArgs quésto stampa i prìmmi doî argoménti poxiçiónali riçevûi.

Còdice de Modulo:ExampleArgs
local getArgs = require('Modulo: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


Module:ExampleArgs vegne ciamòu da Template:ExampleArgs, che contegne o còdice {{#invoke:ExampleArgs|main|firstInvokeArg}}. Quèsto prodûe cómme rizultâto "firstInvokeArg".

I poscìbile rizultâti da ciamâta de Template:ExampleArgs sun:

Còdice Rizultâto
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstInvokeArg secondTemplateArg

Ghe sun træ inpostaçioîn da adêuviâ pe cangiâ sto conportaménto: frameOnly, parentOnly e parentFirst. Se frameOnly l'è true alôa saián acetæ sôlo i argoménti passæ da-o frame atoâle, se parentOnly l'è true saián acetæ sôlo i argoménti passæ da-o frame poæ (o template) e se parentFirst l'è true saián acetæ ségge i argoménti do frame atoâle che quélli do frame poæ, i quæ avián a prioritæ. Prezénpio i rizultâti saián:

frameOnly pe esclùdde i argoménti da-o template
Còdice Rizultâto
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstInvokeArg
parentOnly pe avéi sôlo i argoménti da-o template
Còdice Rizultâto
{{ExampleArgs}}
{{ExampleArgs|firstTemplateArg}}î firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstTemplateArg secondTemplateArg
parentFirst pe avéi i argoménti da-o template che prevalan in scî argoménti da fonçión reciamante
Còdice Rizultâto
{{ExampleArgs}} firstInvokeArg
{{ExampleArgs|firstTemplateArg}} firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}} firstTemplateArg secondTemplateArg

Nòtte

  1. Se tùtte dôe e scèlte frameOnly e parentOnly sun true, o mòdolo non ricuperîa nisciùn argoménto da-a ciamâta de #invoke.
  2. Inte çèrtidùn scitoaçion o frame poæ puriéiva no êse disponìbile, prezénpio se a getArgs vegne passòu o frame poæ ciufîto che quéllo atoâle. Inte sto câxo chi sôlo i argoménti do frame atoâle saián uzæ, se parentOnly l'è vêo no saiâ dêuviòu nisciùn argoménto e parentFirst e frameOnly no avián efètto.

Wrappers

L'opzione wrappers è da utilizzare per specificare un numero limitato di template di interfaccia, cioè template il cui solo scopo è di chiamare un modulo. Se il modulo rileva di essere chiamato da uno dei template elencati nell'opzione wrappers controllerà solo gli argomenti del frame padre, in caso contrario controllerà solo gli argomenti nel frame passato a getArgs. questo permette ai moduli di essere chiamati da un'#invoke oppure da un template di interfaccia senza la perdita di performance associata al dover controllare sia il frame padre che quello corrente per ogni accesso a un argomento.

Ad esempio il codice del template di en.wiki en:Template:Side box è {{#invoke:Side box|main}} (ecludendo il contenuto in <noinclude>…</noinclude>). Non c'è motivo per controllare gli argomenti passati direttamente all'#invoke dato che non c'è nessun argomento nella chiamata nel codice del template. Potremmo evitare di controllarli usando l'opzione parentOnly, ma in questo caso l'#invoke non funzionerebbe se richiamata da pagine diverse da en:Template:Side box. Per esempio se il modulo Side box venisse richiamato da un'altra pagina con il codice {{#invoke:Side box|main|text=Some text}} il valore del parametro text sarebbe ignorato. Usando l'opzione wrappers per specificare Template:Side box come template di interfaccia, possiamo fare in modo che una chiamata {{#invoke:Side box|main|text=Some text}} presente in altre pagine funzioni anche se modulo continuerà ad evitare di controllare gli argomenti se chiamato dal template Template:Side box.

Le pagine contenenti template di interfaccia possono essere specificate come stringa o come array di stringhe.

Wrappers can be specified either as a string, or as an array of strings.

local args = getArgs(frame, {
wrappers = 'Template:Wrapper template'
})


local args = getArgs(frame, {
wrappers = {
'Template:Wrapper 1',
'Template:Wrapper 2',
-- Any number of wrapper templates can be added here.
}
})

Note:

  1. Il modulo riconoscerà automatica se richiamato dalla sottopagina /sandbox di un template di interfaccia. Quindi non è necessario specificarle.
  2. L'opzione wrappers cambia il default delle opzioni frameOnly, parentOnly e parentFirst. Se per esempio parentOnly viene settato escplictamente a falso le chiamate dal template di interfaccia caricheranno sia gli argomenti del template corrente che in uqello padre, sebbene chiamate attraverso template diversi da quelli specificati come di interfaccia caricheranno solo gli argomenti del frame corrente.
  3. Se l'opzione quando l'opzione wrappers è settata non è disponibile un frame padre il modulo userà gli argomenti del frame corrente passati a getArgs.

Scrivere sulla tabella args

A volte può essere utile scrivere nuovi valori sulla tabella args. Questo è possibile usando il valore di default di questo modulo. Comunque di solito è uno stile di codifica migliore creare una nuova tabella in cui copiare gli argomenti necessari dalla tabella args e i nuovi valori.

args.foo = 'some value'

È possibile alterare questo comportamento con le opzioni readOnly e noOverwrite. Se readOnly è true allora non è possibile scrivere nuovi valori nella tabella args. Se noOverwrite è true è possibile aggiungere nuovi valori ma non è possibile cambiare un valore passato dall'#invoke.

Tag Ref

Questo modulo usa metatable per recuperare gli argomenti da #invoke senza usare la funzione pairs() per accedere al frame corrente e al frame padre. Questo può essere d'aiuto se gli argomenti passati al modulo possono contenere tag <ref>…</ref>.

Nel momento in cui un un modulo Lua accede a un argomento contenente un tag <ref>…</ref> questo è immediatamente processato dal software Mediawiki e il suo contenuto viene aggiunto nella lista di note a fondo voce. Se per qualche motivo il modulo omette dal risultato che ritorna l'argomento contenente il tag ref questo creerà una nota fantasma — una nota che appare nella lista delle note, ma senza alcun numero a cui collegarsi. Questo è stato un problema con i moduli che usano la funzione pairs() per rilevare l'uso degli argomenti dal frame corrente o dal frame padre, dato che questi processano automaticamente tutti gli argomenti disponibili.

Questo modulo risolve il problema permettendo l'accesso sia agli argomenti del frame che del frame padre, pur recuperando gli argomenti solo se necessario. Il problema comunque si ripresenterà se usate la funzione pairs(args) da qualche altra parte del vostro modulo.

Limitazioni note

L'uso delle metatable ha i suoi svantaggi. La maggior parte delle funzioni Lua per le tabelle non funzionerà propriamente sulla tabella args, incluso l'operatore #, la funzione next() e le funzioni della libreria table. Se usare queste è importante per il vostro modulo dovrete processare gli argomenti con una vostra funzione invece di usare questo modulo.


-- 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