base-typed-string 0.1.0__tar.gz → 0.1.2__tar.gz

{base_typed_string-0.1.0/src/base_typed_string.egg-info → base_typed_string-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-typed-string
-Version: 0.1.0
+Version: 0.1.2
 Summary: Strict typed string base class with exact runtime subtype preservation and optional Pydantic v2 support.
 Author-email: Eldeniz Guseinli <eldenizfamilyanskicode@gmail.com>
 License-Expression: MIT
@@ -26,6 +26,7 @@ Requires-Dist: pydantic<3,>=2.6; extra == "pydantic"
 Provides-Extra: test
 Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: pytest-cov>=5.0; extra == "test"
+Requires-Dist: pydantic<3,>=2.6; extra == "test"
 Provides-Extra: lint
 Requires-Dist: ruff>=0.5; extra == "lint"
 Provides-Extra: typecheck
@@ -101,7 +102,6 @@ domain-specific names in type annotations, while keeping real `str` behavior at
 - no normalization
 - no regex engine
 - no domain-specific methods
-- no custom JSON layer
 
 This package is intentionally minimal.
 
@@ -446,6 +446,39 @@ assert type(restored_email) is EmailAddress
 
 ---
 
+## JSON behavior
+
+Since `BaseTypedString` inherits from `str`, standard JSON serialization naturally produces plain JSON strings.
+
+```python
+import json
+
+from base_typed_string import BaseTypedString
+
+
+class EmailAddress(BaseTypedString):
+    pass
+
+
+value: EmailAddress = EmailAddress("hello@example.com")
+serialized_value: str = json.dumps(value)
+restored_value: object = json.loads(serialized_value)
+
+assert serialized_value == '"hello@example.com"'
+assert restored_value == "hello@example.com"
+assert type(restored_value) is str
+```
+
+This behavior is intentional.
+
+JSON is a plain data boundary.
+
+The exact runtime subtype exists only inside Python objects.
+After serialization, values become plain strings and do not carry subtype information.
+
+---
+
+
 ## Public API
 
 ```python

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/README.md

@@ -54,7 +54,6 @@ domain-specific names in type annotations, while keeping real `str` behavior at
 - no normalization
 - no regex engine
 - no domain-specific methods
-- no custom JSON layer
 
 This package is intentionally minimal.
 
@@ -399,6 +398,39 @@ assert type(restored_email) is EmailAddress
 
 ---
 
+## JSON behavior
+
+Since `BaseTypedString` inherits from `str`, standard JSON serialization naturally produces plain JSON strings.
+
+```python
+import json
+
+from base_typed_string import BaseTypedString
+
+
+class EmailAddress(BaseTypedString):
+    pass
+
+
+value: EmailAddress = EmailAddress("hello@example.com")
+serialized_value: str = json.dumps(value)
+restored_value: object = json.loads(serialized_value)
+
+assert serialized_value == '"hello@example.com"'
+assert restored_value == "hello@example.com"
+assert type(restored_value) is str
+```
+
+This behavior is intentional.
+
+JSON is a plain data boundary.
+
+The exact runtime subtype exists only inside Python objects.
+After serialization, values become plain strings and do not carry subtype information.
+
+---
+
+
 ## Public API
 
 ```python

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "base-typed-string"
-version = "0.1.0"
+version = "0.1.2"
 description = "Strict typed string base class with exact runtime subtype preservation and optional Pydantic v2 support."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -40,6 +40,7 @@ pydantic = [
 test = [
     "pytest>=8.0",
     "pytest-cov>=5.0",
+    "pydantic>=2.6,<3",
 ]
 lint = [
     "ruff>=0.5",

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/src/base_typed_string/__init__.py

@@ -12,4 +12,4 @@ __all__: list[str] = [
     "BaseTypedStringInvariantViolationError",
 ]
 
-__version__: str = "0.1.0"
+__version__: str = "0.1.2"

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/src/base_typed_string/_base_typed_string.py

@@ -29,9 +29,9 @@ class BaseTypedString(str):
 
     def __new__(
         cls: type[BaseTypedStringType],
-        value: Any,
+        value: str,
     ) -> BaseTypedStringType:
-        if not isinstance(value, str):
+        if not isinstance(value, str):  # pyright: ignore[reportUnnecessaryIsInstance] runtime boundary guard
             raise BaseTypedStringInvalidInputValueError(
                 "BaseTypedString must be initialized only with str. "
                 f"Got: {type(value).__name__}."
@@ -39,7 +39,6 @@ class BaseTypedString(str):
 
         return str.__new__(cls, value)
 
-
     @classmethod
     def __get_pydantic_core_schema__(
         cls,
@@ -56,8 +55,13 @@ class BaseTypedString(str):
         Serialization:
         - serializes as plain str
         """
+        del source_type
+        del handler
+
         try:
-            from pydantic_core import core_schema
+            from pydantic_core import (  # pyright: ignore[reportMissingImports]
+                core_schema,
+            )
         except ImportError as import_error:
             raise BaseTypedStringInvariantViolationError(
                 "pydantic-core is required to build BaseTypedString schema."
@@ -82,3 +86,6 @@ class BaseTypedString(str):
         self,
     ) -> tuple[type[BaseTypedString], tuple[str]]:
         return (self.__class__, (str(self),))
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}({str(self)!r})"

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/src/base_typed_string/_exceptions.py

@@ -7,4 +7,4 @@ class BaseTypedStringInvalidInputValueError(BaseTypedStringError, TypeError):
 
 
 class BaseTypedStringInvariantViolationError(BaseTypedStringError):
-    """Raised when an internal invariant or contract is violated."""
+    """Raised when an internal invariant or contract is violated."""

{base_typed_string-0.1.0 → base_typed_string-0.1.2/src/base_typed_string.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-typed-string
-Version: 0.1.0
+Version: 0.1.2
 Summary: Strict typed string base class with exact runtime subtype preservation and optional Pydantic v2 support.
 Author-email: Eldeniz Guseinli <eldenizfamilyanskicode@gmail.com>
 License-Expression: MIT
@@ -26,6 +26,7 @@ Requires-Dist: pydantic<3,>=2.6; extra == "pydantic"
 Provides-Extra: test
 Requires-Dist: pytest>=8.0; extra == "test"
 Requires-Dist: pytest-cov>=5.0; extra == "test"
+Requires-Dist: pydantic<3,>=2.6; extra == "test"
 Provides-Extra: lint
 Requires-Dist: ruff>=0.5; extra == "lint"
 Provides-Extra: typecheck
@@ -101,7 +102,6 @@ domain-specific names in type annotations, while keeping real `str` behavior at
 - no normalization
 - no regex engine
 - no domain-specific methods
-- no custom JSON layer
 
 This package is intentionally minimal.
 
@@ -446,6 +446,39 @@ assert type(restored_email) is EmailAddress
 
 ---
 
+## JSON behavior
+
+Since `BaseTypedString` inherits from `str`, standard JSON serialization naturally produces plain JSON strings.
+
+```python
+import json
+
+from base_typed_string import BaseTypedString
+
+
+class EmailAddress(BaseTypedString):
+    pass
+
+
+value: EmailAddress = EmailAddress("hello@example.com")
+serialized_value: str = json.dumps(value)
+restored_value: object = json.loads(serialized_value)
+
+assert serialized_value == '"hello@example.com"'
+assert restored_value == "hello@example.com"
+assert type(restored_value) is str
+```
+
+This behavior is intentional.
+
+JSON is a plain data boundary.
+
+The exact runtime subtype exists only inside Python objects.
+After serialization, values become plain strings and do not carry subtype information.
+
+---
+
+
 ## Public API
 
 ```python

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/src/base_typed_string.egg-info/requires.txt

@@ -22,6 +22,7 @@ pydantic<3,>=2.6
 [test]
 pytest>=8.0
 pytest-cov>=5.0
+pydantic<3,>=2.6
 
 [typecheck]
 mypy>=1.10

{base_typed_string-0.1.0 → base_typed_string-0.1.2}/tests/test_runtime_behavior.py

@@ -120,6 +120,14 @@ def test_typed_string_has_same_hash_and_equality_as_plain_string() -> None:
     assert hash(typed_value) == hash(plain_value)
 
 
+def test_repr_uses_exact_runtime_subtype_name_and_plain_string_value() -> None:
+    typed_value: AdminUserName = AdminUserName("root")
+
+    rendered_value: str = repr(typed_value)
+
+    assert rendered_value == "AdminUserName('root')"
+
+
 def test_plain_class_attribute_preserves_exact_runtime_subtype() -> None:
     typed_value: UserName = UserName("alice")