Counter Class

class Counter(name, visible=0, hidden=0, only_visible=True, *, step=1.0, logger=None, behavior=_DEFAULT_COUNTER_BEHAVIOR)

Purpose

Counter tracks visible, hidden, and fractional progress.

Examples

from piethorn.logging.counter import Counter

counter = Counter("jobs", visible=1, hidden=2, only_visible=False, step=0.5)
counter.add(2)
counter.float_add(1.25, hidden=True)
counter.tick(2, worth=2)

Key methods

build_message(...) / message_send(...)

Message helpers for logger integration.

counter.build_message()
counter.message_send(return_only=True)

add(...) / float_add(...)

Increment helpers.

counter.add(2)
counter.float_add(1.25, hidden=True)

tick_worth(...) / tick(...) / non_linear_tick(...)

Tick-based progression helpers.

counter.tick_worth(2, 1.0, True)
counter.tick(2, worth=2)
counter.non_linear_tick(2, worth=1)

reset(), check(), compare(other)

Lifecycle and comparison helpers.

counter.compare(10)
counter.reset()

Behavior notes

current exposes visible or visible + hidden depending on the only_visible flag, and then adds the decimal portion.