Module:Protect

Module documentation

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other MetaWiki resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This metamodule simplifies error handling in other modules. It transforms a function, which may throw an error, into a function, which returns a specified error message in that case.

Usage

[edit ]

localprotect=require('Module:Protect')
localprotectedFunc=protect(func,errFormat,options)

Arguments

[edit ]

func
Function to be transformed.
errFormat (default: 'Error: %s')
Custom error message.

Use '%s' to include the message from a caught error.
options – optional table with the following fields:
- raw (default: false)
  If true, then errFormat will be used as is, otherwise it will be wrapped inside a tag <strong class="error">.
- removeLocation (default: true)
  If true, removes location information from caught error messages.

Return value

[edit ]

The resulting protectedFunc is a function, which calls the original function func, passing all arguments to it, and returns all its return values. If func throws an error, the specified error message is returned instead.

Example

[edit ]

localprotect=require('Module:Protect')
localp={}
functionp.main(frame)
ifnotframe.args[1]then
error('missing argument')
end
returnframe.args[1]
end
p.main=protect(p.main)
returnp

Invoking the main function without arguments will output: Error: missing argument

The above documentation is transcluded from Module:Protect/doc. (edit | history)
Editors can experiment in this module’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this module.

 localfunctionprocessResult(options,success,...)
 ifnotsuccessthen
 localmessage=tostring(...or'(no message)')
 ifoptions.removeLocationthen
 message=string.gsub(message,'^Module:[^:]+:%d+: ','',1)
 end
 returnstring.format(options.errFormat,message)
 end
 return...
 end

 localfunctionprotect(func,errFormat,options)
 iftype(errFormat)=='table'then
 options=optionsorerrFormat
 errFormat=nil
 end
 options=mw.clone(options)or{}
 options.errFormat=errFormatoroptions.errFormator'Error: %s'
 ifnotoptions.rawthen
 options.errFormat='<strong class="error">'..options.errFormat..'</strong>'
 end
 options.removeLocation=options.removeLocation==niloroptions.removeLocation

 returnfunction(...)
 returnprocessResult(options,pcall(func,...))
 end
 end

 returnprotect

Retrieved from "https://meta.wikimedia.org/w/index.php?title=Module:Protect&oldid=29294744"