Welcome to AdvancedCounter’s documentation!

This utility class provides some helpers for more advanced counting needs.

This was intended to help with the many times that I was trying to maintain multiple counters in an application, then needed to do various things with those counters such as pass them to/from other modules, reporting on counters at the end of a process, etc.

This is also the base module for a number of other functions that have similar needs

Some of the abilities that this provides are:

• Increment counters by a set value each time.

• Increment counters by more complex approaches.

• fixed min/max options for counters, as well as rollover/rollunder when the counter exceeds the min/max.

• tracks percentages and can handle percentage math against the counter.

• Multi-counter helper that maintains multiple named counters and can return a final report on the counters.

• Call a function every x times the counter is called (updating a status message).

Also included is a sub-class if AdvCounter called IndentHelper that provides some functions for handling running indents

Contents:

• Usage of Advanced Counter
  • Basic Usage
  • Using Min / Max options
  • Percentage Operations
  • Standard Methods
  • Calling
  • API
• Advanced Usage
  • IncrementBy Helpers
  • Call Function Every…
• Example Implementations
• Usage of NamedCounter
  • Basic Usage
  • Accessing Counters
  • Locked v. Unlocked
  • Keys and Names
  • Adding new counters
  • Removing Counters
  • Reporting from Counters
  • API
• Indent Helper
  • Setup
  • Changing levels
  • Getting output
  • Other operations
  • Other Helpers
  • API
• Release History

Install

Installation can be done through pip using

>>> pip install AdvancedCounter

Indices and tables

• Index

• Module Index

• Search Page