typeid-python 0.2.1__tar.gz → 0.2.3__tar.gz

{typeid_python-0.2.1 → typeid_python-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: typeid-python
-Version: 0.2.1
+Version: 0.2.3
 Summary: Python implementation of TypeIDs: type-safe, K-sortable, and globally unique identifiers inspired by Stripe IDs
 Home-page: https://github.com/akhundMurad/typeid-python
 License: MIT
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: cli
 Requires-Dist: uuid6 (>=2023.5.2,<2024.0.0)
 Project-URL: Repository, https://github.com/akhundMurad/typeid-python
@@ -82,9 +83,9 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from string:
 
     ```python
-    from typeid import from_string
+    from typeid import TypeID
 
-    typeid = from_string("user_01h45ytscbebyvny4gc8cr8ma2")
+    typeid = TypeID.from_string("user_01h45ytscbebyvny4gc8cr8ma2")
 
     print(str(typeid))  # "user_01h45ytscbebyvny4gc8cr8ma2"
     ```
@@ -92,13 +93,13 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from uuid7:
 
     ```python
-    from typeid import from_uuid
+    from typeid import TypeID
     from uuid6 import uuid7
 
     uuid = uuid7()  # UUID('01890bf0-846f-7762-8605-5a3abb40e0e5')
     prefix = "user"
 
-    typeid = from_uuid(prefix=prefix, suffix=uuid)
+    typeid = TypeID.from_uuid(prefix=prefix, suffix=uuid)
 
     print(str(typeid))  # "user_01h45z113fexh8c1at7axm1r75"
     ```

{typeid_python-0.2.1 → typeid_python-0.2.3}/README.md

@@ -59,9 +59,9 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from string:
 
     ```python
-    from typeid import from_string
+    from typeid import TypeID
 
-    typeid = from_string("user_01h45ytscbebyvny4gc8cr8ma2")
+    typeid = TypeID.from_string("user_01h45ytscbebyvny4gc8cr8ma2")
 
     print(str(typeid))  # "user_01h45ytscbebyvny4gc8cr8ma2"
     ```
@@ -69,13 +69,13 @@ This particular implementation provides an pip package that can be used by any P
 - Create TypeID from uuid7:
 
     ```python
-    from typeid import from_uuid
+    from typeid import TypeID
     from uuid6 import uuid7
 
     uuid = uuid7()  # UUID('01890bf0-846f-7762-8605-5a3abb40e0e5')
     prefix = "user"
 
-    typeid = from_uuid(prefix=prefix, suffix=uuid)
+    typeid = TypeID.from_uuid(prefix=prefix, suffix=uuid)
 
     print(str(typeid))  # "user_01h45z113fexh8c1at7axm1r75"
     ```

{typeid_python-0.2.1 → typeid_python-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "typeid-python"
-version = "0.2.1"
+version = "0.2.3"
 description = "Python implementation of TypeIDs: type-safe, K-sortable, and globally unique identifiers inspired by Stripe IDs"
 authors = ["Murad Akhundov <akhundov1murad@gmail.com>"]
 license = "MIT"
@@ -13,6 +13,7 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
   "Operating System :: OS Independent",
 ]
 keywords = ["typeid", "uuid", "uuid6", "guid"]

{typeid_python-0.2.1 → typeid_python-0.2.3}/typeid/typeid.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Optional
 from uuid import UUID
 
@@ -18,6 +19,16 @@ class TypeID:
         self._prefix = prefix or ""
         self._suffix = suffix
 
+    @classmethod
+    def from_string(cls, string: str):
+        prefix, suffix = get_prefix_and_suffix(string=string)
+        return cls(suffix=suffix, prefix=prefix)
+
+    @classmethod
+    def from_uuid(cls, suffix: UUID, prefix: Optional[str] = None):
+        suffix_str = _convert_uuid_to_b32(suffix)
+        return TypeID(suffix=suffix_str, prefix=prefix)
+
     @property
     def suffix(self) -> str:
         return self._suffix
@@ -26,6 +37,10 @@ class TypeID:
     def prefix(self) -> str:
         return self._prefix
 
+    @property
+    def uuid(self) -> UUID:
+        return _convert_b32_to_uuid(self.suffix)
+
     def __str__(self) -> str:
         value = ""
         if self.prefix:
@@ -33,20 +48,36 @@ class TypeID:
         value += self.suffix
         return value
 
+    def __repr__(self):
+        return "%s(%r)" % (self.__class__.__name__, str(self))
+
     def __eq__(self, value: object) -> bool:
         if not isinstance(value, TypeID):
             return False
         return value.prefix == self.prefix and value.suffix == self.suffix
 
+    def __gt__(self, other):
+        if isinstance(other, TypeID):
+            return str(self) > str(other)
+        return NotImplemented
+
+    def __ge__(self, other):
+        if isinstance(other, TypeID):
+            return str(self) >= str(other)
+        return NotImplemented
+
+    def __hash__(self) -> int:
+        return hash((self.prefix, self.suffix))
+
 
 def from_string(string: str) -> TypeID:
-    prefix, suffix = get_prefix_and_suffix(string=string)
-    return TypeID(suffix=suffix, prefix=prefix)
+    warnings.warn("Consider TypeID.from_string instead.", DeprecationWarning)
+    return TypeID.from_string(string=string)
 
 
 def from_uuid(suffix: UUID, prefix: Optional[str] = None) -> TypeID:
-    suffix_str = _convert_uuid_to_b32(suffix)
-    return TypeID(suffix=suffix_str, prefix=prefix)
+    warnings.warn("Consider TypeID.from_uuid instead.", DeprecationWarning)
+    return TypeID.from_uuid(suffix=suffix, prefix=prefix)
 
 
 def get_prefix_and_suffix(string: str) -> tuple:
@@ -66,3 +97,7 @@ def get_prefix_and_suffix(string: str) -> tuple:
 
 def _convert_uuid_to_b32(uuid_instance: UUID) -> str:
     return base32.encode(list(uuid_instance.bytes))
+
+
+def _convert_b32_to_uuid(b32: str) -> UUID:
+    return UUID(bytes=bytes(base32.decode(b32)))