truequery 0.1.0__tar.gz

truequery-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Python
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+
+# TrueQuery's own per-project state
+.truequery/
+
+# Generated demo data (each folder documents how to rebuild it)
+*.duckdb
+*.duckdb.wal
+
+# Local working notes, never published
+internal/
+
+.DS_Store

truequery-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

truequery-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+TrueQuery — Copyright Analytically.ai
+
+This product includes software developed by Analytically.ai.
+Licensed under the Apache License, Version 2.0 (see LICENSE).

truequery-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: truequery
+Version: 0.1.0
+Summary: TrueQuery engine: offline, deterministic checks for SQL that silently returns the wrong answer
+Project-URL: Homepage, https://github.com/Analytically-ai/truequery
+Project-URL: Issues, https://github.com/Analytically-ai/truequery/issues
+Author: Analytically.ai
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: analytics,data-engineering,dbt,lint,sql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: sqlglot==30.22.0
+Provides-Extra: test
+Requires-Dist: duckdb; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# TrueQuery engine
+
+The offline checker behind [TrueQuery](https://github.com/Analytically-ai/truequery).
+It installs two commands, `truequery` and its short alias `tq`.
+
+```bash
+pip install truequery
+uvx truequery detect .
+```
+
+It looks for SQL that silently returns the wrong answer: a `NOT IN` that one
+NULL empties, a `WHERE` that turns a `LEFT JOIN` into an inner join, a
+`COUNT(*)` that counts missing rows, an unguarded `UPDATE` or `DELETE`.
+Twenty-five checks ship with the preview, 15 of them on by default, each
+promoted only when it proves precise on real projects. Files it can't parse,
+can't decode, or that are over the 10 MB limit are listed as not checked,
+never as clean.
+
+It runs offline and gives deterministic output, with no LLM and no network
+calls: plain code on your machine, in well under a second per file. Text,
+JSON and SARIF output; exit codes 0 (clean), 1 (findings), 2 (usage or config
+error) and 3 (some files couldn't be checked). See the
+[repository README](https://github.com/Analytically-ai/truequery) for the
+full guide: the skill, the receipt, hooks, and the standard behind the checks.

truequery-0.1.0/README.md

@@ -0,0 +1,24 @@
+# TrueQuery engine
+
+The offline checker behind [TrueQuery](https://github.com/Analytically-ai/truequery).
+It installs two commands, `truequery` and its short alias `tq`.
+
+```bash
+pip install truequery
+uvx truequery detect .
+```
+
+It looks for SQL that silently returns the wrong answer: a `NOT IN` that one
+NULL empties, a `WHERE` that turns a `LEFT JOIN` into an inner join, a
+`COUNT(*)` that counts missing rows, an unguarded `UPDATE` or `DELETE`.
+Twenty-five checks ship with the preview, 15 of them on by default, each
+promoted only when it proves precise on real projects. Files it can't parse,
+can't decode, or that are over the 10 MB limit are listed as not checked,
+never as clean.
+
+It runs offline and gives deterministic output, with no LLM and no network
+calls: plain code on your machine, in well under a second per file. Text,
+JSON and SARIF output; exit codes 0 (clean), 1 (findings), 2 (usage or config
+error) and 3 (some files couldn't be checked). See the
+[repository README](https://github.com/Analytically-ai/truequery) for the
+full guide: the skill, the receipt, hooks, and the standard behind the checks.

truequery-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+# hatchling builds out of tree: running the engine straight from an
+# installed plugin (uv run --with-editable <plugin>/engine) writes nothing
+# into it; the plugin's scripts send bytecode to ~/.cache/truequery.
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "truequery"
+version = "0.1.0"
+description = "TrueQuery engine: offline, deterministic checks for SQL that silently returns the wrong answer"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+dependencies = ["sqlglot==30.22.0", "pyyaml==6.0.3"]
+
+authors = [{ name = "Analytically.ai" }]
+keywords = ["sql", "analytics", "data-engineering", "lint", "dbt"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Database",
+  "Topic :: Software Development :: Quality Assurance",
+]
+
+[project.urls]
+Homepage = "https://github.com/Analytically-ai/truequery"
+Issues = "https://github.com/Analytically-ai/truequery/issues"
+
+[project.optional-dependencies]
+test = ["duckdb", "pytest"]
+
+[project.scripts]
+truequery = "truequery.cli:main"
+tq = "truequery.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/truequery"]
+exclude = ["**/__pycache__"]

truequery-0.1.0/src/truequery/__init__.py

@@ -0,0 +1,3 @@
+"""TrueQuery: one standard for data work, enforced on every edit."""
+
+__version__ = "0.1.0"

truequery-0.1.0/src/truequery/analyzers/project_checks.py

@@ -0,0 +1,220 @@
+"""Preview non-SQL checks (v1, Stop tier, never immediate).
+
+Each check is backed by an existing standard practice (cited in its
+``why``); practices with no detector-shaped record yet (Airflow dynamic
+``start_date``, pandas ``merge(validate=)``) are NOT implemented here —
+they are listed as gaps in docs. Deterministic, offline, file/project
+evidence only.
+"""
+import ast
+import os
+import re
+
+import yaml
+
+INCREMENTAL = re.compile(r"materialized\s*=\s*['\"]incremental['\"]")
+UNIQUE_KEY = re.compile(r"unique_key\s*=")
+
+
+def _finding(rule, registry, settings, mode, path, line, why, fix,
+             snippet=""):
+    record = registry.RECORDS.get(rule) if registry else None
+    sev = None
+    if settings:
+        sev = settings.get(rule, {}).get("severity")
+    if not sev and record:
+        sev = record["severity"].get(mode, "warning")
+    return {"rule": rule, "severity": sev or "warning", "mode": mode,
+            "evidence": "project", "file": path, "line": line, "col": 1,
+            "snippet": snippet[:120], "why": why, "fix": fix}
+
+
+STRATEGY = re.compile(r"incremental_strategy\s*=\s*['\"]([\w+]+)['\"]")
+
+
+def _yaml_unique_key(path):
+    """True when a properties YAML next to the model sets unique_key in
+    the model's config block (dbt allows config there as well as in
+    the SQL)."""
+    model = os.path.splitext(os.path.basename(path))[0]
+    directory = os.path.dirname(os.path.abspath(path))
+    try:
+        names = sorted(os.listdir(directory))
+    except OSError:
+        return False
+    for name in names:
+        if not name.endswith((".yml", ".yaml")):
+            continue
+        try:
+            with open(os.path.join(directory, name), encoding="utf-8") as handle:
+                doc = yaml.safe_load(handle)
+        except (OSError, ValueError, yaml.YAMLError):
+            continue
+        specs = doc.get("models") if isinstance(doc, dict) else None
+        for spec in specs or []:
+            if (isinstance(spec, dict) and spec.get("name") == model
+                    and isinstance(spec.get("config"), dict)
+                    and spec["config"].get("unique_key")):
+                return True
+    return False
+
+
+def check_dbt_model(text, path, mode="build", registry=None,
+                    settings=None):
+    """model/unique-key-merge-key: merge/delete+insert incremental
+    model with no unique_key (in the SQL config or the model's YAML).
+    Microbatch/insert_overwrite strategies key on event_time/partitions
+    instead — no unique_key expected."""
+    out = []
+    m = INCREMENTAL.search(text)
+    strat = STRATEGY.search(text)
+    merge_like = strat is None or strat.group(1) in (
+        "merge", "delete+insert", "delete_insert")
+    if (m and merge_like and not UNIQUE_KEY.search(text)
+            and not _yaml_unique_key(path)):
+        line = text[:m.start()].count("\n") + 1
+        out.append(_finding(
+            "model/unique-key-merge-key", registry, settings, mode, path,
+            line,
+            "incremental model declares no unique_key; a merge degrades "
+            "to append and duplicates rows on every re-run "
+            "(model/unique-key-merge-key)",
+            "add unique_key='<key>' to the model config and a "
+            "unique + not_null test on the key"))
+    return out
+
+
+def _tests_of(entry):
+    tests = set()
+    for t in entry.get("tests") or []:
+        tests.add(t if isinstance(t, str) else next(iter(t), ""))
+    for t in entry.get("data_tests") or []:
+        tests.add(t if isinstance(t, str) else next(iter(t), ""))
+    return tests
+
+
+def check_schema_yaml(text, path, mode="build", registry=None,
+                      settings=None):
+    """dq/uniqueness-key-no-duplicates + ingest/declare-source-freshness
+    over a dbt schema YAML (models:/sources:)."""
+    out = []
+    try:
+        doc = yaml.safe_load(text)
+    except Exception:
+        return out
+    if not isinstance(doc, dict):
+        return out
+    lines = text.splitlines()
+
+    def line_of(needle, after=0):
+        for i, row in enumerate(lines[after:], start=after + 1):
+            if needle in row:
+                return i
+        return 1
+
+    for model in doc.get("models") or []:
+        if not isinstance(model, dict):
+            continue
+        name = model.get("name", "")
+        cols = model.get("columns") or []
+        # A key candidate needs a declared signal: a MetricFlow primary
+        # entity, or a unique test (someone claimed uniqueness). A bare
+        # *_id column is as often a foreign key, and a column with an
+        # accepted_values test is not a key — stay silent there.
+        key_cols = []
+        for c in cols:
+            if not isinstance(c, dict):
+                continue
+            entity = c.get("entity") or {}
+            if entity.get("type") == "primary" or "unique" in _tests_of(c):
+                key_cols.append(c)
+        if not key_cols:
+            continue  # no declared key candidate: cannot infer, stay silent
+        col = key_cols[0]
+        tests = _tests_of(col)
+        combo = any("unique_combination_of_columns" in t
+                    for t in _tests_of(model))
+        if combo or {"unique", "not_null"} <= tests:
+            continue
+        out.append(_finding(
+            "dq/uniqueness-key-no-duplicates", registry, settings, mode,
+            path, line_of(str(col.get("name"))),
+            f"model {name}: key column {col.get('name')} lacks a "
+            "unique + not_null test pair, so duplicate or null keys "
+            "pass silently (dq/uniqueness-key-no-duplicates)",
+            f"add unique and not_null tests on {col.get('name')}, or a "
+            "unique_combination_of_columns test on the model"))
+    for source in doc.get("sources") or []:
+        if not isinstance(source, dict):
+            continue
+        for table in source.get("tables") or []:
+            if not isinstance(table, dict):
+                continue
+            freshness = source.get("freshness") or table.get("freshness")
+            loaded = (source.get("loaded_at_field")
+                      or table.get("loaded_at_field"))
+            # Fire only on intent: the source tracks its load time but
+            # never checks it. A source with no loaded_at_field at all
+            # has not opted into freshness — stay silent.
+            if freshness or not loaded:
+                continue
+            out.append(_finding(
+                "ingest/declare-source-freshness", registry, settings,
+                mode, path, line_of(str(table.get("name", ""))),
+                f"source table {table.get('name')} tracks loaded_at_field "
+                "but declares no freshness check, so a stalled source is "
+                "invisible (ingest/declare-source-freshness)",
+                "add freshness: {warn_after/error_after} to the source"))
+    return out
+
+
+def check_python(text, path, mode="build", registry=None, settings=None):
+    """orch/explicit-catchup-policy: Airflow DAG without catchup."""
+    out = []
+    try:
+        tree = ast.parse(text)
+    except SyntaxError:
+        return out
+    for node in ast.walk(tree):
+        if not isinstance(node, ast.Call):
+            continue
+        func = node.func
+        name = (func.id if isinstance(func, ast.Name)
+                else func.attr if isinstance(func, ast.Attribute) else "")
+        if name not in ("DAG", "dag"):  # DAG(...), models.DAG, @dag(...)
+            continue
+        kws = {k.arg for k in node.keywords if k.arg}
+        if "catchup" in kws:
+            continue
+        out.append(_finding(
+            "orch/explicit-catchup-policy", registry, settings, mode,
+            path, node.lineno,
+            "Airflow DAG declares no explicit catchup; the default "
+            "backfills every missed interval on first deploy "
+            "(orch/explicit-catchup-policy)",
+            "set catchup=False (or True deliberately) on the DAG"))
+    return out
+
+
+def check_aux_file(text, path, mode="build", registry=None, settings=None):
+    """Dispatch by file kind. Returns finding dicts (engine shape)."""
+    if path.endswith(".py"):
+        return check_python(text, path, mode, registry, settings)
+    if path.endswith((".yml", ".yaml")):
+        return check_schema_yaml(text, path, mode, registry, settings)
+    return []
+
+
+def check_model_sql(text, path, mode="build", registry=None, settings=None):
+    if path.endswith(".sql"):
+        return check_dbt_model(text, path, mode, registry, settings)
+    return []
+
+
+# slug -> implementing function, for the standard<->checks CI test.
+PREVIEW_CHECKS = {
+    "model/unique-key-merge-key": check_dbt_model,
+    "dq/uniqueness-key-no-duplicates": check_schema_yaml,
+    "ingest/declare-source-freshness": check_schema_yaml,
+    "orch/explicit-catchup-policy": check_python,
+}