ulid-transform 0.11.0__tar.gz → 0.12.0__tar.gz

{ulid_transform-0.11.0 → ulid_transform-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ulid-transform
-Version: 0.11.0
+Version: 0.12.0
 Summary: Create and transform ULIDs
 Home-page: https://github.com/bdraco/ulid-transform
 License: MIT

{ulid_transform-0.11.0 → ulid_transform-0.12.0}/build_ext.py

@@ -1,5 +1,6 @@
 """Build optional cython modules."""
 
+import logging
 import os
 from distutils.command.build_ext import build_ext
 from os.path import join
@@ -10,6 +11,16 @@ try:
 except ImportError:
     from distutils.core import Extension
 
+
+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
+    raise ValueError(f"Invalid value for boolean envvar {key}: {value}")
+
+
 ulid_module = Extension(
     "ulid_transform._ulid_impl",
     [
@@ -27,11 +38,13 @@ class BuildExt(build_ext):
         try:
             super().build_extensions()
         except Exception:  # nosec
-            pass
+            logging.exception("Failed to build extensions")
+            if getenv_bool("REQUIRE_CYTHON"):
+                raise
 
 
 def build(setup_kwargs: Any) -> None:
-    if os.environ.get("SKIP_CYTHON", False):
+    if getenv_bool("SKIP_CYTHON"):
         return
     try:
         from Cython.Build import cythonize
@@ -43,6 +56,7 @@ def build(setup_kwargs: Any) -> None:
                         ulid_module,
                     ],
                     compiler_directives={"language_level": "3"},  # Python 3
+                    verbose=True,
                 ),
                 cmdclass=dict(build_ext=BuildExt),
             )
@@ -51,6 +65,6 @@ def build(setup_kwargs: Any) -> None:
             pkg: ["_ulid_impl.cpp"] for pkg in setup_kwargs["packages"]
         }
     except Exception:
-        if os.environ.get("REQUIRE_CYTHON"):
+        logging.exception("Failed to configure cython")
+        if getenv_bool("REQUIRE_CYTHON"):
             raise
-        pass

{ulid_transform-0.11.0 → ulid_transform-0.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ulid-transform"
-version = "0.11.0"
+version = "0.12.0"
 description = "Create and transform ULIDs"
 authors = ["J. Nick Koston <nick@koston.org>"]
 license = "MIT"
@@ -34,6 +34,12 @@ pytest-cov = "^3.0"
 Cython = ">=3.0.5"
 setuptools = "^65.4.1"
 
+
+[tool.poetry.group.benchmark.dependencies]
+ulid-py = "^1.1.0"
+ulid2 = "^0.3.0"
+pytest-benchmark = "^4.0.0"
+
 [tool.semantic_release]
 branch = "main"
 version_toml = "pyproject.toml:tool.poetry.version"
@@ -41,7 +47,6 @@ version_variable = "src/ulid_transform/__init__.py:__version__"
 build_command = "pip install poetry && poetry build"
 
 [tool.pytest.ini_options]
-addopts = "-v -Wdefault --cov=ulid_transform --cov-report=term-missing:skip-covered"
 pythonpath = ["src"]
 
 [tool.coverage.run]
@@ -78,6 +83,9 @@ exclude = [
 module = "tests.*"
 allow_untyped_defs = true
 
+[[tool.mypy.overrides]]
+module = "bench.*"
+allow_untyped_defs = true
 
 [build-system]
 requires = ['setuptools>=65.4.1', 'wheel', 'Cython>=3.0.2', "poetry-core>=1.0.0"]

{ulid_transform-0.11.0 → ulid_transform-0.12.0}/setup.py

@@ -12,7 +12,7 @@ package_data = \
 
 setup_kwargs = {
     'name': 'ulid-transform',
-    'version': '0.11.0',
+    'version': '0.12.0',
     'description': 'Create and transform ULIDs',
     'long_description': '# Fast ULID transformations\n\n<p align="center">\n  <a href="https://github.com/bdraco/ulid-transform/actions/workflows/ci.yml?query=branch%3Amain">\n    <img src="https://img.shields.io/github/actions/workflow/status/bdraco/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/bdraco/ulid-transform">\n    <img src="https://img.shields.io/codecov/c/github/bdraco/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</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 CPP implementation from https://github.com/suyash/ulid if cython 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 cython 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',

ulid_transform-0.12.0/src/ulid_transform/__init__.py

@@ -0,0 +1,38 @@
+__version__ = "0.12.0"
+
+try:
+    from ._ulid_impl import (
+        bytes_to_ulid,
+        bytes_to_ulid_or_none,
+        ulid_at_time,
+        ulid_at_time_bytes,
+        ulid_hex,
+        ulid_now,
+        ulid_now_bytes,
+        ulid_to_bytes,
+        ulid_to_bytes_or_none,
+    )
+except ImportError:
+    from ._py_ulid_impl import (
+        bytes_to_ulid,
+        bytes_to_ulid_or_none,
+        ulid_at_time,
+        ulid_at_time_bytes,
+        ulid_hex,
+        ulid_now,
+        ulid_now_bytes,
+        ulid_to_bytes,
+        ulid_to_bytes_or_none,
+    )
+
+__all__ = [
+    "bytes_to_ulid",
+    "bytes_to_ulid_or_none",
+    "ulid_at_time",
+    "ulid_at_time_bytes",
+    "ulid_hex",
+    "ulid_now",
+    "ulid_now_bytes",
+    "ulid_to_bytes",
+    "ulid_to_bytes_or_none",
+]

ulid_transform-0.11.0/src/ulid_transform/ulid_impl.py → ulid_transform-0.12.0/src/ulid_transform/_py_ulid_impl.py

@@ -432,40 +432,11 @@ def ulid_to_bytes_or_none(ulid: str | None) -> bytes | None:
         return None
 
 
-def bytes_to_ulid_or_none(_bytes: bytes | None) -> str | None:
+def bytes_to_ulid_or_none(ulid_bytes: bytes | None) -> str | None:
     """Convert bytes to a ulid."""
-    if _bytes is None:
+    if ulid_bytes is None:
         return None
     try:
-        return bytes_to_ulid(_bytes)
+        return bytes_to_ulid(ulid_bytes)
     except ValueError:
         return None
-
-
-try:
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _bytes_to_ulid as bytes_to_ulid,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _bytes_to_ulid_or_none as bytes_to_ulid_or_none,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_at_time as ulid_at_time,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_at_time_bytes as ulid_at_time_bytes,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_now as ulid_now,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_now_bytes as ulid_now_bytes,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_to_bytes as ulid_to_bytes,
-    )
-    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401 # pragma: no cover
-        _ulid_to_bytes_or_none as ulid_to_bytes_or_none,
-    )
-except ImportError:  # pragma: no cover
-    pass  # pragma: no cover

ulid_transform-0.12.0/src/ulid_transform/_ulid_impl.pyx

@@ -0,0 +1,91 @@
+# distutils: language = c++
+from libcpp.string cimport string
+from libcpp.vector cimport vector
+
+
+cdef extern from "ulid_wrapper.h":
+    string _cpp_ulid_at_time(double timestamp)
+    vector[unsigned char] _cpp_ulid_at_time_bytes(double timestamp)
+    string _cpp_ulid_to_bytes(const char * ulid_string)
+    string _cpp_ulid()
+    vector[unsigned char] _cpp_ulid_bytes()
+    string _cpp_bytes_to_ulid(string ulid_bytes)
+
+
+def ulid_hex() -> str:
+    """Generate a ULID in lowercase hex that will work for a UUID.
+
+    This ulid should not be used for cryptographically secure
+    operations.
+
+    This string can be converted with https://github.com/ahawker/ulid
+
+    ulid.from_uuid(uuid.UUID(ulid_hex))
+    """
+    return bytes(_cpp_ulid_bytes()).hex()
+
+
+def ulid_now_bytes() -> bytes:
+    """Generate an ULID as 16 bytes that will work for a UUID."""
+    return bytes(_cpp_ulid_bytes())
+
+
+def ulid_at_time_bytes(timestamp: float) -> bytes:
+    """Generate an ULID as 16 bytes that will work for a UUID.
+
+    uuid.UUID(bytes=ulid_bytes)
+    """
+    return bytes(_cpp_ulid_at_time_bytes(timestamp))
+
+
+def ulid_now() -> str:
+    """Generate a ULID."""
+    return _cpp_ulid().decode("ascii")
+
+
+def ulid_at_time(timestamp: float) -> str:
+    """Generate a ULID.
+
+    This ulid should not be used for cryptographically secure
+    operations.
+
+     01AN4Z07BY      79KA1307SR9X4MV3
+    |----------|    |----------------|
+     Timestamp          Randomness
+       48bits             80bits
+
+    This string can be loaded directly with https://github.com/ahawker/ulid
+
+    import ulid_transform as ulid_util
+    import ulid
+    ulid.parse(ulid_util.ulid())
+    """
+    return _cpp_ulid_at_time(timestamp).decode("ascii")
+
+
+def ulid_to_bytes(value: str) -> bytes:
+    """Decode a ulid to bytes."""
+    if len(value) != 26:
+        raise ValueError(f"ULID must be a 26 character string: {value}")
+    return _cpp_ulid_to_bytes(value.encode("ascii"))
+
+
+def bytes_to_ulid(value: bytes) -> str:
+    """Encode bytes to a ulid."""
+    if len(value) != 16:
+        raise ValueError(f"ULID bytes must be 16 bytes: {value!r}")
+    return _cpp_bytes_to_ulid(value).decode("ascii")
+
+
+def ulid_to_bytes_or_none(ulid: str | None) -> bytes | None:
+    """Convert an ulid to bytes."""
+    if ulid is None or len(ulid) != 26:
+        return None
+    return _cpp_ulid_to_bytes(ulid.encode("ascii"))
+
+
+def bytes_to_ulid_or_none(ulid_bytes: bytes | None) -> str | None:
+    """Convert bytes to a ulid."""
+    if ulid_bytes is None or len(ulid_bytes) != 16:
+        return None
+    return _cpp_bytes_to_ulid(ulid_bytes).decode("ascii")

{ulid_transform-0.11.0 → ulid_transform-0.12.0}/src/ulid_transform/ulid_wrapper.h

@@ -1,4 +1,5 @@
 #include <string>
+#include <vector>
 
 #ifndef ULID_WRAPPER_H
 #define ULID_WRAPPER_H

ulid_transform-0.11.0/src/ulid_transform/__init__.py

@@ -1,25 +0,0 @@
-__version__ = "0.11.0"
-
-from .ulid_impl import (
-    bytes_to_ulid,
-    bytes_to_ulid_or_none,
-    ulid_at_time,
-    ulid_at_time_bytes,
-    ulid_hex,
-    ulid_now,
-    ulid_now_bytes,
-    ulid_to_bytes,
-    ulid_to_bytes_or_none,
-)
-
-__all__ = [
-    "bytes_to_ulid",
-    "bytes_to_ulid_or_none",
-    "ulid_at_time",
-    "ulid_at_time_bytes",
-    "ulid_hex",
-    "ulid_now",
-    "ulid_now_bytes",
-    "ulid_to_bytes",
-    "ulid_to_bytes_or_none",
-]

ulid_transform-0.11.0/src/ulid_transform/_ulid_impl.pyx

@@ -1,46 +0,0 @@
-# distutils: language = c++
-from libcpp.string cimport string
-from libcpp.vector cimport vector
-
-from typing import Optional
-
-
-cdef extern from "ulid_wrapper.h":
-    string _cpp_ulid_at_time(double timestamp)
-    vector[unsigned char] _cpp_ulid_at_time_bytes(double timestamp)
-    string _cpp_ulid_to_bytes(const char * ulid_string)
-    string _cpp_ulid()
-    vector[unsigned char] _cpp_ulid_bytes()
-    string _cpp_bytes_to_ulid(string ulid_bytes)
-
-def _ulid_now_bytes() -> bytes:
-    return bytes(_cpp_ulid_bytes())
-
-def _ulid_at_time_bytes(_time: float) -> bytes:
-    return bytes(_cpp_ulid_at_time_bytes(_time))
-
-def _ulid_now() -> str:
-    return _cpp_ulid().decode("ascii")
-
-def _ulid_at_time(_time: float) -> str:
-    return _cpp_ulid_at_time(_time).decode("ascii")
-
-def _ulid_to_bytes(ulid_str: str) -> bytes:
-    if len(ulid_str) != 26:
-        raise ValueError(f"ULID must be a 26 character string: {ulid_str}")
-    return _cpp_ulid_to_bytes(ulid_str.encode("ascii"))
-
-def _bytes_to_ulid(ulid_bytes: bytes) -> str:
-    if len(ulid_bytes) != 16:
-        raise ValueError(f"ULID bytes must be 16 bytes: {ulid_bytes!r}")
-    return _cpp_bytes_to_ulid(ulid_bytes).decode("ascii")
-
-def _ulid_to_bytes_or_none(ulid_str: Optional[str]) -> Optional[bytes]:
-    if ulid_str is None or len(ulid_str) != 26:
-        return None
-    return _cpp_ulid_to_bytes(ulid_str.encode("ascii"))
-
-def _bytes_to_ulid_or_none(ulid_bytes: Optional[bytes]) -> Optional[str]:
-    if ulid_bytes is None or len(ulid_bytes) != 16:
-        return None
-    return _cpp_bytes_to_ulid(ulid_bytes).decode("ascii")