Modul:Arguments

Arguments[mi ez?] • [dokumentáció: mutat, szerkeszt] • [tesztek: létrehozás]

Ez a modul az #invoke-kal hívott modulok paramétereinek egyszerű feldolgozását segíti. Ez egy meta-modul, azaz más modulok használják, ezért az #invoke-kal történő közvetlen hívása értelmetlen. Képességei:

A paraméterek kezdő és záró szőközöktől való megtisztítása (trim). Az üres paraméterek eldobása
A paramétereket az aktuális és a szülő feldolgozókeret is egyszerre át tudja adni. (Részletek lejjebb.)
A paraméterek átadhatók: más Lua modulból közvetlenül, vagy hibakereső (debug) konzolról.
A paraméterek, akkor kerülnek átvételre, amikor szükség van rájuk, ezzel elkerülhetők egyes, a referencia tag-ekből adódó problémák.
A legtöbb képesség testreszabható.

Alap felhasználási mód

Legelőször be kell tölteni a modult. Egyetlen függvényt, a getArgs-ot tartalmazza.

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

A legegyszerűbb esetben a getArgs a hívó modul fő függvényből meghívható. Az args változó egy tábla, amely az #invoke-ból jövő paramétereket tartalmazza. (Részletek lejjebb.)

local getArgs = require('Modul:Arguments').getArgslocal p = {}function p.main(frame)local args = getArgs(frame)-- Ide jön a modul fő kódja.endreturn p

Javasolt a függvényt elsősorban az #invoke-ból jövő paraméterek kezelésére használni. Azért, mert ha modulunkat egy másik Lua-modul közvetlenül hívja, nem kell külön keret-objektumot alkalmazni, ami növeli a kód futási teljesítményét.

local getArgs = require('Modul:Arguments').getArgslocal p = {}function p.main(frame)local args = getArgs(frame)return p._main(args)endfunction p._main(args)-- Ide jön a modul fő kódja.endreturn p

Ha több függvényben akarjuk felhasználni az #invoke-ból elérhető paramétereket, akkor egy külön függvénybe csomagolhatjuk a getArgs-ot:

local getArgs = require('Modul:Arguments').getArgslocal function makeInvokeFunc(funcName)return function (frame)local args = getArgs(frame)return p[funcName](args)endendlocal p = {}p.func1 = makeInvokeFunc('_func1')function p._func1(args)-- Ide jön az első függvény kódja.endp.func2 = makeInvokeFunc('_func2')function p._func2(args)-- Ide jön a második függvény kódja.endreturn p

Opciók

A következő opciók érhetők el (az alábbi szakaszokban elmagyarázzuk):

local args = getArgs(frame, {trim = false,removeBlanks = false,valueFunc = function (key, value)-- a paramétreket feldolgozó kódend,frameOnly = true,parentOnly = true,parentFirst = true,wrappers = {'Sablon:Burkoló sablon','Sablon:Másik burkoló sablon'},readOnly = true,noOverwrite = true})

Szóközök elhagyása és üres paraméterek eltávolítása

Az üres paraméterek problémájába gyakran beleütköznek a MediaWiki-sablonokat Luába konvertálni kívánó kezdő programozók. A sablon szintaxisában az üres vagy csak white space-t tartalmazó karakterláncok hamis értékűnek számítanak. Ugyanakkor a Lua ezeket a karakterláncokat igaz értékűnek tekinti. Ha tehát nem figyelünk ezekre a különbségekre, akkor előfordulhat, hogy a Lua-modulban igazként kezelünk valamit, amit valójában hamis értékűnek kellene vennünk. Hogy az ilyen helyzeteket elkerülhessük, ez a modul alapértelmezésben eltávolítja az üres paramétereket.

Hasonló gondot okozhatnak a névtelen paraméterek is. Jóllehet a white space el van távolítva az #invoke-ból nevesített paraméterek elejéről és végéről, ez nem történik meg a névtelen, ún. pozicionális paraméterek esetén. A legtöbbször nincs szükség ezekre a karakterekre, ezért ez a modul alapértelmezésben eltávolítja azokat.

Ha mégis szükség van az üres paraméterekre, illetve a paraméterszéleken megtalálható white space-re, például bizonyos sablonok működésének pontos lemásolása céljából, akkor a trim illetve removeBlanks paramétereket hamisra (false) kell állítani.

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

A paraméterek testreszabott formázása

Néha bizonyos üres paramétereket el kívánunk hagyni, másokat azonban nem, vagy esetleg minden névtelen paramétert kisbetűssé kívánunk tenni. Ilyen feladatokat a valueFunc opció segítségével tudunk megoldani. Ennek a bemenete egy kétváltozós függvény (key és value), visszatérési értéke pedig egyetlen érték, ami az args táblában a key mezőben lesz található.

1. példa: A függvény az első névtelen paraméter értékét pontosan megtartja, az összes többi paraméter széleiről eltávolítja a white space-t, és a többi üres paramétert pedig elhagyja.

local args = getArgs(frame, {valueFunc = function (key, value)if key == 1 thenreturn valueelseif value thenvalue = mw.text.trim(value)if value ~= '' thenreturn valueendendreturn nilend})

2. példa: Ez a függvény elhagyja az üres paramétereket, és valamennyi értékét kisbetűsíti, de nem távolítja el a white space-t.

local args = getArgs(frame, {valueFunc = function (key, value)if not value thenreturn nilendvalue = mw.ustring.lower(value)if mw.ustring.find(value, '%S') thenreturn valueendreturn nilend})

Megjegyzés: a fenti függvény hibás, ha a bemenete nem string típusú vagy nil. Ez olyankor fordulhat elő, ha a getArgs függvényt modulunk fő függvényében használjuk, amelyet viszont egy másik Lua-modul hív meg. Ebben az esetben ellenőrizni kell a bemeneti paraméter típusát. Ilyen gond nem lép fel, ha egy speciális függvényt használunk fel az #invoke paramétereinek beolvasására (pl. p.main a fő kódunk és a p._main speciális függvényt alkalmazzuk).

A valueFunc függvényt szinte minden alkalommal meghívjuk, ha szükségünk van a args tábla egy elemére; ha szempont számunkra a kód hatékonysága, akkor figyeljük, hogy ne maradjanak a kódunkban rossz hatékonyságú elemek.

Keretek és szülő-keretek

Mind az aktuális, mind a szülősablon kerete adhat át paramétereket az args táblába. A legegyszerűbben ezt egy példán keresztül érthetjük meg. Legyen ez a Modul:ExampleArgs modul. Ez a neki átadott két első névtelen paramétert írja ki.

A Modul:ExampleArgs modulunkat meghívja a Sablon:ExampleArgs sablon, amely a következő kódot tartalmazza: {{#invoke:ExampleArgs|main|firstInvokeArg}}. Ez a hívás a firstInvokeArg kimenetet eredményezi.

Ha most meghívjuk aSablon:ExampleArgs-t, a következő történik:

Kód	Eredmény
`{{ExampleArgs}}`	firstInvokeArg
`{{ExampleArgs\|firstTemplateArg}}`	firstInvokeArg
`{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}`	firstInvokeArg secondTemplateArg

Három kapcsoló áll rendelkezésünkre, hogy ezt a viselkedést megváltoztassuk: a frameOnly, a parentOnly és a parentFirst. Ha frameOnly kapcsolót használjuk, akkor csak az aktuális keret paramétereit fogadjuk el; ha a parentOnly kapcsolót állítjuk be, akkor csak szülőkeret paramétereit fogadjuk el, ha a parentFirst kapcsolót állítjuk be, mindkét helyről megkapjuk a paramétereket, de a szülőkeret élvez elsőbbséget az aktuálissal szemben. Ezek a TSAblonExampleArgs futásának eredményei:

frameOnly

Kód	Eredmény
`{{ExampleArgs}}`	firstInvokeArg
`{{ExampleArgs\|firstTemplateArg}}`	firstInvokeArg
`{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}`	firstInvokeArg

parentOnly

Kód	Eredmény
`{{ExampleArgs}}`
`{{ExampleArgs\|firstTemplateArg}}`	firstTemplateArg
`{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}`	firstTemplateArg secondTemplateArg

parentFirst

Kód	Eredmény
`{{ExampleArgs}}`	firstInvokeArg
`{{ExampleArgs\|firstTemplateArg}}`	firstTemplateArg
`{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}`	firstTemplateArg secondTemplateArg

Megjegyzések:

Ha a frameOnly és a parentOnly kapcsolót is beállítjuk, a modul egyik paramétert sem fogja beolvasni. Valószínűleg ilyet nem akarunk.
Bizonyos esetekben a szülő-keret nem elérhető: pl. getArgs eleve a szülőkeretet kapja meg aktuális helyett. Ebben az esetben csak az átadott keret paraméterei használhatóak (kivéve ha a parentOnly be van kapcsolva, mert ilyenkor egyetlen paramétert sem használunk fel). Ilyenkor a parentFirst és frameOnly kapcsolók hatástalanok.

Burkolósablonok (Wrappers)

A wrappers kapcsolót arra használjuk, hogy megjelöljük az ún. burkolósablonokat, vagyis olyan sablonokat, amelyeknek egyetlen funkciója az, hogy egy adott modult meghívjanak. Ha a modul érzékeli, hogy a burkolósablon hívja, akkor csak a szülősablon keretének paramétereit fogja tekintetbe venni, azaz csak a getArgs-nak átadott keret paramétereit fogja ellenőrizni. Ezzel elérjük, hogy a modult akár #invoke-kal, akár burkolósablonnal hívjuk, csak a szükséges paramétereket fogja ellenőrizni, növelve ezzel a kód hatékonyságát.

Például: Ha Sablon:Side box összes valódi tartalma (a noinclude tag-ek en kívül): {{#invoke:Side box|main}}, akkor semmi értelme, hogy megpróbáljuk megkeresni az #invoke parancsnak átadott paramétereket, mivel ilyenek egyszerűen nincsenek. Az #invoke paramétereinek fölösleges ellenőrzése elkerülhető parentOnly kapcsoló használatával is, de ha ezt tesszük, akkor a más sablonokban elhelyezett #invoke-ok paramétereit sem fogjuk látni. Pl. a |text=Some text a {{#invoke:Side box|main|text=Some text}} kódban mindig figyelmen kívül maradna, függetlenül attól, hogy mely lapról alkalmaznánk. A wrappers kapcsoló segítségével a Sablon:Side boxot burkolósablonként jelöljük meg, így a {{#invoke:Side box|main|text=Some text}} kód a legtöbb lapról működni fog, míg magán a Sablon:Side box lapon továbbra sem történik meg a fölösleges paraméter-ellenőrzés.

A burkolósablonokat karakterláncként, vagy azok tömbjeként adhatjuk meg.

local args = getArgs(frame, {wrappers = 'Sablon:Burkolósablon'})

local args = getArgs(frame, {wrappers = {'Template:Burkoló 1','Template:Burkoló 2',-- akárhány további (burkoló-) sablon neve megadható itt}})

Megjegyzések:

A modul automatikusan érzékeli, ha burkolósablon /sandbox allapjáról hívják, ezért a homokozóallapokat nem szükséges explicit módon megadni.
A wrappers kapcsoló automatikusan igazítja a frameOnly és parentOnly kapcsolókat az értelemszerűen helyes működésre. Például, ha parentOnly kapcsolót a wrappers beállításával automatikusan false-ra állítanánk, akkor a burkolósablonon keresztül történő hívások a keret és a szülőkeret paramétereit minden esetben beolvasnák, míg a nem burkolósablonokon keresztül történő hívások mindig csak a keret paramétereit adnák át.
Ha a wrappers kapcsoló be van állítva, de nem érhető el szülő keret, a modul monden esetben a getArgs-nak átadott keret paramétereit fogja kiolvasni.

Az args paramétertábla írása

Néha hasznosnak bizonyulhat, ha a paraméterek táblájába új értékeket tudunk elhelyezni. Ez ennek a modulnak az alapbeállításaival is lehetséges. (Jóllehet, általában véve jobb kódolási gyakorlat, ha új táblát hozunk létre az új értékekkel, és belemásoljuk a paraméterek közül a szükségeseket.)

args.foo = 'valamilyen érték'

Ez az alapviselkedés megváltoztatható a readOnly és noOverwrite kapcsolókkal. Ha a readOnly kapcsoló be van állítva, akkor az args paramétertáblába nem írható semmilyen új érték. Ha a noOverwrite be van állítva, akkor új értékek adhatók a táblához, de meglévőek nem írhatóak felül.

Lábjegyzetek

Ez a modul metatáblákat használ arra, hogy a paramétereket olvassanak ki az #invoke-ból. Ez lehetővé teszi, hogy mind a keret, és mind a szülőkeret paramétereit kiolvassuk anélkül, hogy a pairs() függvényt használnánk. Ez hasznos lehet akkor, ha a modulunk lábjegyzeteket (<ref> címkéket) tartalmazó bemenetet kaphat.

Ha a Luából <ref> címkét tartalmazó szöveget érünk el, a MediaWiki szoftver azonnal feldolgozza azt, és a lábjegyzet megjelenik a cikk alján. Amennyiben a szöveg végül nem kerül bele a kimenetbe, egy fantomjegyzet keletkezik – a listában megjelenik, de nem mutat rá hivatkozás. Ez olyan modulok számára volt probléma, amelyek a pairs() függvényt használták annak eldöntésére, hogy a paramétereket az aktuális keretből vagy annak szülőkeretéből vegyék, mivel ezek a modulok így automatikusan minden elérhető paramétert feldogoztak.

Ez a modul megoldja ezt a problémát azzal, hogy lehetővé teszi mind az aktuális, mind a szülő keret paramétereinek kiolvasását, de csak akkor, ha ténylegesen szükség van rájuk. A probléma azonban még előfordulhat, ha a pairs(args) függvényt a modul másik részén felhasználjuk.

Ismert problémák

A metatáblák használatának hátrányai is vannak. A legtöbb szokásos Lua-táblaeszköz nem működik rendesen az args táblán, beleértve a # operátort, a next() függvényt és a table könyvtár függvényeit. Ha mindenképpen szükséged van ezekre a modulodban, saját paraméterfeldolgozó függvényt kell írnod ennek a modulnak a használata helyett.

-- 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.checkTypelocal 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' thenval = val:match('^%s*(.-)%s*$')if val == '' thenreturn nilelsereturn valendelsereturn valendendlocal function tidyValTrimOnly(key, val)if type(val) == 'string' thenreturn val:match('^%s*(.-)%s*$')elsereturn valendendlocal function tidyValRemoveBlanksOnly(key, val)if type(val) == 'string' thenif val:find('%S') thenreturn valelsereturn nilendelsereturn valendendlocal function tidyValNoChange(key, val)return valendlocal function matchesTitle(given, title)local tp = type( given )return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == titleendlocal 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 thensetmetatable(options.translate, translate_mt)endif options.backtranslate == nil thenoptions.backtranslate = {}for k,v in pairs(options.translate) dooptions.backtranslate[v] = kendendif options.backtranslate and getmetatable(options.backtranslate) == nil thensetmetatable(options.backtranslate, {__index = function(t, k)if options.translate[k] ~= k thenreturn nilelsereturn kendend})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, luaArgsif type(frame.args) == 'table' and type(frame.getParent) == 'function' thenif 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 thenfargs = frame.argselselocal title = parent:getTitle():gsub('/sandbox$', '')local found = falseif matchesTitle(options.wrappers, title) thenfound = trueelseif type(options.wrappers) == 'table' thenfor _,v in pairs(options.wrappers) doif matchesTitle(v, title) thenfound = truebreakendendend-- We test for false specifically here so that nil (the default) acts like true.if found or options.frameOnly == false thenpargs = parent.argsendif not found or options.parentOnly == false thenfargs = frame.argsendendelse-- options.wrapper isn't set, so check the other options.if not options.parentOnly thenfargs = frame.argsendif not options.frameOnly thenlocal parent = frame:getParent()pargs = parent and parent.args or nilendendif options.parentFirst thenfargs, pargs = pargs, fargsendelseluaArgs = frameend-- 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] = pargsargTables[#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.valueFuncif tidyVal thenif type(tidyVal) ~= 'function' thenerror("bad value assigned to option 'valueFunc'".. '(function expected, got '.. type(tidyVal).. ')',2)endelseif options.trim ~= false thenif options.removeBlanks ~= false thentidyVal = tidyValDefaultelsetidyVal = tidyValTrimOnlyendelseif options.removeBlanks ~= false thentidyVal = tidyValRemoveBlanksOnlyelsetidyVal = tidyValNoChangeendend--[[-- 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) dofor key, val in pairs(t) doif metaArgs[key] == nil and nilArgs[key] ~= 'h' thenlocal tidiedVal = tidyVal(key, val)if tidiedVal == nil thennilArgs[key] = 's'elsemetaArgs[key] = tidiedValendendendendend--[[-- 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' thenkey = options.translate[key]endlocal val = metaArgs[key]if val ~= nil thenreturn valelseif metatable.donePairs or nilArgs[key] thenreturn nilendfor _, argTable in ipairs(argTables) dolocal argTableVal = tidyVal(key, argTable[key])if argTableVal ~= nil thenmetaArgs[key] = argTableValreturn argTableValendendnilArgs[key] = 'h'return nilendmetatable.__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' thenkey = options.translate[key]endif options.readOnly thenerror('could not write to argument table key "'.. tostring(key).. '"; the table is read-only',2)elseif options.noOverwrite and args[key] ~= nil thenerror('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] = nilnilArgs[key] = 'h'elsemetaArgs[key] = valendendlocal function translatenext(invariant)local k, v = next(invariant.t, invariant.k)invariant.k = kif k == nil thenreturn nilelseif type(k) ~= 'string' or not options.backtranslate thenreturn k, velselocal backtranslate = options.backtranslate[k]if backtranslate == nil then-- Skip this one. This is a tail call, so this won't cause stack overflowreturn translatenext(invariant)elsereturn backtranslate, vendendendmetatable.__pairs = function ()-- Called when pairs is run on the args table.if not metatable.donePairs thenmergeArgs(argTables)metatable.donePairs = trueendreturn translatenext, { t = metaArgs }endlocal function inext(t, i)-- This uses our __index metamethodlocal v = t[i + 1]if v ~= nil thenreturn i + 1, vendendmetatable.__ipairs = function (t)-- Called when ipairs is run on the args table.return inext, t, 0endreturn argsendreturn arguments

Search