dynast.stats

Module Contents

Classes

Step

Class that represents a processing step.

Stats

Class used to collect run statistics.

class dynast.stats.Step(skipped: bool = False, **kwargs)[source]

Class that represents a processing step.

start(self)[source]

Signal the step has started.

end(self)[source]

Signal the step has ended.

to_dict(self) Dict[str, Any][source]

Convert this step to a dictionary.

class dynast.stats.Stats[source]

Class used to collect run statistics.

start(self)[source]

Start collecting statistics.

Sets start time, the command line call.

end(self)[source]

End collecting statistics.

step(self, key: str, skipped: bool = False, **kwargs)[source]

Register a processing step.

Any additional keyword arguments are passed to the constructor of Step.

save(self, path: str) str[source]

Save statistics as JSON to path.

to_dict(self) Dict[str, Any][source]

Convert statistics to dictionary, so that it is easily parsed by the report-rendering functions.