data-sitter 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

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/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/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.dist-info → data_sitter-0.1.7.dist-info}/METADATA

@@ -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.dist-info → data_sitter-0.1.7.dist-info}/RECORD

@@ -1,9 +1,9 @@
-data_sitter/Contract.py,sha256=ykeBA_gr7r7MO4FYvdDrstUzGiq7dyIIipkOZRk8qkA,4042
-data_sitter/FieldResolver.py,sha256=Bh7_MTTO7E87S31dQq3tvkL9E_K-4EDlh3NJSn0eLU0,2732
+data_sitter/Contract.py,sha256=uIGf6mkWEzJtNOcC_Hx5DzKFG8go7eVeesFn4e_e72o,4336
+data_sitter/FieldResolver.py,sha256=tJKMwAAjEBzWB6ttbrIa_-JNj2dXWoeNtax_UpYZMbk,2784
 data_sitter/Validation.py,sha256=5jdIQZyTrEmXZ_SJP0lq-EEFKrGbYH6z4EQ56oFR7Ck,1474
 data_sitter/__init__.py,sha256=qbE-wU8ELMFwOMG4UTK0lmzn5XF2MK3rc22E8ROgypo,113
 data_sitter/cli.py,sha256=SBmxNC508qt8-C4x2IS6XNZLihtfeALw34QLLYr_p_Q,1686
-data_sitter/field_types/BaseField.py,sha256=2s5wJjz1NoNWvSa-69mMxVf7f5wptuxr6UGVubM6MAQ,1997
+data_sitter/field_types/BaseField.py,sha256=EfHv7GrUOZielh1V5YSfyxPMMuQfE8OlL79ZcVePNLk,2172
 data_sitter/field_types/FieldTypes.py,sha256=ntuguQtLnVon1cB2YvG0p2c1r0zk67qw6o4qfJHxLlY,158
 data_sitter/field_types/FloatField.py,sha256=gHmiSg8Eft57T_J8covrEctMEGa0zuT6R3xJP2UlyIY,945
 data_sitter/field_types/IntegerField.py,sha256=Ll6eool8Rwo2pzyXQz95TjJpzdgW9ShtCK1uHmOi_pQ,213
@@ -23,8 +23,8 @@ data_sitter/rules/Parser/alias_parameters_parser.py,sha256=xUgOFJCm42w1eUmZOQ2Os
 data_sitter/rules/Parser/parser_utils.py,sha256=ypI021uYJTsHAoKGShAfnhd5xQGtqqTGTHozleefsLQ,642
 data_sitter/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 data_sitter/utils/logger_config.py,sha256=fBbDNZOsmDnO6TtLHI1tty4EXi2AnbrA-OgkhXcm1Aw,1235
-data_sitter-0.1.6.dist-info/METADATA,sha256=H3QVZTUxe4F2FtWVEhe0JEmlgZG4n8krQCyBqp5XgdQ,5597
-data_sitter-0.1.6.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-data_sitter-0.1.6.dist-info/entry_points.txt,sha256=1I7xxqFZvA78wmDx7NGavttAb8JFWM3Wxgehftx_5C4,53
-data_sitter-0.1.6.dist-info/top_level.txt,sha256=Q7N21PYeqIdRbDvZQCJXhbbv0PFIf876gu1_DpInH_E,12
-data_sitter-0.1.6.dist-info/RECORD,,
+data_sitter-0.1.7.dist-info/METADATA,sha256=RtvZRB3Hby5Kg3bKEQcEtOIb--OYglf2S4OWwqhKkac,5597
+data_sitter-0.1.7.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+data_sitter-0.1.7.dist-info/entry_points.txt,sha256=1I7xxqFZvA78wmDx7NGavttAb8JFWM3Wxgehftx_5C4,53
+data_sitter-0.1.7.dist-info/top_level.txt,sha256=Q7N21PYeqIdRbDvZQCJXhbbv0PFIf876gu1_DpInH_E,12
+data_sitter-0.1.7.dist-info/RECORD,,