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

{base_typed_string-0.1.1/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.1
+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.1 → 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.1 → 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.1"
+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.1 → 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.1 → 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__}."

{base_typed_string-0.1.1 → 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.1 → 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.1
+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.1 → 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.1 → base_typed_string-0.1.2}/tests/test_runtime_behavior.py

@@ -127,6 +127,7 @@ def test_repr_uses_exact_runtime_subtype_name_and_plain_string_value() -> None:
 
     assert rendered_value == "AdminUserName('root')"
 
+
 def test_plain_class_attribute_preserves_exact_runtime_subtype() -> None:
     typed_value: UserName = UserName("alice")
 
@@ -140,4 +141,3 @@ def test_plain_class_attribute_preserves_exact_runtime_subtype() -> None:
         expected_plain_value="alice",
         expected_type=UserName,
     )
-