python-ulid 3.0.0__tar.gz → 3.1.0__tar.gz

{python_ulid-3.0.0 → python_ulid-3.1.0}/.github/workflows/lint-and-test.yml

@@ -10,11 +10,11 @@ jobs:
   lint-docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.12
+      - uses: actions/checkout@v5
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - name: Install hatch
         uses: pypa/hatch@install
       - name: Lint documentation
@@ -24,11 +24,11 @@ jobs:
     runs-on: ubuntu-latest
     name: Lint code
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.12
+      - uses: actions/checkout@v5
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - name: Install hatch
         uses: pypa/hatch@install
       - name: Lint code
@@ -38,11 +38,11 @@ jobs:
     runs-on: ubuntu-latest
     name: Lint type annotations
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python 3.12
+      - uses: actions/checkout@v5
+      - name: Set up Python 3.13
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - name: Install hatch
         uses: pypa/hatch@install
       - name: Lint typing
@@ -53,9 +53,9 @@ jobs:
     name: Run tests
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -84,7 +84,7 @@ jobs:
     needs:
       - test
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Install Hatch
         uses: pypa/hatch@install
 
@@ -109,5 +109,5 @@ jobs:
     name: Build & verify package
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: hynek/build-and-inspect-python-package@v2

{python_ulid-3.0.0 → python_ulid-3.1.0}/.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.9
+    rev: v0.12.9
     hooks:
       - id: ruff
       - id: ruff-format
   - repo: https://github.com/pycqa/doc8
-    rev: v1.1.2
+    rev: v2.0.0
     hooks:
       - id: doc8

{python_ulid-3.0.0 → python_ulid-3.1.0}/.readthedocs.yml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.13"
 
 sphinx:
   configuration: docs/source/conf.py

{python_ulid-3.0.0 → python_ulid-3.1.0}/.ruff_defaults.toml

@@ -386,7 +386,6 @@ select = [
   "S317",
   "S318",
   "S319",
-  "S320",
   "S321",
   "S323",
   "S324",
@@ -446,12 +445,12 @@ select = [
   "T100",
   "T201",
   "T203",
-  "TCH001",
-  "TCH002",
-  "TCH003",
-  "TCH004",
-  "TCH005",
-  "TCH010",
+  "TC001",
+  "TC002",
+  "TC003",
+  "TC004",
+  "TC005",
+  "TC010",
   "TD004",
   "TD005",
   "TD006",
@@ -463,9 +462,9 @@ select = [
   "TRY003",
   "TRY004",
   "TRY201",
+  "TRY203",
   "TRY300",
   "TRY301",
-  "TRY302",
   "TRY400",
   "TRY401",
   "UP001",
@@ -502,7 +501,6 @@ select = [
   "UP035",
   "UP036",
   "UP037",
-  "UP038",
   "UP039",
   "UP040",
   "UP041",

{python_ulid-3.0.0 → python_ulid-3.1.0}/CHANGELOG.rst

@@ -5,11 +5,26 @@ Changelog
 
 Versions follow `Semantic Versioning <http://www.semver.org>`_
 
+`3.1.0`_ - 2025-08-18
+---------------------
+Changed
+~~~~~~~
+* Added Python 3.13 to the trove classifiers.
+* Optimze ``@property`` to ``@cached_property`` `@WH-2099 <https://github.com/WH-2099>`_.
+* When generating ULIDs within the same millisecond, the library will ensure monotonic sort order by
+  incrementing the randomness component by 1 bit. This process is descrbied in the
+  `spec <https://github.com/ulid/spec/blob/master/README.md#monotonicity>`_.
+
+Fixed
+~~~~~
+* Sharpen regular expression for Pydantic `@aplhk <https://github.com/aplhk>`_.
+* Fix Sphinx warnings when referencing ULID from an external project. `@BoboTiG <https://github.com/BoboTiG>`_.
+
 `3.0.0`_ - 2024-10-11
 ---------------------
 Changed
 ~~~~~~~
-* Raise `TypeError` instead of `ValueError` if constructor is called with value of wrong type.
+* Raise ``TypeError`` instead of ``ValueError`` if constructor is called with value of wrong type.
 * Update ``ruff`` linter rules and switch to ``hatch fmt``.
 
 Added
@@ -71,7 +86,7 @@ Added
 ~~~~~
 * Added a new flag ``--uuid4`` to the CLI ``show`` command, that converts the provided ``ULID``
   into an RFC 4122 compliant ``UUID``.
-* The `ulid build` command allows the use of the special value ``-`` for all options to read its
+* The ``ulid build`` command allows the use of the special value ``-`` for all options to read its
   inputs from ``stdin``. E.g.
 
   .. code-block:: bash
@@ -128,7 +143,7 @@ Changed
 Added
 ~~~~~
 * Added support for Python 3.10.
-* Added :attr:`__version__` variable to package.
+* Added ``__version__`` variable to package.
 
 
 `1.0.3`_ - 2021-07-14
@@ -153,7 +168,7 @@ Added
 Changed
 ~~~~~~~
 * Dropped support for Python 2. Only Python 3.6+ is supported.
-* The named constructor :meth:`.ULID.new` has been removed. Use one of the specifc named
+* The named constructor ``ULID.new`` has been removed. Use one of the specifc named
   constructors instead. For a new :class:`.ULID` created from the current timestamp use the
   standard constructor.
 
@@ -169,8 +184,8 @@ Changed
     ulid = ULID.from_timestamp(time.time())
     ulid = ULID.from_datetime(datetime.now())
 
-* The :meth:`.ULID.str` and :meth:`.ULID.int` methods have been removed in favour of the more
-  Pythonic special dunder-methods. Use `str(ulid)` and `int(ulid)` instead.
+* The ``ULID.str`` and ``ULID.int`` methods have been removed in favour of the more
+  Pythonic special dunder-methods. Use ``str(ulid)`` and ``int(ulid)`` instead.
 * Added the property :meth:`.ULID.hex` that returns a hex representation of the :class:`.ULID`.
 
   .. code-block:: python
@@ -182,6 +197,7 @@ Changed
 * The package now has no external dependencies.
 * The test-coverage has been raised to 100%.
 
+.. _3.1.0: https://github.com/mdomke/python-ulid/compare/3.0.0...3.1.0
 .. _3.0.0: https://github.com/mdomke/python-ulid/compare/2.7.0...3.0.0
 .. _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

{python_ulid-3.0.0 → python_ulid-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: python-ulid
-Version: 3.0.0
+Version: 3.1.0
 Summary: Universally unique lexicographically sortable identifier
 Project-URL: Homepage, https://github.com/mdomke/python-ulid
 Project-URL: Documentation, https://python-ulid.readthedocs.io
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.9
 Provides-Extra: pydantic

python_ulid-3.1.0/devbox.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://raw.githubusercontent.com/jetify-com/devbox/0.13.3/.schema/devbox.schema.json",
+  "packages": [
+    "python@3.13",
+    "pre-commit@4.2",
+    "uv@latest"
+  ],
+  "shell": {
+    "init_hook": ". ${VENV_DIR}/bin/activate"
+  }
+}

python_ulid-3.1.0/devbox.lock

@@ -0,0 +1,178 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "github:NixOS/nixpkgs/nixpkgs-unstable": {
+      "last_modified": "2025-07-24T23:24:55Z",
+      "resolved": "github:NixOS/nixpkgs/0d00f23f023b7215b3f1035adb5247c8ec180dbc?lastModified=1753399495&narHash=sha256-7XG%2FQBqhrYOyA2houjRTL2NMa7IKZZ%2FsomBqr%2BQ%2F6Wo%3D"
+    },
+    "pre-commit@4.2": {
+      "last_modified": "2025-08-11T07:05:29Z",
+      "resolved": "github:NixOS/nixpkgs/9585e9192aadc13ec3e49f33f8333bd3cda524df#pre-commit",
+      "source": "devbox-search",
+      "version": "4.2.0",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/awyg4wwb7w117sr32zbw453yylzy1sv5-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/6j8b2k8vcm8ff3fwrwpkxr2q796yqwzl-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/awyg4wwb7w117sr32zbw453yylzy1sv5-pre-commit-4.2.0"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/z7aiyfndjqrzk0igjdzjf2sab137083p-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/mr9jivn3fc4g4ncb25ij73481ilmba4k-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/z7aiyfndjqrzk0igjdzjf2sab137083p-pre-commit-4.2.0"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/mx4vjrjzfxsarwkx12ddvn18kvphsds4-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/hgf3j4hj0ng2xwq71n5a8j02y6zha5gq-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/mx4vjrjzfxsarwkx12ddvn18kvphsds4-pre-commit-4.2.0"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/h9f0ac5z0scz7fp4p8xznw2m04xx45in-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/k9svwjpac38jf5c1zlxdhvhpk3ljf57r-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/h9f0ac5z0scz7fp4p8xznw2m04xx45in-pre-commit-4.2.0"
+        }
+      }
+    },
+    "python@3.13": {
+      "last_modified": "2025-05-16T20:19:48Z",
+      "plugin_version": "0.0.4",
+      "resolved": "github:NixOS/nixpkgs/12a55407652e04dcf2309436eb06fef0d3713ef3#python313",
+      "source": "devbox-search",
+      "version": "3.13.3",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/1a8xg8l3m67hxinxzzcsak9736qm9vsf-python3-3.13.3",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/1a8xg8l3m67hxinxzzcsak9736qm9vsf-python3-3.13.3"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/yy0xvc2rydhrs0h1v8d7r3sql347xzz5-python3-3.13.3",
+              "default": true
+            },
+            {
+              "name": "debug",
+              "path": "/nix/store/42bxfqfrh8cwspl7szr0cw8739xv8qlq-python3-3.13.3-debug"
+            }
+          ],
+          "store_path": "/nix/store/yy0xvc2rydhrs0h1v8d7r3sql347xzz5-python3-3.13.3"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/gbrigjhghz9v2p0zf9b2fnvs0g0yx7q4-python3-3.13.3",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/gbrigjhghz9v2p0zf9b2fnvs0g0yx7q4-python3-3.13.3"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/2mab9iiwhcqwk75qwvp3zv0bvbiaq6cs-python3-3.13.3",
+              "default": true
+            },
+            {
+              "name": "debug",
+              "path": "/nix/store/9z6k8ijl2md0y2n95yprbjj4vxbfsi15-python3-3.13.3-debug"
+            }
+          ],
+          "store_path": "/nix/store/2mab9iiwhcqwk75qwvp3zv0bvbiaq6cs-python3-3.13.3"
+        }
+      }
+    },
+    "uv@latest": {
+      "last_modified": "2025-07-28T17:09:23Z",
+      "resolved": "github:NixOS/nixpkgs/648f70160c03151bc2121d179291337ad6bc564b#uv",
+      "source": "devbox-search",
+      "version": "0.8.2",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/db9y1b002zlnyjgpsnbl9hvlwsiqajl4-uv-0.8.2",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/db9y1b002zlnyjgpsnbl9hvlwsiqajl4-uv-0.8.2"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/bdps6h2gn2rysavc3cq2slqnjlsyyk03-uv-0.8.2",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/bdps6h2gn2rysavc3cq2slqnjlsyyk03-uv-0.8.2"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/91g6383zq1wbiik2an7g6yfrj294c19v-uv-0.8.2",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/91g6383zq1wbiik2an7g6yfrj294c19v-uv-0.8.2"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/swq8qrr7n5gkc1b4940q62a3ll52prgl-uv-0.8.2",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/swq8qrr7n5gkc1b4940q62a3ll52prgl-uv-0.8.2"
+        }
+      }
+    }
+  }
+}

{python_ulid-3.0.0 → python_ulid-3.1.0}/docs/source/conf.py

@@ -12,7 +12,7 @@ import ulid
 copyright = f"{datetime.now(timezone.utc).year}, Martin Domke"
 author = "Martin Domke"
 master_doc = "index"
-source_suffix = [".rst", ".md"]
+source_suffix = {".rst": "restructuredtext", ".md": "restructuredtext"}
 
 # The full version, including alpha/beta/rc tags
 release = ulid.__version__
@@ -23,6 +23,7 @@ version = release.rsplit(".", 1)[0]
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
@@ -31,11 +32,6 @@ extensions = [
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -76,7 +72,10 @@ html_sidebars = {
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
 pygments_style = "sphinx"
 
 autodoc_member_order = "groupwise"
+# ----------------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

{python_ulid-3.0.0 → python_ulid-3.1.0}/hatch.toml

@@ -5,7 +5,7 @@ features = [
 ]
 
 [envs.hatch-static-analysis]
-dependencies = ["ruff==0.6.*"]
+dependencies = ["ruff==0.12.*"]
 config-path = ".ruff_defaults.toml"
 
 [envs.hatch-test]
@@ -29,12 +29,12 @@ xml = "coverage xml"
 
 [envs.types]
 extra-dependencies = [
-  "mypy==1.11.*",
+  "mypy==1.17.*",
 ]
 scripts = { check = "mypy --install-types --non-interactive {args:ulid}" }
 
 [envs.docs]
 extra-dependencies = [
-  "doc8==1.1.*",
+  "doc8==2.0.*",
 ]
 scripts = { check = "doc8 docs" }

{python_ulid-3.0.0 → python_ulid-3.1.0}/pyproject.toml

@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Libraries",
 ]
 
@@ -104,6 +105,13 @@ source = ["ulid"]
 [tool.doc8]
 max-line-length = 100
 
+[tool.uv]
+dev-dependencies = [
+    "hatch>=1.14.1",
+    "freezegun>=1.5",
+    "sphinx>=7.4.7",
+]
+
 [tool.hatch.metadata.hooks.fancy-pypi-readme]
 content-type = "text/x-rst"
 

{python_ulid-3.0.0 → python_ulid-3.1.0}/tests/test_ulid.py

@@ -61,6 +61,19 @@ def test_ulid_monotonic_sorting(tick: int) -> None:
     assert_sorted([v.bytes for v in ulids])
 
 
+@freeze_time()
+def test_same_millisecond_monotonic_sorting() -> None:
+    ulids = [ULID() for _ in range(1000)]
+    assert_sorted(ulids)
+
+
+@freeze_time()
+def test_same_millisecond_overflow() -> None:
+    ULID.provider.prev_randomness = constants.MAX_RANDOMNESS
+    with pytest.raises(ValueError, match="Randomness within same millisecond exhausted"):
+        ULID()
+
+
 def assert_sorted(seq: list) -> None:
     last = seq[0]
     for item in seq[1:]:
@@ -154,6 +167,11 @@ def test_ulid_from_timestamp() -> None:
     assert ulid1.timestamp == ulid2.timestamp
 
 
+def test_ulid_from_timestamp_overflow() -> None:
+    with pytest.raises(ValueError, match="Value exceeds maximum possible timestamp"):
+        ULID.from_timestamp(constants.MAX_TIMESTAMP + 1)
+
+
 Params = Union[bytes, str, int, float]
 
 
@@ -217,6 +235,7 @@ def test_pydantic_protocol() -> None:
     class Model(BaseModel):
         ulid: Optional[ULID] = None  # noqa: FA100
 
+    model: Model | None = None
     for value in [ulid, str(ulid), int(ulid), bytes(ulid)]:
         model = Model(ulid=value)
         assert isinstance(model.ulid, ULID)
@@ -226,6 +245,7 @@ def test_pydantic_protocol() -> None:
         with pytest.raises(ValidationError):
             Model(ulid=value)
 
+    assert model is not None
     model_dict = model.model_dump()
     ulid_from_dict = model_dict["ulid"]
     assert ulid_from_dict == ulid
@@ -243,7 +263,7 @@ def test_pydantic_protocol() -> None:
     assert {
         "maxLength": 26,
         "minLength": 26,
-        "pattern": "[A-Z0-9]{26}",
+        "pattern": "[0-7][0123456789ABCDEFGHJKMNPQRSTVWXYZ]{25}",
         "type": "string",
     } in model_json_schema["properties"]["ulid"]["anyOf"]
     assert {