dbt-common 1.16.0__tar.gz → 1.18__tar.gz

{dbt_common-1.16.0 → dbt_common-1.18}/CHANGELOG.md

@@ -5,13 +5,40 @@
 - "Breaking changes" listed under a version may require action from end users or external maintainers when upgrading to that version.
 - Do not edit this file directly. This file is auto-generated using [changie](https://github.com/miniscruff/changie). For details on how to document a change, see [the contributing guide](https://github.com/dbt-labs/dbt-common/blob/main/CONTRIBUTING.md#adding-changelog-entry)
 
-## dbt-common 1.16.0 - March 18, 2025
+## dbt-common 1.18 - April 14, 2025
 
 ### Features
 
-- Add sequence number to record/replay records and add new invocation context accessor ([#251](https://github.com/dbt-labs/dbt-common/issues/251))
+- Ability to specify 'Deprecations' in `WarnErrorOptions` ([#265](https://github.com/dbt-labs/dbt-common/issues/265))
+
+### Fixes
+
+- Replace depricated datetime.datetime.utcnow() for datetime.datetime.now(timezone.utc) to reduce stdout spam. ([#238](https://github.com/dbt-labs/dbt-common/issues/238), [#99](https://github.com/dbt-labs/dbt-common/issues/99))
+
+### Under the Hood
+
+- Add support for Python 3.13 ([#263](https://github.com/dbt-labs/dbt-common/issues/263))
+- Add new event to signal issues during record/replay ([#268](https://github.com/dbt-labs/dbt-common/issues/268))
+
+### Contributors
+- [@cfernhout](https://github.com/cfernhout) ([#238](https://github.com/dbt-labs/dbt-common/issues/238), [#99](https://github.com/dbt-labs/dbt-common/issues/99))
+
 
+## dbt-common 1.17.0 - March 31, 2025
 
+### Breaking Changes
+
+- Update `fire_event` to handle `warn_or_error` logic ([#236](https://github.com/dbt-labs/dbt-common/issues/236))
+
+### Under the Hood
+
+- Stream recorded events to disk rather than storing them in memory. ([#260](https://github.com/dbt-labs/dbt-common/issues/260))
+
+## dbt-common 1.16.0 - March 18, 2025
+
+### Features
+
+- Add sequence number to record/replay records and add new invocation context accessor ([#251](https://github.com/dbt-labs/dbt-common/issues/251))
 
 ## dbt-common 1.15.0 - February 14, 2025
 

{dbt_common-1.16.0 → dbt_common-1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbt-common
-Version: 1.16.0
+Version: 1.18
 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
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9

dbt_common-1.18/dbt_common/__about__.py

@@ -0,0 +1 @@
+version = "1.18"

dbt_common-1.18/dbt_common/events/event_manager.py

@@ -0,0 +1,138 @@
+import os
+import traceback
+from typing import Any, List, Optional, Protocol, Tuple
+
+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
+
+
+class EventManager:
+    def __init__(self) -> None:
+        self.loggers: List[_Logger] = []
+        self.callbacks: List[TCallback] = []
+        self._warn_error: Optional[bool] = None
+        self._warn_error_options: Optional[WarnErrorOptions] = None
+        self.require_warn_or_error_handling: bool = False
+
+    @property
+    def warn_error(self) -> bool:
+        if self._warn_error is None:
+            from dbt_common.events.functions import WARN_ERROR
+
+            return WARN_ERROR
+        return self._warn_error
+
+    @warn_error.setter
+    def warn_error(self, warn_error: bool) -> None:
+        self._warn_error = warn_error
+
+    @property
+    def warn_error_options(self) -> WarnErrorOptions:
+        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
+
+    @warn_error_options.setter
+    def warn_error_options(self, warn_error_options: WarnErrorOptions) -> None:
+        self._warn_error_options = warn_error_options
+
+    def fire_event(
+        self,
+        e: BaseEvent,
+        level: Optional[EventLevel] = None,
+        node: Any = None,
+        force_warn_or_error_handling: bool = False,
+    ) -> None:
+        msg = msg_from_base_event(e, level=level)
+
+        if force_warn_or_error_handling or (
+            self.require_warn_or_error_handling and msg.info.level == "warn"
+        ):
+            event_name = type(e).__name__
+            if self.warn_error or self.warn_error_options.includes(event_name):
+                # 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)
+            elif self.warn_error_options.silenced(event_name):
+                # Return early if the event is silenced
+                return
+
+        if os.environ.get("DBT_TEST_BINARY_SERIALIZATION"):
+            print(f"--- {msg.info.name}")
+            try:
+                msg.SerializeToString()
+            except Exception as exc:
+                raise Exception(
+                    f"{msg.info.name} is not serializable to binary. ",
+                    f"Originating exception: {exc}, {traceback.format_exc()}",
+                )
+
+        for logger in self.loggers:
+            if logger.filter(msg):  # type: ignore
+                logger.write_line(msg)
+
+        for callback in self.callbacks:
+            callback(msg)
+
+    def add_logger(self, config: LoggerConfig) -> None:
+        logger = (
+            _JsonLogger(config) if config.line_format == LineFormat.Json else _TextLogger(config)
+        )
+        self.loggers.append(logger)
+
+    def add_callback(self, callback: TCallback) -> None:
+        self.callbacks.append(callback)
+
+    def flush(self) -> None:
+        for logger in self.loggers:
+            logger.flush()
+
+
+class IEventManager(Protocol):
+    callbacks: List[TCallback]
+    loggers: List[_Logger]
+    warn_error: bool
+    warn_error_options: WarnErrorOptions
+    require_warn_or_error_handling: bool
+
+    def fire_event(
+        self,
+        e: BaseEvent,
+        level: Optional[EventLevel] = None,
+        node: Any = None,
+        force_warn_or_error_handling: bool = False,
+    ) -> None:
+        ...
+
+    def add_logger(self, config: LoggerConfig) -> None:
+        ...
+
+    def add_callback(self, callback: TCallback) -> None:
+        ...
+
+
+class TestEventManager(IEventManager):
+    __test__ = False
+
+    def __init__(self) -> None:
+        self.event_history: List[Tuple[BaseEvent, Optional[EventLevel]]] = []
+        self.loggers = []
+        self.warn_error = False
+        self.warn_error_options = WarnErrorOptions(include=[], exclude=[])
+        self.require_warn_or_error_handling = False
+
+    def fire_event(
+        self,
+        e: BaseEvent,
+        level: Optional[EventLevel] = None,
+        node: Any = None,
+        force_warn_or_error_handling: bool = False,
+    ) -> None:
+        self.event_history.append((e, level))
+
+    def add_logger(self, config: LoggerConfig) -> None:
+        raise NotImplementedError()

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/event_manager_client.py

@@ -8,17 +8,14 @@ _EVENT_MANAGER: IEventManager = EventManager()
 
 
 def get_event_manager() -> IEventManager:
-    global _EVENT_MANAGER
     return _EVENT_MANAGER
 
 
 def add_logger_to_manager(logger) -> None:
-    global _EVENT_MANAGER
     _EVENT_MANAGER.add_logger(logger)
 
 
 def add_callback_to_manager(callback: TCallback) -> None:
-    global _EVENT_MANAGER
     _EVENT_MANAGER.add_callback(callback)
 
 

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/functions.py

@@ -1,9 +1,8 @@
 from pathlib import Path
 
 from dbt_common.events.event_manager_client import get_event_manager
-from dbt_common.exceptions import EventCompilationError
-from dbt_common.invocation import get_invocation_id
 from dbt_common.helper_types import WarnErrorOptions
+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
 from dbt_common.events.logger import LoggerConfig, LineFormat
@@ -13,7 +12,7 @@ from functools import partial
 import json
 import os
 import sys
-from typing import Callable, Dict, Optional, TextIO, Union
+from typing import Any, Callable, Dict, Optional, TextIO, Union
 from google.protobuf.json_format import MessageToDict
 
 LOG_VERSION = 3
@@ -114,12 +113,9 @@ def msg_to_dict(msg: EventMsg) -> dict:
     return msg_dict
 
 
+# This function continues to exist to provide backwards compatibility
 def warn_or_error(event, node=None) -> None:
-    event_name = type(event).__name__
-    if WARN_ERROR or WARN_ERROR_OPTIONS.includes(event_name):
-        raise EventCompilationError(event.message(), node)
-    elif not WARN_ERROR_OPTIONS.silenced(event_name):
-        fire_event(event)
+    fire_event(e=event, node=node, force_warn_or_error_handling=True)
 
 
 # an alternative to fire_event which only creates and logs the event value
@@ -135,8 +131,15 @@ def fire_event_if(
 # this is where all the side effects happen branched by event type
 # (i.e. - mutating the event history, printing to stdout, logging
 # to files, etc.)
-def fire_event(e: BaseEvent, level: Optional[EventLevel] = None) -> None:
-    get_event_manager().fire_event(e, level=level)
+def fire_event(
+    e: BaseEvent,
+    level: Optional[EventLevel] = None,
+    node: Any = None,
+    force_warn_or_error_handling: bool = False,
+) -> None:
+    get_event_manager().fire_event(
+        e, level=level, node=node, force_warn_or_error_handling=force_warn_or_error_handling
+    )
 
 
 def get_metadata_vars() -> Dict[str, str]:

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/helpers.py

@@ -1,4 +1,4 @@
-from datetime import datetime
+from datetime import datetime, timezone
 
 
 # This converts a datetime to a json format datetime string which
@@ -9,6 +9,6 @@ def datetime_to_json_string(dt: datetime) -> str:
 
 # preformatted time stamp
 def get_json_string_utcnow() -> str:
-    ts = datetime.utcnow()
+    ts = datetime.now(timezone.utc).replace(tzinfo=None)
     ts_rfc3339 = datetime_to_json_string(ts)
     return ts_rfc3339

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/logger.py

@@ -2,7 +2,7 @@ import json
 import logging
 import threading
 from dataclasses import dataclass
-from datetime import datetime
+from datetime import datetime, timezone
 from enum import Enum
 from logging.handlers import RotatingFileHandler
 from typing import Optional, TextIO, Any, Callable
@@ -156,7 +156,7 @@ class _TextLogger(_Logger):
         if _is_print_event(msg):
             # PrintEvent is a special case, we don't want to add a timestamp
             return scrubbed_msg
-        ts: str = datetime.utcnow().strftime("%H:%M:%S")
+        ts: str = datetime.now(timezone.utc).replace(tzinfo=None).strftime("%H:%M:%S")
         return f"{self._get_color_tag()}{ts}  {scrubbed_msg}"
 
     def create_debug_line(self, msg: EventMsg) -> str:

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/types.proto

@@ -144,3 +144,13 @@ message PrintEventMsg {
     EventInfo info = 1;
     PrintEvent data = 2;
 }
+
+// Z053
+message RecordReplayIssue {
+    string msg = 1;
+}
+
+message RecordReplayIssueMsg {
+    EventInfo info = 1;
+    RecordReplayIssue data = 2;
+}

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/types.py

@@ -118,7 +118,7 @@ class SystemReportReturnCode(DebugLevel):
 
 
 # We use events to create console output, but also think of them as a sequence of important and
-# meaningful occurrences to be used for debugging and monitoring. The Formatting event helps eases
+# meaningful occurrences to be used for debugging and monitoring. The Formatting event eases
 # the tension between these two goals by allowing empty lines, heading separators, and other
 # formatting to be written to the console, while they can be ignored for other purposes. For
 # general information that isn't simple formatting, the Note event should be used instead.
@@ -156,3 +156,13 @@ class PrintEvent(InfoLevel):
 
     def message(self) -> str:
         return self.msg
+
+
+class RecordReplayIssue(InfoLevel):
+    """General event for reporting record/replay issues at runtime."""
+
+    def code(self) -> str:
+        return "Z053"
+
+    def message(self) -> str:
+        return self.msg

{dbt_common-1.16.0 → dbt_common-1.18}/dbt_common/events/types_pb2.py

@@ -25,7 +25,7 @@ _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.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.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)
@@ -84,4 +84,8 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _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)

dbt_common-1.18/dbt_common/helper_types.py

@@ -0,0 +1,270 @@
+# never name this package "types", or mypy will crash in ugly ways
+
+# necessary for annotating constructors
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Tuple, AbstractSet, Union
+from typing import Callable, cast, Generic, Optional, TypeVar, List, NewType, Set
+
+from dbt_common.dataclass_schema import (
+    dbtClassMixin,
+    ValidationError,
+    StrEnum,
+)
+from dbt_common.events.base_types import BaseEvent
+
+Port = NewType("Port", int)
+
+
+class NVEnum(StrEnum):
+    novalue = "novalue"
+
+    def __eq__(self, other) -> bool:
+        return isinstance(other, NVEnum)
+
+
+@dataclass
+class NoValue(dbtClassMixin):
+    """Sometimes, you want a way to say none that isn't None!"""
+
+    novalue: NVEnum = field(default_factory=lambda: NVEnum.novalue)
+
+
+@dataclass
+class IncludeExclude(dbtClassMixin):
+    INCLUDE_ALL = ("all", "*")
+
+    include: Union[str, List[str]]
+    exclude: List[str] = field(default_factory=list)
+
+    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"
+            )
+
+        if self.exclude and self.include not in self.INCLUDE_ALL:
+            raise ValidationError(
+                f"exclude can only be specified if include is one of {self.INCLUDE_ALL}"
+            )
+
+        if isinstance(self.include, list):
+            self._validate_items(self.include)
+
+        if isinstance(self.exclude, list):
+            self._validate_items(self.exclude)
+
+    def includes(self, item_name: str) -> bool:
+        return (
+            item_name in self.include or self.include in self.INCLUDE_ALL
+        ) and item_name not in self.exclude
+
+    def _validate_items(self, items: List[str]) -> None:
+        pass
+
+
+class WarnErrorOptions(IncludeExclude):
+    """
+    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.
+    silence: a list of event names.
+    valid_error_names: a set of event names that can be named in include, exclude, and silence.
+
+    In a hierarchy of configuration, the following rules apply:
+    1. named > Deprecations > "all"/"*"
+    2. silence > exclude > include
+    3. (1) > (2)
+    """
+
+    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 []))
+
+    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"
+            )
+
+        # 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
+            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."
+            )
+
+        if isinstance(self.include, list):
+            self._validate_items(self.include)
+
+        if isinstance(self.exclude, list):
+            self._validate_items(self.exclude)
+
+        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 _named_inclusion(self, item_name: str) -> bool:
+        """Is the item_name named in the include list?"""
+        return item_name in self.include
+
+    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_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?"""
+        return (
+            event is not None
+            and event.code().startswith("D")
+            and self.DEPRECATIONS in self.include
+        )
+
+    def _exclude_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
+        """Is event excluded as a deprecation?"""
+        return (
+            event is not None
+            and event.code().startswith("D")
+            and self.DEPRECATIONS in self.exclude
+        )
+
+    def _silence_as_deprecation(self, event: Optional[BaseEvent]) -> bool:
+        """Is event silenced as a deprecation?"""
+        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?
+
+        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`
+        """
+        # Setup based on item_name type
+        if isinstance(item_name, str):
+            event_name = item_name
+            event = None
+        else:
+            event_name = type(item_name).__name__
+            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(
+            event
+        ) or self._silence_as_deprecation(event)
+
+        # Calculate result
+        if self._named_inclusion(event_name) and not named_elsewhere:
+            return True
+        elif self._include_as_deprecation(event) and not (
+            named_elsewhere or deprecation_elsewhere
+        ):
+            return True
+        elif self._includes_all() and not (named_elsewhere or deprecation_elsewhere):
+            return True
+        else:
+            return False
+
+    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`
+        """
+        # Setup based on item_name type
+        if isinstance(item_name, str):
+            event_name = item_name
+            event = None
+        else:
+            event_name = type(item_name).__name__
+            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)
+
+        # Calculate result
+        if self._named_silence(event_name):
+            return True
+        elif self._silence_as_deprecation(event) and not named_elsewhere:
+            return True
+        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]
+
+T = TypeVar("T")
+
+
+# A data type for representing lazily evaluated values.
+#
+# usage:
+# x = Lazy.defer(lambda: expensive_fn())
+# y = x.force()
+#
+# inspired by the purescript data type
+# https://pursuit.purescript.org/packages/purescript-lazy/5.0.0/docs/Data.Lazy
+@dataclass
+class Lazy(Generic[T]):
+    _f: Callable[[], T]
+    memo: Optional[T] = None
+
+    # constructor for lazy values
+    @classmethod
+    def defer(cls, f: Callable[[], T]) -> Lazy[T]:
+        return Lazy(f)
+
+    # workaround for open mypy issue:
+    # https://github.com/python/mypy/issues/6910
+    def _typed_eval_f(self) -> T:
+        return cast(Callable[[], T], getattr(self, "_f"))()
+
+    # evaluates the function if the value has not been memoized already
+    def force(self) -> T:
+        if self.memo is None:
+            self.memo = self._typed_eval_f()
+        return self.memo
+
+
+# This class is used in to_target_dict, so that accesses to missing keys
+# will return an empty string instead of Undefined
+class DictDefaultEmptyStr(dict):
+    def __getitem__(self, key):
+        return dict.get(self, key, "")