Merge pull request #110 from posit-dev/fix-validations-to-work-with-datetime

fix: allow validations to work with dates/datetimes

Author: rich-iannone

pointblank/_constants.py

@@ -7,12 +7,12 @@
 ]
 
 COMPATIBLE_DTYPES = {
-    "gt": ["numeric"],
-    "lt": ["numeric"],
-    "eq": ["numeric"],
-    "ne": ["numeric"],
-    "ge": ["numeric"],
-    "le": ["numeric"],
+    "gt": ["numeric", "datetime"],
+    "lt": ["numeric", "datetime"],
+    "eq": ["numeric", "datetime"],
+    "ne": ["numeric", "datetime"],
+    "ge": ["numeric", "datetime"],
+    "le": ["numeric", "datetime"],
     "between": ["numeric"],
     "outside": ["numeric"],
     "in_set": ["numeric", "str"],

pointblank/validate.py

@@ -7987,14 +7987,19 @@ def _prep_column_text(column: list[str]) -> str:
 
 
 def _prep_values_text(
-    values: str | int | float | list[str | int | float],
+    values: str
+    | int
+    | float
+    | datetime.datetime
+    | datetime.date
+    | list[str | int | float | datetime.datetime | datetime.date],
     lang: str,
     limit: int = 3,
 ) -> str:
     if isinstance(values, ColumnLiteral):
         return f"`{values}`"
 
-    if isinstance(values, (str, int, float)):
+    if isinstance(values, (str, int, float, datetime.datetime, datetime.date)):
         values = [values]
 
     length_values = len(values)
@@ -8005,6 +8010,14 @@ def _prep_values_text(
     if length_values > limit:
         num_omitted = length_values - limit
 
+        # Format datetime objects as strings if present
+        formatted_values = []
+        for value in values[:limit]:
+            if isinstance(value, (datetime.datetime, datetime.date)):
+                formatted_values.append(f"`{value.isoformat()}`")
+            else:
+                formatted_values.append(f"`{value}`")
+
         values_str = ", ".join([f"`{value}`" for value in values[:limit]])
 
         additional_text = EXPECT_FAIL_TEXT["values_text"][lang]
@@ -8014,6 +8027,14 @@ def _prep_values_text(
         values_str = f"{values_str}, {additional_str}"
 
     else:
+        # Format datetime objects as strings if present
+        formatted_values = []
+        for value in values:
+            if isinstance(value, (datetime.datetime, datetime.date)):
+                formatted_values.append(f"`{value.isoformat()}`")
+            else:
+                formatted_values.append(f"`{value}`")
+
         values_str = ", ".join([f"`{value}`" for value in values])
 
     return values_str

tests/test_validate.py

@@ -82,6 +82,11 @@
     "tbl_dates_times_text_sqlite",
 ]
 
+TBL_TRUE_DATES_TIMES_LIST = [
+    "tbl_true_dates_times_pd",
+    "tbl_true_dates_times_pl",
+]
+
 
 @pytest.fixture
 def tbl_pd():
@@ -104,6 +109,18 @@ def tbl_dates_times_text_pd():
     )
 
 
+@pytest.fixture
+def tbl_true_dates_times_pd():
+    return pd.DataFrame(
+        {
+            "date_1": pd.to_datetime(["2021-01-01", "2021-02-01"]),
+            "date_2": pd.to_datetime(["2021-02-01", "2021-03-01"]),
+            "dttm_1": pd.to_datetime(["2021-01-01 02:30:00", "2021-02-01 02:30:00"]),
+            "dttm_2": pd.to_datetime(["2021-02-01 03:30:00", "2021-03-01 03:30:00"]),
+        }
+    )
+
+
 @pytest.fixture
 def tbl_pl():
     return pl.DataFrame({"x": [1, 2, 3, 4], "y": [4, 5, 6, 7], "z": [8, 8, 8, 8]})
@@ -125,6 +142,27 @@ def tbl_dates_times_text_pl():
     )
 
 
+@pytest.fixture
+def tbl_true_dates_times_pl():
+    pl_df = pl.DataFrame(
+        {
+            "date_1": ["2021-01-01", "2021-02-01"],
+            "date_2": ["2021-02-01", "2021-03-01"],
+            "dttm_1": ["2021-01-01 02:30:00", "2021-02-01 02:30:00"],
+            "dttm_2": ["2021-02-01 03:30:00", "2021-03-01 03:30:00"],
+        }
+    )
+
+    return pl_df.with_columns(
+        [
+            pl.col("date_1").str.to_date(),
+            pl.col("date_2").str.to_date(),
+            pl.col("dttm_1").str.to_datetime(),
+            pl.col("dttm_2").str.to_datetime(),
+        ]
+    )
+
+
 @pytest.fixture
 def tbl_parquet():
     file_path = pathlib.Path.cwd() / "tests" / "tbl_files" / "tbl_xyz.parquet"
@@ -4065,6 +4103,162 @@ def test_col_schema_match_columns_only():
     )
 
 
+@pytest.mark.parametrize("tbl_fixture", TBL_TRUE_DATES_TIMES_LIST)
+def test_date_validation_across_cols(request, tbl_fixture):
+    # {
+    #     "date_1": pd.to_datetime(["2021-01-01", "2021-02-01"]),
+    #     "date_2": pd.to_datetime(["2021-02-01", "2021-03-01"]),
+    #     "dttm_1": pd.to_datetime(["2021-01-01 02:30:00", "2021-02-01 02:30:00"]),
+    #     "dttm_2": pd.to_datetime(["2021-02-01 03:30:00", "2021-03-01 03:30:00"]),
+    # }
+
+    tbl = request.getfixturevalue(tbl_fixture)
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_gt(
+            columns="date_2",
+            value=col("date_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_ge(
+            columns="date_2",
+            value=col("date_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_eq(
+            columns="date_2",
+            value=col("date_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 0
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_ne(
+            columns="date_2",
+            value=col("date_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_lt(
+            columns="date_1",
+            value=col("date_2"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_le(
+            columns="date_1",
+            value=col("date_2"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+
+@pytest.mark.parametrize("tbl_fixture", TBL_TRUE_DATES_TIMES_LIST)
+def test_datetime_validation_across_cols(request, tbl_fixture):
+    # {
+    #     "date_1": pd.to_datetime(["2021-01-01", "2021-02-01"]),
+    #     "date_2": pd.to_datetime(["2021-02-01", "2021-03-01"]),
+    #     "dttm_1": pd.to_datetime(["2021-01-01 02:30:00", "2021-02-01 02:30:00"]),
+    #     "dttm_2": pd.to_datetime(["2021-02-01 03:30:00", "2021-03-01 03:30:00"]),
+    # }
+
+    tbl = request.getfixturevalue(tbl_fixture)
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_gt(
+            columns="dttm_2",
+            value=col("dttm_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_ge(
+            columns="dttm_2",
+            value=col("dttm_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_eq(
+            columns="dttm_2",
+            value=col("dttm_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 0
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_ne(
+            columns="dttm_2",
+            value=col("dttm_1"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_lt(
+            columns="dttm_1",
+            value=col("dttm_2"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+    assert (
+        Validate(data=tbl)
+        .col_vals_le(
+            columns="dttm_1",
+            value=col("dttm_2"),
+        )
+        .interrogate()
+        .n_passed(i=1, scalar=True)
+        == 2
+    )
+
+
 @pytest.mark.parametrize(
     "tbl_fixture", ["tbl_pd_variable_names", "tbl_pl_variable_names", "tbl_memtable_variable_names"]
 )