patito 0.4.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

patito/validators.py

@@ -1,9 +1,11 @@
 """Module for validating datastructures with respect to model specifications."""
 from __future__ import annotations
 
+import sys
 from typing import TYPE_CHECKING, Type, Union, cast
 
 import polars as pl
+from typing_extensions import get_args, get_origin
 
 from patito.exceptions import (
     ColumnDTypeError,
@@ -15,6 +17,13 @@ from patito.exceptions import (
     ValidationError,
 )
 
+if sys.version_info >= (3, 10):  # pragma: no cover
+    from types import UnionType  # pyright: ignore
+
+    UNION_TYPES = (Union, UnionType)
+else:
+    UNION_TYPES = (Union,)  # pragma: no cover
+
 try:
     import pandas as pd
 
@@ -44,6 +53,44 @@ VALID_POLARS_TYPES = {
 }
 
 
+def _is_optional(type_annotation: Type) -> 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.
+    """
+    return (get_origin(type_annotation) in UNION_TYPES) and (
+        type(None) in get_args(type_annotation)
+    )
+
+
+def _dewrap_optional(type_annotation: Type) -> Type:
+    """
+    Return the inner, wrapped type of an Optional.
+
+    Is a no-op for non-Optional types.
+
+    Args:
+        type_annotation: The type annotation to be dewrapped.
+
+    Returns:
+        The input type, but with the outermost Optional removed.
+    """
+    return (
+        next(  # pragma: no cover
+            valid_type
+            for valid_type in get_args(type_annotation)
+            if valid_type is not type(None)  # noqa: E721
+        )
+        if _is_optional(type_annotation)
+        else type_annotation
+    )
+
+
 def _find_errors(  # noqa: C901
     dataframe: pl.DataFrame,
     schema: Type[Model],
@@ -99,6 +146,45 @@ def _find_errors(  # noqa: C901
                 )
             )
 
+    for column, dtype in schema.dtypes.items():
+        if not isinstance(dtype, pl.List):
+            continue
+
+        annotation = schema.__annotations__[column]  # type: ignore[unreachable]
+
+        # Retrieve the annotation of the list itself,
+        # dewrapping any potential Optional[...]
+        list_type = _dewrap_optional(annotation)
+
+        # Check if the list items themselves should be considered nullable
+        item_type = get_args(list_type)[0]
+        if _is_optional(item_type):
+            continue
+
+        num_missing_values = (
+            dataframe.lazy()
+            .select(column)
+            # Remove those rows that do not contain lists at all
+            .filter(pl.col(column).is_not_null())
+            # Convert lists of N items to N individual rows
+            .explode(column)
+            # Calculate how many nulls are present in lists
+            .filter(pl.col(column).is_null())
+            .collect()
+            .height
+        )
+        if num_missing_values != 0:
+            errors.append(
+                ErrorWrapper(
+                    MissingValuesError(
+                        f"{num_missing_values} missing "
+                        f"{'value' if num_missing_values == 1 else 'values'} "
+                        f"in lists"
+                    ),
+                    loc=column,
+                )
+            )
+
     # Check if any column has a wrong dtype
     valid_dtypes = schema.valid_dtypes
     dataframe_datatypes = dict(zip(dataframe.columns, dataframe.dtypes))
@@ -189,7 +275,7 @@ def _find_errors(  # noqa: C901
             )
             if "_" in constraints.meta.root_names():
                 # An underscore is an alias for the current field
-                illegal_rows = dataframe.with_column(
+                illegal_rows = dataframe.with_columns(
                     pl.col(column_name).alias("_")
                 ).filter(constraints)
             else:

patito/xdg.py

@@ -0,0 +1,22 @@
+"""Module implementing the XDG directory standard."""
+import os
+from pathlib import Path
+from typing import Optional
+
+
+def cache_home(application: Optional[str] = None) -> Path:
+    """
+    Return path to directory containing user-specific non-essential data files.
+
+    Args:
+        application: An optional name of an application for which to return an
+            application-specific cache directory for.
+
+    Returns:
+        A path object pointing to a directory to store cache files.
+    """
+    path = Path(os.environ.get("XDG_CACHE_HOME", "~/.cache")).resolve()
+    if application:
+        path = path / application
+    path.mkdir(exist_ok=True, parents=True)
+    return path

{patito-0.4.3.dist-info → patito-0.5.0.dist-info}/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2022 Oda Group Holding AS
+Copyright (c) 2023 Jakob Gerhard Martinussen and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{patito-0.4.3.dist-info → patito-0.5.0.dist-info}/METADATA

@@ -1,33 +1,34 @@
 Metadata-Version: 2.1
 Name: patito
-Version: 0.4.3
+Version: 0.5.0
 Summary: A dataframe modelling library built on top of polars and pydantic.
 Home-page: https://github.com/kolonialno/patito
 License: MIT
 Keywords: validation,dataframe
 Author: Jakob Gerhard Martinussen
 Author-email: jakobgm@gmail.com
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.7
 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; extra == "docs"
-Requires-Dist: duckdb (>=0.5.0); (python_version >= "3.8" and python_version < "4.0") and (extra == "duckdb")
-Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: pandas; (python_version >= "3.8" and python_version < "4.0") and (extra == "pandas")
-Requires-Dist: polars (>=0.14.0)
-Requires-Dist: pyarrow (>=5.0.0); (python_version >= "3.8" and python_version < "4.0") and (extra == "duckdb")
+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.3)
+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)
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
-Requires-Dist: sphinx-rtd-theme; extra == "docs"
-Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
+Requires-Dist: sphinx-autobuild ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme ; extra == "docs"
+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
@@ -284,7 +285,7 @@ class Product(pt.Model):
     @property
     def url(self) -> str:
         return (
-            "https://oda.com/no/products/"
+            "https://example.com/no/products/"
             f"{self.product_id}-"
             f"{self.name.lower().replace(' ', '-')}"
         )
@@ -302,7 +303,7 @@ products = pl.DataFrame(
 milk_row = products.filter(pl.col("product_id" == 1))
 milk = Product.from_row(milk_row)
 print(milk.url)
-# https://oda.com/no/products/1-skimmed-milk
+# https://example.com/no/products/1-skimmed-milk
 ```
 
 If you "connect" the `Product` model with the `DataFrame` by the use of `patito.DataFrame.set_model()`, or alternatively by using `Product.DataFrame` directly, you can use the `.get()` method in order to filter the data frame down to a single row _and_ cast it to the respective model class:
@@ -317,6 +318,6 @@ products = Product.DataFrame(
 )
 milk = products.get(pl.col("product_id") == 1)
 print(milk.url)
-# https://oda.com/no/products/1-skimmed-milk
+# https://example.com/no/products/1-skimmed-milk
 ```
 

patito-0.5.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+patito/__init__.py,sha256=J-p3aBiyNGdsyHxViEsP1C6bE-OxtxAul7xSA1xXpIE,1169
+patito/_docs.py,sha256=bobkmo8-RRdz80_KY53y_i1Gcp1WWTH5-D5ZHGidpok,161
+patito/database.py,sha256=IaxbsmyQMzL3KzvJUq0tgVGUxdr55KEv-wd1X673U2o,27917
+patito/duckdb.py,sha256=MnC4C7m3epXODz_eYBLqb7dTAcOh2o1Y8BViPoPKTaA,111015
+patito/exceptions.py,sha256=4WuaQJoc5wLUehhBRQPvL59LVFLcn_K806Z9fg0KBss,1262
+patito/polars.py,sha256=oFS8In6cUiKQu-QclkJ1Egxbf2HF2SlbTF76bcyE4Vo,26161
+patito/pydantic.py,sha256=HKQ6dfeeJCq1xaVJbqfo5UpF-WI_jBEaDRAy2tLnvtM,54832
+patito/sql.py,sha256=_xmvVfC1kUUq2d8KTBPExJmfZ9ec6uoMfZv52naFFkY,3218
+patito/validators.py,sha256=D5hdCfAc1rv15FwQILSmaZNZ5j88QfYUYZ37GMwgvQU,10659
+patito/xdg.py,sha256=3EcUGcYBBUX2Secegajb4DB2QgAHNPs6oi0tMsL--UQ,686
+patito-0.5.0.dist-info/LICENSE,sha256=3bc4YyuF0e5nd59E3CsR8QM1Ua7pqKfC9DD1LVBVMs4,1139
+patito-0.5.0.dist-info/METADATA,sha256=K16UBKdqYnZfDmVdVqUuMc3AqknsaAmWfgljNVg0q_g,14562
+patito-0.5.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+patito-0.5.0.dist-info/RECORD,,

{patito-0.4.3.dist-info → patito-0.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry 1.0.8
+Generator: poetry-core 1.6.1
 Root-Is-Purelib: true
 Tag: py3-none-any

patito-0.4.3.dist-info/RECORD

@@ -1,12 +0,0 @@
-patito/__init__.py,sha256=BSTuaflPBdcoJKJTMGDAa7fvoJVduWb28N6Fnw_Gpns,1079
-patito/_docs.py,sha256=bobkmo8-RRdz80_KY53y_i1Gcp1WWTH5-D5ZHGidpok,161
-patito/duckdb.py,sha256=Kxkn5Z4Rl_9KthO_zzbYCEhRtoGtV5T0xGueV6qgoZw,113446
-patito/exceptions.py,sha256=4WuaQJoc5wLUehhBRQPvL59LVFLcn_K806Z9fg0KBss,1262
-patito/polars.py,sha256=Ds_pH302wtWTDN78mmDdUrHn5K906L6H66GnpKrMGDo,26335
-patito/pydantic.py,sha256=x9gNcS29_nZaT_TUqsvMZm5UZwWZGGMFOe6WGvSdgvs,54976
-patito/sql.py,sha256=HhNGhYwIPTJOs08fMEAX6PUjeIKuzI2IB_cjOJknpJg,3249
-patito/validators.py,sha256=YhDMgua8c7Hs97pmscX3vIs-kqzq3vrAjAomYR42IfI,8061
-patito-0.4.3.dist-info/LICENSE,sha256=0LkhXGFNXIt9gW0zs6_9YZynb4DDt3OZaRXz7DpD0qQ,1077
-patito-0.4.3.dist-info/WHEEL,sha256=DA86_h4QwwzGeRoz62o1svYt5kGEXpoUTuTtwzoTb30,83
-patito-0.4.3.dist-info/METADATA,sha256=Bhj5XsAbskyczUNkQzUYroXjbgsFooqaLLEabVnZx-8,14500
-patito-0.4.3.dist-info/RECORD,,