data-sitter 0.1.6__tar.gz → 0.1.7__tar.gz

{data_sitter-0.1.6 → data_sitter-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-sitter
-Version: 0.1.6
+Version: 0.1.7
 Summary: A Python library that reads data contracts and generates Pydantic models for seamless data validation.
 Author-email: Lázaro Pereira Candea <lazaro@candea.es>
 Requires-Python: >=3.8

{data_sitter-0.1.6 → data_sitter-0.1.7}/data_sitter/Contract.py

@@ -22,7 +22,8 @@ class ContractWithoutName(Exception):
 class Field(NamedTuple):
     name: str
     type: str
-    rules: List[str]
+    description: str = None
+    rules: List[str] = []
 
 
 class Contract:
@@ -67,7 +68,9 @@ class Contract:
         field_validators = {}
         for field in self.fields:
             field_resolver = self.field_resolvers[field.type]
-            field_validators[field.name] = field_resolver.get_field_validator(field.name, field.rules)
+            field_validators[field.name] = field_resolver.get_field_validator(
+                field.name, field.rules, field.description
+            )
         return field_validators
 
     @cached_property
@@ -98,6 +101,7 @@ class Contract:
                 {
                     "name": name,
                     "type": field_validator.type_name.value,
+                    **({"description": field_validator.description} if field_validator.description is not None else {}),
                     "rules": [rule.parsed_rule for rule in self.rules.get(name, [])]
                 }
                 for name, field_validator in self.field_validators.items()
@@ -105,12 +109,15 @@ class Contract:
             "values": self.rule_parser.values
         }
 
-    def get_json_contract(self, indent: int=2) -> str:
-        return json.dumps(self.contract, indent=indent)
+    def to_json(self, indent: int=2) -> str:
+        return json.dumps(self.contract, indent=indent, sort_keys=False)
 
-    def get_yaml_contract(self, indent: int=2) -> str:
+    def to_yaml(self, indent: int=2) -> str:
         return yaml.dump(self.contract, Dumper=yaml.Dumper, indent=indent, sort_keys=False)
 
+    def to_json_schema(self) -> dict:
+        return self.pydantic_model.model_json_schema()
+
     def get_front_end_contract(self) -> dict:
         return {
             "name": self.name,

{data_sitter-0.1.6 → data_sitter-0.1.7}/data_sitter/FieldResolver.py

@@ -25,8 +25,10 @@ class FieldResolver:
         self.rules = RuleRegistry.get_rules_for(field_class)
         self._match_rule_cache = {}
 
-    def get_field_validator(self, name: str, parsed_rules: List[Union[str, dict]]) -> BaseField:
-        field_validator = self.field_class(name)
+    def get_field_validator(
+        self, name: str, parsed_rules: List[Union[str, dict]], description: str = None
+    ) -> BaseField:
+        field_validator = self.field_class(name, description)
         processed_rules = self.get_processed_rules(parsed_rules)
         validators = [pr.get_validator(field_validator) for pr in processed_rules]
         field_validator.validators = validators

{data_sitter-0.1.6 → data_sitter-0.1.7}/data_sitter/field_types/BaseField.py

@@ -1,7 +1,7 @@
 from abc import ABC
 from typing import Annotated, Callable, List, Optional, Type
 
-from pydantic import AfterValidator
+from pydantic import AfterValidator, Field
 
 from .FieldTypes import FieldTypes
 from ..rules import register_rule, register_field
@@ -23,13 +23,15 @@ def aggregated_validator(validators: List[Callable], is_optional: bool):
 @register_field
 class BaseField(ABC):
     name: str
+    description: str
     is_optional: bool
     validators = None
     field_type = None
     type_name = FieldTypes.BASE
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str, description: str = None) -> None:
         self.name = name
+        self.description = description
         self.is_optional = True
         self.validators = None
 
@@ -53,7 +55,11 @@ class BaseField(ABC):
         if self.validators is None:
             raise NotInitialisedError()
         field_type = Optional[self.field_type] if self.is_optional else self.field_type
-        return Annotated[field_type, AfterValidator(aggregated_validator(self.validators, self.is_optional))]
+        return Annotated[
+            field_type,
+            Field(description=self.description),
+            AfterValidator(aggregated_validator(self.validators, self.is_optional))
+        ]
 
     @classmethod
     def get_parents(cls: Type["BaseField"]) -> List[Type["BaseField"]]:

{data_sitter-0.1.6 → data_sitter-0.1.7}/data_sitter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-sitter
-Version: 0.1.6
+Version: 0.1.7
 Summary: A Python library that reads data contracts and generates Pydantic models for seamless data validation.
 Author-email: Lázaro Pereira Candea <lazaro@candea.es>
 Requires-Python: >=3.8

{data_sitter-0.1.6 → data_sitter-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = 'data-sitter'
-version = "0.1.6"
+version = "0.1.7"
 description = "A Python library that reads data contracts and generates Pydantic models for seamless data validation."
 readme = "README.md"
 requires-python = ">=3.8"

{data_sitter-0.1.6 → data_sitter-0.1.7}/tests/test_contract.py

@@ -13,6 +13,7 @@ def sample_contract_dict():
             {
                 "name": "name",
                 "type": "String",
+                "description": "The name of the person",
                 "rules": [
                     "Is not null",
                     "Has minimum length 3"
@@ -142,19 +143,27 @@ class TestContract:
         assert "age" in validation.errors
         assert validation.unknowns == {"extra": "value"}
 
-    def test_get_json_contract(self, sample_contract):
+    def test_contract_property(self, sample_contract, sample_contract_dict):
+        """Test contract property"""
+        assert sample_contract.contract == sample_contract_dict
+
+    def test_to_json(self, sample_contract, sample_contract_dict):
         """Test JSON contract generation"""
-        json_contract = sample_contract.get_json_contract()
+        json_contract = sample_contract.to_json()
         contract_dict = json.loads(json_contract)
-        assert contract_dict["name"] == "TestContract"
-        assert len(contract_dict["fields"]) == 2
+        assert contract_dict == sample_contract_dict
 
-    def test_get_yaml_contract(self, sample_contract):
+    def test_to_yaml(self, sample_contract, sample_contract_dict):
         """Test YAML contract generation"""
-        yaml_contract = sample_contract.get_yaml_contract()
+        yaml_contract = sample_contract.to_yaml()
         contract_dict = yaml.safe_load(yaml_contract)
-        assert contract_dict["name"] == "TestContract"
-        assert len(contract_dict["fields"]) == 2
+        assert contract_dict == sample_contract_dict
+
+    def test_to_json_schema(self, sample_contract):
+        """Test JSON schema generation"""
+        json_schema = sample_contract.to_json_schema()
+        assert json_schema["title"] == "TestContract"
+        assert len(json_schema["properties"]) == 2
 
     def test_get_front_end_contract(self, sample_contract):
         """Test front-end contract representation"""

{data_sitter-0.1.6 → data_sitter-0.1.7}/tests/test_field_resolver.py

@@ -59,11 +59,11 @@ class TestFieldResolver:
 
         with patch.object(field_resolver, 'get_processed_rules', return_value=[mock_processed_rule]):
             # Call the method
-            result = field_resolver.get_field_validator("test_field", ["rule1", "rule2"])
+            result = field_resolver.get_field_validator("test_field", ["rule1", "rule2"], "test_description")
 
             # Assertions
             assert result == mock_field_instance
-            mock_field_class.assert_called_once_with("test_field")
+            mock_field_class.assert_called_once_with("test_field", "test_description")
             mock_processed_rule.get_validator.assert_called_once_with(mock_field_instance)
             assert mock_field_instance.validators == [mock_validator]