lastuuid 0.2.1__cp312-cp312-macosx_10_12_x86_64.whl → 0.2.2__cp312-cp312-macosx_10_12_x86_64.whl

lastuuid/dummies.py

@@ -1,4 +1,9 @@
-"""A dummy uuid usefull for unit testing purpose."""
+"""
+A dummy uuid usefull for unit testing purpose.
+
+UUID generated here are full of 0, they does not respect any kind of UUID version,
+they remove a bit of cognitive load while testing.
+"""
 
 from typing import Iterator
 from uuid import UUID
@@ -19,6 +24,43 @@ next_id = gen_id()
 def uuidgen(i: int = 0, j: int = 0, k: int = 0, x: int = 0, y: int = 0) -> UUID:
     """
     A UUID generator that makes UUIDs more readable for humans.
+
+    # Generate autoincrement UUID that you need to predict
+
+    Sometime you prepare fixtures with well known UUID and you want to repeat them,
+
+    uuidgen(1) is more readable that UUID('00000001-0000-0000-0000-000000000000'),
+    this is why this function is made for.
+    Every section of the uuid can be filled out using `i`, `j`, `k`, `x`, `y` but,
+    I personnaly never use more than `i` and `j`.
+
+    ```python
+    >>> from lastuuid.dummies import uuidgen
+    >>> uuidgen(1)
+    UUID('00000001-0000-0000-0000-000000000000')
+    >>> uuidgen(1, 2)
+    UUID('00000001-0002-0000-0000-000000000000')
+    >>> uuidgen(1, 2, 3, 4, 5)
+    UUID('00000001-0002-0003-0004-000000000005')
+    ```
+
+    ```{tip}
+    if you don't want a dependency for that, the standard library let you write
+    UUID(int=1) which produce UUID('00000000-0000-0000-0000-000000000001').
+    ```
+
+    # Generate autoincrement UUID that you don't need to predict
+
+    Without any parameter, it will generate UUID where the last bits are incremented.
+
+    ```python
+    >>> from lastuuid.dummies import uuidgen
+    >>> uuidgen()
+    UUID('00000000-0000-0000-0000-000000000001')
+    >>> uuidgen()
+    UUID('00000000-0000-0000-0000-000000000002')
+    ```
+
     """
     if i == 0 and y == 0:
         y = next(next_id)

lastuuid/utils.py

@@ -1,13 +1,24 @@
 """
 Utilities methods that may be used for database querying purpose.
 
-uuid7 are timestamped sorted, so there are a good solution for generating
-primary keys. Because they contains a date time, a UUID range can be compute
+Because UUIDv7 are timestamped ordered and monotonically increasing,
+there are a good solution for generating primary keys.
+
+The design of UUIDv7 feet well with the design of BTree.
+
+Because they contains a date time, a UUID range can be compute
 in order to retrieve UUIDs generated at a given time.
 
-Note that in any distribyted system, only using a datetime, or an uuid
-has its limit to properly sort items. This documentation does not cover
-the design data intensive application book ;).
+
+```{important}
+In a distributed system, relying solely on a datetime or UUIDv7 for sorting
+has limitations.
+While UUIDv7 ensures sequential ordering on a single machine, there is no guarantee
+that a UUIDv7 generated later on one machine will be greater than one generated
+earlier on another machine.
+
+This documentation does not cover the book Designing Data-Intensive Applications ;).
+```
 """
 
 from datetime import UTC, date, datetime, time, timedelta

{lastuuid-0.2.1.dist-info → lastuuid-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lastuuid
-Version: 0.2.1
+Version: 0.2.2
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
@@ -35,8 +35,10 @@ Project-URL: Changelog, https://mardiros.github.io/lastuuid/changelog.html
 UUID type is awesome, but, at the moment, the UUID type in the standard library
 does not support the uuid7 format.
 
-You may find plenty of library that implement uuid7, but they have downside,
-such has ignoring pull request to fix issues, or not compatible with Pydantic.
+**lastuuid** provide **fast UUIDv7 generation** made by the
+[rust crate uuid7](https://crates.io/crates/uuid7) **compatible with Pydantic**.
+
+It has additional features that may helps for testing or inspecting UUIDv7.
 
 ```{note}
 lastuuid is a developer joke based on the nature of UUIDv7,
@@ -70,7 +72,7 @@ from pydantic import BaseModel, Field
 from lastuuid import uuid7
 
 
-class Dummy(BaseModel):
+class Event(BaseModel):
     id: UUID = Field(default_factory=uuid7)
 
 ```

lastuuid-0.2.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+lastuuid-0.2.2.dist-info/METADATA,sha256=cgW4wG5bSCTox0hUYk6JtHSKJvmATHDsZWYAfK4wMs0,3425
+lastuuid-0.2.2.dist-info/WHEEL,sha256=UikT-0yNSRjFwHTq48Crva23dP51dpEy0cz15Gdw5Lc,106
+lastuuid/lastuuid.pyi,sha256=s-ll8KBbUeUUqQz087pADg3Y3HLnOikty6dpmYC8fMs,340
+lastuuid/__init__.py,sha256=QwhIMAj4P8cB98_6Qj3mUceQXkHtS9G3bNfGrgb-R1w,122
+lastuuid/utils.py,sha256=4770hKz093r6psV4zczXwQKnfCBjS-l_NEnJ3laZpIQ,2834
+lastuuid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lastuuid/dummies.py,sha256=qXs-fm8oztJ0sUhX9H8If66u5H1JPq6Vx28Dczy5zbc,1883
+lastuuid/lastuuid.cpython-312-darwin.so,sha256=SD423jz-UTJJmycUBLZ0wKI8bEx0zwUnGY4VbVSpkD8,478472
+lastuuid-0.2.2.dist-info/RECORD,,

lastuuid-0.2.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-lastuuid-0.2.1.dist-info/METADATA,sha256=L3PIVuRQrjOFjyF-JbNsSRYNYAWdEn49d72veTLBOyY,3363
-lastuuid-0.2.1.dist-info/WHEEL,sha256=UikT-0yNSRjFwHTq48Crva23dP51dpEy0cz15Gdw5Lc,106
-lastuuid/lastuuid.pyi,sha256=s-ll8KBbUeUUqQz087pADg3Y3HLnOikty6dpmYC8fMs,340
-lastuuid/__init__.py,sha256=QwhIMAj4P8cB98_6Qj3mUceQXkHtS9G3bNfGrgb-R1w,122
-lastuuid/utils.py,sha256=PPxM7WYP_Bjy1uXn_dg6rc1GMVEkleh2Z0vjb91XXUo,2538
-lastuuid/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lastuuid/dummies.py,sha256=0YcdycGKVya59RUnBZSlJg49WeYwjxBcVZKEwuflu4E,520
-lastuuid/lastuuid.cpython-312-darwin.so,sha256=2__Io1okYi9MBlfFk7FjbZY2vxwN4XW85vaRNhx4OL8,478472
-lastuuid-0.2.1.dist-info/RECORD,,