ulid-transform 0.10.2__tar.gz → 0.11.1__tar.gz

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/PKG-INFO

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

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/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.10.2 → ulid_transform-0.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ulid-transform"
-version = "0.10.2"
+version = "0.11.1"
 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.10.2 → ulid_transform-0.11.1}/setup.py

@@ -12,7 +12,7 @@ package_data = \
 
 setup_kwargs = {
     'name': 'ulid-transform',
-    'version': '0.10.2',
+    'version': '0.11.1',
     '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.10.2 → ulid_transform-0.11.1}/src/ulid_transform/__init__.py

@@ -1,21 +1,25 @@
-__version__ = "0.10.2"
+__version__ = "0.11.1"
 
 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__ = [
-    "ulid_now",
+    "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",
-    "bytes_to_ulid",
     "ulid_to_bytes_or_none",
-    "bytes_to_ulid_or_none",
 ]

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/src/ulid_transform/_ulid_impl.pyx

@@ -1,18 +1,23 @@
 # distutils: language = c++
 from libcpp.string cimport string
+from libcpp.vector cimport vector
 
-from time import time
 from typing import Optional
 
-import cython
-
 
 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")

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/src/ulid_transform/ulid_impl.py

@@ -280,6 +280,21 @@ def ulid_hex() -> str:
     return f"{int(time()*1000):012x}{getrandbits(80):020x}"
 
 
+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 int(timestamp * 1000).to_bytes(6, byteorder="big") + int(
+        getrandbits(80)
+    ).to_bytes(10, byteorder="big")
+
+
+def ulid_now_bytes() -> bytes:
+    """Generate an ULID as 16 bytes that will work for a UUID."""
+    return ulid_at_time_bytes(time())
+
+
 def ulid_now() -> str:
     """Generate a ULID."""
     return ulid_at_time(time())
@@ -302,10 +317,7 @@ def ulid_at_time(timestamp: float) -> str:
     import ulid
     ulid.parse(ulid_util.ulid())
     """
-    return _encode(
-        int((timestamp) * 1000).to_bytes(6, byteorder="big")
-        + int(getrandbits(80)).to_bytes(10, byteorder="big")
-    )
+    return _encode(ulid_at_time_bytes(timestamp))
 
 
 def _encode(ulid_bytes: bytes) -> str:
@@ -440,9 +452,15 @@ try:
     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,
     )

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/src/ulid_transform/ulid_wrapper.cpp

@@ -10,6 +10,13 @@ std::string _cpp_ulid() {
   return ulid::Marshal(ulid);
 }
 
+std::vector<uint8_t> _cpp_ulid_bytes() {
+  ulid::ULID ulid;
+  ulid::EncodeTimeSystemClockNow(ulid);
+  ulid::EncodeEntropyRand(ulid);
+  return ulid::MarshalBinary(ulid);
+}
+
 std::string _cpp_ulid_at_time(double epoch_time) {
   ulid::ULID ulid;
   ulid::EncodeTimestamp(static_cast<int64_t>(epoch_time*1000), ulid);
@@ -17,6 +24,13 @@ std::string _cpp_ulid_at_time(double epoch_time) {
   return ulid::Marshal(ulid);
 }
 
+std::vector<uint8_t> _cpp_ulid_at_time_bytes(double epoch_time) {
+  ulid::ULID ulid;
+  ulid::EncodeTimestamp(static_cast<int64_t>(epoch_time*1000), ulid);
+  ulid::EncodeEntropyRand(ulid);
+  return ulid::MarshalBinary(ulid);
+}
+
 std::string _cpp_ulid_to_bytes(const char * ulid_string) {
   ulid::ULID ulid;
   ulid::UnmarshalFrom(ulid_string, ulid);

{ulid_transform-0.10.2 → ulid_transform-0.11.1}/src/ulid_transform/ulid_wrapper.h

@@ -1,10 +1,13 @@
 #include <string>
+#include <vector>
 
 #ifndef ULID_WRAPPER_H
 #define ULID_WRAPPER_H
 
 std::string _cpp_ulid();
+std::vector<uint8_t> _cpp_ulid_bytes();
 std::string _cpp_ulid_at_time(double timestamp);
+std::vector<uint8_t> _cpp_ulid_at_time_bytes(double timestamp);
 std::string _cpp_ulid_to_bytes(const char * ulid_string);
 std::string _cpp_bytes_to_ulid(std::string bytes_string);