uuid-utils 0.5.0__cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl → 0.7.0__cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

uuid_utils/__init__.py

@@ -9,6 +9,7 @@ from ._uuid_utils import (
     RFC_4122,
     UUID,
     __version__,
+    getnode,
     uuid1,
     uuid3,
     uuid4,
@@ -29,6 +30,7 @@ __all__ = [
     "RFC_4122",
     "UUID",
     "__version__",
+    "getnode",
     "uuid1",
     "uuid3",
     "uuid4",

uuid_utils/__init__.pyi

@@ -112,6 +112,7 @@ class UUID:
         """Get UUID timestamp milliseconds since epoch.
         Only works for UUID versions 1, 6 and 7, otherwise raises ValueError."""
         ...
+
     @property
     def urn(self) -> str: ...
     @property
@@ -131,7 +132,7 @@ if sys.version_info >= (3, 9):
 else:
     def getnode(*, getters: Unused = None) -> int: ...  # undocumented
 
-def uuid1(node: _Int, clock_seq: _Int | None = None) -> UUID:
+def uuid1(node: _Int | None = None, clock_seq: _Int | None = None) -> UUID:
     """Generate a UUID from a host ID, sequence number, and the current time.
     If 'node' is not given, getnode() is used to obtain the hardware
     address.  If 'clock_seq' is given, it is used as the sequence number;
@@ -150,7 +151,7 @@ def uuid5(namespace: UUID, name: str) -> UUID:
     """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
     ...
 
-def uuid6(node: _Int, timestamp: _Int | None = None) -> UUID:
+def uuid6(node: _Int | None = None, timestamp: _Int | None = None) -> UUID:
     """Generate a version 6 UUID using the given timestamp and a host ID.
     This is similar to version 1 UUIDs,
     except that it is lexicographically sortable by timestamp.

uuid_utils/compat/__init__.py

@@ -0,0 +1,77 @@
+from uuid import (
+    NAMESPACE_DNS,
+    NAMESPACE_OID,
+    NAMESPACE_URL,
+    NAMESPACE_X500,
+    RESERVED_FUTURE,
+    RESERVED_MICROSOFT,
+    RESERVED_NCS,
+    RFC_4122,
+    UUID,
+    getnode,
+)
+
+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",
+]
+
+
+def uuid1(node=None, clock_seq=None):
+    """Generate a UUID from a host ID, sequence number, and the current time.
+    If 'node' is not given, getnode() is used to obtain the hardware
+    address.  If 'clock_seq' is given, it is used as the sequence number;
+    otherwise a random 14-bit sequence number is chosen."""
+    return UUID(int=uuid_utils.uuid1(node, clock_seq).int)
+
+
+def uuid3(namespace, name):
+    """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
+    namespace = uuid_utils.UUID(namespace.hex) if namespace else namespace
+    return UUID(int=uuid_utils.uuid3(namespace, name).int)
+
+
+def uuid4():
+    """Generate a random UUID."""
+    return UUID(int=uuid_utils.uuid4().int)
+
+
+def uuid5(namespace, name):
+    """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
+    namespace = uuid_utils.UUID(namespace.hex) if namespace else namespace
+    return UUID(int=uuid_utils.uuid5(namespace, name).int)
+
+
+def uuid6(node=None, timestamp=None):
+    """Generate a version 6 UUID using the given timestamp and a host ID.
+    This is similar to version 1 UUIDs,
+    except that it is lexicographically sortable by timestamp.
+    """
+    return UUID(int=uuid_utils.uuid6(node, timestamp).int)
+
+
+def uuid7(timestamp=None):
+    """Generate a version 7 UUID using a time value and random bytes."""
+    return UUID(int=uuid_utils.uuid7(timestamp).int)
+
+
+def uuid8(bytes):
+    """Generate a custom UUID comprised almost entirely of user-supplied bytes.."""
+    return UUID(bytes=uuid_utils.uuid8(bytes).bytes)

uuid_utils/compat/__init__.pyi

@@ -0,0 +1,41 @@
+from uuid import UUID
+
+from typing_extensions import TypeAlias
+
+# Because UUID has properties called int and bytes we need to rename these temporarily.
+_Int: TypeAlias = int
+_Bytes: TypeAlias = bytes
+
+def uuid1(node: _Int | None = None, clock_seq: _Int | None = None) -> UUID:
+    """Generate a UUID from a host ID, sequence number, and the current time.
+    If 'node' is not given, getnode() is used to obtain the hardware
+    address.  If 'clock_seq' is given, it is used as the sequence number;
+    otherwise a random 14-bit sequence number is chosen."""
+    ...
+
+def uuid3(namespace: UUID, name: str) -> UUID:
+    """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
+    ...
+
+def uuid4() -> UUID:
+    """Generate a random UUID."""
+    ...
+
+def uuid5(namespace: UUID, name: str) -> UUID:
+    """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
+    ...
+
+def uuid6(node: _Int | None = None, timestamp: _Int | None = None) -> UUID:
+    """Generate a version 6 UUID using the given timestamp and a host ID.
+    This is similar to version 1 UUIDs,
+    except that it is lexicographically sortable by timestamp.
+    """
+    ...
+
+def uuid7(timestamp: _Int | None = None) -> UUID:
+    """Generate a version 7 UUID using a time value and random bytes."""
+    ...
+
+def uuid8(bytes: _Bytes) -> UUID:
+    """Generate a custom UUID comprised almost entirely of user-supplied bytes.."""
+    ...

{uuid_utils-0.5.0.dist-info → uuid_utils-0.7.0.dist-info}/METADATA

@@ -1,11 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: uuid_utils
-Version: 0.5.0
+Version: 0.7.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -19,7 +18,7 @@ License-File: LICENSE.md
 Summary: Drop-in replacement for Python UUID in Rust
 Keywords: rust,uuid
 Author-email: Amin Alaee <me@aminalaee.dev>
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Documentation, https://github.com/aminalaee/uuid-utils
 Project-URL: Issues, https://github.com/aminalaee/uuid-utils/issues
@@ -85,6 +84,21 @@ UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
 UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
 ```
 
+## Compat module
+
+In some cases you might need `UUID` instances to be returned
+from the standrad-library `uuid`, not a custom `UUID` class.
+In that case you can use the `uuid_utils.compat` which comes with a performance penalty
+in comparison with the `uuid_utils` default behaviour, but still faster than the standard-library.
+
+```py
+>>> import uuid_utils.compat as uuid
+
+>>> # make a random UUID
+>>> uuid.uuid4()
+UUID('ffe95fcc-b818-4aca-a350-e0a35b9de6ec')
+```
+
 ## Benchmarks
 
 |       Benchmark | Min     | Max     | Mean    | Min (+)         | Max (+)         | Mean (+)        |
@@ -98,11 +112,6 @@ UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
 |   UUID from int | 0.024   | 0.025   | 0.024   | 0.004 (6.6x)    | 0.004 (6.7x)    | 0.004 (6.6x)    |
 | UUID from fields | 0.028   | 0.028   | 0.028   | 0.009 (3.1x)    | 0.009 (3.1x)    | 0.009 (3.1x)    |
 
-## Limitations
-
-- The `getnode` function is not available.
-- The `uuid1` and `uuid6` take `node` argument as mandatory.
-
 ## How to develop locally
 
 ```shell

uuid_utils-0.7.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+uuid_utils-0.7.0.dist-info/METADATA,sha256=XpVI7UmfHTsaPEOz1jRzrKQs_8jnpcz8o6G0mRjX3h8,4625
+uuid_utils-0.7.0.dist-info/WHEEL,sha256=rJezEO0Z6B0QBj60bTuiXzpiVI01fMNi1FiYZLZjFxw,131
+uuid_utils-0.7.0.dist-info/license_files/LICENSE.md,sha256=DEf1K0xIS9BMeOfJaVQu6jGv5kT1h_O4qMzOhjUsYEY,1487
+uuid_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+uuid_utils/__init__.py,sha256=teEvYB7oh34wISOjZYdA011-7VdeLKfQGjR615_-lCc,622
+uuid_utils/__init__.pyi,sha256=JNQmgdNecusC7zFZiZTosO9d08yGm3sOCITC6PHF2P4,6058
+uuid_utils/compat/__init__.py,sha256=-pGwZJmEoRzNmqteXXtcbjzO7KO3-xekYT02GjImtmM,2071
+uuid_utils/compat/__init__.pyi,sha256=msxBDRkxWjdSRFmCeP2O2J6pib2qkJoZEaoC5hcF8X8,1425
+uuid_utils/_uuid_utils.cpython-311-aarch64-linux-gnu.so,sha256=9OtFDOU-StU7ts-FTy5BJFBXxRVKL8Bo5oup6zGRxCA,4323224
+uuid_utils-0.7.0.dist-info/RECORD,,

{uuid_utils-0.5.0.dist-info → uuid_utils-0.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (0.14.17)
+Generator: maturin (1.5.1)
 Root-Is-Purelib: false
 Tag: cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64

uuid_utils-0.5.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-uuid_utils-0.5.0.dist-info/METADATA,sha256=oTJvPKqcYD0d23O_u43U20lRwhiNa-ayVb0pSTlLXyI,4332
-uuid_utils-0.5.0.dist-info/WHEEL,sha256=BXhO_vhZOGzuyJiMsN_GnH_bKFMJs3L1-eHaUxgfIlI,133
-uuid_utils-0.5.0.dist-info/license_files/LICENSE.md,sha256=DEf1K0xIS9BMeOfJaVQu6jGv5kT1h_O4qMzOhjUsYEY,1487
-uuid_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-uuid_utils/__init__.py,sha256=adoYcivUSWA1NMO6LVfiScSX0M8vZXL7FS1U5_RQLgI,594
-uuid_utils/__init__.pyi,sha256=7WNYMV1MpcpPwaVhkUBTnZlbbr-3FrX3mkHZ1_yiF2Q,6029
-uuid_utils/_uuid_utils.cpython-311-aarch64-linux-gnu.so,sha256=rSsnu1GVc3AG2eq-4xv_RWDfJWkLvu1hB1bFbrkEC1k,5207224
-uuid_utils-0.5.0.dist-info/RECORD,,