ulid-transform 2.2.5__tar.gz → 2.2.7__tar.gz

{ulid_transform-2.2.5 → ulid_transform-2.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ulid-transform
-Version: 2.2.5
+Version: 2.2.7
 Summary: Create and transform ULIDs
 License-Expression: MIT
 License-File: LICENSE
@@ -64,12 +64,20 @@ This library will use the C++ implementation from https://github.com/suyash/ulid
 '01869a2ea5fb0b43aa056293e47c0a35'
 >>> ulid_transform.ulid_now()
 '0001HZX0NW00GW0X476W5TVBFE'
+>>> ulid_transform.ulid_now_bytes()
+b'\x01\x9eS\x9d\x1bhl~\x1e\xf7\x959\xe1\xf2\xbe\xea'
 >>> ulid_transform.ulid_at_time(1234)
 '000000016JC62D620DGYNG2R8H'
+>>> ulid_transform.ulid_at_time_bytes(1234)
+b'\x00\x00\x00\x12\xd4Pq+\x1eG?\x91\xe9+|\xbd'
 >>> ulid_transform.ulid_to_bytes('0001HZX0NW00GW0X476W5TVBFE')
 b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee'
 >>> ulid_transform.bytes_to_ulid(b"\x01\x86\x99?\xe8\xf3\x11\xbc\xed\xef\x86U.9\x03z")
 '01GTCKZT7K26YEVVW6AMQ3J0VT'
+>>> ulid_transform.ulid_to_timestamp('0001HZX0NW00GW0X476W5TVBFE')  # milliseconds since the epoch
+1677623996
+>>> ulid_transform.ulid_to_timestamp(b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee')  # also accepts bytes
+1677623996
 >>> ulid_transform.ulid_to_bytes_or_none('0001HZX0NW00GW0X476W5TVBFE')
 b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee'
 >>> ulid_transform.ulid_to_bytes_or_none(None)

{ulid_transform-2.2.5 → ulid_transform-2.2.7}/README.md

@@ -40,12 +40,20 @@ This library will use the C++ implementation from https://github.com/suyash/ulid
 '01869a2ea5fb0b43aa056293e47c0a35'
 >>> ulid_transform.ulid_now()
 '0001HZX0NW00GW0X476W5TVBFE'
+>>> ulid_transform.ulid_now_bytes()
+b'\x01\x9eS\x9d\x1bhl~\x1e\xf7\x959\xe1\xf2\xbe\xea'
 >>> ulid_transform.ulid_at_time(1234)
 '000000016JC62D620DGYNG2R8H'
+>>> ulid_transform.ulid_at_time_bytes(1234)
+b'\x00\x00\x00\x12\xd4Pq+\x1eG?\x91\xe9+|\xbd'
 >>> ulid_transform.ulid_to_bytes('0001HZX0NW00GW0X476W5TVBFE')
 b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee'
 >>> ulid_transform.bytes_to_ulid(b"\x01\x86\x99?\xe8\xf3\x11\xbc\xed\xef\x86U.9\x03z")
 '01GTCKZT7K26YEVVW6AMQ3J0VT'
+>>> ulid_transform.ulid_to_timestamp('0001HZX0NW00GW0X476W5TVBFE')  # milliseconds since the epoch
+1677623996
+>>> ulid_transform.ulid_to_timestamp(b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee')  # also accepts bytes
+1677623996
 >>> ulid_transform.ulid_to_bytes_or_none('0001HZX0NW00GW0X476W5TVBFE')
 b'\x00\x00c\xfe\x82\xbc\x00!\xc0t\x877\x0b\xad\xad\xee'
 >>> ulid_transform.ulid_to_bytes_or_none(None)

ulid_transform-2.2.7/build_ext.py

@@ -0,0 +1,112 @@
+"""Build optional C extension modules."""
+
+from distutils.command.build_ext import build_ext
+import logging
+import os
+from pathlib import Path
+import sys
+from typing import Any
+
+try:
+    from setuptools import Extension, setup
+except ImportError:
+    from distutils.core import Extension, setup
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def getenv_bool(key: str, default: bool = False) -> bool:
+    value = os.environ.get(key, str(default)).lower()
+    if value in ("1", "true", "yes"):
+        return True
+    if value in ("0", "false", "no"):
+        return False
+    msg = f"Invalid value for boolean envvar {key}: {value}"
+    raise ValueError(msg)
+
+
+ulid_module = Extension(
+    "ulid_transform._ulid_impl",
+    [
+        str(Path("src") / "ulid_transform" / "_ulid_impl.cpp"),
+    ],
+    language="c++",
+    extra_compile_args=["-std=c++11", "-O3", "-g0"],
+    extra_link_args=["-std=c++11"],
+)
+
+
+class BuildExt(build_ext):
+    def build_extensions(self) -> None:
+        if self.parallel is None:  # type: ignore[has-type, unused-ignore]
+            self.parallel = os.cpu_count() or 1
+        try:
+            super().build_extensions()
+        except Exception:  # nosec
+            _LOGGER.exception("Failed to build extensions")
+            if getenv_bool("REQUIRE_CYTHON") or getenv_bool("REQUIRE_EXTENSION"):
+                raise
+
+
+def build(setup_kwargs: Any) -> None:
+    if getenv_bool("SKIP_CYTHON") or getenv_bool("SKIP_EXTENSION"):
+        return
+    try:
+        setup_kwargs.update(
+            {
+                "ext_modules": [ulid_module],
+                "cmdclass": {"build_ext": BuildExt},
+            }
+        )
+    except Exception:
+        _LOGGER.exception("Failed to configure C extension")
+        if getenv_bool("REQUIRE_CYTHON") or getenv_bool("REQUIRE_EXTENSION"):
+            raise
+
+
+def _clean_stale_artifacts() -> None:
+    """Remove previously-built extension artifacts before packaging.
+
+    The wheel ``include`` globs in ``pyproject.toml`` are unconditional, so a
+    stale ``.so``/``.pyd`` left in ``src/ulid_transform/`` by an earlier build
+    would otherwise be packaged even when the extension is skipped
+    (``SKIP_EXTENSION``) or its build failed and was swallowed, yielding an
+    incompatible binary wheel instead of the requested pure-Python fallback.
+    Clearing them first means the include globs only ever match a freshly
+    built artifact from this run.
+    """
+    pkg_dir = Path("src") / "ulid_transform"
+    for pattern in ("*.so", "*.pyd"):
+        for artifact in pkg_dir.glob(pattern):
+            artifact.unlink()
+
+
+def _run_main() -> None:
+    """Build the C extension when invoked directly.
+
+    poetry-core calls ``python build_ext.py`` (no args) during the wheel
+    build when ``generate-setup-file = false`` is set in
+    ``pyproject.toml``.  We synthesise a ``setuptools.setup()`` call with
+    an in-place ``build_ext`` so the compiled extension lands next to its
+    sources in ``src/ulid_transform/`` where poetry-core's
+    ``find_files_to_add`` picks it up.  ``generate-setup-file = false``
+    is set so the sdist does not ship a generated ``setup.py`` that does
+    ``from build_ext import *``, which fails under
+    ``PYTHONSAFEPATH=1`` (see issue #137).
+    """
+    _clean_stale_artifacts()
+    setup_kwargs: dict[str, Any] = {
+        "name": "ulid-transform",
+        "packages": ["ulid_transform"],
+        "package_dir": {"": "src"},
+    }
+    build(setup_kwargs)
+    if "ext_modules" not in setup_kwargs:
+        return
+    if len(sys.argv) == 1:
+        sys.argv.extend(["build_ext", "--inplace"])
+    setup(**setup_kwargs)
+
+
+if __name__ == "__main__":
+    _run_main()

{ulid_transform-2.2.5 → ulid_transform-2.2.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ulid-transform"
-version = "2.2.5"
+version = "2.2.7"
 license = "MIT"
 description = "Create and transform ULIDs"
 readme = "README.md"
@@ -23,9 +23,13 @@ classifiers = [
 packages = [
     { include = "ulid_transform", from = "src" },
 ]
+include = [
+    { path = "src/ulid_transform/*.so", format = "wheel" },
+    { path = "src/ulid_transform/*.pyd", format = "wheel" },
+]
 
 [tool.poetry.build]
-generate-setup-file = true
+generate-setup-file = false
 script = "build_ext.py"
 
 [tool.poetry.dependencies]

{ulid_transform-2.2.5 → ulid_transform-2.2.7}/src/ulid_transform/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.2.5"
+__version__ = "2.2.7"
 
 try:
     from ._ulid_impl import (

{ulid_transform-2.2.5 → ulid_transform-2.2.7}/src/ulid_transform/_ulid_impl.cpp

@@ -189,7 +189,11 @@ py_ulid_to_bytes(PyObject* module, PyObject* arg)
     const char* str = PyUnicode_AsUTF8AndSize(arg, &len);
     if (!str)
         return NULL;
-    if (len != ULID_TEXT_LEN) {
+    // len is the UTF-8 byte length. A non-ASCII string can still be exactly
+    // 26 bytes (e.g. 13 two-byte codepoints), so an ASCII check is required to
+    // reject it — otherwise DecodeBase32To reads garbage. Mirrors the Python
+    // impl's `len(value) != 26 or not value.isascii()`.
+    if (len != ULID_TEXT_LEN || !PyUnicode_IS_ASCII(arg)) {
         PyErr_Format(PyExc_ValueError,
             "ULID must be a 26 character string: %R", arg);
         return NULL;
@@ -229,7 +233,9 @@ py_ulid_to_bytes_or_none(PyObject* module, PyObject* arg)
     const char* str = PyUnicode_AsUTF8AndSize(arg, &len);
     if (!str)
         return NULL;
-    if (len != ULID_TEXT_LEN)
+    // See py_ulid_to_bytes: a non-ASCII string can be exactly 26 UTF-8 bytes,
+    // so reject anything non-ASCII to match the Python impl returning None.
+    if (len != ULID_TEXT_LEN || !PyUnicode_IS_ASCII(arg))
         Py_RETURN_NONE;
     uint8_t buf[ULID_BYTES_LEN];
     ulid::DecodeBase32To(str, buf);
@@ -271,7 +277,9 @@ py_ulid_to_timestamp(PyObject* module, PyObject* arg)
     const char* str = PyUnicode_AsUTF8AndSize(arg, &len);
     if (!str)
         return NULL;
-    if (len != ULID_TEXT_LEN) {
+    // See py_ulid_to_bytes: a non-ASCII string can be exactly 26 UTF-8 bytes,
+    // so reject anything non-ASCII to match the Python impl raising ValueError.
+    if (len != ULID_TEXT_LEN || !PyUnicode_IS_ASCII(arg)) {
         PyErr_Format(PyExc_ValueError,
             "ULID must be a 26 character string: %R", arg);
         return NULL;

ulid_transform-2.2.5/build_ext.py

@@ -1,63 +0,0 @@
-"""Build optional C extension modules."""
-
-from distutils.command.build_ext import build_ext
-import logging
-import os
-from pathlib import Path
-from typing import Any
-
-try:
-    from setuptools import Extension
-except ImportError:
-    from distutils.core import Extension
-
-_LOGGER = logging.getLogger(__name__)
-
-
-def getenv_bool(key: str, default: bool = False) -> bool:
-    value = os.environ.get(key, str(default)).lower()
-    if value in ("1", "true", "yes"):
-        return True
-    if value in ("0", "false", "no"):
-        return False
-    msg = f"Invalid value for boolean envvar {key}: {value}"
-    raise ValueError(msg)
-
-
-ulid_module = Extension(
-    "ulid_transform._ulid_impl",
-    [
-        str(Path("src") / "ulid_transform" / "_ulid_impl.cpp"),
-    ],
-    language="c++",
-    extra_compile_args=["-std=c++11", "-O3", "-g0"],
-    extra_link_args=["-std=c++11"],
-)
-
-
-class BuildExt(build_ext):
-    def build_extensions(self) -> None:
-        if self.parallel is None:  # type: ignore[has-type, unused-ignore]
-            self.parallel = os.cpu_count() or 1
-        try:
-            super().build_extensions()
-        except Exception:  # nosec
-            _LOGGER.exception("Failed to build extensions")
-            if getenv_bool("REQUIRE_CYTHON") or getenv_bool("REQUIRE_EXTENSION"):
-                raise
-
-
-def build(setup_kwargs: Any) -> None:
-    if getenv_bool("SKIP_CYTHON") or getenv_bool("SKIP_EXTENSION"):
-        return
-    try:
-        setup_kwargs.update(
-            {
-                "ext_modules": [ulid_module],
-                "cmdclass": {"build_ext": BuildExt},
-            }
-        )
-    except Exception:
-        _LOGGER.exception("Failed to configure C extension")
-        if getenv_bool("REQUIRE_CYTHON") or getenv_bool("REQUIRE_EXTENSION"):
-            raise

ulid_transform-2.2.5/setup.py

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['ulid_transform']
-
-package_data = \
-{'': ['*']}
-
-setup_kwargs = {
-    'name': 'ulid-transform',
-    'version': '2.2.5',
-    'description': 'Create and transform ULIDs',
-    'long_description': '# Fast ULID transformations\n\n<p align="center">\n  <a href="https://github.com/bluetooth-devices/ulid-transform/actions/workflows/ci.yml?query=branch%3Amain">\n    <img src="https://img.shields.io/github/actions/workflow/status/bluetooth-devices/ulid-transform/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >\n  </a>\n  <a href="https://codecov.io/gh/bluetooth-devices/ulid-transform">\n    <img src="https://img.shields.io/codecov/c/github/bluetooth-devices/ulid-transform.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">\n  </a>\n</p>\n<p align="center">\n  <a href="https://python-poetry.org/">\n    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">\n  </a>\n  <a href="https://github.com/ambv/black">\n    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">\n  </a>\n  <a href="https://github.com/pre-commit/pre-commit">\n    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">\n  </a>\n  <a href="https://codspeed.io/Bluetooth-Devices/ulid-transform"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed Badge"/></a>\n</p>\n<p align="center">\n  <a href="https://pypi.org/project/ulid-transform/">\n    <img src="https://img.shields.io/pypi/v/ulid-transform.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">\n  </a>\n  <img src="https://img.shields.io/pypi/pyversions/ulid-transform.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">\n  <img src="https://img.shields.io/pypi/l/ulid-transform.svg?style=flat-square" alt="License">\n</p>\n\nCreate and transform ULIDs\n\nThis library will use the C++ implementation from https://github.com/suyash/ulid when the C extension is available, and will fallback to pure python if it is not.\n\n## Example\n\n```python\n>>> import ulid_transform\n>>> ulid_transform.ulid_hex()\n\'01869a2ea5fb0b43aa056293e47c0a35\'\n>>> ulid_transform.ulid_now()\n\'0001HZX0NW00GW0X476W5TVBFE\'\n>>> ulid_transform.ulid_at_time(1234)\n\'000000016JC62D620DGYNG2R8H\'\n>>> ulid_transform.ulid_to_bytes(\'0001HZX0NW00GW0X476W5TVBFE\')\nb\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\'\n>>> ulid_transform.bytes_to_ulid(b"\\x01\\x86\\x99?\\xe8\\xf3\\x11\\xbc\\xed\\xef\\x86U.9\\x03z")\n\'01GTCKZT7K26YEVVW6AMQ3J0VT\'\n>>> ulid_transform.ulid_to_bytes_or_none(\'0001HZX0NW00GW0X476W5TVBFE\')\nb\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\'\n>>> ulid_transform.ulid_to_bytes_or_none(None)\n>>> ulid_transform.bytes_to_ulid_or_none(b\'\\x00\\x00c\\xfe\\x82\\xbc\\x00!\\xc0t\\x877\\x0b\\xad\\xad\\xee\')\n\'0001HZX0NW00GW0X476W5TVBFE\'\n>>> ulid_transform.bytes_to_ulid_or_none(None)\n```\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install ulid-transform`\n\n## Contributors ✨\n\nThanks to https://github.com/suyash/ulid which provides the C++ implementation guts.\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- prettier-ignore-start -->\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- markdownlint-disable -->\n<!-- markdownlint-enable -->\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-end -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## Credits\n\nThis package was created with\n[Copier](https://copier.readthedocs.io/) and the\n[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)\nproject template.\n',
-    'author': 'J. Nick Koston',
-    'author_email': 'nick@koston.org',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'https://github.com/bluetooth-devices/ulid-transform',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'python_requires': '>=3.11',
-}
-from build_ext import *
-build(setup_kwargs)
-
-setup(**setup_kwargs)