Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/cl_sii/extras/pydantic_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ class _RutPydanticAnnotation:
- Customizing the core schema and JSON schema:
https://docs.pydantic.dev/2.9/architecture/#customizing-the-core-schema-and-json-schema
(https://github.com/pydantic/pydantic/blob/v2.9.2/docs/architecture.md#customizing-the-core-schema-and-json-schema)
- Implementing __get_pydantic_json_schema__:
https://docs.pydantic.dev/2.9/concepts/json_schema/#implementing-__get_pydantic_json_schema__
(https://github.com/pydantic/pydantic/blob/v2.9.2/docs/concepts/json_schema.md#implementing-__get_pydantic_json_schema__-)

Examples:

Expand Down Expand Up @@ -73,6 +76,7 @@ class _RutPydanticAnnotation:
'78773510-K'
>>> example_type_adapter.dump_json(cl_sii.rut.Rut('78773510-K'))
b'"78773510-K"'
>>> example_json_schema = example_type_adapter.json_schema()
"""

RUT_CANONICAL_STRICT_REGEX: ClassVar[Pattern] = re.compile(
Expand All @@ -99,7 +103,7 @@ def validate_from_str(value: str) -> cl_sii.rut.Rut:

from_str_schema = pydantic_core.core_schema.chain_schema(
[
pydantic_core.core_schema.str_schema(pattern=cls.RUT_CANONICAL_STRICT_REGEX),
cls.str_schema(),
pydantic_core.core_schema.no_info_plain_validator_function(validate_from_str),
]
)
Expand All @@ -117,6 +121,19 @@ def validate_from_str(value: str) -> cl_sii.rut.Rut:
),
)

@classmethod
def __get_pydantic_json_schema__(
cls,
core_schema: pydantic_core.core_schema.CoreSchema,
handler: pydantic.GetJsonSchemaHandler,
) -> pydantic.json_schema.JsonSchemaValue:
core_schema = cls.str_schema()
return handler(core_schema)

@classmethod
def str_schema(cls) -> pydantic_core.core_schema.CoreSchema:
return pydantic_core.core_schema.str_schema(pattern=cls.RUT_CANONICAL_STRICT_REGEX)


Rut = Annotated[cl_sii.rut.Rut, _RutPydanticAnnotation]
"""
Expand Down
32 changes: 32 additions & 0 deletions src/tests/test_extras_pydantic_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,35 @@ def test_deserialize_invalid(self) -> None:

with self.assertRaises(pydantic.ValidationError):
self.pydantic_type_adapter.validate_json(data)

def test_json_schema_for_validation(self) -> None:
# -----Arrange-----

expected_json_schema = {
'type': 'string',
'pattern': '^(\\d{1,8})-([\\dK])$',
}

# -----Act-----

actual_json_schema = self.pydantic_type_adapter.json_schema(mode='validation')

# -----Assert-----

self.assertEqual(expected_json_schema, actual_json_schema)

def test_json_schema_for_serialization(self) -> None:
# -----Arrange-----

expected_json_schema = {
'type': 'string',
'pattern': '^(\\d{1,8})-([\\dK])$',
}

# -----Act-----

actual_json_schema = self.pydantic_type_adapter.json_schema(mode='serialization')

# -----Assert-----

self.assertEqual(expected_json_schema, actual_json_schema)