cuid2 2.2.1__tar.gz → 2.3.0__tar.gz

{cuid2-2.2.1 → cuid2-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cuid2
-Version: 2.2.1
+Version: 2.3.0
 Summary: Next generation GUIDs. Collision-resistant ids optimized for horizontal scaling and performance.
 Keywords: crypt,security,uuid,guid,cuid,cryptography
 Author: Will Gordon
@@ -11,7 +11,6 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -20,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
 Classifier: Topic :: Security :: Cryptography
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Project-URL: repository, https://github.com/gordon-code/cuid2/
 Project-URL: Changelog, https://github.com/gordon-code/cuid2/blob/main/CHANGELOG.md
 Project-URL: Issues, https://github.com/gordon-code/cuid2/issues
@@ -28,7 +27,7 @@ Description-Content-Type: text/markdown
 
 # cuid2
 
-[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://pypi.org/project/cuid2/)
+[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://pypi.org/project/cuid2/)
 [![PyPi](https://img.shields.io/pypi/v/cuid2.svg)](https://pypi.org/project/cuid2/)
 [![PyPi](https://img.shields.io/pypi/dm/cuid2.svg)](https://pypi.org/project/cuid2/)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/gordon-code/cuid2/badge)](https://scorecard.dev/viewer/?uri=github.com/gordon-code/cuid2)
@@ -105,6 +104,8 @@ short_cuid: str = create_id(length=10)
 print(is_cuid(my_cuid))  # True
 ```
 
+The CUID2 specification allows lengths 2..32; lengths `1` and `33`–`98` are still accepted in 2.x but emit a `FutureWarning` (shown as `cuid2: warning: ...` by the CLI), and 3.0.0 will reject them with `ValueError`.
+
 > **Tip for Django & ORM defaults:** Pass `default=create_id` directly on model fields (e.g., `models.CharField(max_length=24, default=create_id)`). Because `create_id` is a top-level function backed by a lazy singleton generator, Django `makemigrations` can serialize it directly and `Cuid()` initialization is deferred until the first ID is generated in each worker process.
 
 You can also generate and validate CUIDs directly in the terminal:

{cuid2-2.2.1 → cuid2-2.3.0}/README.md

@@ -1,6 +1,6 @@
 # cuid2
 
-[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://pypi.org/project/cuid2/)
+[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://pypi.org/project/cuid2/)
 [![PyPi](https://img.shields.io/pypi/v/cuid2.svg)](https://pypi.org/project/cuid2/)
 [![PyPi](https://img.shields.io/pypi/dm/cuid2.svg)](https://pypi.org/project/cuid2/)
 [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/gordon-code/cuid2/badge)](https://scorecard.dev/viewer/?uri=github.com/gordon-code/cuid2)
@@ -77,6 +77,8 @@ short_cuid: str = create_id(length=10)
 print(is_cuid(my_cuid))  # True
 ```
 
+The CUID2 specification allows lengths 2..32; lengths `1` and `33`–`98` are still accepted in 2.x but emit a `FutureWarning` (shown as `cuid2: warning: ...` by the CLI), and 3.0.0 will reject them with `ValueError`.
+
 > **Tip for Django & ORM defaults:** Pass `default=create_id` directly on model fields (e.g., `models.CharField(max_length=24, default=create_id)`). Because `create_id` is a top-level function backed by a lazy singleton generator, Django `makemigrations` can serialize it directly and `Cuid()` initialization is deferred until the first ID is generated in each worker process.
 
 You can also generate and validate CUIDs directly in the terminal:

{cuid2-2.2.1 → cuid2-2.3.0}/pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "uv_build"
 
 [project]
 name = "cuid2"
-version = "2.2.1"
+version = "2.3.0"
 description = "Next generation GUIDs. Collision-resistant ids optimized for horizontal scaling and performance."
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = "MIT"
 license-files = ["LICENSE"]
 classifiers = [
@@ -15,7 +15,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -44,7 +43,7 @@ Changelog = "https://github.com/gordon-code/cuid2/blob/main/CHANGELOG.md"
 Issues = "https://github.com/gordon-code/cuid2/issues"
 
 [project.scripts]
-cuid2 = "cuid2.cli:main"
+cuid2 = "cuid2.cli:_console_main"
 
 [tool.uv]
 default-groups = [
@@ -70,7 +69,7 @@ exclude = ["hack"]
 [tool.ruff]
 line-length = 120
 src = ["src"]
-target-version = "py310"
+target-version = "py311"
 cache-dir = "local/.ruff_cache"
 extend-exclude = ["hack"]
 force-exclude = true
@@ -158,6 +157,7 @@ exclude = [
     "^dist/",
     "^hack/",
 ]
+python_version = "3.11"
 strict = true
 
 [[tool.mypy.overrides]]
@@ -173,6 +173,7 @@ exclude = [
     "dist",
     "hack",
 ]
+pythonVersion = "3.11"
 strict = ["src"]
 
 [dependency-groups]
@@ -182,12 +183,11 @@ lint = [
     "prek==0.5.7",
     "ruff==0.17.0",
     "rumdl==0.3.0",
-    "zizmor==1.31.1; python_version >= '3.11'",
+    "zizmor==1.31.1",
 ]
 test = [
     "coverage[toml]==7.16.2",
-    "hypothesis==6.168.5; python_version < '3.11'",
-    "hypothesis==6.170.5; python_version >= '3.11'",
+    "hypothesis==6.170.5",
     "keepachangelog==2.0.0",
     "pytest==9.1.1",
     "pytest-cov==7.1.0",

{cuid2-2.2.1 → cuid2-2.3.0}/pyproject.toml.orig

@@ -4,13 +4,13 @@ build-backend = "uv_build"
 
 [project]
 name = "cuid2"
-version = "2.2.1"
+version = "2.3.0"
 authors = [
     {name = "Will Gordon", email = "dev@gordoncode.dev"},
 ]
 description = "Next generation GUIDs. Collision-resistant ids optimized for horizontal scaling and performance."
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = "MIT"
 license-files = ["LICENSE"]
 classifiers = [
@@ -18,7 +18,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -36,7 +35,7 @@ Changelog = "https://github.com/gordon-code/cuid2/blob/main/CHANGELOG.md"
 Issues = "https://github.com/gordon-code/cuid2/issues"
 
 [project.scripts]
-cuid2 = "cuid2.cli:main"
+cuid2 = "cuid2.cli:_console_main"
 
 [tool.uv]
 default-groups = ["build", "lint", "test", "typing"]
@@ -50,12 +49,11 @@ lint = [
     "prek==0.5.7",
     "ruff==0.17.0",
     "rumdl==0.3.0",
-    "zizmor==1.31.1; python_version >= '3.11'",
+    "zizmor==1.31.1",
 ]
 test = [
     "coverage[toml]==7.16.2",
-    "hypothesis==6.168.5; python_version < '3.11'",
-    "hypothesis==6.170.5; python_version >= '3.11'",
+    "hypothesis==6.170.5",
     "keepachangelog==2.0.0",
     "pytest==9.1.1",
     "pytest-cov==7.1.0",
@@ -82,7 +80,7 @@ exclude = ["hack"]
 [tool.ruff]
 line-length = 120
 src = ["src"]
-target-version = "py310"
+target-version = "py311"
 cache-dir = "local/.ruff_cache"
 extend-exclude = ["hack"]
 force-exclude = true
@@ -152,6 +150,7 @@ exclude_also = [
 cache_dir = "local/.mypy_cache"
 files = ["."]
 exclude = ["^build/", "^dist/", "^hack/"]
+python_version = "3.11"
 strict = true
 
 [[tool.mypy.overrides]]
@@ -160,4 +159,5 @@ ignore_missing_imports = true
 
 [tool.pyright]
 exclude = ["build", "dist", "hack"]
+pythonVersion = "3.11"
 strict = ["src"]

{cuid2-2.2.1 → cuid2-2.3.0}/src/cuid2/__main__.py

@@ -2,6 +2,6 @@
 
 from __future__ import annotations
 
-from cuid2.cli import main
+from cuid2.cli import _console_main  # pyright: ignore[reportPrivateUsage]
 
-main()
+_console_main()

{cuid2-2.2.1 → cuid2-2.3.0}/src/cuid2/cli.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import os
 import sys
+import warnings
 from argparse import SUPPRESS, Action, ArgumentParser, ArgumentTypeError, RawDescriptionHelpFormatter
 from contextlib import suppress
 from functools import partial
@@ -18,6 +19,7 @@ if TYPE_CHECKING:
     from argparse import Namespace
     from collections.abc import Iterable, Iterator, Sequence
     from random import Random
+    from typing import TextIO
 
 _SLUG_LENGTH: int = 5
 
@@ -93,6 +95,23 @@ def _fixed_fingerprint(random_generator: Random, *, fingerprint: str) -> str:
     return fingerprint
 
 
+def _show_cli_warning(  # noqa: PLR0913, PLR0917
+    message: Warning | str,
+    category: type[Warning],
+    filename: str,
+    lineno: int,
+    file: TextIO | None = None,
+    line: str | None = None,
+) -> None:
+    # Prints warnings as one clean `cuid2: warning: <message>` stderr line, without the source path or code line.
+    del category, filename, lineno, line
+    stream = file if file is not None else sys.stderr
+    if stream is None:  # No stderr (pythonw or fd 2 closed at startup): drop the warning like the stdlib does.
+        return
+    with suppress(OSError):
+        stream.write(f"cuid2: warning: {message}\n")
+
+
 def _build_parser() -> ArgumentParser:
     parser = ArgumentParser(
         prog="cuid2",
@@ -246,7 +265,16 @@ def main(args: Sequence[str] | None = None) -> None:
     ------
     SystemExit
         Raised with exit code ``0`` or ``1`` in ``--check``/``--validate`` or
-        ``--version``/``--help`` modes, or exit code ``2`` on invalid arguments.
+        ``--version``/``--help`` modes, or exit code ``2`` on invalid arguments,
+        including a length warning that a warnings filter turned into an error.
+
+    Warns
+    -----
+    FutureWarning
+        When generating IDs (not in ``--check``/``--validate`` mode) with a length
+        outside the CUID2 specification range (``MIN_LENGTH``..``BIG_LENGTH``,
+        i.e., 2..32). The ``cuid2`` console script and ``python -m cuid2`` print it
+        as a ``cuid2: warning: ...`` line.
     """
     parser = _build_parser()
     cli_args = parser.parse_args(args)
@@ -259,12 +287,24 @@ def main(args: Sequence[str] | None = None) -> None:
 
     resolved_length = target_length if target_length is not None else DEFAULT_LENGTH
     count = cli_args.count if cli_args.count is not None else 1
-    cuid_generator = (
-        Cuid(length=resolved_length)
-        if cli_args.fingerprint is None
-        else Cuid(
-            length=resolved_length,
-            fingerprint=partial(_fixed_fingerprint, fingerprint=cli_args.fingerprint),
+    try:
+        cuid_generator = (
+            Cuid(length=resolved_length)
+            if cli_args.fingerprint is None
+            else Cuid(
+                length=resolved_length,
+                fingerprint=partial(_fixed_fingerprint, fingerprint=cli_args.fingerprint),
+            )
         )
-    )
+    except FutureWarning as warning:
+        # A warnings filter such as -W error or PYTHONWARNINGS=error turned the length warning into an error.
+        parser.error(str(warning))
     _write_lines(f"{cuid_generator.generate()}\n" for _ in range(count))
+
+
+def _console_main(args: Sequence[str] | None = None) -> None:  # pyright: ignore[reportUnusedFunction]
+    # Entry point for the `cuid2` console script and `python -m cuid2`: prints warnings as `cuid2: warning:` lines.
+    # main() leaves warning delivery to its caller, so programmatic use never touches the global showwarning hook.
+    with warnings.catch_warnings():
+        warnings.showwarning = _show_cli_warning
+        main(args)

{cuid2-2.2.1 → cuid2-2.3.0}/src/cuid2/generator.py

@@ -71,7 +71,7 @@ def _validate_length(length: int) -> None:
 
     Warns
     -----
-    DeprecationWarning
+    FutureWarning
         If `length` is outside the CUID2 specification range (`MIN_LENGTH`..`BIG_LENGTH`, i.e., 2..32).
     """
     if isinstance(length, bool) or length < 1:
@@ -84,7 +84,7 @@ def _validate_length(length: int) -> None:
         warnings.warn(
             f"Length {length} outside the CUID2 specification range ({MIN_LENGTH}..{BIG_LENGTH}) "
             "is deprecated and will raise ValueError in v3.0.0.",
-            DeprecationWarning,
+            FutureWarning,
             stacklevel=3,
         )
 
@@ -174,7 +174,7 @@ class Cuid:
             The length parameter is an integer that determines the maximum length of the generated string.
             It has a default value of DEFAULT_LENGTH (24).
             A length value less than 1 or greater than `MAXIMUM_LENGTH` (98 characters) will raise a ValueError.
-            Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a DeprecationWarning.
+            Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a FutureWarning (a ValueError in 3.0.0).
         fingerprint : "FingerprintCallable", default=utils.create_fingerprint
             The "fingerprint" parameter is a callable function that generates a unique identifier. Called again in a
             forked child process; the default includes the child's `os.getpid()`.
@@ -186,7 +186,7 @@ class Cuid:
 
         Warns
         -----
-        DeprecationWarning
+        FutureWarning
             If the length parameter is outside `MIN_LENGTH`..`BIG_LENGTH` (2..32 characters).
 
         Notes
@@ -272,7 +272,7 @@ class Cuid:
             The length parameter is an optional integer value that specifies the length of the generated string.
             If it is not provided, the default length value provided during class initialization is used.
             A length value less than 1 or greater than `MAXIMUM_LENGTH` (98 characters) will raise a ValueError.
-            Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a DeprecationWarning.
+            Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a FutureWarning (a ValueError in 3.0.0).
 
         Returns
         -------
@@ -288,7 +288,7 @@ class Cuid:
 
         Warns
         -----
-        DeprecationWarning
+        FutureWarning
             If the length parameter is outside `MIN_LENGTH`..`BIG_LENGTH` (2..32 characters).
         """
         if length is not None:
@@ -330,7 +330,7 @@ def create_id(length: int | None = None) -> str:
     length : int, optional
         The optional length of the generated CUID2 string. Defaults to `DEFAULT_LENGTH` (24) when omitted.
         A length value less than 1 or greater than `MAXIMUM_LENGTH` (98 characters) will raise a ValueError.
-        Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a DeprecationWarning.
+        Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a FutureWarning (a ValueError in 3.0.0).
 
     Returns
     -------
@@ -344,7 +344,7 @@ def create_id(length: int | None = None) -> str:
 
     Warns
     -----
-    DeprecationWarning
+    FutureWarning
         If the length parameter is outside `MIN_LENGTH`..`BIG_LENGTH` (2..32 characters).
     """
     global _default_generator  # noqa: PLW0603
@@ -369,7 +369,7 @@ def cuid_wrapper(length: int = DEFAULT_LENGTH) -> Callable[[], str]:
         The length parameter is an integer that determines the maximum length of the generated string.
         It has a default value of DEFAULT_LENGTH (24).
         A length value less than 1 or greater than `MAXIMUM_LENGTH` (98 characters) will raise a ValueError.
-        Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a DeprecationWarning.
+        Lengths outside `MIN_LENGTH`..`BIG_LENGTH` (2..32) emit a FutureWarning (a ValueError in 3.0.0).
 
     Returns
     -------
@@ -383,7 +383,7 @@ def cuid_wrapper(length: int = DEFAULT_LENGTH) -> Callable[[], str]:
 
     Warns
     -----
-    DeprecationWarning
+    FutureWarning
         If the length parameter is outside `MIN_LENGTH`..`BIG_LENGTH` (2..32 characters).
     """
     _validate_length(length)