Type-check package (#229)

* Draft usage of mypy.

* Apply pchs.

* Draft usage of pixi.

* Adapt more integration tests.

* Adapt bigquery integration test task.

* Migrate docs deployment to pixi.

* Update build and publish.

* Run postinstall for readthedocs.

* Adapt liniting to rely on pixi.

* Add pytest as dependency.

* Adapt readthedocs configuration.

* Update development instructions.

* Switch to pixi in helper script.

* Minor adadptations.

* Introduce mypy CI step.

* Add changelog entry.

* Fix usage of condarc file.

* Adapt development.rst.

* Use pixi for mypy job.

* Fix yml syntax.

* Create pixi environment for mypy.

* Remove impala step for debugging.

* Add type packages.

* Comment out impala run for debugging.

* Move flit to host-dependencies.

* Remove redundant dependency.

* Update .github/workflows/ci.yaml

Co-authored-by: Pavel Zwerschke <pavel.zwerschke@quantco.com>

* Add color to ci tests.

* Update .github/workflows/ci.yaml

Co-authored-by: Pavel Zwerschke <pavel.zwerschke@quantco.com>

* Update .github/workflows/ci.yaml

Co-authored-by: Pavel Zwerschke <pavel.zwerschke@quantco.com>

* Remove configurations which were erroneously added.

* Remove configurations which were erroneously added.

* Consistently use ubuntu-latest.

* Update .github/workflows/ci.yaml

Co-authored-by: Pavel Zwerschke <pavel.zwerschke@quantco.com>

* Also run unit tests on macos and windows.

* Fix impala test syntax.

* Downgrade sqlalchemy version for impala tests.

* Downgrade sqlalchemy version for impala tests.

* Disable BigQuery tests for now.

---------

Co-authored-by: Pavel Zwerschke <pavel.zwerschke@quantco.com>

Author: kklein

.github/workflows/ci.yaml

@@ -29,6 +29,21 @@ jobs:
       - name: pre-commit
         run: pixi run pre-commit-run --color=always --show-diff-on-failure
 
+  mypy-type-checks:
+    name: Mypy Type Checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.8.1
+        with:
+          environments: default lint
+      - name: mypy
+        run: |
+          pixi run -e mypy postinstall
+          pixi run -e mypy mypy .
+
   unit-tests:
     name: "unit tests"
     strategy:

CHANGELOG.rst

@@ -11,8 +11,14 @@ Changelog
 ------------------
 
 **New features**
+
 - Added styling for assertion messages. See :ref:`assertion-message-styling` for more information.
 
+**Other changes**
+
+- Provide a ``py.typed`` file.
+
+
 1.8.0 - 2023.06.16
 ------------------
 

pixi.lock

@@ -88,6 +88,13 @@ sqlalchemy = "2.*"
 pytest-cov = "*"
 pytest-xdist = "*"
 
+[feature.mypy.dependencies]
+mypy = "*"
+types-setuptools = "*"
+types-colorama = "*"
+pandas-stubs = "*"
+types-jinja2 = "*"
+
 [feature.lint.dependencies]
 pre-commit = "*"
 black = "*"
@@ -150,3 +157,5 @@ impala-py38 = ["impala", "py38", "sa1", "test"]
 impala-sa1 = ["impala", "sa1", "test"]
 
 lint = { features = ["lint"], no-default-feature = true }
+
+mypy = ["mypy"]

pixi.toml

@@ -46,6 +46,10 @@ skip_glob = '\.eggs/*,\.git/*,\.venv/*,build/*,dist/*'
 default_section = 'THIRDPARTY'
 
 [tool.mypy]
-# Temporary fix.
-no_implicit_optional = false
+no_implicit_optional = true
 allow_empty_bodies = true
+check_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = ["scipy.*", "impala.*", "pytest_html"]
+ignore_missing_imports = true

pyproject.toml

@@ -117,9 +117,9 @@ def __init__(
         self,
         ref: DataReference,
         *,
-        ref2=None,
-        ref_value: Any = None,
-        name: str = None,
+        ref2: Optional[DataReference] = None,
+        ref_value: Optional[Any] = None,
+        name: Optional[str] = None,
         output_processors: Optional[
             Union[OutputProcessor, List[OutputProcessor]]
         ] = output_processor_limit,

src/datajudge/constraints/base.py

@@ -21,7 +21,9 @@ def retrieve(
 
 
 class ColumnExistence(Column):
-    def __init__(self, ref: DataReference, columns: List[str], name: str = None):
+    def __init__(
+        self, ref: DataReference, columns: List[str], name: Optional[str] = None
+    ):
         super().__init__(ref, ref_value=columns, name=name)
 
     def compare(

src/datajudge/constraints/column.py

@@ -38,10 +38,10 @@ def __init__(
         ref: DataReference,
         use_lower_bound_reference: bool,
         column_type: str,
-        name: str = None,
+        name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        min_value: str = None,
+        ref2: Optional[DataReference] = None,
+        min_value: Optional[str] = None,
     ):
         self.format = get_format_from_column_type(column_type)
         self.use_lower_bound_reference = use_lower_bound_reference
@@ -84,10 +84,10 @@ def __init__(
         ref: DataReference,
         use_upper_bound_reference: bool,
         column_type: str,
-        name: str = None,
+        name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        max_value: str = None,
+        ref2: Optional[DataReference] = None,
+        max_value: Optional[str] = None,
     ):
         self.format = get_format_from_column_type(column_type)
         self.use_upper_bound_reference = use_upper_bound_reference
@@ -132,7 +132,7 @@ def __init__(
         min_fraction: float,
         lower_bound: str,
         upper_bound: str,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref_value=min_fraction, name=name)
         self.lower_bound = lower_bound

src/datajudge/constraints/date.py

@@ -13,10 +13,10 @@ def __init__(
         ref: DataReference,
         aggregation_column: str,
         start_value: int = 0,
-        name: str = None,
+        name: Optional[str] = None,
         *,
         tolerance: float = 0,
-        ref2: DataReference = None,
+        ref2: Optional[DataReference] = None,
     ):
         super().__init__(ref, ref2=ref2, ref_value=object(), name=name)
         self.aggregation_column = aggregation_column

src/datajudge/constraints/groupby.py

@@ -18,7 +18,7 @@ def __init__(
         start_columns: List[str],
         end_columns: List[str],
         max_relative_n_violations: float,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref_value=object(), name=name)
         self.key_columns = key_columns
@@ -56,7 +56,9 @@ def retrieve(
         sample_selection, n_violations_selection = self.select(engine, ref)
         with engine.connect() as connection:
             self.sample = connection.execute(sample_selection).first()
-            n_violation_keys = connection.execute(n_violations_selection).scalar()
+            n_violation_keys = int(
+                str(connection.execute(n_violations_selection).scalar())
+            )
 
         selections = [*n_keys_selections, sample_selection, n_violations_selection]
         return (n_violation_keys, n_distinct_key_values), selections
@@ -97,7 +99,7 @@ def select(self, engine: sa.engine.Engine, ref: DataReference):
         return sample_selection, n_violations_selection
 
     @abc.abstractmethod
-    def compare(self, engine: sa.engine.Engine, ref: DataReference):
+    def compare(self, factual: Any, target: Any):
         pass
 
 

src/datajudge/constraints/interval.py

@@ -9,7 +9,7 @@
 
 
 class PrimaryKeyDefinition(Constraint):
-    def __init__(self, ref, primary_keys: List[str], name: str = None):
+    def __init__(self, ref, primary_keys: List[str], name: Optional[str] = None):
         super().__init__(ref, ref_value=set(primary_keys), name=name)
 
     def retrieve(
@@ -55,7 +55,7 @@ def __init__(
         max_duplicate_fraction: float = 0,
         max_absolute_n_duplicates: int = 0,
         infer_pk_columns: bool = False,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         if max_duplicate_fraction != 0 and max_absolute_n_duplicates != 0:
             raise ValueError(
@@ -148,10 +148,10 @@ def __init__(
         self,
         ref,
         *,
-        ref2: DataReference = None,
-        max_null_fraction: float = None,
+        ref2: Optional[DataReference] = None,
+        max_null_fraction: Optional[float] = None,
         max_relative_deviation: float = 0,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, ref_value=max_null_fraction, name=name)
         if max_null_fraction is not None and not (0 <= max_null_fraction <= 1):

src/datajudge/constraints/miscs.py

@@ -1,5 +1,5 @@
 import abc
-from typing import Tuple
+from typing import Optional, Tuple
 
 import sqlalchemy as sa
 
@@ -11,7 +11,12 @@
 
 class NRows(Constraint, abc.ABC):
     def __init__(
-        self, ref, *, ref2: DataReference = None, n_rows: int = None, name: str = None
+        self,
+        ref,
+        *,
+        ref2: Optional[DataReference] = None,
+        n_rows: Optional[int] = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, ref_value=n_rows, name=name)
 
@@ -79,7 +84,7 @@ def __init__(
         ref: DataReference,
         ref2: DataReference,
         max_relative_loss_getter: ToleranceGetter,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, name=name)
         self.max_relative_loss_getter = max_relative_loss_getter
@@ -110,7 +115,7 @@ def __init__(
         ref: DataReference,
         ref2: DataReference,
         max_relative_gain_getter: ToleranceGetter,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, name=name)
         self.max_relative_gain_getter = max_relative_gain_getter
@@ -141,7 +146,7 @@ def __init__(
         ref: DataReference,
         ref2: DataReference,
         min_relative_gain_getter: ToleranceGetter,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, name=name)
         self.min_relative_gain_getter = min_relative_gain_getter

src/datajudge/constraints/nrows.py

@@ -12,10 +12,10 @@ class NumericMin(Constraint):
     def __init__(
         self,
         ref: DataReference,
-        name: str = None,
+        name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        min_value: float = None,
+        ref2: Optional[DataReference] = None,
+        min_value: Optional[float] = None,
     ):
         super().__init__(ref, ref2=ref2, ref_value=min_value, name=name)
 
@@ -45,10 +45,10 @@ class NumericMax(Constraint):
     def __init__(
         self,
         ref: DataReference,
-        name: str = None,
+        name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        max_value: float = None,
+        ref2: Optional[DataReference] = None,
+        max_value: Optional[float] = None,
     ):
         super().__init__(
             ref,
@@ -86,7 +86,7 @@ def __init__(
         min_fraction: float,
         lower_bound: float,
         upper_bound: float,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref_value=min_fraction, name=name)
         self.lower_bound = lower_bound
@@ -122,10 +122,10 @@ def __init__(
         self,
         ref: DataReference,
         max_absolute_deviation: float,
-        name: str = None,
+        name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        mean_value: float = None,
+        ref2: Optional[DataReference] = None,
+        mean_value: Optional[float] = None,
     ):
         super().__init__(
             ref,
@@ -170,8 +170,8 @@ def __init__(
         max_relative_deviation: Optional[float] = None,
         name: Optional[str] = None,
         *,
-        ref2: DataReference = None,
-        expected_percentile: float = None,
+        ref2: Optional[DataReference] = None,
+        expected_percentile: Optional[float] = None,
     ):
         super().__init__(
             ref,

src/datajudge/constraints/numeric.py

@@ -15,7 +15,7 @@ def __init__(
         ref: DataReference,
         ref2: DataReference,
         max_missing_fraction_getter: ToleranceGetter,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(ref, ref2=ref2, name=name)
         self.max_missing_fraction_getter = max_missing_fraction_getter
@@ -62,6 +62,8 @@ def compare(
         result = missing_fraction <= self.max_missing_fraction
         if result:
             return result, None
+        if self.ref2 is None:
+            raise ValueError("RowEquality constraint requires ref2.")
         if n_rows_missing_left > 0:
             sample_string = format_sample(self.ref1_minus_ref2_sample, self.ref2)
         else:
@@ -139,6 +141,8 @@ def compare(
         result = missing_fraction <= self.max_missing_fraction
         if result:
             return result, None
+        if self.ref2 is None:
+            raise ValueError("RowSuperset constraint requires ref2.")
         sample_string = format_sample(self.ref2_minus_ref1_sample, self.ref2)
         assertion_message = (
             f"{missing_fraction} > "
@@ -161,7 +165,7 @@ def __init__(
         comparison_columns1: List[str],
         comparison_columns2: List[str],
         max_missing_fraction_getter: ToleranceGetter,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         super().__init__(
             ref,

src/datajudge/constraints/row.py

@@ -15,7 +15,7 @@ def __init__(
         ref: DataReference,
         ref2: DataReference,
         significance_level: float = 0.05,
-        name: str = None,
+        name: Optional[str] = None,
     ):
         self.significance_level = significance_level
         super().__init__(ref, ref2=ref2, name=name)
@@ -97,6 +97,8 @@ def calculate_statistic(
         return d_statistic, p_value, n_samples, m_samples, selections
 
     def test(self, engine: sa.engine.Engine) -> TestResult:
+        if self.ref2 is None:
+            raise ValueError("KolmogorovSmirnov2Sample requires ref2.")
         (
             d_statistic,
             p_value,