Python UUID Utils

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.

Avaialble UUID versions:

• uuid1 - Version 1 UUIDs using a timestamp and monotonic counter.
• uuid3 - Version 3 UUIDs based on the MD5 hash of some data.
• uuid4 - Version 4 UUIDs with random data.
• uuid5 - Version 5 UUIDs based on the SHA1 hash of some data.
• uuid6 - Version 6 UUIDs using a timestamp and monotonic counter.
• uuid7 - Version 7 UUIDs using a Unix timestamp ordered by time.
• uuid8 - Version 8 UUIDs using user-defined data.

^{Please note that UUID versions 6, 7 and 8 are still in draft RFC.}

Installation

Using pip:

$ pip install uuid-utils

or, using conda:

$ conda install -c conda-forge uuid-utils

Example

>>> import uuid_utils as uuid

>>> # make a random UUID
>>> uuid.uuid4()
UUID('ffe95fcc-b818-4aca-a350-e0a35b9de6ec')

>>> # make a random UUID using a Unix timestamp which is time-ordered.
>>> uuid.uuid7()
UUID('018afa4a-0d21-7e6c-b857-012bc678552b')

>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

>>> # make a UUID using an MD5 hash of a namespace UUID and a name
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
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.

>>> import uuid_utils.compat as uuid

>>> # make a random UUID
>>> uuid.uuid4()
UUID('ffe95fcc-b818-4aca-a350-e0a35b9de6ec')

Benchmarks

^{Benchmark results might vary in different environments, but in most cases the uuid_utils should outperform stdlib uuid.}

How to develop locally

$ make build
$ make test

Or:

$ RUSTFLAGS="--cfg uuid_unstable" maturin develop --release