dbt-contracts 0.1.0__py3-none-any.whl

dbt_contracts/__init__.py

@@ -0,0 +1,12 @@
+"""Welcome to dbt-contracts"""
+from pathlib import Path
+
+PROGRAM_NAME = "dbt-contracts"
+PROGRAM_OWNER_NAME = "George Martin Marino"
+PROGRAM_OWNER_USER = "geo-martino"
+PROGRAM_OWNER_EMAIL = f"gm.engineer+{PROGRAM_NAME.lower()}@pm.me"
+PROGRAM_URL = f"https://github.com/{PROGRAM_OWNER_USER}/{PROGRAM_NAME.lower()}"
+DOCUMENTATION_URL = f"https://{PROGRAM_OWNER_USER}.github.io/{PROGRAM_NAME.lower()}"
+
+MODULE_ROOT: str = Path(__file__).parent.name
+PACKAGE_ROOT: Path = Path(__file__).parent.parent

dbt_contracts/cli.py

@@ -0,0 +1,146 @@
+import argparse
+import os
+
+from dbt.cli.resolvers import default_profiles_dir, default_project_dir
+
+from dbt_contracts import PROGRAM_NAME
+from dbt_contracts.contracts import CONTRACTS, ParentContract
+
+DEFAULT_CONFIG_FILE_NAME: str = "contracts.yml"
+DEFAULT_OUTPUT_FILE_NAME: str = "contracts_results"
+
+CORE_PARSER = argparse.ArgumentParser(
+    prog=PROGRAM_NAME,
+)
+
+################################################################################
+## DBT args
+################################################################################
+profiles_dir = CORE_PARSER.add_argument(
+    "--profiles-dir",
+    help="Which directory to look in for the profiles.yml file. "
+         "If not set, dbt will look in the current working directory first, then HOME/.dbt/",
+    nargs="?",
+    default=os.getenv("DBT_PROFILES_DIR", default_profiles_dir()),
+    type=str,
+)
+
+project_dir = CORE_PARSER.add_argument(
+    "--project-dir",
+    help="Which directory to look in for the dbt_project.yml file. "
+         "Default is the current working directory and its parents.",
+    nargs="?",
+    default=os.getenv("DBT_PROJECT_DIR", default_project_dir()),
+    type=str,
+)
+
+profile = CORE_PARSER.add_argument(
+    "--profile",
+    help="Which existing profile to load. Overrides setting in dbt_project.yml.",
+    nargs="?",
+    default=os.getenv("DBT_PROFILE"),
+    type=str,
+)
+
+target = CORE_PARSER.add_argument(
+    "--target",
+    "-t",
+    help="Which target to load for the given profile",
+    nargs="?",
+    default=os.getenv("DBT_TARGET"),
+    type=str,
+)
+
+threads = CORE_PARSER.add_argument(
+    "--threads",
+    help="Specify number of threads to use while executing models. Overrides settings in profiles.yml.",
+    nargs="?",
+    default=None,
+    type=int,
+)
+
+################################################################################
+## DBT commands
+################################################################################
+clean = CORE_PARSER.add_argument(
+    "--clean",
+    help="When this option is passed, run `dbt clean` before operations. "
+         "If not passed, will attempt to load artifacts from the target folder before operations.",
+    action='store_true'
+)
+
+install_deps = CORE_PARSER.add_argument(
+    "--deps",
+    help="When this option is passed, run `dbt deps` before operations.",
+    action='store_true'
+)
+
+################################################################################
+## Runner args
+################################################################################
+config = CORE_PARSER.add_argument(
+    "--config",
+    help="Either the path to a contracts configuration file, "
+         f"or the directory to look in for the {DEFAULT_CONFIG_FILE_NAME!r} file. "
+         "Defaults to the project dir when not specified.",
+    nargs="?",
+    default=None,
+    type=str,
+)
+
+output = CORE_PARSER.add_argument(
+    "--output",
+    help="Either the path to a file to write to when formatting results output, "
+         f"or the directory to write a file to with filename {DEFAULT_OUTPUT_FILE_NAME!r}. "
+         "Defaults to the project's target folder when not specified.",
+    nargs="?",
+    default=None,
+    type=str,
+)
+
+output_format = CORE_PARSER.add_argument(
+    "--format",
+    help="Specify the format of results output if desired. Output file will not be generated when not specified.",
+    nargs="?",
+    default=None,
+    choices=["text", "json", "jsonl", "github-annotations"],
+    type=str,
+)
+
+no_fail = CORE_PARSER.add_argument(
+    "--no-fail",
+    help="When this option is passed, do not fail when contracts do not pass.",
+    action='store_true'
+)
+
+contract = CORE_PARSER.add_argument(
+    "--contract",
+    help="Run only this contract. If none given, apply all configured contracts. "
+         "Specify granular contracts by separating keys by a '.' e.g. 'model', 'model.columns'",
+    nargs="?",
+    default=None,
+    choices=[
+        str(contract.config_key) for contract in CONTRACTS
+    ] + [
+        f"{contract.config_key}.{contract.child_type.config_key}"
+        for contract in CONTRACTS if issubclass(contract, ParentContract)
+    ],
+    type=str,
+)
+
+enforcements = CORE_PARSER.add_argument(
+    "--enforce",
+    help="Apply only these enforcements. If none given, apply all configured enforcements.",
+    nargs="+",
+    default=None,
+    type=str,
+)
+
+files = CORE_PARSER.add_argument(
+    "files",
+    help="Apply contract to only these files. "
+         "Must either be relative to the current folder, relative to the project folder, or absolute.",
+    nargs="*",
+    default=None,
+    type=str,
+)

dbt_contracts/contracts/__init__.py

@@ -0,0 +1,12 @@
+"""
+Implementations for dbt contracts according to the dbt object type.
+"""
+from ._core import Contract, ParentContract, ChildContract, ProcessorMethod
+from ._properties import PatchT, MetaT, TagT
+from ._node import NodeT, NodeContract, CompiledNodeT, CompiledNodeContract
+from .macro import MacroContract
+from .model import ModelContract
+from .source import SourceContract
+
+CONTRACTS: list[type[ParentContract]] = [ModelContract, SourceContract, MacroContract]
+CONTRACTS_CONFIG_MAP = {str(cls.config_key): cls for cls in CONTRACTS}