python-ulid 2.5.0__tar.gz → 2.7.0__tar.gz

{python_ulid-2.5.0 → python_ulid-2.7.0}/CHANGELOG.rst

@@ -5,6 +5,21 @@ Changelog
 
 Versions follow `Semantic Versioning <http://www.semver.org>`_
 
+`2.7.0`_ - 2024-06-17
+---------------------
+Changed
+~~~~~~~
+* Ensure that the validation of ULID's timestamp component aligns more closely with
+  the ULID specification.
+
+`2.6.0`_ - 2024-05-26
+---------------------
+Changed
+~~~~~~~
+* Use stricter validation when a :class:`.ULID` value from user input. When using
+  :meth:`.ULID.from_str` we will check if the characters match the base32 alphabet. In general,
+  it is ensured that the timestamp part of the ULID is not out of range.
+
 `2.5.0`_ - 2024-04-26
 ---------------------
 
@@ -159,6 +174,8 @@ Changed
 * The package now has no external dependencies.
 * The test-coverage has been raised to 100%.
 
+.. _2.7.0: https://github.com/mdomke/python-ulid/compare/2.6.0...2.7.0
+.. _2.6.0: https://github.com/mdomke/python-ulid/compare/2.5.0...2.6.0
 .. _2.5.0: https://github.com/mdomke/python-ulid/compare/2.4.0...2.5.0
 .. _2.4.0: https://github.com/mdomke/python-ulid/compare/2.3.0...2.4.0
 .. _2.3.0: https://github.com/mdomke/python-ulid/compare/2.2.0...2.3.0

{python_ulid-2.5.0 → python_ulid-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-ulid
-Version: 2.5.0
+Version: 2.7.0
 Summary: Universally unique lexicographically sortable identifier
 Project-URL: Homepage, https://github.com/mdomke/python-ulid
 Project-URL: Documentation, https://python-ulid.readthedocs.io

{python_ulid-2.5.0 → python_ulid-2.7.0}/tests/test_base32.py

@@ -21,6 +21,7 @@ from ulid import constants
         (base32.decode, "A" * (constants.REPR_LEN + 1)),
         (base32.decode_timestamp, "A" * (constants.TIMESTAMP_REPR_LEN - 1)),
         (base32.decode_timestamp, "A" * (constants.TIMESTAMP_REPR_LEN + 1)),
+        (base32.decode_timestamp, "Z" * constants.TIMESTAMP_REPR_LEN),
         (base32.decode_randomness, "A" * (constants.RANDOMNESS_REPR_LEN - 1)),
         (base32.decode_randomness, "A" * (constants.RANDOMNESS_REPR_LEN + 1)),
     ],

{python_ulid-2.5.0 → python_ulid-2.7.0}/tests/test_ulid.py

@@ -149,15 +149,17 @@ Params = Union[bytes, str, int, float]
 @pytest.mark.parametrize(
     ("constructor", "value"),
     [
-        (ULID, b"sdf"),
-        (ULID.from_timestamp, b"not-a-timestamp"),
-        (ULID.from_datetime, time.time()),
-        (ULID.from_bytes, b"not-enough"),
-        (ULID.from_bytes, 123),
-        (ULID.from_str, "not-enough"),
-        (ULID.from_str, 123),
-        (ULID.from_int, "not-an-int"),
-        (ULID.from_uuid, "not-a-uuid"),
+        (ULID, b"sdf"),  # invalid length
+        (ULID.from_timestamp, b"not-a-timestamp"),  # invalid type
+        (ULID.from_datetime, time.time()),  # invalid type
+        (ULID.from_bytes, b"not-enough"),  # invalid length
+        (ULID.from_bytes, 123),  # invalid type
+        (ULID.from_str, "not-enough"),  # invalid length
+        (ULID.from_str, 123),  # inavlid type
+        (ULID.from_str, "notavalidulidnotavalidulid"),  # invalid alphabet
+        (ULID.from_str, "Z" * 26),  # invalid timestamp
+        (ULID.from_int, "not-an-int"),  # invalid type
+        (ULID.from_uuid, "not-a-uuid"),  # invalid type
     ],
 )
 def test_ulid_invalid_input(constructor: Callable[[Params], ULID], value: Params) -> None:
@@ -165,6 +167,37 @@ def test_ulid_invalid_input(constructor: Callable[[Params], ULID], value: Params
         constructor(value)
 
 
+@pytest.mark.parametrize(
+    ("constructor", "value"),
+    [
+        (ULID, b"\x00" * 16),
+        (ULID.from_timestamp, 0),
+        (ULID.from_bytes, b"\x00" * 16),
+        (ULID.from_str, "0" * 26),
+        (ULID.from_hex, "0" * 32),
+        (ULID.from_uuid, uuid.UUID("0" * 32)),
+    ],
+)
+def test_ulid_min_input(constructor: Callable[[Params], ULID], value: Params) -> None:
+    constructor(value)
+
+
+@pytest.mark.parametrize(
+    ("constructor", "value"),
+    [
+        (ULID, b"\xff" * 16),
+        (ULID.from_timestamp, 281474976710655),
+        (ULID.from_datetime, datetime.max.replace(tzinfo=timezone.utc)),
+        (ULID.from_bytes, b"\xff" * 16),
+        (ULID.from_str, "7" + "Z" * 25),
+        (ULID.from_hex, "f" * 32),
+        (ULID.from_uuid, uuid.UUID("f" * 32)),
+    ],
+)
+def test_ulid_max_input(constructor: Callable[[Params], ULID], value: Params) -> None:
+    constructor(value)
+
+
 def test_pydantic_protocol() -> None:
     ulid = ULID()
 

{python_ulid-2.5.0 → python_ulid-2.7.0}/ulid/__init__.py

@@ -71,6 +71,12 @@ class ULID:
         >>> ulid = ULID()
         >>> str(ulid)
         '01E75PVKXA3GFABX1M1J9NZZNF'
+
+    Args:
+        value (bytes, None):  A sequence of 16 bytes representing an encoded ULID.
+
+    Raises:
+        ValueError: If the provided value is not a valid encoded ULID.
     """
 
     def __init__(self, value: bytes | None = None) -> None:

{python_ulid-2.5.0 → python_ulid-2.7.0}/ulid/base32.py

@@ -198,6 +198,8 @@ def encode_randomness(binary: bytes) -> str:
 def decode(encoded: str) -> bytes:
     if len(encoded) != constants.REPR_LEN:
         raise ValueError("Encoded ULID has to be exactly 26 characters long.")
+    if any((c not in ENCODE) for c in encoded):
+        raise ValueError(f"Encoded ULID can only consist of letters in {ENCODE}.")
     return decode_timestamp(encoded[: constants.TIMESTAMP_REPR_LEN]) + decode_randomness(
         encoded[constants.TIMESTAMP_REPR_LEN :]
     )
@@ -208,6 +210,9 @@ def decode_timestamp(encoded: str) -> bytes:
         raise ValueError("ULID timestamp has to be exactly 10 characters long.")
     lut = DECODE
     values: bytes = bytes(encoded, "ascii")
+    # https://github.com/ulid/spec?tab=readme-ov-file#overflow-errors-when-parsing-base32-strings
+    if lut[values[0]] > 7:
+        raise ValueError(f"Timestamp value {encoded} is too large and will overflow 128-bits.")
     return bytes(
         [
             ((lut[values[0]] << 5) | lut[values[1]]) & 0xFF,