Add doctests to some of this stuff.

[python_utils.git] / id_generator.py

diff --git a/id_generator.py b/id_generator.py
index c5a0d93e6908838c1f382b386a64957f3c2ea3fc..4e650dca9f13662a1ace7013d4f00bcd3a0082e2 100644 (file)
--- a/id_generator.py
+++ b/id_generator.py
@@ -12,11 +12,22 @@ generators = {}
 
 def get(name: str) -> int:
     """
-    def __init__(self):
-        self.my_unique_id = id_generator.get("student_id")
+    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
     """
     if name not in generators:
         generators[name] = itertools.count()
     x = next(generators[name])
     logger.debug(f"Generated next id {x}")
     return x
+
+
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()