Модуль:Arguments (Bk;rl,&Arguments)

Документация

[просмотр | править | история | ]

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

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

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

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

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

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

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

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

return p

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

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. В синтаксисе шаблонов пустые строки или строки из пробелов приравниваются к false. В Lua же такие строки соответствуют true. Поэтому, если вы уделите недостаточно внимания обработке таких аргументов, может нарушиться задуманная логика шаблона. Чтобы избежать такого развития событий, по умолчанию модуль удаляет все пустые аргументы.

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

Однако же, если требуется сохранить эти пробелы, можно задать опциям trim и removeBlanks значение false.

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

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

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

Пример 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
})

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

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

Пример 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
})

Пример 2 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
})

Также следует обращать внимание, что функция valueFunc вызывается приблизительно при каждом запросе к таблице args, так что если стоит вопрос производительности, эта функция не должна быть дорогой.

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

Аргументы в таблице args могут одновременно передаваться из текущего фрейма и его родительского фрейма. Это можно понять на примере. Например, есть модуль Module:ExampleArgs, работа которого заключается в выводе двух первых переданных позиционных аргументов.

Код модуля ExampleArgs

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

Модуль:ExampleArgs вызывается шаблоном {{ExampleArgs}}, код которого — {{#invoke:ExampleArgs|main|первый_аргумент_вызова}}. По умолчанию он возвращает текст «первый_аргумент_вызова».

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

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

Это поведение можно изменить тремя опциями: frameOnly, parentOnly и parentFirst. При установке frameOnly будут обрабатываться только аргументы фрейма, где происходит непосредственно вызов #invoke; при установке parentOnly будут обрабатываться только аргументы родительского фрейма; при установке parentFirst будут обрабатываться аргументы из обоих фреймов, но в первую очередь родительского. В случае рассматриваемого {{ExampleArgs}} это будет выглядеть так:

frameOnly

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

parentOnly

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

parentFirst

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

Замечания:

1. При установке одновременно опций frameOnly и parentOnly модуль не получит никаких аргументов из #invoke. Так делать не стоит.
2. В некоторых ситуациях родительский фрейм может быть недоступен, например, если он был сразу подан на вход функции getArgs. Тогда могут использоваться лишь аргументы этого фрейма (если установлена опция parentOnly, то никакие аргументы получить не удастся), а parentFirst и frameOnly не будут иметь эффекта.

Обёртки

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

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

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

local args = getArgs(frame, {
	wrappers = 'Шаблон:Обёртка'
})

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

Замечания:

1. Модуль автоматически определяет, если вызывается с подстраницы /песочница шаблона-обёртки, такие страницы не надо задавать явным образом.
2. Опцияwrappers изменяет поведение по умолчанию опций frameOnly и parentOnly. Например, если parentOnly явным образом установлена в false при установленных wrappers, вызов через обёртку будет приводить к проверке аргументов текущего и родительского фрейма, тогда как другие вызовы будут проверять только текущие аргументы.
3. Если опция wrappers установлена и родительский фрейм недоступен, модуль всегда будет получать аргументы, переданные функции getArgs.

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

Иногда может быть полезно записать новые значения в таблицу args. При настройках данного модуля по умолчанию это возможно. (Тем не менее, в большинстве случаев лучшим подходом будет создать новую таблицу с новыми значениями и копировать туда нужные значения args.)

args.foo = 'some value'

С помощью установки опций readOnly и noOverwrite это поведение можно переопределить. Если установлена опция readOnly, в таблицу args нельзя вносить изменения вообще. При установке же опции noOverwrite можно добавлять новые значения, но нельзя менять уже имеющиеся в таблице значения, полученные из #invoke.

Тэги ref

Данный модуль использует метатаблицы, чтобы получить аргументы #invoke. Это даёт доступ одновременно к аргументом фрейма и родительского фрейма без использования функции pairs(). Это может быть полезно при передаче на вход тэгов <ref></ref>.

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

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

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

У использования метатаблиц есть свои недостатки. Большинство инструментов для работы с обычными таблицами Lua не будут корректно работать с таблицей args, включая оператор #, функцию next() и функции из стандартной библиотеки table. Если данные функции необходимы для работы модуля, может понадобиться своя реализация обработки аргументов. Также возможно использование функций из модуля TableTools.

Во избежание поломок страниц, использующих этот модуль, экспериментируйте в песочнице (создать) или песочнице для модулей.
Пожалуйста, добавляйте категории на подстраницу /doc. Подстраницы этого модуля.

-- 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('/песочница$', '')
				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