This module will do both debugging and logging
usage: #bp.log.client [-h] [datatype [datatype ...]]
toggle datatypes to clients
if no arguments, data types that are currenty sent to clients will be
listed
positional arguments:
datatype a list of datatypes to toggle (default: [])
optional arguments:
-h, --help show help (default: False)
usage: #bp.log.console [-h] [datatype [datatype ...]]
toggle datatypes to the console
if no arguments, data types that are currenty sent to the console will be
listed
positional arguments:
datatype a list of datatypes to toggle (default: [])
optional arguments:
-h, --help show help (default: False)
usage: #bp.log.file [-n] [-h] [datatype]
toggle datatype to log to a file
the file will be located in the data/logs/<dtype> directory
the filename for the log will be <date>.log
Example: Tue-Feb-26-2013.log
if no arguments, types that are sent to file will be listed
positional arguments:
datatype the datatype to toggle (default: list)
optional arguments:
-n, --notimestamp do not log to file with a timestamp (default: True)
-h, --help show help (default: False)
usage: #bp.log.types [-h] [match]
list all datatypes
positional arguments:
match only list datatypes that have this argument in their name
optional arguments:
-h, --help show help (default: False)
usage: #bp.log.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.log.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.log.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.log.reset [-h]
reset the plugin
optional arguments:
-h, --help show help (default: False)
usage: #bp.log.save [-h]
save the plugin state
optional arguments:
-h, --help show help (default: False)
usage: #bp.log.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.log.stats [-h]
show plugin stats
optional arguments:
-h, --help show help (default: False)
log.msg(args, dtypedict=None)
send a message
msg = This message to send
datatype = the type to toggle
this function returns no values
original defined in plugins/core/log.py
log.client(datatype, flag=True)
toggle a data type to show to clients
datatype = the type to toggle, can be multiple (list)
flag = True to send to clients, false otherwise (default: True)
this function returns no values
original defined in plugins/core/log.py
log.console(datatype, flag=True)
toggle a data type to show to console
datatype = the type to toggle
flag = True to send to console, false otherwise (default: True)
this function returns no values
original defined in plugins/core/log.py
log.file(datatype, timestamp=True)
toggle a data type to show to file
datatype = the type to toggle
flag = True to send to file, false otherwise (default: True)
this function returns no values
original defined in plugins/core/log.py
log.adddtype(datatype)
add a datatype
datatype = the datatype to add
this function returns no values
original defined in plugins/core/log.py