algorithm_logger package

Submodules

algorithm_logger.base module

exception algorithm_logger.base.ValidationError

Bases: exceptions.Exception

algorithm_logger.event module

class algorithm_logger.event.Event

Bases: object

class algorithm_logger.event.FunctionCall(spec)

Bases: algorithm_logger.event.Event

copy()
class algorithm_logger.event.LoopIteration

Bases: algorithm_logger.event.Event

algorithm_logger.logger module

class algorithm_logger.logger.Logger(**kwargs)

Bases: syn.base.b.base.Base

Keyword-Only Arguments:

decoration_enabled (default = True): bool events: dict logging_enabled (default = True): bool

Class Options:

  • args: ()
  • autodoc: True
  • coerce_args: False
  • id_equality: False
  • init_validate: False
  • make_hashable: False
  • make_type_object: True
  • optional_none: False
  • register_subclasses: False
  • repr_template:
  • coerce_hooks: ()
  • create_hooks: ()
  • init_hooks: ()
  • init_order: ()
  • metaclass_lookup: (‘coerce_hooks’, ‘init_hooks’, ‘create_hooks’, ‘setstate_hooks’)
  • setstate_hooks: ()

Groups:

  • _all: decoration_enabled, events, logging_enabled
  • _internal: events
disable()
enable()
log(*args, **kwargs)
log_decorator(spec, before=True, after=False, name=None, log_return=True)
log_event()
record_event(name, event)

algorithm_logger.spec module

class algorithm_logger.spec.Arg(name, index, type, **kwargs)

Bases: algorithm_logger.spec.SpecBase

Descriptor of a positional argument.

Positional Arguments:

name: basestring
The name of this argument
index: int
The index of this argument in *args
type: type
The type of this argument

Keyword-Only Arguments:

required (default = False): bool
If true, will throw an error if argument is not present

Class Options:

  • args: (‘name’, ‘index’, ‘type’)
  • autodoc: True
  • coerce_args: False
  • id_equality: False
  • init_validate: True
  • make_hashable: False
  • make_type_object: True
  • optional_none: False
  • register_subclasses: False
  • repr_template:
  • coerce_hooks: ()
  • create_hooks: ()
  • init_hooks: ()
  • init_order: ()
  • metaclass_lookup: (‘coerce_hooks’, ‘init_hooks’, ‘create_hooks’, ‘setstate_hooks’)
  • setstate_hooks: ()

Groups:

  • _all: index, name, required, type
find_value(args, kwargs)
class algorithm_logger.spec.Kwarg(key, type, **kwargs)

Bases: algorithm_logger.spec.SpecBase

Descriptor of a keyword-only argument.

Positional Arguments:

key: basestring
The key of this argument in **kwargs
type: type
The type of this argument

Keyword-Only Arguments:

name: basestring
The name of this argument
required (default = False): bool
If true, will throw an error if argument is not present

Class Options:

  • args: (‘key’, ‘type’)
  • autodoc: True
  • coerce_args: False
  • id_equality: False
  • init_validate: True
  • make_hashable: False
  • make_type_object: True
  • optional_none: False
  • register_subclasses: False
  • repr_template:
  • coerce_hooks: ()
  • create_hooks: ()
  • init_hooks: ()
  • init_order: ()
  • metaclass_lookup: (‘coerce_hooks’, ‘init_hooks’, ‘create_hooks’, ‘setstate_hooks’)
  • setstate_hooks: ()

Groups:

  • _all: key, name, required, type
find_value(args, kwargs)

Module contents