dbt-common 1.23.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

dbt_common/__about__.py

@@ -1 +1 @@
-version = "1.23.0"
+version = "2.0.0"

dbt_common/events/README.md

@@ -8,14 +8,7 @@ The event module provides types that represent what is happening in dbt in `even
 When events are processed via `fire_event`, nearly everything is logged. Whether or not the user has enabled the debug flag, all debug messages are still logged to the file. However, some events are particularly time consuming to construct because they return a huge amount of data. Today, the only messages in this category are cache events and are only logged if the `--log-cache-events` flag is on. This is important because these messages should not be created unless they are going to be logged, because they cause a noticable performance degredation. These events use a "fire_event_if" functions.
 
 # Adding a New Event
-* Add a new message in types.proto, and a second message with the same name + "Msg". The "Msg" message should have two fields, an "info" field of EventInfo, and a "data" field referring to the message name without "Msg"
-* run the protoc compiler to update types_pb2.py:   make proto_types
-* Add a wrapping class in dbt_common/event/types.py with a Level superclass  plus code and message methods
-* Add the class to tests/unit/test_events.py
-
-We have switched from using betterproto to using google protobuf, because of a lack of support for Struct fields in betterproto.
-
-The google protobuf interface is janky and very much non-Pythonic. The "generated" classes in types_pb2.py do not resemble regular Python classes. They do not have normal constructors; they can only be constructed empty. They can be "filled" by setting fields individually or using a json_format method like ParseDict.  We have wrapped the logging events with a class (in types.py) which allows using a constructor -- keywords only, no positional parameters. 
+All protos have been moved into the central protos repository. To edit an event proto, edit https://github.com/dbt-labs/proto-python-public or open an issue on that repository.
 
 ## Required for Every Event
 

dbt_common/events/base_types.py

@@ -1,17 +1,15 @@
-from enum import Enum
 import os
 import threading
+from enum import Enum
+from typing import Callable, Optional, Protocol
+
 from dbt_common.events import types_pb2
-from google.protobuf.json_format import ParseDict, MessageToDict, MessageToJson
+from google.protobuf.json_format import MessageToDict, MessageToJson, ParseDict
 from google.protobuf.message import Message
-from dbt_common.events.helpers import get_json_string_utcnow
-from typing import Callable, Optional
 
+from dbt_common.events.helpers import get_json_string_utcnow
 from dbt_common.invocation import get_invocation_id
 
-from typing import Protocol
-
-
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 # These base types define the _required structure_ for the concrete event #
 # types defined in types.py                                               #
@@ -66,8 +64,8 @@ class BaseEvent:
             self.pb_msg = ParseDict(kwargs, msg_cls())
         except Exception as exc:
             # Imports need to be here to avoid circular imports
-            from dbt_common.events.types import Note
             from dbt_common.events.functions import fire_event
+            from dbt_common.events.types import Note
 
             error_msg = f"[{class_name}]: Unable to parse logging event dictionary. {exc}. Dictionary: {kwargs}"
             # If we're testing throw an error so that we notice failures

dbt_common/events/event_manager.py

@@ -1,11 +1,11 @@
 import os
 import traceback
-from typing import Any, List, Optional, Protocol, Tuple
+from typing import Any, List, Optional, Protocol, Tuple, Union
 
 from dbt_common.events.base_types import BaseEvent, EventLevel, msg_from_base_event, TCallback
 from dbt_common.events.logger import LoggerConfig, _Logger, _TextLogger, _JsonLogger, LineFormat
 from dbt_common.exceptions.events import EventCompilationError
-from dbt_common.helper_types import WarnErrorOptions
+from dbt_common.helper_types import WarnErrorOptions, WarnErrorOptionsV2
 
 
 class EventManager:
@@ -13,7 +13,7 @@ class EventManager:
         self.loggers: List[_Logger] = []
         self.callbacks: List[TCallback] = []
         self._warn_error: Optional[bool] = None
-        self._warn_error_options: Optional[WarnErrorOptions] = None
+        self._warn_error_options: Optional[Union[WarnErrorOptions, WarnErrorOptionsV2]] = None
         self.require_warn_or_error_handling: bool = False
 
     @property
@@ -29,15 +29,21 @@ class EventManager:
         self._warn_error = warn_error
 
     @property
-    def warn_error_options(self) -> WarnErrorOptions:
+    def warn_error_options(self) -> Union[WarnErrorOptions, WarnErrorOptionsV2]:
+        # Technically this always returns a WarnErrorOptionsV2, but to remain backwards compatible
+        # with the protocol, we need to type the function as being able to return either.
+
         if self._warn_error_options is None:
             from dbt_common.events.functions import WARN_ERROR_OPTIONS
 
-            return WARN_ERROR_OPTIONS
-        return self._warn_error_options
+            return WARN_ERROR_OPTIONS._warn_error_options_v2
+
+        return self._warn_error_options._warn_error_options_v2
 
     @warn_error_options.setter
-    def warn_error_options(self, warn_error_options: WarnErrorOptions) -> None:
+    def warn_error_options(
+        self, warn_error_options: Union[WarnErrorOptions, WarnErrorOptionsV2]
+    ) -> None:
         self._warn_error_options = warn_error_options
 
     def fire_event(
@@ -52,7 +58,7 @@ class EventManager:
         if force_warn_or_error_handling or (
             self.require_warn_or_error_handling and msg.info.level == "warn"
         ):
-            if self.warn_error or self.warn_error_options.includes(e):
+            if self.warn_error or self.warn_error_options.errors(e):
                 # This has the potential to create an infinite loop if the handling of the raised
                 # EventCompilationError fires an event as a warning instead of an error.
                 raise EventCompilationError(e.message(), node)
@@ -95,7 +101,7 @@ class IEventManager(Protocol):
     callbacks: List[TCallback]
     loggers: List[_Logger]
     warn_error: bool
-    warn_error_options: WarnErrorOptions
+    warn_error_options: Union[WarnErrorOptions, WarnErrorOptionsV2]
     require_warn_or_error_handling: bool
 
     def fire_event(

dbt_common/events/functions.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 
 from dbt_common.events.event_manager_client import get_event_manager
-from dbt_common.helper_types import WarnErrorOptions
+from dbt_common.helper_types import WarnErrorOptions, WarnErrorOptionsV2
 from dbt_common.invocation import get_invocation_id
 from dbt_common.utils.encoding import ForgivingJSONEncoder
 from dbt_common.events.base_types import BaseEvent, EventLevel, EventMsg
@@ -18,7 +18,9 @@ from google.protobuf.json_format import MessageToDict
 LOG_VERSION = 3
 metadata_vars: Optional[Dict[str, str]] = None
 _METADATA_ENV_PREFIX = "DBT_ENV_CUSTOM_ENV_"
-WARN_ERROR_OPTIONS = WarnErrorOptions(include=[], exclude=[])
+WARN_ERROR_OPTIONS: Union[WarnErrorOptions, WarnErrorOptionsV2] = WarnErrorOptions(
+    include=[], exclude=[]
+)
 WARN_ERROR = False
 
 # This global, and the following two functions for capturing stdout logs are

dbt_common/events/types_pb2.py

@@ -1,91 +1,2 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# NO CHECKED-IN PROTOBUF GENCODE
-# source: types.proto
-# Protobuf Python Version: 5.28.3
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import runtime_version as _runtime_version
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-_runtime_version.ValidateProtobufRuntimeVersion(
-    _runtime_version.Domain.PUBLIC,
-    5,
-    28,
-    3,
-    '',
-    'types.proto'
-)
-# @@protoc_insertion_point(imports)
-
-_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\"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.PrintEvent\" \n\x11RecordReplayIssue\x12\x0b\n\x03msg\x18\x01 \x01(\t\"j\n\x14RecordReplayIssueMsg\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.RecordReplayIssueb\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
-  _globals['_EVENTINFO_EXTRAENTRY']._serialized_options = b'8\001'
-  _globals['_EVENTINFO']._serialized_start=62
-  _globals['_EVENTINFO']._serialized_end=335
-  _globals['_EVENTINFO_EXTRAENTRY']._serialized_start=291
-  _globals['_EVENTINFO_EXTRAENTRY']._serialized_end=335
-  _globals['_GENERICMESSAGE']._serialized_start=337
-  _globals['_GENERICMESSAGE']._serialized_end=391
-  _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
-  _globals['_RECORDREPLAYISSUE']._serialized_start=2005
-  _globals['_RECORDREPLAYISSUE']._serialized_end=2037
-  _globals['_RECORDREPLAYISSUEMSG']._serialized_start=2039
-  _globals['_RECORDREPLAYISSUEMSG']._serialized_end=2145
-# @@protoc_insertion_point(module_scope)
+# preserving import path during dbtlabs.proto refactor
+from dbtlabs.proto.public.v1.fields.common_types_pb2 import *  # noqa

dbt_common/helper_types.py

@@ -65,109 +65,169 @@ class IncludeExclude(dbtClassMixin):
 
 
 class WarnErrorOptions(IncludeExclude):
+    """Deprecated, use WarnErrorOptionsV2 instead."""
+
+    DEPRECATIONS = "Deprecations"
+
+    def __init__(
+        self,
+        include: Union[str, List[str]],
+        exclude: Optional[List[str]] = None,
+        valid_error_names: Optional[Set[str]] = None,
+        silence: Optional[List[str]] = None,
+    ):
+        self.silence = silence or []
+        self._valid_error_names: Set[str] = valid_error_names or set()
+        self._valid_error_names.add(self.DEPRECATIONS)
+        super().__init__(include=include, exclude=(exclude or []))
+
+        self._warn_error_options_v2 = WarnErrorOptionsV2(
+            error=self.include,
+            warn=self.exclude,
+            silence=self.silence,
+            valid_error_names=self._valid_error_names,
+        )
+
+    def __post_init__(self):
+        # We don't want IncludeExclude's post_init to run, so we override it.
+        # We are fine with just having the WarnErrorOptionsV2's post_init run on instantiation.
+        pass
+
+    def includes(self, item_name: Union[str, BaseEvent]) -> bool:
+        return self._warn_error_options_v2.includes(item_name)
+
+    def errors(self, item_name: Union[str, BaseEvent]) -> bool:
+        """Exists for forward compatibility with WarnErrorOptionsV2."""
+        return self._warn_error_options_v2.errors(item_name)
+
+    def silenced(self, item_name: Union[str, BaseEvent]) -> bool:
+        return self._warn_error_options_v2.silenced(item_name)
+
+
+@dataclass
+class WarnErrorOptionsV2(dbtClassMixin):
     """
     This class is used to configure the behavior of the warn_error feature (now part of fire_event).
 
-    include: "all", "*", or a list of event names.
-    exclude: a list of event names.
+    error: "all", "*", or a list of event names.
+    warn: a list of event names.
     silence: a list of event names.
-    valid_error_names: a set of event names that can be named in include, exclude, and silence.
+    valid_error_names: a set of event names that can be named in error, warn, and silence.
 
     In a hierarchy of configuration, the following rules apply:
     1. named > Deprecations > "all"/"*"
-    2. silence > exclude > include
+    2. silence > warn > error
     3. (1) > (2)
     """
 
+    ERROR_ALL = ("all", "*")
     DEPRECATIONS = "Deprecations"
 
+    error: Union[str, List[str]]
+    warn: List[str]
+    silence: List[str]
+
     def __init__(
         self,
-        include: Union[str, List[str]],
-        exclude: Optional[List[str]] = None,
-        valid_error_names: Optional[Set[str]] = None,
+        error: Optional[Union[str, List[str]]] = None,
+        warn: Optional[List[str]] = None,
         silence: Optional[List[str]] = None,
+        valid_error_names: Optional[Set[str]] = None,
     ):
-        self.silence = silence or []
         self._valid_error_names: Set[str] = valid_error_names or set()
         self._valid_error_names.add(self.DEPRECATIONS)
-        super().__init__(include=include, exclude=(exclude or []))
 
-    def __post_init__(self):
-        if isinstance(self.include, str) and self.include not in self.INCLUDE_ALL:
-            raise ValidationError(
-                f"include must be one of {self.INCLUDE_ALL} or a list of strings"
-            )
+        # We can't do `= error or []` because if someone passes in an empty list, and latter appends to that list
+        # they would expect references to the original list to be updated.
+        self.error = error if error is not None else []
+        self.warn = warn if warn is not None else []
+        self.silence = silence if silence is not None else []
 
-        # To specify exclude, either `include` must be "all" or "deprecations" must be
-        # in `include` or `silence`.
-        if self.exclude and not (
-            self.include in self.INCLUDE_ALL
-            or self.DEPRECATIONS in self.include
+        # since we're overriding the dataclass auto __init__, we need to call __post_init__ manually
+        self.__post_init__()
+
+    def __post_init__(self):
+        if isinstance(self.error, str) and self.error not in self.ERROR_ALL:
+            raise ValidationError(f"error must be one of {self.ERROR_ALL} or a list of strings")
+
+        # To specify `warn`, one of the following must be true
+        # 1. `error` must be "all"/"*"
+        # 2. "deprecations" must be in either `error` or `silence`.
+        if self.warn and not (
+            self.error in self.ERROR_ALL
+            or self.DEPRECATIONS in self.error
             or self.DEPRECATIONS in self.silence
         ):
             raise ValidationError(
-                f"exclude can only be specified if include is one of {self.INCLUDE_ALL} or "
-                f"{self.DEPRECATIONS} is in include or silence."
+                f"`warn` can only be specified if `error` is one of {self.ERROR_ALL} or "
+                f"{self.DEPRECATIONS} is in `error` or silence."
             )
 
-        if isinstance(self.include, list):
-            self._validate_items(self.include)
+        if isinstance(self.error, list):
+            self._validate_items(self.error)
 
-        if isinstance(self.exclude, list):
-            self._validate_items(self.exclude)
+        if isinstance(self.warn, list):
+            self._validate_items(self.warn)
 
         if isinstance(self.silence, list):
             self._validate_items(self.silence)
 
-    def _includes_all(self) -> bool:
-        """Is `*` or `all` set as include?"""
-        return self.include in self.INCLUDE_ALL
+    def _validate_items(self, items: List[str]):
+        for item in items:
+            if item not in self._valid_error_names:
+                raise ValidationError(f"{item} is not a valid dbt error name.")
+
+    @property
+    def _warn_error_options_v2(self) -> WarnErrorOptionsV2:
+        # This is necessary because in core we directly set the WARN_ERROR_OPTIONS global variable
+        # without this we'd need to do isinstance checks in `EventManager.warn_error_options`, which
+        # would be costly as it gets called every time an event is fired.
+        return self
+
+    def _error_all(self) -> bool:
+        """Is `*` or `all` set as error?"""
+        return self.error in self.ERROR_ALL
 
-    def _named_inclusion(self, item_name: str) -> bool:
-        """Is the item_name named in the include list?"""
-        return item_name in self.include
+    def _named_error(self, item_name: str) -> bool:
+        """Is the item_name named in the error list?"""
+        return item_name in self.error
 
-    def _named_exclusion(self, item_name: str) -> bool:
-        """Is the item_name named in the exclude list?"""
-        return item_name in self.exclude
+    def _named_warn(self, item_name: str) -> bool:
+        """Is the item_name named in the warn list?"""
+        return item_name in self.warn
 
     def _named_silence(self, item_name: str) -> bool:
         """Is the item_name named in the silence list?"""
         return item_name in self.silence
 
-    def _include_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
-        """Is event included as a deprecation?"""
+    def _error_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
+        """Is the event a deprecation, and if so should it be treated as an error?"""
         return (
-            event is not None
-            and event.code().startswith("D")
-            and self.DEPRECATIONS in self.include
+            event is not None and event.code().startswith("D") and self.DEPRECATIONS in self.error
         )
 
-    def _exclude_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
-        """Is event excluded as a deprecation?"""
+    def _warn_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
+        """Is the event a deprecation, and if so should it be treated as an warning?"""
         return (
-            event is not None
-            and event.code().startswith("D")
-            and self.DEPRECATIONS in self.exclude
+            event is not None and event.code().startswith("D") and self.DEPRECATIONS in self.warn
         )
 
     def _silence_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
-        """Is event silenced as a deprecation?"""
+        """Is the event a deprecation, and if so should it be silenced?"""
         return (
             event is not None
             and event.code().startswith("D")
             and self.DEPRECATIONS in self.silence
         )
 
-    def includes(self, item_name: Union[str, BaseEvent]) -> bool:
-        """Is the event included?
+    def errors(self, item_name: Union[str, BaseEvent]) -> bool:
+        """Should the event be treated as an error?
 
-        An event included if any of the following are true:
-        - The event is named in `include` and not named in `exclude` or `silence`
-        - "*" or "all" is specified for `include`, and the event is not named in `exclude` or `silence`
-        - The event is a deprecation, "deprecations" is in `include`, and the event is not named in `exclude` or `silence`
-          nor is "deprecations" in `exclude` or `silence`
+        An event should error if any of the following are true:
+        - The event is named in `error` and not named in `warn` or `silence`
+        - "*" or "all" is specified for `error`, and the event is not named in `warn` or `silence`
+        - The event is a deprecation, "deprecations" is in `error`, and the event is not named in `warn` or `silence`
+          nor is "deprecations" in `warn` or `silence`
         """
         # Setup based on item_name type
         if isinstance(item_name, str):
@@ -178,29 +238,31 @@ class WarnErrorOptions(IncludeExclude):
             event = item_name
 
         # Pre-compute checks that will be used multiple times
-        named_elsewhere = self._named_exclusion(event_name) or self._named_silence(event_name)
-        deprecation_elsewhere = self._exclude_as_deprecation(
+        named_elsewhere = self._named_warn(event_name) or self._named_silence(event_name)
+        deprecation_elsewhere = self._warn_as_deprecation(event) or self._silence_as_deprecation(
             event
-        ) or self._silence_as_deprecation(event)
+        )
 
         # Calculate result
-        if self._named_inclusion(event_name) and not named_elsewhere:
+        if self._named_error(event_name) and not named_elsewhere:
             return True
-        elif self._include_as_deprecation(event) and not (
-            named_elsewhere or deprecation_elsewhere
-        ):
+        elif self._error_as_deprecation(event) and not (named_elsewhere or deprecation_elsewhere):
             return True
-        elif self._includes_all() and not (named_elsewhere or deprecation_elsewhere):
+        elif self._error_all() and not (named_elsewhere or deprecation_elsewhere):
             return True
         else:
             return False
 
+    def includes(self, item_name: Union[str, BaseEvent]) -> bool:
+        """Deprecated, use `errors` instead."""
+        return self.errors(item_name)
+
     def silenced(self, item_name: Union[str, BaseEvent]) -> bool:
         """Is the event silenced?
 
         An event silenced if any of the following are true:
         - The event is named in `silence`
-        - "Deprecations" is in `silence` and the event is not named in `include` or `exclude`
+        - "Deprecations" is in `silence` and the event is not named in `error` or `warn`
         """
         # Setup based on item_name type
         if isinstance(item_name, str):
@@ -211,7 +273,7 @@ class WarnErrorOptions(IncludeExclude):
             event = item_name
 
         # Pre-compute checks that will be used multiple times
-        named_elsewhere = self._named_inclusion(event_name) or self._named_exclusion(event_name)
+        named_elsewhere = self._named_error(event_name) or self._named_warn(event_name)
 
         # Calculate result
         if self._named_silence(event_name):
@@ -221,11 +283,6 @@ class WarnErrorOptions(IncludeExclude):
         else:
             return False
 
-    def _validate_items(self, items: List[str]):
-        for item in items:
-            if item not in self._valid_error_names:
-                raise ValidationError(f"{item} is not a valid dbt error name.")
-
 
 FQNPath = Tuple[str, ...]
 PathSet = AbstractSet[FQNPath]

dbt_common/ui.py

@@ -1,7 +1,7 @@
 from os import getenv as os_getenv
 import sys
 import textwrap
-from typing import Dict
+from typing import Dict, Optional
 
 import colorama
 
@@ -78,13 +78,19 @@ def line_wrap_message(msg: str, subtract: int = 0, dedent: bool = True, prefix:
     return "\n".join(textwrap.fill(chunk, width=width, break_on_hyphens=False) for chunk in chunks)
 
 
-def warning_tag(msg: str) -> str:
-    return f'[{yellow("WARNING")}]: {msg}'
+def warning_tag(msg: str, event_name: Optional[str] = None) -> str:
+    tag = f'[{yellow("WARNING")}]'
+    if event_name:
+        tag += f"[{event_name}]"
+    return f"{tag}: {msg}"
 
 
-def deprecation_tag(msg: str) -> str:
-    return warning_tag(f"Deprecated functionality\n\n{msg}")
+def deprecation_tag(msg: str, event_name: Optional[str] = None) -> str:
+    return warning_tag(f"Deprecated functionality\n\n{msg}", event_name)
 
 
-def error_tag(msg: str) -> str:
-    return f'[{red("ERROR")}]: {msg}'
+def error_tag(msg: str, event_name: Optional[str] = None) -> str:
+    tag = f'[{red("ERROR")}]'
+    if event_name:
+        tag += f"[{event_name}]"
+    return f"{tag}: {msg}"

{dbt_common-1.23.0.dist-info → dbt_common-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbt-common
-Version: 1.23.0
+Version: 2.0.0
 Summary: The shared common utilities that dbt-core and adapter implementations use
 Project-URL: Homepage, https://github.com/dbt-labs/dbt-common
 Project-URL: Repository, https://github.com/dbt-labs/dbt-common.git
@@ -26,6 +26,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9
 Requires-Dist: agate<1.10,>=1.7.0
 Requires-Dist: colorama<0.5,>=0.3.9
+Requires-Dist: dbt-protos<2.0.0,>=1.0.291
 Requires-Dist: deepdiff<8.0,>=7.0
 Requires-Dist: isodate<0.7,>=0.6
 Requires-Dist: jinja2<4,>=3.1.3

{dbt_common-1.23.0.dist-info → dbt_common-2.0.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
-dbt_common/__about__.py,sha256=aQAgejfvBJWgErscsekMI9-f-XZYA6Im-fYbFUo9xPI,19
+dbt_common/__about__.py,sha256=5ZOF-5IV4pxLAC7yWK2kh4cvLYgnT2AwvRq2FGzBL94,18
 dbt_common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/behavior_flags.py,sha256=hQzxCqQSweJbRp_xoQqNnlUF77PBuOdCdLOSdcBlkxk,4885
 dbt_common/constants.py,sha256=-Y5DIL1SDPQWtlCNizXRYxFgbx1D7LaLs1ysamvGMRk,278
 dbt_common/context.py,sha256=-ErtKG4xfOh1-Y569fwu6u2O381nRan18HhATrYDoZE,2950
 dbt_common/dataclass_schema.py,sha256=u2S0dxwxIghv8RMqC91HlWZJVxmsC_844yZQaGyOwdY,5563
-dbt_common/helper_types.py,sha256=v6ak-05SodNDxJM7BGXyCT4yPM-OUhcvznjemXRYT-g,9117
+dbt_common/helper_types.py,sha256=wxbbjfsvHVraWexK88PEY3q_dAYqlPl6yOIXnpxCcyY,11569
 dbt_common/invocation.py,sha256=xw0NBIE-6LHd135cx4non-MkGGsia0mYN0lMkmNEucE,435
 dbt_common/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/record.py,sha256=QLrKppBHYuV7ZTckOMi4Gnz7jLQJcOa5kp4PwK0JmwY,21889
 dbt_common/semver.py,sha256=Znewz6tc_NBpXr4mZf20bK_RayPL4ODrnxDbkUZrrRo,15034
 dbt_common/tests.py,sha256=6lC_JuRtoYO6cbAF8-R5aTM4HtQiM_EH8X5m_97duGY,315
-dbt_common/ui.py,sha256=rC-d4J3u0sBH_0L1AZdQ-mDxPrTDYecTFn65mNqQ-ig,2668
+dbt_common/ui.py,sha256=geIk3ElFj5y_SG5EDc6RMJFEvYGdo-6C21l0pB8I-EU,2934
 dbt_common/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/clients/_jinja_blocks.py,sha256=eUjZLBtLCASJRRj1G8b9u15A3PQMDCKvytIdWkTLSP4,15451
 dbt_common/clients/agate_helper.py,sha256=anKKgKV5PSnFRuFeBwRMdHK3JCaQoUqB2ZXHD0su0Wo,9123
@@ -25,21 +25,20 @@ dbt_common/contracts/config/base.py,sha256=vLkmnwWUGazIpUuUYqdnTrpBmFLJQ9hantsIv
 dbt_common/contracts/config/materialization.py,sha256=rahC72qZ0-jB8oPwxyPooZXc5NJ-smg74g2HnGOMj34,256
 dbt_common/contracts/config/metadata.py,sha256=X47-tEA8q2ZfSMcYv0godUwTSVjt8NI77tD4NqdgM0c,1877
 dbt_common/contracts/config/properties.py,sha256=gWt6xsP4rVOqRKhmagiUhWnDynzD9mykfMYMTviwpEU,2281
-dbt_common/events/README.md,sha256=CSwVajoxCAqOug2UCnXldH1EUK7Kjf3rcq7z9ACjrss,3023
+dbt_common/events/README.md,sha256=g-DyrZciHNTB3RrGqhEiw_HJJWBglsdEaXGThxD_lZE,2168
 dbt_common/events/__init__.py,sha256=av08vfpxo0ek7PqZNtMxY8FODJ3xwph4ehRxgInx4LA,383
-dbt_common/events/base_types.py,sha256=bdDMbawAV0FkxmvuxgsTev82vxTuyu6rJiSkvEQPsO8,5525
+dbt_common/events/base_types.py,sha256=d_qLgjQre5o_nIW4rkcODjZ21NEfgkUyvofUL9Y7xqg,5506
 dbt_common/events/contextvars.py,sha256=EIs1P6NrJzx_IAV17x5cVqOAS4Lqbu6oc0etHtWCJOo,3097
 dbt_common/events/event_handler.py,sha256=jfi0PyqIOGnXCG9HEa0VIVULqNvXs1RYmAg0b50ChQs,1385
-dbt_common/events/event_manager.py,sha256=ElltioymOwrDmSdYpiyTNPOEFIOWQMQ9b_hAARmf5aE,4528
+dbt_common/events/event_manager.py,sha256=9J-_UYsg3gic82yenrjubCqUq9Ju7xD084-hlbaPr8U,4912
 dbt_common/events/event_manager_client.py,sha256=5IVdIuRVi5xCNQGiZqXdywlED2kLj1W_Pj0lh2HiDiI,1115
 dbt_common/events/format.py,sha256=x1RWDZ8G7ZMHmxdld6Q4VXca4kvnhiQOIaQXkC6Uo0Q,1609
-dbt_common/events/functions.py,sha256=R3DuyNy2TqOwNyMACVOYtiG1NjZ9FQa6FWKkzMeMCBY,4767
+dbt_common/events/functions.py,sha256=2laadmQkHCUuEPHdWCJ2yIKlYSlEkpwD7A6iKKuQpJI,4838
 dbt_common/events/helpers.py,sha256=29FF0ZR24Zdvk23-bzIZKu8Pb4wFn-B1fFx28lLIpNw,450
 dbt_common/events/interfaces.py,sha256=hEDeDoB0FW2RYHVZBG7gebEt_mUVBzkn1yPubpaxs-s,147
 dbt_common/events/logger.py,sha256=siCM47WnjiA5wWoYzHDqe9mIr-b-XYNctP8r3o1zvSc,6800
-dbt_common/events/types.proto,sha256=ohV5f2KfhaM3NRWHFJBNJQtqP3Hie65smA0imlWNkHg,2425
 dbt_common/events/types.py,sha256=Xg2QBLTWSM_p2BP_Key_JcygmR1LyNYzQhKVYvZ9Zmc,4683
-dbt_common/events/types_pb2.py,sha256=fgIoTp7-0hy9FMM0tiJmzENupZH_Vl28Xz2IRvg2KGg,7862
+dbt_common/events/types_pb2.py,sha256=5-2q4Khin8YHzV6YA0PYo_UgRB9j_q7yRLe8LoR8reM,125
 dbt_common/exceptions/__init__.py,sha256=X_Uw7BxOzXev_9JMYfs5Cm-_i_Qf2PJim8_-dDJI7Y8,361
 dbt_common/exceptions/base.py,sha256=23ijq-AtQgUSvZ9JbrCIZ87Pbyn8iEYezX95IXAZ4FY,7783
 dbt_common/exceptions/cache.py,sha256=0z4fBcdNZMAR41YbPRo2GN0__xAMaYs8Uc-t3hjmVio,2532
@@ -57,7 +56,7 @@ dbt_common/utils/encoding.py,sha256=6_kSY2FvGNYMg7oX7PrbvVioieydih3Kl7Ii802LaHI,
 dbt_common/utils/executor.py,sha256=pNY0UbPlwQmTE69Vt_Rj91YGCIOEaqeYU3CjAds0T70,2454
 dbt_common/utils/formatting.py,sha256=JUn5rzJ-uajs9wPCN0-f2iRFY1pOJF5YjTD9dERuLoc,165
 dbt_common/utils/jinja.py,sha256=JXgNmJArGGy0h7qkbNLA3zaEQmoF1CxsNBYTlIwFXDw,1101
-dbt_common-1.23.0.dist-info/METADATA,sha256=ba64BsaO0C5gCGrnpfKQ8IOxJsgdoX6ZKFJc7w3REMU,4946
-dbt_common-1.23.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dbt_common-1.23.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dbt_common-1.23.0.dist-info/RECORD,,
+dbt_common-2.0.0.dist-info/METADATA,sha256=Q9L9WVUQ3uBubJ7JKJ4x3ahK-qG8aiR2Z0mQOiY2OM0,4987
+dbt_common-2.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbt_common-2.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dbt_common-2.0.0.dist-info/RECORD,,

dbt_common/events/types.proto

@@ -1,156 +0,0 @@
-syntax = "proto3";
-
-package proto_types;
-
-import "google/protobuf/timestamp.proto";
-
-// Common event info
-message EventInfo {
-    string name = 1;
-    string code = 2;
-    string msg = 3;
-    string level = 4;
-    string invocation_id = 5;
-    int32 pid = 6;
-    string thread = 7;
-    google.protobuf.Timestamp ts = 8;
-    map<string, string> extra = 9;
-    string category = 10;
-}
-
-// GenericMessage, used for deserializing only
-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
-message RetryExternalCall {
-    int32 attempt = 1;
-    int32 max = 2;
-}
-
-message RetryExternalCallMsg {
-    EventInfo info = 1;
-    RetryExternalCall data = 2;
-}
-
-// M021
-message RecordRetryException {
-    string exc = 1;
-}
-
-message RecordRetryExceptionMsg {
-    EventInfo info = 1;
-    RecordRetryException data = 2;
-}
-
-// Z - Misc
-
-// Z005
-message SystemCouldNotWrite {
-    string path = 1;
-    string reason = 2;
-    string exc = 3;
-}
-
-message SystemCouldNotWriteMsg {
-    EventInfo info = 1;
-    SystemCouldNotWrite data = 2;
-}
-
-// Z006
-message SystemExecutingCmd {
-    repeated string cmd = 1;
-}
-
-message SystemExecutingCmdMsg {
-    EventInfo info = 1;
-    SystemExecutingCmd data = 2;
-}
-
-// Z007
-message SystemStdOut{
-    string bmsg = 1;
-}
-
-message SystemStdOutMsg {
-    EventInfo info = 1;
-    SystemStdOut data = 2;
-}
-
-// Z008
-message SystemStdErr {
-    string bmsg = 1;
-}
-
-message SystemStdErrMsg {
-    EventInfo info = 1;
-    SystemStdErr data = 2;
-}
-
-// Z009
-message SystemReportReturnCode {
-    int32 returncode = 1;
-}
-
-message SystemReportReturnCodeMsg {
-    EventInfo info = 1;
-    SystemReportReturnCode data = 2;
-}
-
-// Z017
-message Formatting {
-    string msg = 1;
-}
-
-message FormattingMsg {
-    EventInfo info = 1;
-    Formatting data = 2;
-}
-
-// Z050
-message Note {
-    string msg = 1;
-}
-
-message NoteMsg {
-    EventInfo info = 1;
-    Note data = 2;
-}
-
-// Z052
-message PrintEvent {
-    string msg = 1;
-}
-
-message PrintEventMsg {
-    EventInfo info = 1;
-    PrintEvent data = 2;
-}
-
-// Z053
-message RecordReplayIssue {
-    string msg = 1;
-}
-
-message RecordReplayIssueMsg {
-    EventInfo info = 1;
-    RecordReplayIssue data = 2;
-}