Pincer-org / Pincer

pincer/utils/snowflake.py

# Copyright Pincer 2021-Present

Missing module docstring

# Full MIT License can be found in `LICENSE` at the project root.

from __future__ import annotations


class Snowflake(int):
    """Discord utilizes Twitter's snowflake format for uniquely
    identifiable descriptors (IDs).

    These IDs are guaranteed to be unique across all of Discord,
    except in some unique scenarios in which child objects
    share their parent's ID.

    Because Snowflake IDs are up to 64 bits in size (e.g. an uint64),
    they are always returned as strings in the HTTP API
    to prevent integer overflows in some languages.
    """

    _MAX_VALUE: int = 9223372036854775807
    _MIN_VALUE: int = 0

    def __init__(self, _):
        super().__init__()

        if self < self._MIN_VALUE:
            raise ValueError(
                "snowflake value should be greater than or equal to 0."
            )

        if self > self._MAX_VALUE:
            raise ValueError(
                "snowflake value should be less than"
                " or equal to 9223372036854775807."
            )

    @classmethod
    def __factory__(cls, string: str) -> Snowflake:
        # TODO: fix docs

TODO and FIXME comments should generally be avoided.

        """

        Parameters
        ----------
        string

        Returns
        -------

        """
        return cls.from_string(string)

    @classmethod
    def from_string(cls, string: str):
        """Initialize a new Snowflake from a string.

        Parameters
        ----------
        string: :class:`str`
            The snowflake as a string.
        """
        return Snowflake(int(string))

    @property
    def timestamp(self) -> int:
        """:class:`int`: Milliseconds since Discord Epoch,
        the first second of 2015 or 14200704000000
        """
        return self >> 22

    @property
    def worker_id(self) -> int:
        """:class:`int`: Internal worker ID"""
        return (self >> 17) % 16

    @property
    def process_id(self) -> int:
        """:class:`int`: Internal process ID"""
        return (self >> 12) % 16

    @property
    def increment(self) -> int:
        """:class:`int`: For every ID that is generated on that process,
        this number is incremented.
        """
        return self % 2048

    @property
    def unix(self) -> int:

Missing function or method docstring

        return self.timestamp + 1420070400000