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.findtools

class box.findtools.FindFiles
class box.findtools.FindFilesCall(name=None, basedir=None, max_depth=None, mappers=[], reducers=[])
default_basedir = '.'
execute()
class box.findtools.FindFilesMaxDepthMapper(basedir, max_depth)
class box.findtools.FindFilesNameMapper(name)
class box.findtools.FindObjects
class box.findtools.FindObjectsCall(name=None, filename=None, basedir=None, max_depth=None, mappers=[], reducers=[])
default_basedir = '.'
execute()
class box.findtools.FindObjectsNameMapper(name)
class box.findtools.FindStrings
class box.findtools.FindStringsCall(string, filename=None, basedir=None, max_depth=None, mappers=[], reducers=[])
default_basedir = '.'
execute()

box.functools

box.itertools

class box.itertools.MapEmmiter(value, **context)
emit(value, condition=None)
emitted
skip(condition=None)
skipped
stop(condition=None)
stopped
value(value='box.functools.DEFAULT', condition=None)
class box.itertools.MapReduce

MapReduce function-class

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

Table Of Contents

Previous topic

Box

This Page