uuid-utils 0.6.1__cp38-cp38-musllinux_1_2_aarch64.whl → 0.8.0__cp38-cp38-musllinux_1_2_aarch64.whl

uuid_utils/__init__.pyi

@@ -60,12 +60,15 @@ class UUID:
         variant     the UUID variant (one of the constants RESERVED_NCS,
                     RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
 
-        version     the UUID version number (1 through 5, meaningful only
-                    when the variant is RFC_4122)
+        version     the UUID version number
 
         is_safe     An enum indicating whether the UUID has been generated in
                     a way that is safe for multiprocessing applications, via
                     uuid_generate_time_safe(3).
+
+        timestamp   The timestamp of the UUID in milliseconds since epoch.
+                    Only works for UUID versions 1, 6 and 7,
+                    otherwise raises ValueError.
     """
 
     def __init__(
@@ -112,6 +115,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
@@ -138,31 +142,43 @@ def uuid1(node: _Int | None = None, clock_seq: _Int | None = None) -> UUID:
     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."""
-    ...
+if sys.version_info >= (3, 12):
+    def uuid3(namespace: UUID, name: str | bytes) -> UUID:
+        """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
+        ...
+else:
+    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."""
-    ...
+if sys.version_info >= (3, 12):
+    def uuid5(namespace: UUID, name: str | bytes) -> UUID:
+        """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
+        ...
+else:
+    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:
+def uuid6(
+    node: _Int | None = None, timestamp: _Int | None = None, nanos: _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:
+def uuid7(timestamp: _Int | None = None, nanos: _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.."""
+    """Generate a custom UUID comprised almost entirely of user-supplied bytes."""
     ...
 
 NAMESPACE_DNS: UUID

uuid_utils/compat/__init__.py

@@ -1,31 +1,62 @@
-import uuid
+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.UUID(int=uuid_utils.uuid1(node, clock_seq).int)
+    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.UUID(int=uuid_utils.uuid3(namespace, name).int)
+    return UUID(int=uuid_utils.uuid3(namespace, name).int)
 
 
 def uuid4():
     """Generate a random UUID."""
-    return uuid.UUID(int=uuid_utils.uuid4().int)
+    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.UUID(int=uuid_utils.uuid5(namespace, name).int)
+    return UUID(int=uuid_utils.uuid5(namespace, name).int)
 
 
 def uuid6(node=None, timestamp=None):
@@ -33,14 +64,14 @@ def uuid6(node=None, timestamp=None):
     This is similar to version 1 UUIDs,
     except that it is lexicographically sortable by timestamp.
     """
-    return uuid.UUID(int=uuid_utils.uuid6(node, timestamp).int)
+    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.UUID(int=uuid_utils.uuid7(timestamp).int)
+    return UUID(int=uuid_utils.uuid7(timestamp).int)
 
 
 def uuid8(bytes):
     """Generate a custom UUID comprised almost entirely of user-supplied bytes.."""
-    return uuid.UUID(bytes=uuid_utils.uuid8(bytes).bytes)
+    return UUID(bytes=uuid_utils.uuid8(bytes).bytes)

uuid_utils/compat/__init__.pyi

@@ -1,7 +1,34 @@
-from uuid import UUID
+import sys
+from uuid import (
+    NAMESPACE_DNS,
+    NAMESPACE_OID,
+    NAMESPACE_URL,
+    NAMESPACE_X500,
+    RESERVED_FUTURE,
+    RESERVED_MICROSOFT,
+    RESERVED_NCS,
+    RFC_4122,
+    UUID,
+    SafeUUID,
+    getnode,
+)
 
 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
@@ -13,17 +40,28 @@ def uuid1(node: _Int | None = None, clock_seq: _Int | None = None) -> UUID:
     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."""
-    ...
+if sys.version_info >= (3, 12):
+    def uuid3(namespace: UUID, name: str | bytes) -> UUID:
+        """Generate a UUID from the MD5 hash of a namespace UUID and a name."""
+        ...
+
+else:
+    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."""
-    ...
+if sys.version_info >= (3, 12):
+    def uuid5(namespace: UUID, name: str | bytes) -> UUID:
+        """Generate a UUID from the SHA-1 hash of a namespace UUID and a name."""
+        ...
+else:
+    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.

{uuid_utils-0.6.1.dist-info → uuid_utils-0.8.0.dist-info}/METADATA

@@ -1,11 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: uuid_utils
-Version: 0.6.1
+Version: 0.8.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
@@ -42,8 +41,8 @@ Python UUID implementation using Rust's UUID library.
 This will make `uuid4` function around 10x faster.
 
 This package can be a drop-in replacement to the standard library UUID
-which implements existing UUID versions like V4 in Rust
-and also adds draft UUID versions like V6.
+which implements existing UUID versions like v4 in Rust
+and also adds draft UUID versions like v6.
 
 Avaialble UUID versions:
 
@@ -58,10 +57,15 @@ Avaialble UUID versions:
 <sup>Please note that UUID versions 6, 7 and 8 are still in draft RFC.</sup><br>
 
 ## Installation
-
+Using `pip`:
 ```shell
 $ pip install uuid-utils
 ```
+or, using `conda`:
+
+```shell
+$ conda install -c conda-forge uuid-utils
+```
 
 ## Example
 
@@ -85,18 +89,33 @@ UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
 UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
 ```
 
+## Compatibility
+
+In some cases, for example if you are using `Django`, 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 is 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 (+)        |
-|-----------------|---------|---------|---------|-----------------|-----------------|-----------------|
-|         UUID V1 | 0.058   | 0.059   | 0.058   | 0.005 (12.0x)   | 0.005 (11.9x)   | 0.005 (12.0x)   |
-|         UUID V3 | 0.063   | 0.064   | 0.063   | 0.008 (7.9x)    | 0.008 (8.1x)    | 0.008 (8.0x)    |
-|         UUID V4 | 0.041   | 0.041   | 0.041   | 0.004 (11.1x)   | 0.004 (10.8x)   | 0.004 (10.9x)   |
-|         UUID V5 | 0.064   | 0.066   | 0.065   | 0.008 (8.1x)    | 0.008 (8.1x)    | 0.008 (8.1x)    |
-|   UUID from hex | 0.024   | 0.025   | 0.024   | 0.004 (6.7x)    | 0.004 (6.6x)    | 0.004 (6.6x)    |
-| UUID from bytes | 0.024   | 0.025   | 0.024   | 0.004 (6.7x)    | 0.004 (6.6x)    | 0.004 (6.7x)    |
-|   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)    |
+| Benchmark        | Min   | Max   | Mean  | Min (+)       | Max (+)       | Mean (+)      |
+| ---------------- | ----- | ----- | ----- | ------------- | ------------- | ------------- |
+| UUID v1          | 0.058 | 0.059 | 0.058 | 0.005 (12.0x) | 0.005 (11.9x) | 0.005 (12.0x) |
+| UUID v3          | 0.063 | 0.064 | 0.063 | 0.008 (7.9x)  | 0.008 (8.1x)  | 0.008 (8.0x)  |
+| UUID v4          | 0.041 | 0.041 | 0.041 | 0.004 (11.1x) | 0.004 (10.8x) | 0.004 (10.9x) |
+| UUID v5          | 0.064 | 0.066 | 0.065 | 0.008 (8.1x)  | 0.008 (8.1x)  | 0.008 (8.1x)  |
+| UUID from hex    | 0.024 | 0.025 | 0.024 | 0.004 (6.7x)  | 0.004 (6.6x)  | 0.004 (6.6x)  |
+| UUID from bytes  | 0.024 | 0.025 | 0.024 | 0.004 (6.7x)  | 0.004 (6.6x)  | 0.004 (6.7x)  |
+| 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)  |
 
 ## How to develop locally
 

uuid_utils-0.8.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+uuid_utils-0.8.0.dist-info/METADATA,sha256=9q-Z0SoccWh0vieNO2iG_B7t6LQdl62q96dfCZCYKLA,4644
+uuid_utils-0.8.0.dist-info/WHEEL,sha256=-RjMhxHDFkv6r5Nuo8tOF8K60lh-s7-UBZwq-iK_eT8,106
+uuid_utils-0.8.0.dist-info/license_files/LICENSE.md,sha256=DEf1K0xIS9BMeOfJaVQu6jGv5kT1h_O4qMzOhjUsYEY,1487
+uuid_utils.libs/libgcc_s-60abea67.so.1,sha256=5Ymeh-PwFBkI5B-deNMLyVYu2EYmgIu7iQGitm7d2t4,724137
+uuid_utils/__init__.py,sha256=teEvYB7oh34wISOjZYdA011-7VdeLKfQGjR615_-lCc,622
+uuid_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+uuid_utils/__init__.pyi,sha256=-Ar3_QVwpdIGtIWW-JuPVCoh-cN26YesW1X6l81WR4g,6627
+uuid_utils/compat/__init__.py,sha256=-pGwZJmEoRzNmqteXXtcbjzO7KO3-xekYT02GjImtmM,2071
+uuid_utils/compat/__init__.pyi,sha256=Qv8zmz1maatMXQ9Q_f9dkm8YUJoj4VaMUll_DR_SyM4,2259
+uuid_utils/_uuid_utils.cpython-38-aarch64-linux-gnu.so,sha256=mVLesNEfpU0JI4T2PjXQ2oBrlTjjKXeljJNsB2SX72Q,4393769
+uuid_utils-0.8.0.dist-info/RECORD,,

{uuid_utils-0.6.1.dist-info → uuid_utils-0.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.3.1)
+Generator: maturin (1.6.0)
 Root-Is-Purelib: false
 Tag: cp38-cp38-musllinux_1_2_aarch64

uuid_utils-0.6.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-uuid_utils-0.6.1.dist-info/METADATA,sha256=n2cRIvPyh16fFb-4OMW4g-FRdXcVcV1kwuf-cCFeXNQ,4211
-uuid_utils-0.6.1.dist-info/WHEEL,sha256=UgeUxneNW9_mlWZPhhB43lkTVY70Kf5hPdpqMczTUKA,106
-uuid_utils-0.6.1.dist-info/license_files/LICENSE.md,sha256=DEf1K0xIS9BMeOfJaVQu6jGv5kT1h_O4qMzOhjUsYEY,1487
-uuid_utils.libs/libgcc_s-60abea67.so.1,sha256=5Ymeh-PwFBkI5B-deNMLyVYu2EYmgIu7iQGitm7d2t4,724137
-uuid_utils/compat/__init__.pyi,sha256=msxBDRkxWjdSRFmCeP2O2J6pib2qkJoZEaoC5hcF8X8,1425
-uuid_utils/compat/__init__.py,sha256=ajFZzOqIG4NPov3MOxyX3RoZeORisTJqn6X1H0PWGRY,1617
-uuid_utils/__init__.pyi,sha256=Nyd0LDQeqTqOKkjU4358YbDFbxrqwpPb9hP6aQioVCg,6057
-uuid_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-uuid_utils/__init__.py,sha256=teEvYB7oh34wISOjZYdA011-7VdeLKfQGjR615_-lCc,622
-uuid_utils/_uuid_utils.cpython-38-aarch64-linux-gnu.so,sha256=FT4G_B97FPLE-P8P4iDXPFihLxF8L0Nlh34Op4ZDoc0,5376713
-uuid_utils-0.6.1.dist-info/RECORD,,