Модуль:Arguments/doc

Данный модуль служит для облегчения обработки аргументов, передаваемых в <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>. Это мета-модуль, предназначенный для использования в других модулях, а не вики-страницах напрямую. Его функционал включает:

• Облегчение обрезки аргументов и удаления пустых аргументов.
• Аргументы, передаваемые не только текущим фреймов, но и родительским фреймом. (См. ниже)
• Аргументы, передаваемые из другого модуля или отладочной консоли.
• Аргументы передаются как надо, что может помочь избежать части проблем с тэгами <ref></ref>.
• Большинство возможностей поддаются настройке.

Базовое использование

Первым делом, необходимо загрузить модуль. Он содержит всего одну функцию — <syntaxhighlight lang="text" class="" id="" style="" inline="1">getArgs</syntaxhighlight>. <syntaxhighlight lang="lua">local getArgs = require('Module:Arguments').getArgs</syntaxhighlight> В наиболее простом сценарии вы можете использовать <syntaxhighlight lang="text" class="" id="" style="" inline="1">getArgs</syntaxhighlight> в главной функции вашего модуля. Переменная <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight> содержит таблицу аргументов, переданных в <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>.

<syntaxhighlight lang="lua">local getArgs = require('Module:Arguments').getArgs local p = {}

function p.main(frame) local args = getArgs(frame) -- Основной код модуля. end

return p</syntaxhighlight>

Тем не менее, принятая практика заключается в использовании функции отдельной функции для получения аргуметов из <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> и отдельной функции для их обработки — чтобы было проще вызывать ваши функции из другого модуля без передачи аргумента <syntaxhighlight lang="text" class="" id="" style="" inline="1">frame</syntaxhighlight>, что положительно влияет на производительность.

<syntaxhighlight lang="lua">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) -- Основной код модуля. end

return p</syntaxhighlight>

Если вам нужно несколько разных функций, использующих аргументы вызова, вы можете использовать функцию-обёртку.

<syntaxhighlight lang="lua">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) -- Код первой функции. end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args) -- Код второй функции. end

return p</syntaxhighlight>

Опции

Доступные опции приведены ниже. <syntaxhighlight lang="lua">local args = getArgs(frame, { trim = false, removeBlanks = false, valueFunc = function (key, value) -- код, обрабатывающий единственный аргумент end, frameOnly = true, parentOnly = true, parentFirst = true, wrappers = { 'Шаблон:Обёртка', 'Шаблон:Другая обёртка' }, readOnly = true, noOverwrite = true })</syntaxhighlight>

Обрезка и удаление пробелов

Пустые аргументы могут представлять сложность при портировании кода шаблонов на Lua. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к <syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>. В Lua же такие строки соответствуют <syntaxhighlight lang="lua" inline="1">true</syntaxhighlight>. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.

Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.

Однако же, если требуется сохранить эти пробелы, можно задать опциям <syntaxhighlight lang="text" class="" id="" style="" inline="1">trim</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">removeBlanks</syntaxhighlight> значение <syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>.

<syntaxhighlight lang="lua">local args = getArgs(frame, { trim = false, removeBlanks = false })</syntaxhighlight>

Произвольное форматирование аргументов

В некоторых случаях может потребоваться удалить только часть пустых аргументов или, например, привести все позиционные аргументы к нижнему регистру. Для этого можно использовать опцию <syntaxhighlight lang="text" class="" id="" style="" inline="1">valueFunc</syntaxhighlight>. На вход этой опции должна подавиться функция от двух параметров, key и value, возвращающая единственное значение. Это значение будет записано в поле <syntaxhighlight lang="text" class="" id="" style="" inline="1">key</syntaxhighlight> таблицы <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight>.

Пример 1: оставлять нетронутыми пробелы в первом позиционном аргументе и применять стандартную обрезку для прочих. <syntaxhighlight lang="lua">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 })</syntaxhighlight>

Пример 2: удалить пробельные и пустые аргументы и привести все аргументы к нижнему регистру, но не обрезать пробелы из позиционных аргументов. <syntaxhighlight lang="lua">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 })</syntaxhighlight>

Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу <syntaxhighlight lang="text" class="" id="" style="" inline="1">string</syntaxhighlight> или <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight>. Это может произойти при вызове функции <syntaxhighlight lang="text" class="" id="" style="" inline="1">getArgs</syntaxhighlight> из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> такая проблема не стоит.

Примеры 1 и 2 с проверкой типов

Пример 1: <syntaxhighlight lang="lua">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 })</syntaxhighlight>

Пример 2 2: <syntaxhighlight lang="lua">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 })</syntaxhighlight>

Также следует обращать внимание, что функция <syntaxhighlight lang="text" class="" id="" style="" inline="1">valueFunc</syntaxhighlight> вызывается приблизительно при каждом запросе к таблице <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight>, так что если стоит вопрос производительности, эта функция не должна быть дорогой.

Фреймы и родительские фреймы

Аргументы в таблице <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight> могут одновременно передаваться из текущего фрейма и его родительского фрейма. Это можно понять на примере. Например, есть модуль <syntaxhighlight lang="text" class="" id="" style="" inline="1">Module:ExampleArgs</syntaxhighlight>, работа которого заключается в выводе двух первых переданных позиционных аргументов.

Код модуля ExampleArgs

<syntaxhighlight lang="lua">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</syntaxhighlight>

<syntaxhighlight lang="text" class="" id="" style="" inline="1">Модуль:ExampleArgs</syntaxhighlight> вызывается шаблоном {{ExampleArgs}}, код которого — {{#invoke:ExampleArgs|main|первый_аргумент_вызова}}. По умолчанию он возвращает текст «первый_аргумент_вызова».

Далее возможны следующие варианты:

Код	Результат
{{ExampleArgs}}	первый_аргумент_вызова
{{ExampleArgs|первый_аргумент_вызова}}	первый_аргумент_вызова
{{ExampleArgs|первый_аргумент_вызова|второй_аргумент_вызова}}	первый_аргумент_вызова второй_аргумент_вызова

Это поведение можно изменить тремя опциями: <syntaxhighlight lang="text" class="" id="" style="" inline="1">frameOnly</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentOnly</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentFirst</syntaxhighlight>. При установке <syntaxhighlight lang="text" class="" id="" style="" inline="1">frameOnly</syntaxhighlight> будут обрабатываться только аргументы фрейма, где происходит непосредственно вызов <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>; при установке <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentOnly</syntaxhighlight> будут обрабатываться только аргументы родительского фрейма; при установке <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentFirst</syntaxhighlight> будут обрабатываться аргументы из обоих фреймов, но в первую очередь родительского. В случае рассматриваемого {{ExampleArgs}} это будет выглядеть так:

frameOnly

Код	Результат
{{ExampleArgs}}	первый_аргумент_вызова
{{ExampleArgs|первый_аргумент_шаблона}}	первый_аргумент_вызова
{{ExampleArgs|первый_аргумент_шаблона|второй_аргумент_шаблона}}	первый_аргумент_вызова

parentOnly

Код	Результат
{{ExampleArgs}}
{{ExampleArgs|первый_аргумент_шаблона}}	первый_аргумент_шаблона
{{ExampleArgs|первый_аргумент_шаблона|второй_аргумент_шаблона}}	первый_аргумент_шаблона второй_аргумент_шаблона

parentFirst

Код	Результат
{{ExampleArgs}}	первый_аргумент_вызова
{{ExampleArgs|первый_аргумент_шаблона}}	первый_аргумент_шаблона
{{ExampleArgs|первый_аргумент_шаблона|второй_аргумент_шаблона}}	первый_аргумент_шаблона второй_аргумент_шаблона

Замечания:

1. При установке одновременно опций <syntaxhighlight lang="text" class="" id="" style="" inline="1">frameOnly</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentOnly</syntaxhighlight> модуль не получит никаких аргументов из <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>. Так делать не стоит.
2. В некоторых ситуациях родительский фрейм может быть недоступен, например, если он был сразу подан на вход функции <syntaxhighlight lang="text" class="" id="" style="" inline="1">getArgs</syntaxhighlight>. Тогда могут использоваться лишь аргументы этого фрейма (если установлена опция <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentOnly</syntaxhighlight>, то никакие аргументы получить не удастся), а <syntaxhighlight lang="text" class="" id="" style="" inline="1">parentFirst</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">frameOnly</syntaxhighlight> не будут иметь эффекта.

Обёртки

Опция wrappers используется для указания ограниченного числа шаблонов как шаблонов-обёрток, то есть шаблонов, чьей единственной целью является вызов модуля. Если модуль обнаружит, что вызывается из шаблона-обёртки, то будут проверяться только аргументы родительского фрейма, иначе будут проверяться только аргументы непосредственного вызывающего фрейма. Это позволяет вызвать модули через <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> и через шаблон-обёртку без потери производительности из-за поиска аргументов в двух фреймах.

Например, единственное содержимое шаблона {{optp}} вне тэгов <noinclude></noinclude> это вызов {{#invoke:Template call code|onlyParams}}. Нет смысла проверять аргументы, передаваемые <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> на странице шаблона, поскольку там их никогда не будет. Этого можно избежать с помощью опции parentOnly, но тогда <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight> не будет работать и на других страницах. В таком случае параметр |text=Некий текст в коде {{#invoke:Template call code|onlyParams|text=Некий текст}} игнорировался бы на всех страницах. Но если мы укажем в опции wrappers 'Шаблон:Optp', код {{#invoke:Template call code|onlyParams|text=Некий текст}} будет работать на всех страницах, не проверяя аргументы на странице шаблона.

Обёртки могут задаваться строкой или массивом строк.

<syntaxhighlight lang="lua">local args = getArgs(frame, { wrappers = 'Шаблон:Обёртка' })</syntaxhighlight>

<syntaxhighlight lang="lua">local args = getArgs(frame, { wrappers = { 'Шаблон:Обёртка 1', 'Шаблон:Обёртка 2', -- Тут может быть задано любое количество шаблонов. } })</syntaxhighlight>

Замечания:

1. Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.
2. Опцияwrappers изменяет поведение по умолчанию опций frameOnly и parentOnly. Например, если parentOnly явным образом установлена в <syntaxhighlight lang="lua" inline="1">false</syntaxhighlight> при установленных wrappers, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.
3. Если опция wrappers установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции <syntaxhighlight lang="text" class="" id="" style="" inline="1">getArgs</syntaxhighlight>.

Запись в таблицу args

Иногда может быть полезно записать новые значения в таблицу <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight>. При настройках данного модуля по умолчанию это возможно. (Теме не менее, в большинстве случаев лучшим подходом будет создать новую таблицу с новыми значениями и копировать туда нужные значения <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight>.)

<syntaxhighlight lang="lua">args.foo = 'some value'</syntaxhighlight>

С помощью установки опций readOnly и noOverwrite это поведение можно переопределить. Если установлена опция readOnly, в таблицу <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight> нельзя вносить изменения вообще. При установке же опции noOverwrite можно добавлять новые значения, но нельзя менять уже имеющиеся в таблице значения, полученные из <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>.

Тэги ref

Данный модуль использует метатаблицы, чтобы получить аргументы <syntaxhighlight lang="text" class="" id="" style="" inline="1">#invoke</syntaxhighlight>. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции <syntaxhighlight lang="lua" inline="1">pairs()</syntaxhighlight>. Это может быть полезно при передаче на вход тэгов <ref></ref>.

Поскольку из Lua происходит доступ к тэгам <ref></ref>, они обрабатываются движком MediaWiki и примечание появляется в списке примечаний (<referenes />). Если модуль не выводит содержимое тэгов, то может появиться сноска-призрак, отображающаяся только в списке примечаний, но не в основном тексте. Это может являться проблемой для модулей, использующих <syntaxhighlight lang="lua" inline="1">pairs()</syntaxhighlight> для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.

Эта проблема не стоит при использовании данного модуля, поскольку хотя доступ к аргументам производится только по необходимости. Однако же при явном вызове <syntaxhighlight lang="lua" inline="1">pairs(args)</syntaxhighlight> в коде функций, ошибочное поведение может воспроизводиться.

Известные ограничения

У использования метатаблиц есть свои недостатки. Большинство инструментов для работы с обычными таблицами Lua не будут корректно работать с таблицей <syntaxhighlight lang="text" class="" id="" style="" inline="1">args</syntaxhighlight>, включая оператор <syntaxhighlight lang="text" class="" id="" style="" inline="1">#</syntaxhighlight>, функцию <syntaxhighlight lang="lua" inline="1">next()</syntaxhighlight> и функции из стандартной библиотеки <syntaxhighlight lang="text" class="" id="" style="" inline="1">table</syntaxhighlight>. Если данные функции необходимы для работы модуля, может понадобиться своя реализация обработки аргументов. Также возможно использование функций из модуля TableTools.