set base model + update release history

Signed-off-by: geo-martino <gm.login+tech@pm.me>

Author: geo-martino

dbt_contracts/_core.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, ConfigDict
+
+
+class BaseModelConfig(BaseModel):
+    """
+    Base class for all models in the dbt_contracts package.
+
+    Sets common config and functionality as required.
+    """
+    model_config = ConfigDict(validate_assignment=True, validate_default=True)

dbt_contracts/contracts/_core.py

@@ -6,14 +6,14 @@
 
 from dbt.artifacts.schemas.catalog import CatalogArtifact
 from dbt.contracts.graph.manifest import Manifest
-from pydantic import BaseModel
 
+from dbt_contracts._core import BaseModelConfig
 from dbt_contracts.contracts.result import Result, RESULT_PROCESSOR_MAP
 from dbt_contracts.properties import PropertiesIO
 from dbt_contracts.types import ItemT, ParentT
 
 
-class ContractPart(BaseModel, metaclass=ABCMeta):
+class ContractPart(BaseModelConfig, metaclass=ABCMeta):
     """
     A part of a contract.
 

dbt_contracts/contracts/conditions/properties.py

@@ -42,12 +42,16 @@ class PathCondition(ContractCondition[BaseResource], PatternMatcher):
         - ["path", "to", "another", "folder2"]
         - ["path", "to", "another", "folder3"]
     """
-    model_config = ConfigDict(validate_assignment=True)
-
+    # noinspection PyNestedDecorators
     @field_validator("include", "exclude", mode="after", check_fields=True)
     @classmethod
-    def _escape_backslashes_in_windows_paths(cls, values: Sequence[str]) -> Sequence[str]:
-        return [path.replace("\\", "\\\\") for path in values]
+    def escape_backslashes_in_windows_paths[T: Sequence[str]](cls, values: T) -> T:
+        """
+        Replace all single backslashes with double backslashes in Windows paths.
+
+        This is needed to ensure regex patterns are correctly interpreted and avoid any 'bad escape' errors.
+        """
+        return values.__class__(path.replace("\\", "\\\\") for path in values)
 
     # noinspection PyNestedDecorators
     @field_validator("include", "exclude", mode="before")

dbt_contracts/contracts/matchers.py

@@ -2,12 +2,13 @@
 from collections.abc import Sequence, Collection
 from typing import Annotated, Self
 
-from pydantic import BaseModel, Field, BeforeValidator, model_validator
+from pydantic import Field, BeforeValidator, model_validator
 
+from dbt_contracts._core import BaseModelConfig
 from dbt_contracts.contracts.utils import to_tuple
 
 
-class RangeMatcher(BaseModel):
+class RangeMatcher(BaseModelConfig):
     min_count: int = Field(
         description="The minimum count allowed.",
         ge=1,
@@ -39,7 +40,7 @@ def _match(self, count: int, kind: str) -> str | None:
         return f"Too {quantifier} {kind} found: {count}. Expected: {expected}."
 
 
-class StringMatcher(BaseModel):
+class StringMatcher(BaseModelConfig):
     ignore_whitespace: bool = Field(
         description="Ignore any whitespaces when comparing data type keys.",
         default=False,
@@ -78,7 +79,7 @@ def _match(self, actual: str | None, expected: str | None) -> bool:
         return match
 
 
-class PatternMatcher(BaseModel):
+class PatternMatcher(BaseModelConfig):
     include: Annotated[Sequence[str], BeforeValidator(to_tuple)] = Field(
         description="Patterns to match against for values to include",
         default=tuple(),

dbt_contracts/contracts/result.py

@@ -7,13 +7,13 @@
 from dbt.artifacts.resources.v1.components import ColumnInfo
 from dbt.artifacts.resources.v1.macro import MacroArgument
 from dbt.contracts.graph.nodes import ModelNode, SourceDefinition, Macro
-from pydantic import BaseModel
 
+from dbt_contracts._core import BaseModelConfig
 from dbt_contracts.properties import PropertiesIO
 from dbt_contracts.types import ItemT, ParentT
 
 
-class Result[I: ItemT, P: ParentT](BaseModel, metaclass=ABCMeta):
+class Result[I: ItemT, P: ParentT](BaseModelConfig, metaclass=ABCMeta):
     """Store information of the result from a contract execution."""
     name: str
     path: Path | None

dbt_contracts/formatters/_core.py

@@ -2,8 +2,7 @@
 from collections.abc import Callable, Collection, Iterable
 from typing import Any
 
-from pydantic import BaseModel
-
+from dbt_contracts._core import BaseModelConfig
 from dbt_contracts.contracts.result import Result
 
 type KeysT[T] = str | Callable[[T], Any]
@@ -34,7 +33,7 @@ def get_values_from_object[T](obj: T, keys: Collection[KeysT[T]]) -> Iterable[An
     return (get_value_from_object(obj, key) for key in keys)
 
 
-class ResultsFormatter[T: Result](BaseModel, metaclass=ABCMeta):
+class ResultsFormatter[T: Result](BaseModelConfig, metaclass=ABCMeta):
     """
     Base class for implementations which format a set of :py:class:`.Result` objects to a string for displaying results.
     Usually used to format results for logging purposes.

dbt_contracts/formatters/table.py

@@ -5,8 +5,9 @@
 from typing import Self, Any, Annotated, Literal
 
 from colorama import Fore
-from pydantic import BaseModel, Field, model_validator, BeforeValidator
+from pydantic import Field, model_validator, BeforeValidator
 
+from dbt_contracts._core import BaseModelConfig
 from dbt_contracts.contracts.result import Result
 from dbt_contracts.contracts.utils import to_tuple
 from dbt_contracts.formatters import ResultsFormatter
@@ -22,7 +23,7 @@ def _align_and_pad_print_length(value: str, alignment: Literal["<", "^", ">"], w
     return f"{value:{alignment}{width}}"
 
 
-class TableCellBuilder[T: Result](BaseModel):
+class TableCellBuilder[T: Result](BaseModelConfig):
     key: str | Callable[[T], str] = Field(
         description="The key to use to get the value from the :py:class:`.Result` "
                     "or a callable object which returns a formatted string for the value",
@@ -151,7 +152,7 @@ def build(self, result: T, min_width: int = None) -> str:
         return value
 
 
-class TableRowBuilder[T: Result](BaseModel):
+class TableRowBuilder[T: Result](BaseModelConfig):
     cells: Sequence[TableCellBuilder[T]] | Sequence[Sequence[TableCellBuilder[T] | None]] = Field(
         description="The cell builders to use to build the row.",
     )

docs/info/release-history.rst

@@ -32,12 +32,20 @@ The format is based on `Keep a Changelog <https://keepachangelog.com/en>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_
 
 
-1.0.8
+1.0.9
 =====
 
 Fixed
 -----
+* Path separators in Windows paths were being intepreted as special characters when path filtering.
+  All backslashes in paths are now double escaped to prevent issues with regex matching.
+
 
+1.0.8
+=====
+
+Fixed
+-----
 * :py:class:`.PathCondition` now excludes paths correctly
 
 
@@ -46,7 +54,6 @@ Fixed
 
 Changed
 -------
-
 * Properties files now outputted with extra indentation for arrays
 
 
@@ -55,7 +62,6 @@ Changed
 
 Fixed
 -----
-
 * When selecting only a child contract with ``dbt-validate``,
   paths were not being set on parent contracts leading to overprocessing. Paths are now set correctly.
 
@@ -65,7 +71,6 @@ Fixed
 
 Fixed
 -----
-
 * Paths were not assigned to runner when passed via CLI. Now passed as expected.
 
 
@@ -74,7 +79,6 @@ Fixed
 
 Fixed
 -----
-
 * :py:class:`.HasAllColumns` was not logging the correct extra columns. This is now fixed.
 
 
@@ -83,7 +87,6 @@ Fixed
 
 Changed
 -------
-
 * Drop requirement for pre-release pydantic version
 
 
@@ -92,7 +95,6 @@ Changed
 
 Fixed
 -----
-
 * CLI functions now set logging to INFO by default. Results can now be viewed in terminal output.
 
 
@@ -101,7 +103,6 @@ Fixed
 
 Fixed
 -----
-
 * Fixed the hooks IDs and added generate hook