Moduł:Protect

Dokumentacja modułu[zobacz] [edytuj] [historia] • [odśwież] • § podstrony

Użycie

Ten meta-moduł (biblioteka) upraszcza obsługę błędów w innych modułach. Przekształca funkcję, która może zgłaszać błąd, w funkcję, która w takim przypadku zwraca określony komunikat o błędzie.

Moduł został skopiowany z enwiki w kwietniu 2025 roku [1] na potrzeby Moduł:Template test case.

Instrukcja

 local protect = require('Module:Protect')
 local protectedFunc = protect(func, errFormat, options)

Argumenty

func
Funkcja do przekształcenia.
errFormat (domyślnie: 'Error: %s')
Własny komunikat błędu.

Użyj '%s', aby uwzględnić treść przechwyconego błędu.
options – opcjonalna tabela z poniższymi polami:
- raw (domyślnie: false)
  Jeśli ustawione na true, errFormat zostanie użyty bez zmian, w przeciwnym razie zostanie opakowany w znacznik <strong class="error">.
- removeLocation (domyślnie: true)
  Jeśli ustawione na true, usuwa informacje o lokalizacji z przechwyconych komunikatów o błędach.

Wartość zwracana

Wynikowy protectedFunc to funkcja, która wywołuje oryginalną funkcję func, przekazując jej wszystkie argumenty i zwracając wszystkie jej wartości zwrotne. Jeśli func zgłosi błąd, zamiast tego zwracany jest określony komunikat o błędzie.

Przykład

local protect = require('Module:Protect')

local p = {}

function p.main(frame)
    if not frame.args[1] then
        error('missing argument')
    end
    return frame.args[1]
end

p.main = protect(p.main)

return p

Wywołanie funkcji głównej bez argumentów da wynik: Error: missing argument

Błędy

Błędy należy zgłaszać na stronie Wikipedia:Kawiarenka/Kwestie techniczne.

Zobacz też

Moduł:Template test case

Powyższy opis jest dołączany ze strony Moduł:Protect/opis. (edytuj | historia)

Zobacz wszystkie podstrony tej strony.

local function processResult(options, success, ...)
	if not success then
		local message = tostring(... or '(no message)')
		if options.removeLocation then
			message = string.gsub(message, '^Module:[^:]+:%d+: ', '', 1)
		end
		return string.format(options.errFormat, message)
	end
	return ...
end

local function protect(func, errFormat, options)
	if type(errFormat) == 'table' then
		options = options or errFormat
		errFormat = nil
	end
	options = mw.clone(options) or {}
	options.errFormat = errFormat or options.errFormat or 'Error: %s'
	if not options.raw then
		options.errFormat = '<strong class="error">' .. options.errFormat .. '</strong>'
	end
	options.removeLocation = options.removeLocation == nil or options.removeLocation
	
	return function (...)
		return processResult(options, pcall(func, ...))
	end
end

return protect