patito 0.6.1__tar.gz → 0.6.2__tar.gz

{patito-0.6.1 → patito-0.6.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: patito
-Version: 0.6.1
+Version: 0.6.2
 Summary: A dataframe modelling library built on top of polars and pydantic.
-Home-page: https://github.com/kolonialno/patito
+Home-page: https://github.com/JakobGM/patito
 License: MIT
 Keywords: validation,dataframe
 Author: Jakob Gerhard Martinussen
 Author-email: jakobgm@gmail.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -17,10 +17,10 @@ Provides-Extra: caching
 Provides-Extra: docs
 Provides-Extra: pandas
 Requires-Dist: Sphinx (<7) ; extra == "docs"
-Requires-Dist: pandas ; (python_version >= "3.9" and python_version < "4.0") and (extra == "pandas")
+Requires-Dist: pandas ; extra == "pandas"
 Requires-Dist: polars (>=0.20.1)
-Requires-Dist: pyarrow (>=5.0.0) ; (python_version >= "3.9" and python_version < "4.0") and (extra == "caching")
-Requires-Dist: pydantic (>=2.0.0)
+Requires-Dist: pyarrow (>=5.0.0) ; extra == "caching"
+Requires-Dist: pydantic (>=2.4.1)
 Requires-Dist: sphinx-autobuild ; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
 Requires-Dist: sphinx-rtd-theme ; extra == "docs"
@@ -28,7 +28,7 @@ Requires-Dist: sphinx-toolbox ; extra == "docs"
 Requires-Dist: sphinxcontrib-mermaid ; extra == "docs"
 Requires-Dist: typing-extensions
 Project-URL: Documentation, https://patito.readthedocs.io
-Project-URL: Repository, https://github.com/kolonialno/patito
+Project-URL: Repository, https://github.com/JakobGM/patito
 Description-Content-Type: text/markdown
 
 # <center><img height="30px" src="https://em-content.zobj.net/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
@@ -63,7 +63,6 @@ These schema can be used for:
 🧪 Easy generation of valid mock data frames for tests.\
 🐍 Retrieve and represent singular rows in an object-oriented manner.\
 🧠 Provide a single source of truth for the core data models in your code base. \
-🦆 Integration with DuckDB for running flexible SQL queries.
 
 Patito has first-class support for [polars]("https://github.com/pola-rs/polars"), a _"blazingly fast DataFrames library written in Rust"_.
 
@@ -73,16 +72,6 @@ Patito has first-class support for [polars]("https://github.com/pola-rs/polars")
 pip install patito
 ```
 
-#### DuckDB Integration
-
-Patito can also integrate with [DuckDB](https://duckdb.org/).
-In order to enable this integration you must explicitly specify it during installation:
-
-```sh
-pip install 'patito[duckdb]'
-```
-
-
 ## Documentation
 
 The full documentation of Patio can be found [here](https://patito.readthedocs.io).
@@ -93,7 +82,7 @@ Patito allows you to specify the type of each column in your dataframe by creati
 
 ```py
 # models.py
-from typing import Literal, Optional
+from typing import Literal
 
 import patito as pt
 
@@ -118,7 +107,7 @@ df = pl.DataFrame(
 )
 try:
     Product.validate(df)
-except pt.ValidationError as exc:
+except pt.exceptions.DataFrameValidationError as exc:
     print(exc)
 # 3 validation errors for Product
 # is_for_sale
@@ -164,7 +153,7 @@ def num_products_for_sale(products: pl.DataFrame) -> int:
     return products.filter(pl.col("is_for_sale")).height
 ```
 
-The following test would fail with a `patito.ValidationError`:
+The following test would fail with a `patito.exceptions.DataFrameValidationError`:
 
 ```py
 def test_num_products_for_sale():

{patito-0.6.1 → patito-0.6.2}/README.md

@@ -30,7 +30,6 @@ These schema can be used for:
 🧪 Easy generation of valid mock data frames for tests.\
 🐍 Retrieve and represent singular rows in an object-oriented manner.\
 🧠 Provide a single source of truth for the core data models in your code base. \
-🦆 Integration with DuckDB for running flexible SQL queries.
 
 Patito has first-class support for [polars]("https://github.com/pola-rs/polars"), a _"blazingly fast DataFrames library written in Rust"_.
 
@@ -40,16 +39,6 @@ Patito has first-class support for [polars]("https://github.com/pola-rs/polars")
 pip install patito
 ```
 
-#### DuckDB Integration
-
-Patito can also integrate with [DuckDB](https://duckdb.org/).
-In order to enable this integration you must explicitly specify it during installation:
-
-```sh
-pip install 'patito[duckdb]'
-```
-
-
 ## Documentation
 
 The full documentation of Patio can be found [here](https://patito.readthedocs.io).
@@ -60,7 +49,7 @@ Patito allows you to specify the type of each column in your dataframe by creati
 
 ```py
 # models.py
-from typing import Literal, Optional
+from typing import Literal
 
 import patito as pt
 
@@ -85,7 +74,7 @@ df = pl.DataFrame(
 )
 try:
     Product.validate(df)
-except pt.ValidationError as exc:
+except pt.exceptions.DataFrameValidationError as exc:
     print(exc)
 # 3 validation errors for Product
 # is_for_sale
@@ -131,7 +120,7 @@ def num_products_for_sale(products: pl.DataFrame) -> int:
     return products.filter(pl.col("is_for_sale")).height
 ```
 
-The following test would fail with a `patito.ValidationError`:
+The following test would fail with a `patito.exceptions.DataFrameValidationError`:
 
 ```py
 def test_num_products_for_sale():

{patito-0.6.1 → patito-0.6.2}/pyproject.toml

@@ -1,23 +1,23 @@
 [tool.poetry]
 name = "patito"
-version = "0.6.1"
+version = "0.6.2"
 description = "A dataframe modelling library built on top of polars and pydantic."
 authors = ["Jakob Gerhard Martinussen <jakobgm@gmail.com>"]
 license = "MIT"
 readme = "README.md"
-homepage = "https://github.com/kolonialno/patito"
-repository = "https://github.com/kolonialno/patito"
+homepage = "https://github.com/JakobGM/patito"
+repository = "https://github.com/JakobGM/patito"
 documentation = "https://patito.readthedocs.io"
 keywords = ["validation", "dataframe"]
 
 [tool.poetry.dependencies]
-python = "^3.9"
-pydantic = ">=2.0.0"
+python = ">=3.9"
+pydantic = ">=2.4.1"
 polars = ">=0.20.1"
-# Required for typing.Literal in python3.7
+# Required for typing.get_args backports in python3.9 and 3.10
 typing-extensions = "*"
-pandas = {version = "*", optional = true, python = "^3.9"}
-pyarrow = {version = ">=5.0.0", optional = true, python = "^3.9"}
+pandas = {version = "*", optional = true}
+pyarrow = {version = ">=5.0.0", optional = true}
 # Optional docs dependencies
 Sphinx = {version = "<7", optional = true}
 sphinx-rtd-theme = {version = "*", optional = true}
@@ -43,7 +43,7 @@ docs = [
 ruff = ">=0.2.1"
 coverage = {version = "*", extras = ["toml"]}
 flake8 = "3.9.2"
-flake8-annotations = "*"
+flake8-annotations = { version = "*", python = ">=3.9,<4.0" }
 flake8-bandit = "*"
 flake8-black = "*"
 flake8-bugbear = "*"
@@ -51,7 +51,7 @@ flake8-isort = "*"
 pyright = ">=1.1.239"
 pytest = ">=7.1.2"
 pytest-cov = ">=3.0.0"
-pytest-watcher = ">=0.2.3"
+pytest-watcher = { version = ">=0.2.3", python = ">=3.9,<4.0" }
 xdoctest = ">=1.0.0"
 
 mypy = ">=0.950"
@@ -115,31 +115,16 @@ exclude = [
   "noxfile.py",
 ]
 
-[[tool.mypy.overrides]]
-module = ["tests.*", "noxfile"]
-allow_untyped_defs = true
-check_untyped_defs = true
-disallow_incomplete_defs = false
-# TODO: Go through and remove those we want to check in tests
-disable_error_code = [
-  "var-annotated",
-  "override",
-  "attr-defined",
-  "call-arg",
-  "type-var",
-  "misc",
-  "arg-type",
-  "assignment",
-]
 
 [[tool.mypy.overrides]]
 module = ["tests.test_validators"]
 warn_unused_ignores = false
 
+[tool.ruff]
+extend-exclude= ["tests/__init__.py"]
+
 [tool.ruff.lint]
 select = ["E4", "E7", "E9", "F", "I", "B", "D"]
-ignore = []
 
-# Allow fix for all enabled rules (when `--fix`) is provided.
-fixable = ["ALL"]
-unfixable = []
+[tool.ruff.lint.pydocstyle]
+convention = "google"

{patito-0.6.1 → patito-0.6.2}/src/patito/__init__.py

@@ -1,4 +1,5 @@
 """Patito, a data-modelling library built on top of polars and pydantic."""
+
 from polars import Expr, Series, col
 
 from patito import exceptions

{patito-0.6.1 → patito-0.6.2}/src/patito/_docs.py

@@ -1,2 +1,3 @@
 """Ugly workaround for Sphinx + autodoc + ModelMetaclass + classproperty."""
+
 from patito.pydantic import ModelMetaclass as Model  # noqa: F401, pragma: no cover

{patito-0.6.1 → patito-0.6.2}/src/patito/_pydantic/column_info.py

@@ -19,10 +19,9 @@ from patito._pydantic.dtypes import parse_composite_dtype
 
 
 class ColumnInfo(BaseModel, arbitrary_types_allowed=True):
-    """patito-side model for storing column metadata
+    """patito-side model for storing column metadata.
 
     Args:
-    ----
         constraints (Union[polars.Expression, List[polars.Expression]): A single
             constraint or list of constraints, expressed as a polars expression objects.
             All rows must satisfy the given constraint. You can refer to the given column
@@ -40,6 +39,22 @@ class ColumnInfo(BaseModel, arbitrary_types_allowed=True):
     derived_from: Optional[Union[str, pl.Expr]] = None
     unique: Optional[bool] = None
 
+    def __repr__(self) -> str:
+        """Print only Field attributes whose values are not default (mainly None)."""
+        not_default_field = {
+            field: getattr(self, field)
+            for field in self.model_fields
+            if getattr(self, field) is not self.model_fields[field].default
+        }
+
+        string = ""
+        for field, value in not_default_field.items():
+            string += f"{field}={value}, "
+        if string:
+            # remove trailing comma and space
+            string = string[:-2]
+        return f"ColumnInfo({string})"
+
     @field_serializer("constraints", "derived_from")
     def serialize_exprs(self, exprs: str | pl.Expr | Sequence[pl.Expr] | None) -> Any:
         if exprs is None:
@@ -56,17 +71,17 @@ class ColumnInfo(BaseModel, arbitrary_types_allowed=True):
     def _serialize_expr(self, expr: pl.Expr) -> Dict:
         if isinstance(expr, pl.Expr):
             return json.loads(
-                expr.meta.write_json(None)
+                expr.meta.serialize(None)
             )  # can we access the dictionary directly?
         else:
             raise ValueError(f"Invalid type for expr: {type(expr)}")
 
     @field_serializer("dtype")
     def serialize_dtype(self, dtype: DataTypeClass | DataType | None) -> Any:
-        """References
-        ----------
-            [1] https://stackoverflow.com/questions/76572310/how-to-serialize-deserialize-polars-datatypes
+        """Serialize a polars dtype.
 
+        References:
+            [1] https://stackoverflow.com/questions/76572310/how-to-serialize-deserialize-polars-datatypes
         """
         if dtype is None:
             return None

{patito-0.6.1 → patito-0.6.2}/src/patito/_pydantic/dtypes/dtypes.py

@@ -39,24 +39,17 @@ def valid_dtypes_for_model(
 @cache
 def default_dtypes_for_model(
     cls: Type[ModelType],
-) -> dict[str, DataTypeClass | DataType]:
-    default_dtypes = {}
+) -> dict[str, DataType]:
+    default_dtypes: dict[str, DataType] = {}
     for column in cls.columns:
-        dtype = cls.column_infos[column].dtype
+        dtype = (
+            cls.column_infos[column].dtype
+            or DtypeResolver(cls.model_fields[column].annotation).default_polars_dtype()
+        )
         if dtype is None:
-            default_dtype = DtypeResolver(
-                cls.model_fields[column].annotation
-            ).default_polars_dtype()
-            if default_dtype is None:
-                raise ValueError(
-                    f"Unable to find a default dtype for column `{column}`"
-                )
-            else:
-                default_dtypes[column] = default_dtype
-        else:
-            default_dtypes[column] = (
-                dtype if isinstance(dtype, DataType) else dtype()
-            )  # if dtype is not instantiated, instantiate it
+            raise ValueError(f"Unable to find a default dtype for column `{column}`")
+
+        default_dtypes[column] = dtype if isinstance(dtype, DataType) else dtype()
     return default_dtypes
 
 
@@ -68,7 +61,6 @@ def validate_polars_dtype(
     """Check that the polars dtype is valid for the given annotation. Raises ValueError if not.
 
     Args:
-    ----
         annotation (type[Any] | None): python type annotation
         dtype (DataType | DataTypeClass | None): polars dtype
         column (Optional[str], optional): column name. Defaults to None.
@@ -96,7 +88,6 @@ def validate_annotation(
     """Check that the provided annotation has polars/patito support (we can resolve it to a default dtype). Raises ValueError if not.
 
     Args:
-    ----
         annotation (type[Any] | None): python type annotation
         column (Optional[str], optional): column name. Defaults to None.
 
@@ -130,9 +121,9 @@ class DtypeResolver:
             return PT_BASE_SUPPORTED_DTYPES
         return self._valid_polars_dtypes_for_schema(self.schema)
 
-    def default_polars_dtype(self) -> DataTypeClass | DataType | None:
+    def default_polars_dtype(self) -> DataType | None:
         if self.annotation == Any:
-            return pl.String
+            return pl.String()
         return self._default_polars_dtype_for_schema(self.schema)
 
     def _valid_polars_dtypes_for_schema(
@@ -197,9 +188,7 @@ class DtypeResolver:
             PydanticBaseType(pyd_type), props.get("format"), props.get("enum")
         )
 
-    def _default_polars_dtype_for_schema(
-        self, schema: Dict
-    ) -> DataTypeClass | DataType | None:
+    def _default_polars_dtype_for_schema(self, schema: Dict) -> DataType | None:
         if "anyOf" in schema:
             if len(schema["anyOf"]) == 2:  # look for optionals first
                 schema = _without_optional(schema)
@@ -216,10 +205,12 @@ class DtypeResolver:
     def _pydantic_subschema_to_default_dtype(
         self,
         props: Dict,
-    ) -> DataTypeClass | DataType | None:
+    ) -> DataType | None:
         if "column_info" in props:  # user has specified in patito model
             if props["column_info"]["dtype"] is not None:
-                return dtype_from_string(props["column_info"]["dtype"])
+                dtype = dtype_from_string(props["column_info"]["dtype"])
+                dtype = dtype() if isinstance(dtype, DataTypeClass) else dtype
+                return dtype
         if "type" not in props:
             if "enum" in props:
                 raise TypeError("Mixed type enums not supported by patito.")

{patito-0.6.1 → patito-0.6.2}/src/patito/_pydantic/dtypes/utils.py

@@ -78,11 +78,9 @@ def is_optional(type_annotation: type[Any] | Any | None) -> bool:
     """Return True if the given type annotation is an Optional annotation.
 
     Args:
-    ----
         type_annotation: The type annotation to be checked.
 
     Returns:
-    -------
         True if the outermost type is Optional.
 
     """
@@ -92,7 +90,7 @@ def is_optional(type_annotation: type[Any] | Any | None) -> bool:
 
 
 def parse_composite_dtype(dtype: DataTypeClass | DataType) -> str:
-    """For serialization, converts polars dtype to string representation"""
+    """For serialization, converts polars dtype to string representation."""
     if dtype in pl.NESTED_DTYPES:
         if dtype == pl.Struct or isinstance(dtype, pl.Struct):
             raise NotImplementedError("Structs not yet supported by patito")
@@ -110,7 +108,7 @@ def parse_composite_dtype(dtype: DataTypeClass | DataType) -> str:
 
 
 def dtype_from_string(v: str) -> Optional[Union[DataTypeClass, DataType]]:
-    """For deserialization"""
+    """For deserialization."""
     # TODO test all dtypes
     return convert.dtype_short_repr_to_dtype(v)
 

{patito-0.6.1 → patito-0.6.2}/src/patito/_pydantic/repr.py

@@ -82,7 +82,7 @@ class Representation:
     def __pretty__(
         self, fmt: Callable[[Any], Any], **kwargs: Any
     ) -> Generator[Any, None, None]:
-        """Used by devtools (https://python-devtools.helpmanual.io/) to provide a human readable representations of objects"""
+        """Used by devtools (https://python-devtools.helpmanual.io/) to provide a human readable representations of objects."""
         yield self.__repr_name__() + "("
         yield 1
         for name, value in self.__repr_args__():
@@ -101,7 +101,7 @@ class Representation:
         return f'{self.__repr_name__()}({self.__repr_str__(", ")})'
 
     def __rich_repr__(self) -> "RichReprResult":
-        """Get fields for Rich library"""
+        """Get fields for Rich library."""
         for name, field_repr in self.__repr_args__():
             if name is None:
                 yield field_repr

{patito-0.6.1 → patito-0.6.2}/src/patito/_pydantic/schema.py

@@ -16,14 +16,12 @@ if TYPE_CHECKING:
 def schema_for_model(cls: Type[ModelType]) -> Dict[str, Dict[str, Any]]:
     """Return schema properties where definition references have been resolved.
 
-    Returns
-    -------
+    Returns:
         Field information as a dictionary where the keys are field names and the
             values are dictionaries containing metadata information about the field
             itself.
 
-    Raises
-    ------
+    Raises:
         TypeError: if a field is annotated with an enum where the values are of
             different types.
 

{patito-0.6.1 → patito-0.6.2}/src/patito/exceptions.py

@@ -1,3 +1,5 @@
+"""Exceptions used by patito."""
+
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -34,19 +36,24 @@ __all__ = "ErrorWrapper", "DataFrameValidationError"
 
 
 class ErrorWrapper(Representation):
+    """Error handler for nicely accumulating errors."""
+
     __slots__ = "exc", "_loc"
 
     def __init__(self, exc: Exception, loc: Union[str, "Loc"]) -> None:
+        """Wrap an error in an ErrorWrapper."""
         self.exc = exc
         self._loc = loc
 
     def loc_tuple(self) -> "Loc":
+        """Represent error as tuple."""
         if isinstance(self._loc, tuple):
             return self._loc
         else:
             return (self._loc,)
 
     def __repr_args__(self) -> "ReprArgs":
+        """Pydantic repr."""
         return [("exc", self.exc), ("loc", self.loc_tuple())]
 
 
@@ -56,19 +63,24 @@ ErrorList = Union[Sequence[Any], ErrorWrapper]
 
 
 class DataFrameValidationError(Representation, ValueError):
+    """Parent error for DataFrame validation errors."""
+
     __slots__ = "raw_errors", "model", "_error_cache"
 
     def __init__(self, errors: Sequence[ErrorList], model: Type["BaseModel"]) -> None:
+        """Create a dataframe validation error."""
         self.raw_errors = errors
         self.model = model
         self._error_cache: Optional[List["ErrorDict"]] = None
 
     def errors(self) -> List["ErrorDict"]:
+        """Get list of errors."""
         if self._error_cache is None:
             self._error_cache = list(flatten_errors(self.raw_errors))
         return self._error_cache
 
     def __str__(self) -> str:
+        """String reprentation of error."""
         errors = self.errors()
         no_errors = len(errors)
         return (
@@ -77,6 +89,7 @@ class DataFrameValidationError(Representation, ValueError):
         )
 
     def __repr_args__(self) -> "ReprArgs":
+        """Pydantic repr."""
         return [("model", self.model.__name__), ("errors", self.errors())]