API Reference
Box’s application programming interface.
box
-
class box.Settings(settings=None, **kwargs)
-
class box.Version
-
info
-
level = 'final'
-
major = 0
-
micro = 0
-
minor = 0
-
serial = 0
box.argparse
-
class box.argparse.Command(argv, config=None)
-
default_config = {'add_help': True, 'prog': 'program', 'arguments': [{'name': 'arguments', 'nargs': '*'}]}
-
program_help
-
class box.argparse.Program(argv)
Console program abstraction
-
class box.argparse.SilentArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)
-
error(message)
-
exception box.argparse.SilentArgumentParserException
box.collections
-
class box.collections.ManagedDict
All mutations through __setitem__ and __delitem__
-
clear()
-
pop(key, default=None)
-
popitem()
-
setdefault(key, default=None)
-
update(other=None, **kwargs)
box.functools
box.json
-
class box.json.DateEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
-
default(obj)
box.sphinx
-
class box.sphinx.Settings(settings=None, **kwargs)
-
latex_documents
-
man_pages
-
release
-
texinfo_documents
box.types
-
box.types.RegexCompiledPatternType
alias of SRE_Pattern