This plugin will handle watching for commands coming from the client
usage: #bp.watch.detail [-h] [watch [watch ...]]
get details of a watch
positional arguments:
watch the trigger to detail (default: [])
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.list [-h] [match]
list watches
positional arguments:
match list only watches that have this argument in them
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.api [-h] [api]
list functions in the api
positional arguments:
api api to get details of
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.help [-a] [-c] [-h]
show help info for this plugin
optional arguments:
-a, --api show functions this plugin has in the api (default: False)
-c, --commands show commands in this plugin (default: False)
-h, --help show help (default: False)
usage: #bp.watch.inspect [-m METHOD] [-o OBJECT] [-s] [-h]
inspect a plugin
optional arguments:
-m METHOD, --method METHOD
get code for a method
-o OBJECT, --object OBJECT
show an object of the plugin, can be method or
variable
-s, --simple show a simple output (default: False)
-h, --help show help (default: False)
usage: #bp.watch.reset [-h]
reset the plugin
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.save [-h]
save the plugin state
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.set [-h] [name] [value]
change a setting in the plugin
if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin
positional arguments:
name the setting name (default: list)
value the new value of the setting
optional arguments:
-h, --help show help (default: False)
usage: #bp.watch.stats [-h]
show plugin stats
optional arguments:
-h, --help show help (default: False)
watch.add(watchname, regex, plugin=None, **kwargs)
add a command watch
watchname = name
regex = the regular expression that matches this command
plugin = the plugin this comes from
keyword args arguments:
None as of now
this function returns no values
original defined in plugins/core/watch.py
watch.removeplugin(plugin)
remove all watches related to a plugin
plugin = The plugin
this function returns no values
original defined in plugins/core/watch.py
watch.remove(watchname, force=False)
remove a command watch
watchname = The watch name
force = force removal if functions are registered
this function returns no values
original defined in plugins/core/watch.py