pointblank 0.7.2__tar.gz → 0.8.0__tar.gz

{pointblank-0.7.2 → pointblank-0.8.0}/.github/ISSUE_TEMPLATE/bug.md

@@ -1,6 +1,6 @@
 ---
 name: Bug
-about: Something is wrong with 'pointblank'.
+about: Something is wrong with 'Pointblank'.
 title: ""
 labels: "Type: ☹︎ Bug"
 ---
@@ -28,7 +28,7 @@ What should have happened? Please be as specific as possible.
 ## Development environment
 
 - Operating System: [e.g., Linux, macOS, Windows]
-- pointblank Version: [e.g., 0.0.1]
+- Pointblank Version: [e.g., 0.0.1]
 
 ## Additional context
 

{pointblank-0.7.2 → pointblank-0.8.0}/.github/ISSUE_TEMPLATE/feature.md

@@ -7,7 +7,7 @@ labels: "Type: ★ Enhancement"
 
 ## Prework
 
-- [ ] Read and abide by the pointblank [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) and [contributing guidelines](https://github.com/posit-dev/pointblank/blob/main/.github/CONTRIBUTING.md).
+- [ ] Read and abide by the Pointblank [code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) and [contributing guidelines](https://github.com/posit-dev/pointblank/blob/main/.github/CONTRIBUTING.md).
 - [ ] Search for duplicates among the [existing issues](https://github.com/posit-dev/pointblank/issues) (both open and closed).
 
 ## Proposal

{pointblank-0.7.2 → pointblank-0.8.0}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 # Summary
 
-Thank you for contributing to pointblank! To make this process easier for everyone, please explain the context and purpose of your contribution. Also, list the changes made to the existing code or documentation.
+Thank you for contributing to Pointblank! To make this process easier for everyone, please explain the context and purpose of your contribution. Also, list the changes made to the existing code or documentation.
 
 # Related GitHub Issues and PRs
 

pointblank-0.8.0/.github/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+The following provides information on the versions of Pointblank that are
+currently being supported with security updates.
+
+| Version  | Supported          |
+| -------- | ------------------ |
+| >= 0.7.3 | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report any security vulnerabilities to rich@posit.co.

{pointblank-0.7.2 → pointblank-0.8.0}/.github/workflows/ci-tests.yaml

@@ -29,7 +29,7 @@ jobs:
           pip install -e '.[dev]'
       - name: Install test dependencies
         run: |
-          pip install pytest pytest-cov pytest-snapshot pandas polars ibis-framework[duckdb,mysql,postgres,sqlite]>=9.5.0 chatlas shiny
+          pip install pytest pytest-cov pytest-snapshot pandas polars ibis-framework[duckdb,mysql,postgres,sqlite]>=9.5.0 chatlas requests shiny
       - name: pytest unit tests
         run: |
           make test

{pointblank-0.7.2 → pointblank-0.8.0}/CITATION.cff

@@ -1,9 +1,9 @@
 cff-version: 1.2.0
-message: 'If you wish to cite the "pointblank" package use:'
+message: 'If you wish to cite the "Pointblank" package use:'
 type: software
 license: MIT
-title: "pointblank: Find out if your data is what you think it is"
-version: 0.5.0
+title: "Pointblank: Find out if your data is what you think it is"
+version: 0.7.3
 abstract: Validate data in Polars and Pandas DataFrames and database tables.
   Validation pipelines can be made using easily-readable, consecutive validation
   steps. Upon execution of the validation plan, several reporting options are available.

{pointblank-0.7.2 → pointblank-0.8.0}/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-There are many ways to contribute to the ongoing development of the pointblank package. Some contributions can be rather easy to do (e.g., fixing typos, improving documentation, filing issues for feature requests or problems, etc.) whereas other contributions can require more time and patience (like answering questions and submitting pull requests with code changes). Just know that help provided in any capacity is very much appreciated.
+There are many ways to contribute to the ongoing development of the Pointblank package. Some contributions can be rather easy to do (e.g., fixing typos, improving documentation, filing issues for feature requests or problems, etc.) whereas other contributions can require more time and patience (like answering questions and submitting pull requests with code changes). Just know that help provided in any capacity is very much appreciated.
 
 ## Filing Issues
 
@@ -10,7 +10,7 @@ If you believe you found a bug, minimal reproducible example (MRE) for your post
 
 One way to help is by simply answering questions. It's amazing how a little conversation could lead to better insights on a problem. Don't quite know the answer? That's okay too. We're all in this together.
 
-Where might you answer user questions? Some of the forums for Q&A on pointblank include the _Issues_ and _Discussion_ pages in the repo. Good etiquette is key during these interactions: be a good person to all who ask questions.
+Where might you answer user questions? Some of the forums for Q&A on Pointblank include the _Issues_ and _Discussion_ pages in the repo. Good etiquette is key during these interactions: be a good person to all who ask questions.
 
 ### Making Pull Requests
 
@@ -19,7 +19,7 @@ Should you consider making a pull request (PR), please file an issue first and e
 Once there is consensus that a PR based on the issue would be helpful, adhering to the following process will make things proceed more quickly:
 
 - Create a separate Git branch for each PR
-- The pointblank package follows the [Style Guide for Python Code](https://peps.python.org/pep-0008/) so please adopt those guidelines in your submitted code as best as possible
+- The Pointblank package follows the [Style Guide for Python Code](https://peps.python.org/pep-0008/) so please adopt those guidelines in your submitted code as best as possible
 - Comment your code, particularly in those hard-to-understand areas
 - Add test cases that cover the changes made in the PR; having tests for any new codepaths will help guard against regressions
 

{pointblank-0.7.2 → pointblank-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pointblank
-Version: 0.7.2
+Version: 0.8.0
 Summary: Find out if your data is what you think it is.
 Author-email: Richard Iannone <riannone@me.com>
 License: MIT License
@@ -177,6 +177,13 @@ You can install Pointblank using pip:
 pip install pointblank
 ```
 
+You can also install [Pointblank from Conda-Forge](https://anaconda.org/conda-forge/pointblank) by
+using:
+
+```bash
+conda install conda-forge::pointblank
+```
+
 If you don't have Polars or Pandas installed, you'll need to install one of them to use Pointblank.
 
 ```bash

{pointblank-0.7.2 → pointblank-0.8.0}/README.md

@@ -96,6 +96,13 @@ You can install Pointblank using pip:
 pip install pointblank
 ```
 
+You can also install [Pointblank from Conda-Forge](https://anaconda.org/conda-forge/pointblank) by
+using:
+
+```bash
+conda install conda-forge::pointblank
+```
+
 If you don't have Polars or Pandas installed, you'll need to install one of them to use Pointblank.
 
 ```bash

{pointblank-0.7.2 → pointblank-0.8.0}/docs/_quarto.yml

@@ -171,19 +171,26 @@ quartodoc:
         The *Inspection and Assistance* group contains functions that are helpful for getting to
         grips on a new data table. Use the `DataScan` class to get a quick overview of the data,
         `preview()` to see the first and last few rows of a table, `col_summary_tbl()` for a
-        column-level summary of a table, `missing_vals_tbl()` to see where there are missing values
-        in a table, and `get_column_count()`/`get_row_count()` to get the number of columns and rows
-        in a table. Several datasets included in the package can be accessed via the
-        `load_dataset()` function. Finally, the `config()` utility lets us set global configuration
-        parameters. Want to chat with an assistant? Use the `assistant()` function to get help with
-        Pointblank.
+        column-level summary of a table, and `missing_vals_tbl()` to see where there are missing
+        values in a table. Several datasets included in the package can be accessed via the
+        `load_dataset()` function. On the assistance side, the `assistant()` function can be used to
+        get help with Pointblank.
       contents:
         - name: DataScan
         - name: preview
         - name: col_summary_tbl
         - name: missing_vals_tbl
+        - name: assistant
+        - name: load_dataset
+    - title: Utility Functions
+      desc: >
+        The *Utility Functions* group contains functions that are useful accessing metadata about
+        the target data. Use `get_column_count()` or `get_row_count()` to get the number of columns
+        or rows in a table. The `get_action_metadata()` function is useful when building custom
+        actions since it returns metadata about the validation step that's triggering the action.
+        Lastly, the `config()` utility lets us set global configuration parameters.
+      contents:
         - name: get_column_count
         - name: get_row_count
-        - name: load_dataset
+        - name: get_action_metadata
         - name: config
-        - name: assistant

{pointblank-0.7.2 → pointblank-0.8.0}/docs/styles.css

@@ -9,7 +9,7 @@
 }
 
 body {
-    background-color: #EBEEF7;
+    background-color: #F7F8FC;
 }
 
 p a {

{pointblank-0.7.2 → pointblank-0.8.0}/docs/user-guide/actions.qmd

@@ -70,7 +70,7 @@ considered optional. Put another way, you can set various thresholds and various
 and the interrogation phase will determine whether all the requirements are met for executing
 an action.
 
-## Ways to Express Actions: Text or Custom Functions
+## Expressing Actions with a String
 
 There are a few options in how to define the actions:
 
@@ -99,10 +99,9 @@ Here's an example where we prepare a console message with a number of value plac
 (`action_str`) and use it globally at `Actions(critical=)`:
 
 ```{python}
-
 action_str = "[{LEVEL}: {TYPE}]: Step {step} has failed validation. ({time})"
 
-validation = (
+validation_2 = (
     pb.Validate(
         data=pb.load_dataset(dataset="game_revenue", tbl_type="duckdb"),
         thresholds=pb.Thresholds(warning=0.05, error=0.10, critical=0.15),
@@ -113,6 +112,8 @@ validation = (
     .col_vals_ge(columns="session_duration", value=15)
     .interrogate()
 )
+
+validation_2
 ```
 
 What we get here are two messages in the console, corresponding to critical failures in steps 2 and
@@ -121,16 +122,19 @@ resulting text is capitalized (e.g., `"CRITICAL"`, `"COL_VALS_GT"`, etc.) and th
 capitalized the placeholder text itself. Have a look at the documentation article of
 [`Actions`](https://posit-dev.github.io/pointblank/reference/Actions.html) for more details on this.
 
+## Making Actions with Callables
+
 Aside from strings, any callable can be used as an action value. Here's an example where we use a
 custom function as part of an action:
 
 ```{python}
-def dq_issue():
+def duration_issue():
     from datetime import datetime
 
     print(f"Data quality issue found ({datetime.now()}).")
 
-validation = (
+
+validation_3 = (
     pb.Validate(
         data=pb.load_dataset(dataset="game_revenue", tbl_type="duckdb"),
         thresholds=pb.Thresholds(warning=0.05, error=0.10, critical=0.15),
@@ -140,12 +144,12 @@ validation = (
     .col_vals_gt(
         columns="session_duration",
         value=15,
-        actions=pb.Actions(warning=dq_issue),
+        actions=pb.Actions(warning=duration_issue),
     )
     .interrogate()
 )
 
-validation
+validation_3
 ```
 
 In this case, the 'warning' action is set to call the user's `dq_issue()` function. This action is
@@ -159,3 +163,62 @@ applied to step 3. You are free to mix and match both threshold and action setti
 level (i.e., set in the [`Validate`](https://posit-dev.github.io/pointblank/reference/Validate.html)
 call) or at the step level. The key thing to be aware of is that step-level settings of thresholds
 and actions take precedence.
+
+## Using `get_action_metadata()` to Access Metadata When Building an Action Callable
+
+To access information about the validation step where an action was triggered, we can call
+[`get_action_metadata()`](https://posit-dev.github.io/pointblank/reference/get_action_metadata.html)
+in the body of a function to be used within `Actions`. The dictionary that's returned by that
+function allows us to make more generalized actions that could react accordingly to different
+failure states.
+
+In the following example, we'll make a function called `print_problem()` that prints information to
+the console about the failure state for a validation step. In this case, the action will be applied
+to any threshold level being exceeded (by using `Actions(default=print_problem)`). And only the most
+severe level exceeded per step will execute `print_problem()` since `Actions(highest_only=True)` by
+default.
+
+```{python}
+def print_problem():
+    m = pb.get_action_metadata()
+    print(f"{m['level']} ({m['level_num']}) for Step {m['step']}: {m['failure_text']}")
+
+
+validation = (
+    pb.Validate(
+        data=pb.load_dataset(dataset="game_revenue", tbl_type="duckdb"),
+        thresholds=pb.Thresholds(warning=0.05, error=0.10, critical=0.15),
+        actions=pb.Actions(default=print_problem),
+        brief=True,
+    )
+    .col_vals_regex(columns="player_id", pattern=r"[A-Z]{12}\d{3}")
+    .col_vals_gt(columns="item_revenue", value=0.05)
+    .col_vals_gt(
+        columns="session_duration",
+        value=15,
+    )
+    .interrogate()
+)
+
+validation
+```
+
+We end up seeing two messages printed for failures in Steps 2 and 3. And though those steps had more
+than one threshold exceeded, only the most severe level in each yielded a console message.
+
+Alse note that we set the action in `Validate(actions=)` so that the action would apply to all
+validation steps where thresholds are exceeded. This obviated the need to set `actions=` at every
+validation step (though you can do this as a local override, even setting `actions=None` to disable
+globally set actions).
+
+The metadata dictionary contains the following fields for a given validation step:
+
+- `step`: The step number.
+- `column`: The column name.
+- `value`: The value being compared (only available in certain validation steps).
+- `type`: The assertion type (e.g., `"col_vals_gt"`, etc.).
+- `time`: The time the validation step was executed (in ISO format).
+- `level`: The severity level (`"warning"`, `"error"`, or `"critical"`).
+- `level_num`: The severity level as a numeric value (`30`, `40`, or `50`).
+- `autobrief`: A localized and brief statement of the expectation for the step.
+- `failure_text`: Localized text that explains how the validation step failed.

{pointblank-0.7.2 → pointblank-0.8.0}/pointblank/__init__.py

@@ -28,6 +28,7 @@ from pointblank.thresholds import Actions, Thresholds
 from pointblank.validate import (
     Validate,
     config,
+    get_action_metadata,
     get_column_count,
     get_row_count,
     load_dataset,
@@ -57,6 +58,7 @@ __all__ = [
     "config",
     "preview",
     "missing_vals_tbl",
+    "get_action_metadata",
     "get_column_count",
     "get_row_count",
 ]

{pointblank-0.7.2 → pointblank-0.8.0}/pointblank/_constants.py

@@ -13,8 +13,8 @@ COMPATIBLE_DTYPES = {
     "ne": ["numeric", "datetime"],
     "ge": ["numeric", "datetime"],
     "le": ["numeric", "datetime"],
-    "between": ["numeric"],
-    "outside": ["numeric"],
+    "between": ["numeric", "datetime"],
+    "outside": ["numeric", "datetime"],
     "in_set": ["numeric", "str"],
     "not_in_set": ["numeric", "str"],
     "regex": ["str"],
@@ -159,14 +159,21 @@ REPORTING_LANGUAGES = [
     "it",
     "es",
     "pt",
+    "ro",
     "tr",
     "zh-Hans",
     "zh-Hant",
+    "ja",
+    "ko",
     "ru",
+    "cs",
     "pl",
     "da",
     "sv",
+    "nb",
     "nl",
+    "fi",
+    "is",
 ]
 
 SEVERITY_LEVEL_COLORS = {
@@ -176,6 +183,8 @@ SEVERITY_LEVEL_COLORS = {
     "green": "#4CA64C",
 }
 
+LOG_LEVELS_MAP = {"warning": 30, "error": 40, "critical": 50}
+
 CHECK_MARK_SPAN = "<span style='color: #4CA64C;'>&check;</span>"
 CROSS_MARK_SPAN = "<span style='color: #CF142B;'>&cross;</span>"