ulid-transform 0.1.0__tar.gz → 0.2.1__tar.gz

{ulid_transform-0.1.0 → ulid_transform-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ulid-transform
-Version: 0.1.0
+Version: 0.2.1
 Summary: Create and transform ULIDs
 Home-page: https://github.com/bdraco/ulid-transform
 License: MIT
@@ -16,7 +16,6 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: fast-ulid (>=0.2.0,<0.3.0)
 Project-URL: Bug Tracker, https://github.com/bdraco/ulid-transform/issues
 Project-URL: Changelog, https://github.com/bdraco/ulid-transform/blob/main/CHANGELOG.md
 Project-URL: Repository, https://github.com/bdraco/ulid-transform
@@ -61,6 +60,8 @@ Install this via pip (or your favourite package manager):
 
 ## Contributors ✨
 
+Thanks to https://github.com/suyash/ulid which provides the cython implementation guts.
+
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- prettier-ignore-start -->

{ulid_transform-0.1.0 → ulid_transform-0.2.1}/README.md

@@ -37,6 +37,8 @@ Install this via pip (or your favourite package manager):
 
 ## Contributors ✨
 
+Thanks to https://github.com/suyash/ulid which provides the cython implementation guts.
+
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- prettier-ignore-start -->

{ulid_transform-0.1.0 → ulid_transform-0.2.1}/build_ext.py

@@ -2,8 +2,23 @@
 
 import os
 from distutils.command.build_ext import build_ext
+from os.path import join
 from typing import Any
 
+try:
+    from setuptools import Extension
+except ImportError:
+    from distutils.core import Extension
+
+ulid_module = Extension(
+    "ulid_transform._ulid_impl",
+    [
+        join("src", "ulid_transform", "_ulid_impl.pyx"),
+        join("src", "ulid_transform", "ulid_wrapper.cpp"),
+    ],
+    language="c++",
+)
+
 
 class BuildExt(build_ext):
     def build_extensions(self) -> None:
@@ -23,7 +38,7 @@ def build(setup_kwargs: Any) -> None:
             dict(
                 ext_modules=cythonize(
                     [
-                        "src/ulid_tansform/convert.py",
+                        ulid_module,
                     ],
                     compiler_directives={"language_level": "3"},  # Python 3
                 ),

{ulid_transform-0.1.0 → ulid_transform-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ulid-transform"
-version = "0.1.0"
+version = "0.2.1"
 description = "Create and transform ULIDs"
 authors = ["J. Nick Koston <nick@koston.org>"]
 license = "MIT"
@@ -27,7 +27,6 @@ script = "build_ext.py"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-fast-ulid = "^0.2.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0"

{ulid_transform-0.1.0 → ulid_transform-0.2.1}/setup.py

@@ -10,14 +10,11 @@ packages = \
 package_data = \
 {'': ['*']}
 
-install_requires = \
-['fast-ulid>=0.2.0,<0.3.0']
-
 setup_kwargs = {
     'name': 'ulid-transform',
-    'version': '0.1.0',
+    'version': '0.2.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\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n`pip install ulid-transform`\n\n## Contributors ✨\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',
+    '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\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',
     'author_email': 'nick@koston.org',
     'maintainer': 'None',
@@ -26,7 +23,6 @@ setup_kwargs = {
     'package_dir': package_dir,
     'packages': packages,
     'package_data': package_data,
-    'install_requires': install_requires,
     'python_requires': '>=3.10,<4.0',
 }
 from build_ext import *

ulid_transform-0.2.1/src/ulid_transform/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "0.2.1"
+
+from .ulid_impl import ulid_at_time, ulid_hex, ulid_now, ulid_to_bytes
+
+__all__ = ["ulid_now", "ulid_at_time", "ulid_hex", "ulid_to_bytes"]

ulid_transform-0.2.1/src/ulid_transform/_ulid_impl.pyx

@@ -0,0 +1,20 @@
+# distutils: language = c++
+from libcpp.string cimport string
+
+import cython
+
+
+cdef extern from "ulid_wrapper.h":
+    string _cpp_ulid()
+    string _cpp_ulid_at_time(double timestamp)
+    string _cpp_ulid_to_bytes(string ulid)
+
+
+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:
+    return _cpp_ulid_to_bytes(ulid_str.encode("ascii"))

ulid_transform-0.2.1/src/ulid_transform/ulid.hh

@@ -0,0 +1,17 @@
+// Originally from https://github.com/suyash/ulid
+
+#ifndef ULID_HH
+#define ULID_HH
+
+// http://stackoverflow.com/a/23981011
+#ifdef __SIZEOF_INT128__
+#define ULIDUINT128
+#endif
+
+#ifdef ULIDUINT128
+#include "ulid_uint128.hh"
+#else
+#include "ulid_struct.hh"
+#endif // ULIDUINT128
+
+#endif // ULID_HH

ulid_transform-0.1.0/src/ulid_transform/convert.py → ulid_transform-0.2.1/src/ulid_transform/ulid_impl.py

@@ -1,4 +1,6 @@
 import array
+from random import getrandbits
+from time import time
 
 # From https://github.com/ahawker/ulid/blob/06289583e9de4286b4d80b4ad000d137816502ca/ulid/base32.py#L102
 #: Array that maps encoded string char byte values to enable O(1) lookups.
@@ -264,25 +266,87 @@ DECODE = array.array(
     ),
 )
 
-HAS_CYTHON = 0
-_str = str
 
-try:
-    import cython
+def ulid_hex() -> str:
+    """Generate a ULID in lowercase hex that will work for a UUID.
 
-    HAS_CYTHON = 1
-except ImportError:
-    from ._cython_compat import FAKE_CYTHON as cython
+    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 f"{int(time()*1000):012x}{getrandbits(80):020x}"
+
+
+def ulid_now() -> str:
+    """Generate a ULID."""
+    return ulid_at_time(time())
+
+
+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())
+    """
+    ulid_bytes = int((timestamp) * 1000).to_bytes(6, byteorder="big") + int(
+        getrandbits(80)
+    ).to_bytes(10, byteorder="big")
 
-def decode_ulid(value: _str) -> bytes:
+    # This is base32 crockford encoding with the loop unrolled for performance
+    #
+    # This code is adapted from:
+    # https://github.com/ahawker/ulid/blob/06289583e9de4286b4d80b4ad000d137816502ca/ulid/base32.py#L102
+    #
+    enc = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"
+    return (
+        enc[(ulid_bytes[0] & 224) >> 5]
+        + enc[ulid_bytes[0] & 31]
+        + enc[(ulid_bytes[1] & 248) >> 3]
+        + enc[((ulid_bytes[1] & 7) << 2) | ((ulid_bytes[2] & 192) >> 6)]
+        + enc[((ulid_bytes[2] & 62) >> 1)]
+        + enc[((ulid_bytes[2] & 1) << 4) | ((ulid_bytes[3] & 240) >> 4)]
+        + enc[((ulid_bytes[3] & 15) << 1) | ((ulid_bytes[4] & 128) >> 7)]
+        + enc[(ulid_bytes[4] & 124) >> 2]
+        + enc[((ulid_bytes[4] & 3) << 3) | ((ulid_bytes[5] & 224) >> 5)]
+        + enc[ulid_bytes[5] & 31]
+        + enc[(ulid_bytes[6] & 248) >> 3]
+        + enc[((ulid_bytes[6] & 7) << 2) | ((ulid_bytes[7] & 192) >> 6)]
+        + enc[(ulid_bytes[7] & 62) >> 1]
+        + enc[((ulid_bytes[7] & 1) << 4) | ((ulid_bytes[8] & 240) >> 4)]
+        + enc[((ulid_bytes[8] & 15) << 1) | ((ulid_bytes[9] & 128) >> 7)]
+        + enc[(ulid_bytes[9] & 124) >> 2]
+        + enc[((ulid_bytes[9] & 3) << 3) | ((ulid_bytes[10] & 224) >> 5)]
+        + enc[ulid_bytes[10] & 31]
+        + enc[(ulid_bytes[11] & 248) >> 3]
+        + enc[((ulid_bytes[11] & 7) << 2) | ((ulid_bytes[12] & 192) >> 6)]
+        + enc[(ulid_bytes[12] & 62) >> 1]
+        + enc[((ulid_bytes[12] & 1) << 4) | ((ulid_bytes[13] & 240) >> 4)]
+        + enc[((ulid_bytes[13] & 15) << 1) | ((ulid_bytes[14] & 128) >> 7)]
+        + enc[(ulid_bytes[14] & 124) >> 2]
+        + enc[((ulid_bytes[14] & 3) << 3) | ((ulid_bytes[15] & 224) >> 5)]
+        + enc[ulid_bytes[15] & 31]
+    )
+
+
+def ulid_to_bytes(value: str) -> bytes:
     """Decode a ulid to bytes."""
     if len(value) != 26:
         raise ValueError("ULID must be 26 characters")
     encoded = value.encode("ascii")
-    if cython.compiled:
-        return _decode_ulid(encoded)  # type: ignore[name-defined] # noqa: F821
-
     decoding = DECODE
     return bytes(
         (
@@ -334,3 +398,17 @@ def decode_ulid(value: _str) -> bytes:
             ((decoding[encoded[24]] << 5) | (decoding[encoded[25]])) & 0xFF,
         )
     )
+
+
+try:
+    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401
+        _ulid_at_time as ulid_at_time,
+    )
+    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401
+        _ulid_now as ulid_now,
+    )
+    from ._ulid_impl import (  # type: ignore[no-redef] # noqa: F811 F401
+        _ulid_to_bytes as ulid_to_bytes,
+    )
+except ImportError:
+    pass