patito 0.5.1__tar.gz → 0.6.2__tar.gz

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

@@ -1,29 +1,26 @@
 Metadata-Version: 2.1
 Name: patito
-Version: 0.5.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.8,<4.0
+Requires-Python: >=3.9
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: caching
 Provides-Extra: docs
-Provides-Extra: duckdb
 Provides-Extra: pandas
 Requires-Dist: Sphinx (<7) ; extra == "docs"
-Requires-Dist: duckdb (>=0.6.0) ; (python_version >= "3.8" and python_version < "4.0") and (extra == "duckdb")
-Requires-Dist: pandas ; (python_version >= "3.8" and python_version < "4.0") and (extra == "pandas")
-Requires-Dist: polars (>=0.18.7)
-Requires-Dist: pyarrow (>=5.0.0) ; (python_version >= "3.8" and python_version < "4.0") and (extra == "caching" or extra == "duckdb")
-Requires-Dist: pydantic (>=1.7.0,<2.0.0)
+Requires-Dist: pandas ; extra == "pandas"
+Requires-Dist: polars (>=0.20.1)
+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"
@@ -31,10 +28,10 @@ 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://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
+# <center><img height="30px" src="https://em-content.zobj.net/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
 
 <p align="center">
     <em>
@@ -66,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"_.
 
@@ -76,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).
@@ -96,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
 
@@ -121,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
@@ -167,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.5.1 → patito-0.6.2}/README.md

@@ -1,4 +1,4 @@
-# <center><img height="30px" src="https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
+# <center><img height="30px" src="https://em-content.zobj.net/thumbs/120/samsung/78/duck_1f986.png"> Patito<center>
 
 <p align="center">
     <em>
@@ -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.5.1 → patito-0.6.2}/pyproject.toml

@@ -1,24 +1,23 @@
 [tool.poetry]
 name = "patito"
-version = "0.5.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.8"
-pydantic = "^1.7.0"
-polars = ">=0.18.7"
-# Required for typing.Literal in python3.7
+python = ">=3.9"
+pydantic = ">=2.4.1"
+polars = ">=0.20.1"
+# Required for typing.get_args backports in python3.9 and 3.10
 typing-extensions = "*"
-pandas = {version = "*", optional = true, python = "^3.8"}
-duckdb = {version = ">=0.6.0", optional = true, python = "^3.8"}
-pyarrow = {version = ">=5.0.0", optional = true, python = "^3.8"}
+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}
@@ -30,7 +29,6 @@ sphinxcontrib-mermaid = {version = "*", optional = true}
 [tool.poetry.extras]
 # The pyarrow.parquet module is required for writing parquet caches to disk
 caching = ["pyarrow"]
-duckdb = ["duckdb", "pyarrow"]
 pandas = ["pandas"]
 docs = [
   "Sphinx",
@@ -42,19 +40,18 @@ docs = [
 ]
 
 [tool.poetry.group.dev.dependencies]
-black = ">=22.3.0"
+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 = "*"
 flake8-isort = "*"
-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"
@@ -63,6 +60,10 @@ pandas-stubs = ">=1.2.0"
 codecov = "^2.1.12"
 blackdoc = "*"
 
+
+[tool.poetry.group.docs.dependencies]
+nox = "^2023.4.22"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
@@ -114,23 +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"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

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

@@ -1,47 +1,28 @@
 """Patito, a data-modelling library built on top of polars and pydantic."""
+
 from polars import Expr, Series, col
 
-from patito import exceptions, sql
-from patito.exceptions import ValidationError
+from patito import exceptions
+from patito.exceptions import DataFrameValidationError
 from patito.polars import DataFrame, LazyFrame
 from patito.pydantic import Field, Model
 
 _CACHING_AVAILABLE = False
-_DUCKDB_AVAILABLE = False
 field = col("_")
 __all__ = [
     "DataFrame",
+    "DataFrameValidationError",
     "Expr",
     "Field",
     "LazyFrame",
     "Model",
     "Series",
-    "ValidationError",
     "_CACHING_AVAILABLE",
-    "_DUCKDB_AVAILABLE",
     "col",
     "exceptions",
     "field",
-    "sql",
 ]
 
-try:
-    from patito import duckdb
-
-    _DUCKDB_AVAILABLE = True
-    __all__ += ["duckdb"]
-except ImportError:  # pragma: no cover
-    pass
-
-try:
-    from patito.database import Database
-
-    _CACHING_AVAILABLE = True
-    __all__ += ["Database"]
-except ImportError:
-    pass
-
-
 try:
     from importlib.metadata import PackageNotFoundError, version
 except ImportError:  # pragma: no cover

{patito-0.5.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.2/src/patito/_pydantic/column_info.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+import json
+from typing import (
+    Any,
+    Dict,
+    Optional,
+    Sequence,
+    Type,
+    TypeVar,
+    Union,
+)
+
+import polars as pl
+from polars.datatypes import DataType, DataTypeClass
+from pydantic import BaseModel, field_serializer
+
+from patito._pydantic.dtypes import parse_composite_dtype
+
+
+class ColumnInfo(BaseModel, arbitrary_types_allowed=True):
+    """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
+            with ``pt.field``, which will automatically be replaced with
+            ``polars.col(<field_name>)`` before evaluation.
+        derived_from (Union[str, polars.Expr]): used to mark fields that are meant to be derived from other fields. Users can specify a polars expression that will be called to derive the column value when `pt.DataFrame.derive` is called.
+        dtype (polars.datatype.DataType): The given dataframe column must have the given
+            polars dtype, for instance ``polars.UInt64`` or ``pl.Float32``.
+        unique (bool): All row values must be unique.
+
+    """
+
+    dtype: Optional[Union[DataTypeClass, DataType]] = None
+    constraints: Optional[Union[pl.Expr, Sequence[pl.Expr]]] = None
+    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:
+            return None
+        elif isinstance(exprs, str):
+            return exprs
+        elif isinstance(exprs, pl.Expr):
+            return self._serialize_expr(exprs)
+        elif isinstance(exprs, Sequence):
+            return [self._serialize_expr(c) for c in exprs]
+        else:
+            raise ValueError(f"Invalid type for exprs: {type(exprs)}")
+
+    def _serialize_expr(self, expr: pl.Expr) -> Dict:
+        if isinstance(expr, pl.Expr):
+            return json.loads(
+                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:
+        """Serialize a polars dtype.
+
+        References:
+            [1] https://stackoverflow.com/questions/76572310/how-to-serialize-deserialize-polars-datatypes
+        """
+        if dtype is None:
+            return None
+        elif isinstance(dtype, DataTypeClass) or isinstance(dtype, DataType):
+            return parse_composite_dtype(dtype)
+        else:
+            raise ValueError(f"Invalid type for dtype: {type(dtype)}")
+
+
+CI = TypeVar("CI", bound=Type[ColumnInfo])

patito-0.6.2/src/patito/_pydantic/dtypes/__init__.py

@@ -0,0 +1,25 @@
+from patito._pydantic.dtypes.dtypes import (
+    DtypeResolver,
+    default_dtypes_for_model,
+    valid_dtypes_for_model,
+    validate_annotation,
+    validate_polars_dtype,
+)
+from patito._pydantic.dtypes.utils import (
+    PYTHON_TO_PYDANTIC_TYPES,
+    dtype_from_string,
+    is_optional,
+    parse_composite_dtype,
+)
+
+__all__ = [
+    "DtypeResolver",
+    "validate_annotation",
+    "validate_polars_dtype",
+    "parse_composite_dtype",
+    "dtype_from_string",
+    "valid_dtypes_for_model",
+    "default_dtypes_for_model",
+    "PYTHON_TO_PYDANTIC_TYPES",
+    "is_optional",
+]