Class ExponentialCounter

praw/models/util.py:43–68

A class to provide an exponential counter with jitter.

class ExponentialCounter:
    """A class to provide an exponential counter with jitter."""

    def __init__(self, max_counter: int) -> None:
        """Initialize an :class:`.ExponentialCounter` instance.

        :param max_counter: The maximum base value.

            .. note::

                The computed value may be 3.125% higher due to jitter.

        """
        self._base = 1
        self._max = max_counter

    def counter(self) -> int | float:
        """Increment the counter and return the current value with jitter."""
        max_jitter = self._base / 16.0
        value = self._base + random.random() * max_jitter - max_jitter / 2  # noqa: S311
        self._base = min(self._base * 2, self._max)
        return value

    def reset(self) -> None:
        """Reset the counter to 1."""
        self._base = 1


def permissions_string(*, known_permissions: set[str], permissions: list[str] | None) -> str: