id_generator.py

   1 #!/usr/bin/env python3
   2
   3 # © Copyright 2021-2022, Scott Gasch
   4
   5 """A helper class for generating thread safe monotonically increasing
   6 id numbers.
   7
   8 """
   9
  10 import itertools
  11 import logging
  12
  13 # This module is commonly used by others in here and should avoid
  14 # taking any unnecessary dependencies back on them.
  15
  16 logger = logging.getLogger(__name__)
  17 generators = {}
  18
  19
  20 def get(name: str, *, start=0) -> int:
  21     """
  22     Returns a thread-safe, monotonically increasing id suitable for use
  23     as a globally unique identifier.
  24
  25     >>> import id_generator
  26     >>> id_generator.get('student_id')
  27     0
  28     >>> id_generator.get('student_id')
  29     1
  30     >>> id_generator.get('employee_id', start=10000)
  31     10000
  32     >>> id_generator.get('employee_id', start=10000)
  33     10001
  34     """
  35     if name not in generators:
  36         generators[name] = itertools.count(start, 1)
  37     x = next(generators[name])
  38     logger.debug("Generated next id %d", x)
  39     return x
  40
  41
  42 if __name__ == '__main__':
  43     import doctest
  44
  45     doctest.testmod()