add NIL and MAX (#107)

Author: aminalaee

python/uuid_utils/__init__.py

@@ -1,10 +1,12 @@
 from uuid import SafeUUID
 
 from ._uuid_utils import (
+    MAX,
     NAMESPACE_DNS,
     NAMESPACE_OID,
     NAMESPACE_URL,
     NAMESPACE_X500,
+    NIL,
     RESERVED_FUTURE,
     RESERVED_MICROSOFT,
     RESERVED_NCS,
@@ -23,10 +25,12 @@
 )
 
 __all__ = [
+    "MAX",
     "NAMESPACE_DNS",
     "NAMESPACE_OID",
     "NAMESPACE_URL",
     "NAMESPACE_X500",
+    "NIL",
     "RESERVED_FUTURE",
     "RESERVED_MICROSOFT",
     "RESERVED_NCS",

python/uuid_utils/__init__.pyi

@@ -1,5 +1,6 @@
 import builtins
 import sys
+from typing import Final
 from uuid import SafeUUID
 
 from typing_extensions import TypeAlias
@@ -189,12 +190,16 @@ RESERVED_NCS: str
 RFC_4122: str
 RESERVED_MICROSOFT: str
 RESERVED_FUTURE: str
+NIL: Final[UUID]
+MAX: Final[UUID]
 
 __all__ = [
+    "MAX",
     "NAMESPACE_DNS",
     "NAMESPACE_OID",
     "NAMESPACE_URL",
     "NAMESPACE_X500",
+    "NIL",
     "RESERVED_FUTURE",
     "RESERVED_MICROSOFT",
     "RESERVED_NCS",
@@ -203,6 +208,7 @@ __all__ = [
     "SafeUUID",
     "__version__",
     "getnode",
+    "reseed_rng",
     "uuid1",
     "uuid3",
     "uuid4",

python/uuid_utils/compat/__init__.py

@@ -13,25 +13,8 @@
 
 import uuid_utils
 
-__all__ = [
-    "NAMESPACE_DNS",
-    "NAMESPACE_OID",
-    "NAMESPACE_URL",
-    "NAMESPACE_X500",
-    "RESERVED_FUTURE",
-    "RESERVED_MICROSOFT",
-    "RESERVED_NCS",
-    "RFC_4122",
-    "UUID",
-    "getnode",
-    "uuid1",
-    "uuid3",
-    "uuid4",
-    "uuid5",
-    "uuid6",
-    "uuid7",
-    "uuid8",
-]
+NIL = UUID("00000000-0000-0000-0000-000000000000")
+MAX = UUID("ffffffff-ffff-ffff-ffff-ffffffffffff")
 
 
 def uuid1(node=None, clock_seq=None):
@@ -75,3 +58,26 @@ def uuid7(timestamp=None, nanos=None):
 def uuid8(bytes):
     """Generate a custom UUID comprised almost entirely of user-supplied bytes.."""
     return UUID(bytes=uuid_utils.uuid8(bytes).bytes)
+
+
+__all__ = [
+    "MAX",
+    "NAMESPACE_DNS",
+    "NAMESPACE_OID",
+    "NAMESPACE_URL",
+    "NAMESPACE_X500",
+    "NIL",
+    "RESERVED_FUTURE",
+    "RESERVED_MICROSOFT",
+    "RESERVED_NCS",
+    "RFC_4122",
+    "UUID",
+    "getnode",
+    "uuid1",
+    "uuid3",
+    "uuid4",
+    "uuid5",
+    "uuid6",
+    "uuid7",
+    "uuid8",
+]

python/uuid_utils/compat/__init__.pyi

@@ -1,4 +1,5 @@
 import sys
+from typing import Final
 from uuid import (
     NAMESPACE_DNS,
     NAMESPACE_OID,
@@ -15,20 +16,6 @@ from uuid import (
 
 from typing_extensions import TypeAlias
 
-__all__ = [
-    "NAMESPACE_DNS",
-    "NAMESPACE_OID",
-    "NAMESPACE_URL",
-    "NAMESPACE_X500",
-    "RESERVED_FUTURE",
-    "RESERVED_MICROSOFT",
-    "RESERVED_NCS",
-    "RFC_4122",
-    "UUID",
-    "SafeUUID",
-    "getnode",
-]
-
 # Because UUID has properties called int and bytes we need to rename these temporarily.
 _Int: TypeAlias = int
 _Bytes: TypeAlias = bytes
@@ -77,3 +64,22 @@ def uuid7(timestamp: _Int | None = None, nanos: _Int | None = None) -> UUID:
 def uuid8(bytes: _Bytes) -> UUID:
     """Generate a custom UUID comprised almost entirely of user-supplied bytes.."""
     ...
+
+NIL: Final[UUID]
+MAX: Final[UUID]
+
+__all__ = [
+    "MAX",
+    "NAMESPACE_DNS",
+    "NAMESPACE_OID",
+    "NAMESPACE_URL",
+    "NAMESPACE_X500",
+    "NIL",
+    "RESERVED_FUTURE",
+    "RESERVED_MICROSOFT",
+    "RESERVED_NCS",
+    "RFC_4122",
+    "UUID",
+    "SafeUUID",
+    "getnode",
+]

src/lib.rs

@@ -475,5 +475,7 @@ fn _uuid_utils(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add("RFC_4122", RFC_4122)?;
     m.add("RESERVED_MICROSOFT", RESERVED_MICROSOFT)?;
     m.add("RESERVED_FUTURE", RESERVED_FUTURE)?;
+    m.add("NIL", UUID { uuid: Uuid::nil() })?;
+    m.add("MAX", UUID { uuid: Uuid::max() })?;
     Ok(())
 }

tests/test_uuid.py

@@ -231,3 +231,8 @@ def test_reseed_rng_with_fork() -> None:
 
     # the uuids should be different because we reseeded
     assert next_parent_uuid != uuid_from_pipe
+
+
+def test_max_and_nil() -> None:
+    assert uuid_utils.UUID("ffffffff-ffff-ffff-ffff-ffffffffffff") == uuid_utils.MAX
+    assert uuid_utils.UUID("00000000-0000-0000-0000-000000000000") == uuid_utils.NIL