summaryrefslogtreecommitdiff
path: root/id_generator.py
blob: 4b61a93081d6dd17ab341330e7d4f08991ad4aab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#!/usr/bin/env python3

# © Copyright 2021-2022, Scott Gasch

"""A helper class for generating thread safe monotonically increasing
id numbers.

"""

import itertools
import logging

# This module is commonly used by others in here and should avoid
# taking any unnecessary dependencies back on them.

logger = logging.getLogger(__name__)
generators = {}


def get(name: str, *, start=0) -> int:
    """
    Returns a thread-safe, monotonically increasing id suitable for use
    as a globally unique identifier.

    >>> import id_generator
    >>> id_generator.get('student_id')
    0
    >>> id_generator.get('student_id')
    1
    >>> id_generator.get('employee_id', start=10000)
    10000
    >>> id_generator.get('employee_id', start=10000)
    10001
    """
    if name not in generators:
        generators[name] = itertools.count(start, 1)
    x = next(generators[name])
    logger.debug("Generated next id %d", x)
    return x


if __name__ == '__main__':
    import doctest

    doctest.testmod()