sidewalk.activity_aggregator
This module is the primary workhorse powering Sidewalk. Let’s execute some activity processors!
copyright: |
|
---|---|
license: | ISC, see LICENSE for more details. |
The ActivityAggregator object. It allows for the execution of the defined activity processors.
Simple wrapper for importing the requested module.
The primary workhorse. Runs/executes the active activity processors.
sidewalk.exceptions
This module contains custom exceptions that can be thrown by Sidewalk.
copyright: |
|
---|---|
license: | ISC, see LICENSE for more details. |
Bases: exceptions.Exception
Activity processor group requested is not defined.
Bases: exceptions.Exception
Activity processor requested is not defined.
Bases: exceptions.Exception
The Activity processor (method) does exist in the specified module.
Bases: exceptions.Exception
Activity processor module could not be imported.
Bases: exceptions.Exception
The Activity processor threw an unhandled exception.
Bases: exceptions.Exception
The specified settings file does not contain a required section.
Bases: exceptions.Exception
Settings file IOError.
sidewalk.loggers
This module contains simple loggers for printing pretty messages.
copyright: |
|
---|---|
license: | ISC, see LICENSE for more details. |
Debug log wrapper for log.
Error log wrapper for log.
Simple log/message function for the output of timestamped messages.
sidewalk.manager
This module contains manager(s) for managing Sidewalk resources (setting files, etc.).
copyright: |
|
---|---|
license: | ISC, see LICENSE for more details. |
The ActivityProcessorsManager object. It allows for the management and storage of activity processors defined in the primary settings.conf config file.
Add a new activity processor.
Get the specified activity processor by its key.
Get the specified activity processor pairs. Pairs are returned as a dictionary where the key of the dict is the activity processor’s key and the dict’s associated value is the activity processor’s path.
If no key list is specified, all of the defiend activity processor pairs are returned.
Get the specified activity processor pairs with the specified group key.
Open the specified configuration file.
Remove the specified activity processor by its key.
Remove the specified activity processors by their group key.
Save the changes made.
Get the path of the requested configuration file.