dbt-common 1.7.0__py3-none-any.whl → 1.9.0__py3-none-any.whl

dbt_common/contracts/config/base.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 from dataclasses import dataclass, Field
 
 from itertools import chain
-from typing import Callable, Dict, Any, List, TypeVar, Type
+from typing import Any, Callable, Dict, Iterator, List, Type, TypeVar
 
 from dbt_common.contracts.config.metadata import Metadata
 from dbt_common.exceptions import CompilationError, DbtInternalError
@@ -17,11 +17,11 @@ T = TypeVar("T", bound="BaseConfig")
 @dataclass
 class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
     # enable syntax like: config['key']
-    def __getitem__(self, key):
+    def __getitem__(self, key: str) -> Any:
         return self.get(key)
 
     # like doing 'get' on a dictionary
-    def get(self, key, default=None):
+    def get(self, key: str, default: Any = None) -> Any:
         if hasattr(self, key):
             return getattr(self, key)
         elif key in self._extra:
@@ -30,13 +30,13 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
             return default
 
     # enable syntax like: config['key'] = value
-    def __setitem__(self, key, value):
+    def __setitem__(self, key: str, value) -> None:
         if hasattr(self, key):
             setattr(self, key, value)
         else:
             self._extra[key] = value
 
-    def __delitem__(self, key):
+    def __delitem__(self, key: str) -> None:
         if hasattr(self, key):
             msg = (
                 'Error, tried to delete config key "{}": Cannot delete ' "built-in keys"
@@ -45,7 +45,7 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
         else:
             del self._extra[key]
 
-    def _content_iterator(self, include_condition: Callable[[Field], bool]):
+    def _content_iterator(self, include_condition: Callable[[Field[Any]], bool]) -> Iterator[str]:
         seen = set()
         for fld, _ in self._get_fields():
             seen.add(fld.name)
@@ -57,10 +57,10 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
                 seen.add(key)
                 yield key
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         yield from self._content_iterator(include_condition=lambda f: True)
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self._get_fields()) + len(self._extra)
 
     @staticmethod
@@ -76,7 +76,7 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
         elif key in unrendered and key not in other:
             return False
         else:
-            return unrendered[key] == other[key]
+            return bool(unrendered[key] == other[key])
 
     @classmethod
     def same_contents(cls, unrendered: Dict[str, Any], other: Dict[str, Any]) -> bool:
@@ -96,10 +96,14 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
                     return False
         return True
 
-    # This is used in 'add_config_call' to create the combined config_call_dict.
-    # 'meta' moved here from node
+    # This is used in 'merge_config_dicts' to create the combined orig_dict.
+    # Note: "clobber" fields aren't defined, because that's the default.
+    #    "access" is currently the only Clobber field.
+    # This shouldn't really be defined  here. It would be better to have it
+    # associated with the config definitions, but at the point we use it, we
+    # don't know which config we're dealing with.
     mergebehavior = {
-        "append": ["pre-hook", "pre_hook", "post-hook", "post_hook", "tags"],
+        "append": ["pre-hook", "pre_hook", "post-hook", "post_hook", "tags", "packages"],
         "update": [
             "quoting",
             "column_types",
@@ -108,6 +112,7 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
             "contract",
         ],
         "dict_key_append": ["grants"],
+        "object": ["snapshot_meta_column_names"],
     }
 
     @classmethod
@@ -180,6 +185,7 @@ class MergeBehavior(Metadata):
     Update = 2
     Clobber = 3
     DictKeyAppend = 4
+    Object = 5
 
     @classmethod
     def default_field(cls) -> "MergeBehavior":
@@ -203,11 +209,11 @@ class CompareBehavior(Metadata):
         return "compare"
 
     @classmethod
-    def should_include(cls, fld: Field) -> bool:
+    def should_include(cls, fld: Field[Any]) -> bool:
         return cls.from_field(fld) == cls.Include
 
 
-def _listify(value: Any) -> List:
+def _listify(value: Any) -> List[Any]:
     if isinstance(value, list):
         return value[:]
     else:
@@ -215,17 +221,20 @@ def _listify(value: Any) -> List:
 
 
 # There are two versions of this code. The one here is for config
-# objects, the one in _add_config_call in core context_config.py is for
-# config_call_dict dictionaries.
+# objects which can get the "MergeBehavior" from the field in the class,
+# the one below in 'merge_config_dicts' (formerly in
+# _add_config_call in core context_config.py) is for config_call dictionaries
+# where we need to get the MergeBehavior from someplace else.
 def _merge_field_value(
     merge_behavior: MergeBehavior,
     self_value: Any,
     other_value: Any,
-):
+) -> Any:
     if merge_behavior == MergeBehavior.Clobber:
         return other_value
     elif merge_behavior == MergeBehavior.Append:
-        return _listify(self_value) + _listify(other_value)
+        new_value = _listify(self_value) + _listify(other_value)
+        return new_value
     elif merge_behavior == MergeBehavior.Update:
         if not isinstance(self_value, dict):
             raise DbtInternalError(f"expected dict, got {self_value}")
@@ -258,6 +267,73 @@ def _merge_field_value(
                 # clobber the list
                 new_dict[new_key] = _listify(other_value[key])
         return new_dict
-
+    elif merge_behavior == MergeBehavior.Object:
+        # All fields in classes with MergeBehavior.Object should have a default of None
+        if not type(self_value).__name__ == type(other_value).__name__:
+            raise DbtInternalError(
+                f"got conflicting types: {type(self_value).__name__} and {type(other_value).__name__}"
+            )
+        new_value = self_value.copy()
+        new_value.update(other_value)
+        return new_value
     else:
         raise DbtInternalError(f"Got an invalid merge_behavior: {merge_behavior}")
+
+
+# This is used in ContextConfig._add_config_call. It updates the orig_dict in place.
+def merge_config_dicts(orig_dict: Dict[str, Any], new_dict: Dict[str, Any]) -> None:
+    # orig_dict is already encountered configs, new_dict is new
+    # This mirrors code in _merge_field_value in model_config.py which is similar but
+    # operates on config objects.
+    if orig_dict == {}:
+        orig_dict.update(new_dict)
+        return
+    for k, v in new_dict.items():
+        # MergeBehavior for post-hook and pre-hook is to collect all
+        # values, instead of overwriting
+        if k in BaseConfig.mergebehavior["append"]:
+            if k in orig_dict:  # should always be a list here
+                orig_dict[k] = _listify(orig_dict[k]) + _listify(v)
+            else:
+                orig_dict[k] = _listify(v)
+        elif k in BaseConfig.mergebehavior["update"]:
+            if not isinstance(v, dict):
+                raise DbtInternalError(f"expected dict, got {v}")
+            if k in orig_dict and isinstance(orig_dict[k], dict):
+                orig_dict[k].update(v)
+            else:
+                orig_dict[k] = v
+        elif k in BaseConfig.mergebehavior["dict_key_append"]:
+            if not isinstance(v, dict):
+                raise DbtInternalError(f"expected dict, got {v}")
+            if k in orig_dict:  # should always be a dict
+                for key in orig_dict[k].keys():
+                    orig_dict[k][key] = _listify(orig_dict[k][key])
+                for key, value in v.items():
+                    extend = False
+                    # This might start with a +, to indicate we should extend the list
+                    # instead of just clobbering it. We don't want to remove the + here
+                    # (like in the other method) because we want it preserved
+                    if key.startswith("+"):
+                        extend = True
+                    if key in orig_dict[k] and extend:
+                        # extend the list
+                        orig_dict[k][key].extend(_listify(value))
+                    else:
+                        # clobber the list
+                        orig_dict[k][key] = _listify(value)
+            else:
+                # This is always a dictionary
+                orig_dict[k] = v
+                # listify everything
+                for key, value in orig_dict[k].items():
+                    orig_dict[k][key] = _listify(value)
+        elif k in BaseConfig.mergebehavior["object"]:
+            if not isinstance(v, dict):
+                raise DbtInternalError(f"expected dict, got {v}")
+            if k not in orig_dict:
+                orig_dict[k] = {}
+            for obj_k, obj_v in v.items():
+                orig_dict[k][obj_k] = obj_v
+        else:  # Clobber
+            orig_dict[k] = v

dbt_common/contracts/util.py

@@ -1,21 +1,27 @@
 import dataclasses
+from typing import Any, TypeVar
+
+_R = TypeVar("_R", bound="Replaceable")
 
 
 # TODO: remove from dbt_common.contracts.util:: Replaceable + references
 class Replaceable:
-    def replace(self, **kwargs):
-        return dataclasses.replace(self, **kwargs)
+    def replace(self: _R, **kwargs: Any) -> _R:
+        return dataclasses.replace(self, **kwargs)  # type: ignore
+
+
+_M = TypeVar("_M", bound="Mergeable")
 
 
 class Mergeable(Replaceable):
-    def merged(self, *args):
+    def merged(self: _M, *args: Any) -> _M:
         """Perform a shallow merge, where the last non-None write wins. This is
         intended to merge dataclasses that are a collection of optional values.
         """
         replacements = {}
         cls = type(self)
         for arg in args:
-            for field in dataclasses.fields(cls):
+            for field in dataclasses.fields(cls):  # type: ignore
                 value = getattr(arg, field.name)
                 if value is not None:
                     replacements[field.name] = value

dbt_common/dataclass_schema.py

@@ -1,4 +1,4 @@
-from typing import Any, cast, ClassVar, Dict, get_type_hints, List, Optional, Tuple
+from typing import Any, ClassVar, Dict, get_type_hints, List, Optional, Tuple, Union
 import re
 import jsonschema
 from dataclasses import fields, Field
@@ -6,7 +6,6 @@ from enum import Enum
 from datetime import datetime
 from dateutil.parser import parse
 
-# type: ignore
 from mashumaro.config import (
     TO_DICT_ADD_OMIT_NONE_FLAG,
     ADD_SERIALIZATION_CONTEXT,
@@ -33,8 +32,8 @@ class DateTimeSerialization(SerializationStrategy):
             out += "Z"
         return out
 
-    def deserialize(self, value) -> datetime:
-        return value if isinstance(value, datetime) else parse(cast(str, value))
+    def deserialize(self, value: Union[datetime, str]) -> datetime:
+        return value if isinstance(value, datetime) else parse(value)
 
 
 class dbtMashConfig(MashBaseConfig):
@@ -92,7 +91,7 @@ class dbtClassMixin(DataClassMessagePackMixin):
         return json_schema
 
     @classmethod
-    def validate(cls, data):
+    def validate(cls, data: Any) -> None:
         json_schema = cls.json_schema()
         validator = jsonschema.Draft7Validator(json_schema)
         error = next(iter(validator.iter_errors(data)), None)

dbt_common/events/contextvars.py

@@ -22,7 +22,7 @@ def get_contextvars(prefix: str) -> Dict[str, Any]:
     return rv
 
 
-def get_node_info():
+def get_node_info() -> Dict[str, Any]:
     cvars = get_contextvars(LOG_PREFIX)
     if "node_info" in cvars:
         return cvars["node_info"]

dbt_common/events/types.proto

@@ -23,6 +23,21 @@ message GenericMessage {
     EventInfo info = 1;
 }
 
+// D - Deprecations
+
+// D018
+message BehaviorChangeEvent {
+    string flag_name = 1;
+    string flag_source = 2;
+    string description = 3;
+    string docs_url = 4;
+}
+
+message BehaviorChangeEventMsg {
+    EventInfo info = 1;
+    BehaviorChangeEvent data = 2;
+}
+
 // M - Deps generation
 
 // M020

dbt_common/events/types.py

@@ -1,7 +1,9 @@
 from dbt_common.events.base_types import (
     DebugLevel,
     InfoLevel,
+    WarnLevel,
 )
+from dbt_common.ui import warning_tag
 
 
 # The classes in this file represent the data necessary to describe a
@@ -28,6 +30,24 @@ from dbt_common.events.base_types import (
 #
 # The basic idea is that event codes roughly translate to the natural order of running a dbt task
 
+
+# =======================================================
+# D - Deprecations
+# =======================================================
+
+
+class BehaviorChangeEvent(WarnLevel):
+    def code(self) -> str:
+        return "D018"
+
+    def message(self) -> str:
+        return warning_tag(
+            f"{self.description}\n"
+            f"You may opt into the new behavior sooner by setting `flags.{self.flag_name}` to `True` in `dbt_project.yml`.\n"
+            f"Visit {self.docs_url} for more information."
+        )
+
+
 # =======================================================
 # M - Deps generation
 # =======================================================

dbt_common/events/types_pb2.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: types.proto
-# Protobuf Python Version: 5.26.1
+# Protobuf Python Version: 4.25.2
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -15,14 +15,14 @@ _sym_db = _symbol_database.Default()
 from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0btypes.proto\x12\x0bproto_types\x1a\x1fgoogle/protobuf/timestamp.proto\"\x91\x02\n\tEventInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04\x63ode\x18\x02 \x01(\t\x12\x0b\n\x03msg\x18\x03 \x01(\t\x12\r\n\x05level\x18\x04 \x01(\t\x12\x15\n\rinvocation_id\x18\x05 \x01(\t\x12\x0b\n\x03pid\x18\x06 \x01(\x05\x12\x0e\n\x06thread\x18\x07 \x01(\t\x12&\n\x02ts\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x30\n\x05\x65xtra\x18\t \x03(\x0b\x32!.proto_types.EventInfo.ExtraEntry\x12\x10\n\x08\x63\x61tegory\x18\n \x01(\t\x1a,\n\nExtraEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"6\n\x0eGenericMessage\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\"1\n\x11RetryExternalCall\x12\x0f\n\x07\x61ttempt\x18\x01 \x01(\x05\x12\x0b\n\x03max\x18\x02 \x01(\x05\"j\n\x14RetryExternalCallMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12,\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1e.proto_types.RetryExternalCall\"#\n\x14RecordRetryException\x12\x0b\n\x03\x65xc\x18\x01 \x01(\t\"p\n\x17RecordRetryExceptionMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12/\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32!.proto_types.RecordRetryException\"@\n\x13SystemCouldNotWrite\x12\x0c\n\x04path\x18\x01 \x01(\t\x12\x0e\n\x06reason\x18\x02 \x01(\t\x12\x0b\n\x03\x65xc\x18\x03 \x01(\t\"n\n\x16SystemCouldNotWriteMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12.\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32 .proto_types.SystemCouldNotWrite\"!\n\x12SystemExecutingCmd\x12\x0b\n\x03\x63md\x18\x01 \x03(\t\"l\n\x15SystemExecutingCmdMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12-\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1f.proto_types.SystemExecutingCmd\"\x1c\n\x0cSystemStdOut\x12\x0c\n\x04\x62msg\x18\x01 \x01(\t\"`\n\x0fSystemStdOutMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\'\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x19.proto_types.SystemStdOut\"\x1c\n\x0cSystemStdErr\x12\x0c\n\x04\x62msg\x18\x01 \x01(\t\"`\n\x0fSystemStdErrMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\'\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x19.proto_types.SystemStdErr\",\n\x16SystemReportReturnCode\x12\x12\n\nreturncode\x18\x01 \x01(\x05\"t\n\x19SystemReportReturnCodeMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\x31\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32#.proto_types.SystemReportReturnCode\"\x19\n\nFormatting\x12\x0b\n\x03msg\x18\x01 \x01(\t\"\\\n\rFormattingMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12%\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x17.proto_types.Formatting\"\x13\n\x04Note\x12\x0b\n\x03msg\x18\x01 \x01(\t\"P\n\x07NoteMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\x1f\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x11.proto_types.Note\"\x19\n\nPrintEvent\x12\x0b\n\x03msg\x18\x01 \x01(\t\"\\\n\rPrintEventMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12%\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x17.proto_types.PrintEventb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0btypes.proto\x12\x0bproto_types\x1a\x1fgoogle/protobuf/timestamp.proto\"\x91\x02\n\tEventInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04\x63ode\x18\x02 \x01(\t\x12\x0b\n\x03msg\x18\x03 \x01(\t\x12\r\n\x05level\x18\x04 \x01(\t\x12\x15\n\rinvocation_id\x18\x05 \x01(\t\x12\x0b\n\x03pid\x18\x06 \x01(\x05\x12\x0e\n\x06thread\x18\x07 \x01(\t\x12&\n\x02ts\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x30\n\x05\x65xtra\x18\t \x03(\x0b\x32!.proto_types.EventInfo.ExtraEntry\x12\x10\n\x08\x63\x61tegory\x18\n \x01(\t\x1a,\n\nExtraEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"6\n\x0eGenericMessage\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\"d\n\x13\x42\x65haviorChangeEvent\x12\x11\n\tflag_name\x18\x01 \x01(\t\x12\x13\n\x0b\x66lag_source\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x10\n\x08\x64ocs_url\x18\x04 \x01(\t\"n\n\x16\x42\x65haviorChangeEventMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12.\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32 .proto_types.BehaviorChangeEvent\"1\n\x11RetryExternalCall\x12\x0f\n\x07\x61ttempt\x18\x01 \x01(\x05\x12\x0b\n\x03max\x18\x02 \x01(\x05\"j\n\x14RetryExternalCallMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12,\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1e.proto_types.RetryExternalCall\"#\n\x14RecordRetryException\x12\x0b\n\x03\x65xc\x18\x01 \x01(\t\"p\n\x17RecordRetryExceptionMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12/\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32!.proto_types.RecordRetryException\"@\n\x13SystemCouldNotWrite\x12\x0c\n\x04path\x18\x01 \x01(\t\x12\x0e\n\x06reason\x18\x02 \x01(\t\x12\x0b\n\x03\x65xc\x18\x03 \x01(\t\"n\n\x16SystemCouldNotWriteMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12.\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32 .proto_types.SystemCouldNotWrite\"!\n\x12SystemExecutingCmd\x12\x0b\n\x03\x63md\x18\x01 \x03(\t\"l\n\x15SystemExecutingCmdMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12-\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1f.proto_types.SystemExecutingCmd\"\x1c\n\x0cSystemStdOut\x12\x0c\n\x04\x62msg\x18\x01 \x01(\t\"`\n\x0fSystemStdOutMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\'\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x19.proto_types.SystemStdOut\"\x1c\n\x0cSystemStdErr\x12\x0c\n\x04\x62msg\x18\x01 \x01(\t\"`\n\x0fSystemStdErrMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\'\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x19.proto_types.SystemStdErr\",\n\x16SystemReportReturnCode\x12\x12\n\nreturncode\x18\x01 \x01(\x05\"t\n\x19SystemReportReturnCodeMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\x31\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32#.proto_types.SystemReportReturnCode\"\x19\n\nFormatting\x12\x0b\n\x03msg\x18\x01 \x01(\t\"\\\n\rFormattingMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12%\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x17.proto_types.Formatting\"\x13\n\x04Note\x12\x0b\n\x03msg\x18\x01 \x01(\t\"P\n\x07NoteMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12\x1f\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x11.proto_types.Note\"\x19\n\nPrintEvent\x12\x0b\n\x03msg\x18\x01 \x01(\t\"\\\n\rPrintEventMsg\x12$\n\x04info\x18\x01 \x01(\x0b\x32\x16.proto_types.EventInfo\x12%\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x17.proto_types.PrintEventb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'types_pb2', _globals)
-if not _descriptor._USE_C_DESCRIPTORS:
-  DESCRIPTOR._loaded_options = None
-  _globals['_EVENTINFO_EXTRAENTRY']._loaded_options = None
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_EVENTINFO_EXTRAENTRY']._options = None
   _globals['_EVENTINFO_EXTRAENTRY']._serialized_options = b'8\001'
   _globals['_EVENTINFO']._serialized_start=62
   _globals['_EVENTINFO']._serialized_end=335
@@ -30,44 +30,48 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_EVENTINFO_EXTRAENTRY']._serialized_end=335
   _globals['_GENERICMESSAGE']._serialized_start=337
   _globals['_GENERICMESSAGE']._serialized_end=391
-  _globals['_RETRYEXTERNALCALL']._serialized_start=393
-  _globals['_RETRYEXTERNALCALL']._serialized_end=442
-  _globals['_RETRYEXTERNALCALLMSG']._serialized_start=444
-  _globals['_RETRYEXTERNALCALLMSG']._serialized_end=550
-  _globals['_RECORDRETRYEXCEPTION']._serialized_start=552
-  _globals['_RECORDRETRYEXCEPTION']._serialized_end=587
-  _globals['_RECORDRETRYEXCEPTIONMSG']._serialized_start=589
-  _globals['_RECORDRETRYEXCEPTIONMSG']._serialized_end=701
-  _globals['_SYSTEMCOULDNOTWRITE']._serialized_start=703
-  _globals['_SYSTEMCOULDNOTWRITE']._serialized_end=767
-  _globals['_SYSTEMCOULDNOTWRITEMSG']._serialized_start=769
-  _globals['_SYSTEMCOULDNOTWRITEMSG']._serialized_end=879
-  _globals['_SYSTEMEXECUTINGCMD']._serialized_start=881
-  _globals['_SYSTEMEXECUTINGCMD']._serialized_end=914
-  _globals['_SYSTEMEXECUTINGCMDMSG']._serialized_start=916
-  _globals['_SYSTEMEXECUTINGCMDMSG']._serialized_end=1024
-  _globals['_SYSTEMSTDOUT']._serialized_start=1026
-  _globals['_SYSTEMSTDOUT']._serialized_end=1054
-  _globals['_SYSTEMSTDOUTMSG']._serialized_start=1056
-  _globals['_SYSTEMSTDOUTMSG']._serialized_end=1152
-  _globals['_SYSTEMSTDERR']._serialized_start=1154
-  _globals['_SYSTEMSTDERR']._serialized_end=1182
-  _globals['_SYSTEMSTDERRMSG']._serialized_start=1184
-  _globals['_SYSTEMSTDERRMSG']._serialized_end=1280
-  _globals['_SYSTEMREPORTRETURNCODE']._serialized_start=1282
-  _globals['_SYSTEMREPORTRETURNCODE']._serialized_end=1326
-  _globals['_SYSTEMREPORTRETURNCODEMSG']._serialized_start=1328
-  _globals['_SYSTEMREPORTRETURNCODEMSG']._serialized_end=1444
-  _globals['_FORMATTING']._serialized_start=1446
-  _globals['_FORMATTING']._serialized_end=1471
-  _globals['_FORMATTINGMSG']._serialized_start=1473
-  _globals['_FORMATTINGMSG']._serialized_end=1565
-  _globals['_NOTE']._serialized_start=1567
-  _globals['_NOTE']._serialized_end=1586
-  _globals['_NOTEMSG']._serialized_start=1588
-  _globals['_NOTEMSG']._serialized_end=1668
-  _globals['_PRINTEVENT']._serialized_start=1670
-  _globals['_PRINTEVENT']._serialized_end=1695
-  _globals['_PRINTEVENTMSG']._serialized_start=1697
-  _globals['_PRINTEVENTMSG']._serialized_end=1789
+  _globals['_BEHAVIORCHANGEEVENT']._serialized_start=393
+  _globals['_BEHAVIORCHANGEEVENT']._serialized_end=493
+  _globals['_BEHAVIORCHANGEEVENTMSG']._serialized_start=495
+  _globals['_BEHAVIORCHANGEEVENTMSG']._serialized_end=605
+  _globals['_RETRYEXTERNALCALL']._serialized_start=607
+  _globals['_RETRYEXTERNALCALL']._serialized_end=656
+  _globals['_RETRYEXTERNALCALLMSG']._serialized_start=658
+  _globals['_RETRYEXTERNALCALLMSG']._serialized_end=764
+  _globals['_RECORDRETRYEXCEPTION']._serialized_start=766
+  _globals['_RECORDRETRYEXCEPTION']._serialized_end=801
+  _globals['_RECORDRETRYEXCEPTIONMSG']._serialized_start=803
+  _globals['_RECORDRETRYEXCEPTIONMSG']._serialized_end=915
+  _globals['_SYSTEMCOULDNOTWRITE']._serialized_start=917
+  _globals['_SYSTEMCOULDNOTWRITE']._serialized_end=981
+  _globals['_SYSTEMCOULDNOTWRITEMSG']._serialized_start=983
+  _globals['_SYSTEMCOULDNOTWRITEMSG']._serialized_end=1093
+  _globals['_SYSTEMEXECUTINGCMD']._serialized_start=1095
+  _globals['_SYSTEMEXECUTINGCMD']._serialized_end=1128
+  _globals['_SYSTEMEXECUTINGCMDMSG']._serialized_start=1130
+  _globals['_SYSTEMEXECUTINGCMDMSG']._serialized_end=1238
+  _globals['_SYSTEMSTDOUT']._serialized_start=1240
+  _globals['_SYSTEMSTDOUT']._serialized_end=1268
+  _globals['_SYSTEMSTDOUTMSG']._serialized_start=1270
+  _globals['_SYSTEMSTDOUTMSG']._serialized_end=1366
+  _globals['_SYSTEMSTDERR']._serialized_start=1368
+  _globals['_SYSTEMSTDERR']._serialized_end=1396
+  _globals['_SYSTEMSTDERRMSG']._serialized_start=1398
+  _globals['_SYSTEMSTDERRMSG']._serialized_end=1494
+  _globals['_SYSTEMREPORTRETURNCODE']._serialized_start=1496
+  _globals['_SYSTEMREPORTRETURNCODE']._serialized_end=1540
+  _globals['_SYSTEMREPORTRETURNCODEMSG']._serialized_start=1542
+  _globals['_SYSTEMREPORTRETURNCODEMSG']._serialized_end=1658
+  _globals['_FORMATTING']._serialized_start=1660
+  _globals['_FORMATTING']._serialized_end=1685
+  _globals['_FORMATTINGMSG']._serialized_start=1687
+  _globals['_FORMATTINGMSG']._serialized_end=1779
+  _globals['_NOTE']._serialized_start=1781
+  _globals['_NOTE']._serialized_end=1800
+  _globals['_NOTEMSG']._serialized_start=1802
+  _globals['_NOTEMSG']._serialized_end=1882
+  _globals['_PRINTEVENT']._serialized_start=1884
+  _globals['_PRINTEVENT']._serialized_end=1909
+  _globals['_PRINTEVENTMSG']._serialized_start=1911
+  _globals['_PRINTEVENTMSG']._serialized_end=2003
 # @@protoc_insertion_point(module_scope)

dbt_common/exceptions/base.py

@@ -1,5 +1,5 @@
 import builtins
-from typing import Any, List, Optional
+from typing import Any, Dict, List, Optional
 import os
 
 from dbt_common.constants import SECRET_ENV_PREFIX
@@ -23,7 +23,7 @@ class DbtBaseException(Exception):
     CODE = -32000
     MESSAGE = "Server Error"
 
-    def data(self):
+    def data(self) -> Dict[str, Any]:
         # if overriding, make sure the result is json-serializable.
         return {
             "type": self.__class__.__name__,
@@ -32,7 +32,7 @@ class DbtBaseException(Exception):
 
 
 class DbtInternalError(DbtBaseException):
-    def __init__(self, msg: str):
+    def __init__(self, msg: str) -> None:
         self.stack: List = []
         self.msg = scrub_secrets(msg, env_secrets())
 
@@ -40,7 +40,7 @@ class DbtInternalError(DbtBaseException):
     def type(self) -> str:
         return "Internal"
 
-    def process_stack(self):
+    def process_stack(self) -> List[str]:
         lines = []
         stack = self.stack
         first = True
@@ -81,7 +81,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
         self.node = node
         self.msg = scrub_secrets(msg, env_secrets())
 
-    def add_node(self, node=None):
+    def add_node(self, node=None) -> None:
         if node is not None and node is not self.node:
             if self.node is not None:
                 self.stack.append(self.node)
@@ -91,7 +91,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
     def type(self):
         return "Runtime"
 
-    def node_to_string(self, node: Any):
+    def node_to_string(self, node: Any) -> str:
         """Given a node-like object we attempt to create the best identifier we can."""
         result = ""
         if hasattr(node, "resource_type"):
@@ -103,7 +103,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
 
         return result.strip() if result != "" else "<Unknown>"
 
-    def process_stack(self):
+    def process_stack(self) -> List[str]:
         lines = []
         stack = self.stack + [self.node]
         first = True
@@ -122,7 +122,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
 
         return lines
 
-    def validator_error_message(self, exc: builtins.Exception):
+    def validator_error_message(self, exc: builtins.Exception) -> str:
         """Given a dbt.dataclass_schema.ValidationError return the relevant parts as a string.
 
         dbt.dataclass_schema.ValidationError is basically a jsonschema.ValidationError)
@@ -132,7 +132,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
         path = "[%s]" % "][".join(map(repr, exc.relative_path))
         return f"at path {path}: {exc.message}"
 
-    def __str__(self, prefix: str = "! "):
+    def __str__(self, prefix: str = "! ") -> str:
         node_string = ""
 
         if self.node is not None:
@@ -149,7 +149,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
 
         return lines[0] + "\n" + "\n".join(["  " + line for line in lines[1:]])
 
-    def data(self):
+    def data(self) -> Dict[str, Any]:
         result = DbtBaseException.data(self)
         if self.node is None:
             return result
@@ -236,7 +236,7 @@ class DbtDatabaseError(DbtRuntimeError):
     CODE = 10003
     MESSAGE = "Database Error"
 
-    def process_stack(self):
+    def process_stack(self) -> List[str]:
         lines = []
 
         if hasattr(self.node, "build_path") and self.node.build_path:
@@ -250,7 +250,7 @@ class DbtDatabaseError(DbtRuntimeError):
 
 
 class UnexpectedNullError(DbtDatabaseError):
-    def __init__(self, field_name: str, source):
+    def __init__(self, field_name: str, source) -> None:
         self.field_name = field_name
         self.source = source
         msg = (
@@ -268,7 +268,7 @@ class CommandError(DbtRuntimeError):
         self.cmd = cmd_scrubbed
         self.args = (cwd, cmd_scrubbed, msg)
 
-    def __str__(self):
+    def __str__(self, prefix: str = "! ") -> str:
         if len(self.cmd) == 0:
             return f"{self.msg}: No arguments given"
         return f'{self.msg}: "{self.cmd[0]}"'

dbt_common/exceptions/jinja.py

@@ -1,8 +1,13 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from dbt_common.clients._jinja_blocks import Tag, TagIterator
+
 from dbt_common.exceptions import CompilationError
 
 
 class BlockDefinitionNotAtTopError(CompilationError):
-    def __init__(self, tag_parser, tag_start) -> None:
+    def __init__(self, tag_parser: "TagIterator", tag_start: int) -> None:
         self.tag_parser = tag_parser
         self.tag_start = tag_start
         super().__init__(msg=self.get_message())
@@ -31,7 +36,7 @@ class MissingCloseTagError(CompilationError):
 
 
 class MissingControlFlowStartTagError(CompilationError):
-    def __init__(self, tag, expected_tag: str, tag_parser) -> None:
+    def __init__(self, tag: "Tag", expected_tag: str, tag_parser: "TagIterator") -> None:
         self.tag = tag
         self.expected_tag = expected_tag
         self.tag_parser = tag_parser
@@ -47,7 +52,7 @@ class MissingControlFlowStartTagError(CompilationError):
 
 
 class NestedTagsError(CompilationError):
-    def __init__(self, outer, inner) -> None:
+    def __init__(self, outer: "Tag", inner: "Tag") -> None:
         self.outer = outer
         self.inner = inner
         super().__init__(msg=self.get_message())
@@ -62,7 +67,7 @@ class NestedTagsError(CompilationError):
 
 
 class UnexpectedControlFlowEndTagError(CompilationError):
-    def __init__(self, tag, expected_tag: str, tag_parser) -> None:
+    def __init__(self, tag: "Tag", expected_tag: str, tag_parser: "TagIterator") -> None:
         self.tag = tag
         self.expected_tag = expected_tag
         self.tag_parser = tag_parser

dbt_common/exceptions/system.py

@@ -26,7 +26,7 @@ class WorkingDirectoryError(CommandError):
     def __init__(self, cwd: str, cmd: List[str], msg: str) -> None:
         super().__init__(cwd, cmd, msg)
 
-    def __str__(self):
+    def __str__(self, prefix: str = "! ") -> str:
         return f'{self.msg}: "{self.cwd}"'
 
 
@@ -46,5 +46,5 @@ class CommandResultError(CommandError):
         self.stderr = scrub_secrets(stderr.decode("utf-8"), env_secrets())
         self.args = (cwd, self.cmd, returncode, self.stdout, self.stderr, msg)
 
-    def __str__(self):
+    def __str__(self, prefix: str = "! ") -> str:
         return f"{self.msg} running: {self.cmd}"

dbt_common/invocation.py

@@ -7,6 +7,6 @@ def get_invocation_id() -> str:
     return _INVOCATION_ID
 
 
-def reset_invocation_id():
+def reset_invocation_id() -> None:
     global _INVOCATION_ID
     _INVOCATION_ID = str(uuid.uuid4())