Модуль:Arguments/doc: различия между версиями

Материал из Народные сказки
Перейти к навигации Перейти к поиску
Нет описания правки
Нет описания правки
Строка 12: Строка 12:
== Базовое использование ==
== Базовое использование ==
Первым делом, необходимо загрузить модуль. Он содержит всего одну функцию — {{code|getArgs}}.
Первым делом, необходимо загрузить модуль. Он содержит всего одну функцию — {{code|getArgs}}.
{{Luacode|1=
{{LuaCode|1=
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
}}
}}
В наиболее простом сценарии вы можете использовать {{code|getArgs}} в главной функции вашего модуля. Переменная {{code|args}} содержит таблицу аргументов, переданных в {{code|#invoke}}.  
В наиболее простом сценарии вы можете использовать {{code|getArgs}} в главной функции вашего модуля. Переменная {{code|args}} содержит таблицу аргументов, переданных в {{code|#invoke}}.  


{{Luacode|1=
{{LuaCode|1=
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local p = {}
local p = {}
Строка 31: Строка 31:
Тем не менее, принятая практика заключается в использовании функции отдельной функции для получения аргуметов из {{code|#invoke}} и отдельной функции для их обработки — чтобы было проще вызывать ваши функции из другого модуля без передачи аргумента {{code|frame}}, что положительно влияет на производительность.
Тем не менее, принятая практика заключается в использовании функции отдельной функции для получения аргуметов из {{code|#invoke}} и отдельной функции для их обработки — чтобы было проще вызывать ваши функции из другого модуля без передачи аргумента {{code|frame}}, что положительно влияет на производительность.


{{Luacode|1=
{{LuaCode|1=
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local p = {}
local p = {}
Строка 49: Строка 49:
Если вам нужно несколько разных функций, использующих аргументы вызова, вы можете использовать функцию-обёртку.
Если вам нужно несколько разных функций, использующих аргументы вызова, вы можете использовать функцию-обёртку.


{{luacode|1=
{{LuaCode|1=
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs


Строка 78: Строка 78:
=== Опции ===
=== Опции ===
Доступные опции приведены ниже.
Доступные опции приведены ниже.
{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
trim = false,
trim = false,
Строка 104: Строка 104:
Однако же, если требуется сохранить эти пробелы, можно задать опциям {{code|trim}} и {{code|removeBlanks}} значение {{luafalse}}.
Однако же, если требуется сохранить эти пробелы, можно задать опциям {{code|trim}} и {{code|removeBlanks}} значение {{luafalse}}.


{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
trim = false,
trim = false,
Строка 115: Строка 115:


Пример 1: оставлять нетронутыми пробелы в первом позиционном аргументе и применять стандартную обрезку для прочих.
Пример 1: оставлять нетронутыми пробелы в первом позиционном аргументе и применять стандартную обрезку для прочих.
{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
valueFunc = function (key, value)
valueFunc = function (key, value)
Строка 132: Строка 132:


Пример 2: удалить пробельные и пустые аргументы и привести все аргументы к нижнему регистру, но не обрезать пробелы из позиционных аргументов.
Пример 2: удалить пробельные и пустые аргументы и привести все аргументы к нижнему регистру, но не обрезать пробелы из позиционных аргументов.
{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
valueFunc = function (key, value)
valueFunc = function (key, value)
Строка 151: Строка 151:
{{Начало скрытого блока|Примеры 1 и 2 с проверкой типов}}
{{Начало скрытого блока|Примеры 1 и 2 с проверкой типов}}
Пример 1:
Пример 1:
{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
valueFunc = function (key, value)
valueFunc = function (key, value)
Строка 171: Строка 171:


Пример 2 2:
Пример 2 2:
{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
valueFunc = function (key, value)
valueFunc = function (key, value)
Строка 195: Строка 195:


{{Начало скрытого блока|Код модуля ExampleArgs}}
{{Начало скрытого блока|Код модуля ExampleArgs}}
{{luacode|1=
{{LuaCode|1=
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local p = {}
local p = {}
Строка 294: Строка 294:
Обёртки могут задаваться строкой или массивом строк.
Обёртки могут задаваться строкой или массивом строк.


{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
wrappers = 'Шаблон:Обёртка'
wrappers = 'Шаблон:Обёртка'
Строка 301: Строка 301:




{{luacode|1=
{{LuaCode|1=
local args = getArgs(frame, {
local args = getArgs(frame, {
wrappers = {
wrappers = {
Строка 319: Строка 319:
Иногда может быть полезно записать новые значения в таблицу {{code|args}}. При настройках данного модуля по умолчанию это возможно. (Теме не менее, в большинстве случаев лучшим подходом будет создать новую таблицу с новыми значениями и копировать туда нужные значения {{code|args}}.)
Иногда может быть полезно записать новые значения в таблицу {{code|args}}. При настройках данного модуля по умолчанию это возможно. (Теме не менее, в большинстве случаев лучшим подходом будет создать новую таблицу с новыми значениями и копировать туда нужные значения {{code|args}}.)


{{luacode|1=
{{LuaCode|1=
args.foo = 'some value'
args.foo = 'some value'
}}
}}
Строка 326: Строка 326:


=== Тэги ref ===
=== Тэги ref ===
Данный модуль использует [[mw:Extension:Scribunto/Lua reference manual/ru#Metatables|метатаблицы]], чтобы получить аргументы {{code|#invoke}}. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции {{luacode|pairs()|inline=1}}. Это может быть полезно при передаче на вход тэгов {{xtag|ref|p}}.
Данный модуль использует [[mw:Extension:Scribunto/Lua reference manual/ru#Metatables|метатаблицы]], чтобы получить аргументы {{code|#invoke}}. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции {{LuaCode|pairs()|inline=1}}. Это может быть полезно при передаче на вход тэгов {{xtag|ref|p}}.


Поскольку из Lua происходит доступ к тэгам {{Tag|ref}}, они обрабатываются движком MediaWiki и примечание появляется в списке примечаний ({{Tag|referenes|s}}). Если модуль не выводит содержимое тэгов, то может появиться сноска-призрак, отображающаяся только в списке примечаний, но не в основном тексте. Это может являться проблемой для модулей, использующих {{luacode|pairs()|inline=1}} для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.
Поскольку из Lua происходит доступ к тэгам {{Tag|ref}}, они обрабатываются движком MediaWiki и примечание появляется в списке примечаний ({{Tag|referenes|s}}). Если модуль не выводит содержимое тэгов, то может появиться сноска-призрак, отображающаяся только в списке примечаний, но не в основном тексте. Это может являться проблемой для модулей, использующих {{LuaCode|pairs()|inline=1}} для доступа к аргументам, поскольку эта функция осуществляет доступ ко всем доступным аргументам.


Эта проблема не стоит при использовании данного модуля, поскольку хотя доступ к аргументам производится только по необходимости. Однако же при явном вызове {{luacode|pairs(args)|inline=1}} в коде функций, ошибочное поведение может воспроизводиться.
Эта проблема не стоит при использовании данного модуля, поскольку хотя доступ к аргументам производится только по необходимости. Однако же при явном вызове {{LuaCode|pairs(args)|inline=1}} в коде функций, ошибочное поведение может воспроизводиться.


=== Известные ограничения ===
=== Известные ограничения ===
У использования метатаблиц есть свои недостатки. Большинство инструментов для работы с обычными таблицами Lua не будут корректно работать с таблицей {{code|args}}, включая оператор {{code|#}}, функцию {{luacode|next()|inline=1}} и функции из стандартной библиотеки {{code|table}}. Если данные функции необходимы для работы модуля, может понадобиться своя реализация обработки аргументов. Также возможно использование функций из модуля [[Module:TableTools|TableTools]].
У использования метатаблиц есть свои недостатки. Большинство инструментов для работы с обычными таблицами Lua не будут корректно работать с таблицей {{code|args}}, включая оператор {{code|#}}, функцию {{LuaCode|next()|inline=1}} и функции из стандартной библиотеки {{code|table}}. Если данные функции необходимы для работы модуля, может понадобиться своя реализация обработки аргументов. Также возможно использование функций из модуля [[Module:TableTools|TableTools]].
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Категория:Модули:Базовые]]
[[Категория:Модули:Базовые]]
}}</includeonly>
}}</includeonly>

Версия от 18:40, 14 мая 2023

Шаблон:Module rating

Данный модуль служит для облегчения обработки аргументов, передаваемых в #invoke. Это мета-модуль, предназначенный для использования в других модулях, а не вики-страницах напрямую. Его функционал включает:

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

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

Первым делом, необходимо загрузить модуль. Он содержит всего одну функцию — Шаблон:code.

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

В наиболее простом сценарии вы можете использовать Шаблон:code в главной функции вашего модуля. Переменная Шаблон:code содержит таблицу аргументов, переданных в Шаблон:code.

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

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

return p

Тем не менее, принятая практика заключается в использовании функции отдельной функции для получения аргуметов из Шаблон:code и отдельной функции для их обработки — чтобы было проще вызывать ваши функции из другого модуля без передачи аргумента Шаблон:code, что положительно влияет на производительность.

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

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

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

Опции

Доступные опции приведены ниже.

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

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

Пустые аргументы могут представлять сложность при портировании кода шаблонов на Lua. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к Шаблон:luafalse. В Lua же такие строки соответствуют Шаблон:luatrue. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.

Кроме того, пробелы могут вызывать проблемы при обработке позиционных аргументов. При вызове Шаблон:code из именованных параметров пробелы по краям удаляются сами, но сохраняются для позиционных параметров. Большинство таких пробелов на самом деле не нужно, поэтому модуль по умолчанию их обрезает.

Однако же, если требуется сохранить эти пробелы, можно задать опциям Шаблон:code и Шаблон:code значение Шаблон:luafalse.

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

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

В некоторых случаях может потребоваться удалить только часть пустых аргументов или, например, привести все позиционные аргументы к нижнему регистру. Для этого можно использовать опцию Шаблон:code. На вход этой опции должна подавиться функция от двух параметров, Шаблон:var и Шаблон:var, возвращающая единственное значение. Это значение будет записано в поле Шаблон:code таблицы Шаблон:code.

Пример 1: оставлять нетронутыми пробелы в первом позиционном аргументе и применять стандартную обрезку для прочих.

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

Пример 2: удалить пробельные и пустые аргументы и привести все аргументы к нижнему регистру, но не обрезать пробелы из позиционных аргументов.

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

Замечание: функции выше выдадут ошибку, если входные аргументы не будут принадлежать к типу Шаблон:code или Шаблон:luanil. Это может произойти при вызове функции Шаблон:code из другого модуля. В этом случае требуется проверка типов. В обычном случае при вызове из Шаблон:code такая проблема не стоит.