dictrack.trackers package#

Subpackages#

Submodules#

dictrack.trackers.base module#

class dictrack.trackers.base.BaseTracker(name, conditions, target, group_id=None, limiters=None, reset_policy=2, loop_forever=False, init_progress=0, *args, **kwargs)#

Bases: object

A base class for tracking data and maintaining progress based on conditions, limiters, and targets.

DEFAULT_GROUP_ID = '_THIS_IS_DEFAULT_GID'#
add_listener(code, cb)#
add_targets(target)#
property completed#
property conditions#
property current_stage#
static deserialize(b_tracker)#

Deserialize a byte stream into a tracker.

Parameters:

b_tracker (bytes) – The byte stream representing the serialized tracker.

Returns:

The deserialized tracker instance.

Return type:

BaseTracker

static deserialize_list(b_trackers)#

Deserialize a list of byte streams into a list of trackers.

Parameters:

b_trackers (list[bytes]) – A list of byte streams representing serialized trackers.

Returns:

A list of deserialized tracker instances.

Return type:

list[BaseTracker]

property dirtied#
forward_event(cb)#
property group_id#
property limited#
property limiters#
property loop_forever#
property multi_target#
property name#
property progress#
property removed#
reset(reset_policy=None, *args, **kwargs)#
property reset_policy#
static serialize(tracker)#

Serialize tracker for storing to datasource.

Parameters:

tracker (BaseTracker) – The tracker instance to be serialized.

property target#
track(data, *args, **kwargs)#
class dictrack.trackers.base.ResetPolicy#

Bases: object

ALL = 3#
DEFAULT = 2#
LIMITER = 2#
NONE = 0#
PROGRESS = 1#

Module contents#