dbt-common 1.0.4__py3-none-any.whl → 1.2.0__py3-none-any.whl

dbt_common/__about__.py

@@ -1 +1 @@
-version = "1.0.4"
+version = "1.2.0"

dbt_common/contracts/metadata.py

@@ -0,0 +1,26 @@
+from dataclasses import dataclass
+from typing import Dict, Optional, Union
+
+from dbt_common.dataclass_schema import dbtClassMixin
+
+
+@dataclass
+class StatsItem(dbtClassMixin):
+    id: str
+    label: str
+    value: Union[bool, str, float, None]
+    include: bool
+    description: Optional[str] = None
+
+
+StatsDict = Dict[str, StatsItem]
+
+
+@dataclass
+class TableMetadata(dbtClassMixin):
+    type: str
+    schema: str
+    name: str
+    database: Optional[str] = None
+    comment: Optional[str] = None
+    owner: Optional[str] = None

dbt_common/events/base_types.py

@@ -6,14 +6,11 @@ import sys
 from google.protobuf.json_format import ParseDict, MessageToDict, MessageToJson
 from google.protobuf.message import Message
 from dbt_common.events.helpers import get_json_string_utcnow
-from typing import Optional
+from typing import Callable, Optional
 
 from dbt_common.invocation import get_invocation_id
 
-if sys.version_info >= (3, 8):
-    from typing import Protocol
-else:
-    from typing_extensions import Protocol
+from typing import Protocol
 
 
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@@ -128,6 +125,9 @@ class EventMsg(Protocol):
     data: Message
 
 
+TCallback = Callable[[EventMsg], None]
+
+
 def msg_from_base_event(event: BaseEvent, level: Optional[EventLevel] = None):
     msg_class_name = f"{type(event).__name__}Msg"
     msg_cls = getattr(event.PROTO_TYPES_MODULE, msg_class_name)

dbt_common/events/event_manager.py

@@ -1,15 +1,15 @@
 import os
 import traceback
-from typing import Callable, List, Optional, Protocol, Tuple
+from typing import List, Optional, Protocol, Tuple
 
-from dbt_common.events.base_types import BaseEvent, EventLevel, msg_from_base_event, EventMsg
+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
 
 
 class EventManager:
     def __init__(self) -> None:
         self.loggers: List[_Logger] = []
-        self.callbacks: List[Callable[[EventMsg], None]] = []
+        self.callbacks: List[TCallback] = []
 
     def fire_event(self, e: BaseEvent, level: Optional[EventLevel] = None) -> None:
         msg = msg_from_base_event(e, level=level)
@@ -37,13 +37,16 @@ class EventManager:
         )
         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[Callable[[EventMsg], None]]
+    callbacks: List[TCallback]
     loggers: List[_Logger]
 
     def fire_event(self, e: BaseEvent, level: Optional[EventLevel] = None) -> None:
@@ -52,6 +55,9 @@ class IEventManager(Protocol):
     def add_logger(self, config: LoggerConfig) -> None:
         ...
 
+    def add_callback(self, callback: TCallback) -> None:
+        ...
+
 
 class TestEventManager(IEventManager):
     __test__ = False

dbt_common/events/event_manager_client.py

@@ -1,6 +1,7 @@
 # Since dbt-rpc does not do its own log setup, and since some events can
 # currently fire before logs can be configured by setup_event_logger(), we
 # create a default configuration with default settings and no file output.
+from dbt_common.events.base_types import TCallback
 from dbt_common.events.event_manager import IEventManager, EventManager
 
 _EVENT_MANAGER: IEventManager = EventManager()
@@ -16,6 +17,11 @@ def add_logger_to_manager(logger) -> None:
     _EVENT_MANAGER.add_logger(logger)
 
 
+def add_callback_to_manager(callback: TCallback) -> None:
+    global _EVENT_MANAGER
+    _EVENT_MANAGER.add_callback(callback)
+
+
 def ctx_set_event_manager(event_manager: IEventManager) -> None:
     global _EVENT_MANAGER
     _EVENT_MANAGER = event_manager

dbt_common/events/logger.py

@@ -13,6 +13,13 @@ from dbt_common.events.base_types import EventLevel, EventMsg
 from dbt_common.events.format import timestamp_to_datetime_string
 from dbt_common.utils.encoding import ForgivingJSONEncoder
 
+PRINT_EVENT_NAME = "PrintEvent"
+
+
+def _is_print_event(msg: EventMsg) -> bool:
+    return msg.info.name == PRINT_EVENT_NAME
+
+
 # A Filter is a function which takes a BaseEvent and returns True if the event
 # should be logged, False otherwise.
 Filter = Callable[[EventMsg], bool]
@@ -120,7 +127,14 @@ class _Logger:
     def write_line(self, msg: EventMsg):
         line = self.create_line(msg)
         if self._python_logger is not None:
-            send_to_logger(self._python_logger, msg.info.level, line)
+            # We send PrintEvent to logger as error so it goes to stdout
+            # when --quiet flag is set.
+            # --quiet flag will filter out all events lower than ERROR.
+            if _is_print_event(msg):
+                level = "error"
+            else:
+                level = msg.info.level
+            send_to_logger(self._python_logger, level, line)
 
     def flush(self):
         if self._python_logger is not None:
@@ -138,8 +152,11 @@ class _TextLogger(_Logger):
         return self.create_debug_line(msg) if self.use_debug_format else self.create_info_line(msg)
 
     def create_info_line(self, msg: EventMsg) -> str:
-        ts: str = datetime.utcnow().strftime("%H:%M:%S")
         scrubbed_msg: str = self.scrubber(msg.info.msg)  # type: ignore
+        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")
         return f"{self._get_color_tag()}{ts}  {scrubbed_msg}"
 
     def create_debug_line(self, msg: EventMsg) -> str:

dbt_common/events/types.proto

@@ -119,3 +119,13 @@ message NoteMsg {
     EventInfo info = 1;
     Note data = 2;
 }
+
+// Z052
+message PrintEvent {
+    string msg = 1;
+}
+
+message PrintEventMsg {
+    EventInfo info = 1;
+    PrintEvent data = 2;
+}

dbt_common/events/types.py

@@ -125,3 +125,14 @@ class Note(InfoLevel):
 
     def message(self) -> str:
         return self.msg
+
+
+class PrintEvent(InfoLevel):
+    # Use this event to skip any formatting and just print a message
+    # This event will get to stdout even if the logger is set to ERROR
+    # This is to support commands that want --quiet option but also log something to stdout
+    def code(self) -> str:
+        return "Z052"
+
+    def message(self) -> str:
+        return self.msg

dbt_common/events/types_pb2.py

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: types.proto
+# Protobuf Python Version: 5.26.1
 """Generated protocol buffer code."""
-from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
 from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
 # @@protoc_insertion_point(imports)
 
 _sym_db = _symbol_database.Default()
@@ -14,55 +15,59 @@ _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.Noteb\x06proto3')
-
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'types_pb2', globals())
-if _descriptor._USE_C_DESCRIPTORS == False:
+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._options = None
-  _EVENTINFO_EXTRAENTRY._options = None
-  _EVENTINFO_EXTRAENTRY._serialized_options = b'8\001'
-  _EVENTINFO._serialized_start=62
-  _EVENTINFO._serialized_end=335
-  _EVENTINFO_EXTRAENTRY._serialized_start=291
-  _EVENTINFO_EXTRAENTRY._serialized_end=335
-  _GENERICMESSAGE._serialized_start=337
-  _GENERICMESSAGE._serialized_end=391
-  _RETRYEXTERNALCALL._serialized_start=393
-  _RETRYEXTERNALCALL._serialized_end=442
-  _RETRYEXTERNALCALLMSG._serialized_start=444
-  _RETRYEXTERNALCALLMSG._serialized_end=550
-  _RECORDRETRYEXCEPTION._serialized_start=552
-  _RECORDRETRYEXCEPTION._serialized_end=587
-  _RECORDRETRYEXCEPTIONMSG._serialized_start=589
-  _RECORDRETRYEXCEPTIONMSG._serialized_end=701
-  _SYSTEMCOULDNOTWRITE._serialized_start=703
-  _SYSTEMCOULDNOTWRITE._serialized_end=767
-  _SYSTEMCOULDNOTWRITEMSG._serialized_start=769
-  _SYSTEMCOULDNOTWRITEMSG._serialized_end=879
-  _SYSTEMEXECUTINGCMD._serialized_start=881
-  _SYSTEMEXECUTINGCMD._serialized_end=914
-  _SYSTEMEXECUTINGCMDMSG._serialized_start=916
-  _SYSTEMEXECUTINGCMDMSG._serialized_end=1024
-  _SYSTEMSTDOUT._serialized_start=1026
-  _SYSTEMSTDOUT._serialized_end=1054
-  _SYSTEMSTDOUTMSG._serialized_start=1056
-  _SYSTEMSTDOUTMSG._serialized_end=1152
-  _SYSTEMSTDERR._serialized_start=1154
-  _SYSTEMSTDERR._serialized_end=1182
-  _SYSTEMSTDERRMSG._serialized_start=1184
-  _SYSTEMSTDERRMSG._serialized_end=1280
-  _SYSTEMREPORTRETURNCODE._serialized_start=1282
-  _SYSTEMREPORTRETURNCODE._serialized_end=1326
-  _SYSTEMREPORTRETURNCODEMSG._serialized_start=1328
-  _SYSTEMREPORTRETURNCODEMSG._serialized_end=1444
-  _FORMATTING._serialized_start=1446
-  _FORMATTING._serialized_end=1471
-  _FORMATTINGMSG._serialized_start=1473
-  _FORMATTINGMSG._serialized_end=1565
-  _NOTE._serialized_start=1567
-  _NOTE._serialized_end=1586
-  _NOTEMSG._serialized_start=1588
-  _NOTEMSG._serialized_end=1668
+_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['_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
 # @@protoc_insertion_point(module_scope)

dbt_common/record.py

@@ -2,8 +2,8 @@
 external systems during a command invocation, so that the command can be re-run
 later with the recording 'replayed' to dbt.
 
-If dbt behaves sufficiently deterministically, we will be able to use the
-record/replay mechanism in several interesting test and debugging scenarios.
+The rationale for and architecture of this module is described in detail in the
+docs/guides/record_replay.md document in this repository.
 """
 import functools
 import dataclasses
@@ -59,14 +59,18 @@ class Diff:
 class RecorderMode(Enum):
     RECORD = 1
     REPLAY = 2
+    RECORD_QUERIES = 3
 
 
 class Recorder:
     _record_cls_by_name: Dict[str, Type] = {}
     _record_name_by_params_name: Dict[str, str] = {}
 
-    def __init__(self, mode: RecorderMode, recording_path: Optional[str] = None) -> None:
+    def __init__(
+        self, mode: RecorderMode, types: Optional[List], recording_path: Optional[str] = None
+    ) -> None:
         self.mode = mode
+        self.types = types
         self._records_by_type: Dict[str, List[Record]] = {}
         self._replay_diffs: List["Diff"] = []
 
@@ -118,13 +122,14 @@ class Recorder:
         records_by_type: Dict[str, List[Record]] = {}
 
         for record_type_name in loaded_dct:
+            # TODO: this breaks with QueryRecord on replay since it's
+            # not in common so isn't part of cls._record_cls_by_name yet
             record_cls = cls._record_cls_by_name[record_type_name]
             rec_list = []
             for record_dct in loaded_dct[record_type_name]:
                 rec = record_cls.from_dict(record_dct)
                 rec_list.append(rec)  # type: ignore
             records_by_type[record_type_name] = rec_list
-
         return records_by_type
 
     def expect_record(self, params: Any) -> Any:
@@ -147,17 +152,44 @@ class Recorder:
 
 
 def get_record_mode_from_env() -> Optional[RecorderMode]:
-    replay_val = os.environ.get("DBT_REPLAY")
-    if replay_val is not None and replay_val != "0" and replay_val.lower() != "false":
-        return RecorderMode.REPLAY
+    """
+    Get the record mode from the environment variables.
+
+    If the mode is not set to 'RECORD' or 'REPLAY', return None.
+    Expected format: 'DBT_RECORDER_MODE=RECORD'
+    """
+    record_mode = os.environ.get("DBT_RECORDER_MODE")
 
-    record_val = os.environ.get("DBT_RECORD")
-    if record_val is not None and record_val != "0" and record_val.lower() != "false":
+    if record_mode is None:
+        return None
+
+    if record_mode.lower() == "record":
         return RecorderMode.RECORD
+    # replaying requires a file path, otherwise treat as noop
+    elif record_mode.lower() == "replay" and os.environ.get("DBT_RECORDER_FILE_PATH") is not None:
+        return RecorderMode.REPLAY
 
+    # if you don't specify record/replay it's a noop
     return None
 
 
+def get_record_types_from_env() -> Optional[List]:
+    """
+    Get the record subset from the environment variables.
+
+    If no types are provided, there will be no filtering.
+    Invalid types will be ignored.
+    Expected format: 'DBT_RECORDER_TYPES=QueryRecord,FileLoadRecord,OtherRecord'
+    """
+    record_types_str = os.environ.get("DBT_RECORDER_TYPES")
+
+    # if all is specified we don't want any type filtering
+    if record_types_str is None or record_types_str.lower == "all":
+        return None
+
+    return record_types_str.split(",")
+
+
 def record_function(record_type, method=False, tuple_result=False):
     def record_function_inner(func_to_record):
         # To avoid runtime overhead and other unpleasantness, we only apply the
@@ -176,6 +208,9 @@ def record_function(record_type, method=False, tuple_result=False):
             if recorder is None:
                 return func_to_record(*args, **kwargs)
 
+            if recorder.types is not None and record_type.__name__ not in recorder.types:
+                return func_to_record(*args, **kwargs)
+
             # For methods, peel off the 'self' argument before calling the
             # params constructor.
             param_args = args[1:] if method else args

{dbt_common-1.0.4.dist-info → dbt_common-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbt-common
-Version: 1.0.4
+Version: 1.2.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
@@ -55,6 +55,7 @@ Requires-Dist: types-requests; extra == 'lint'
 Provides-Extra: test
 Requires-Dist: hypothesis<7.0,>=6.87; extra == 'test'
 Requires-Dist: pytest-cov<5.0,>=4.1; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
 Requires-Dist: pytest-xdist<4.0,>=3.2; extra == 'test'
 Requires-Dist: pytest<8.0,>=7.3; extra == 'test'
 Description-Content-Type: text/markdown

{dbt_common-1.0.4.dist-info → dbt_common-1.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dbt_common/__about__.py,sha256=R604FHUDDjGzi5hem3DYdlBvcBVjznL7PmfCQFtRkDI,18
+dbt_common/__about__.py,sha256=-XvoSdwL-0go8ZX6VN74e-D6dwG0z-0p7vL5MO0Sz5s,18
 dbt_common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/constants.py,sha256=-Y5DIL1SDPQWtlCNizXRYxFgbx1D7LaLs1ysamvGMRk,278
 dbt_common/context.py,sha256=BhgT7IgyvpZHEtIdFVVuBBBX5LuU7obXT7NvIPeuD2g,1760
@@ -6,7 +6,7 @@ dbt_common/dataclass_schema.py,sha256=t3HGD0oXTSjitctuCVHv3iyq5BT3jxoSxv_VGkrJlE
 dbt_common/helper_types.py,sha256=NoxqGFAq9bOjh7rqtz_eepXAxk20n3mmW_gUVpnMyYU,3901
 dbt_common/invocation.py,sha256=Zw8jRPn75oi2VrUD6qGvaCDtSyIfqm5pJlPpRjs3s1E,202
 dbt_common/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dbt_common/record.py,sha256=bQ_1fC5qp_RlQxLXq_wHYl5G37BvkzE0d_F2F39PDUA,7015
+dbt_common/record.py,sha256=fwp8Q2x0UiB9fHbMFkmOlAgKLst1dhDxQpSSsd04aDw,8204
 dbt_common/semver.py,sha256=2zoZYCQ7PfswqslT2NHuMGgPGMuMuX-yRThVoqfDWQU,13954
 dbt_common/tests.py,sha256=6lC_JuRtoYO6cbAF8-R5aTM4HtQiM_EH8X5m_97duGY,315
 dbt_common/ui.py,sha256=rc2TEM29raBFc_LXcg901pMDD07C2ohwp9qzkE-7pBY,2567
@@ -17,6 +17,7 @@ dbt_common/clients/jinja.py,sha256=i6VQ94FU4F6ZCQLHTxNSeGHmvyYSIe34nDhNkH6wO08,1
 dbt_common/clients/system.py,sha256=OOhRDWR5t0Ns3OhkqjPTNTtyl_RMRWPDHWCzDoFtgkA,23014
 dbt_common/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/contracts/constraints.py,sha256=hyqTW2oPB1dfXWW388LWnL-EFdqTpQciKISH3CeLkro,1267
+dbt_common/contracts/metadata.py,sha256=d5zKvIR3s2j6_ZvafvlyNm5z6MVs8augT2jclbOSG-k,528
 dbt_common/contracts/util.py,sha256=RZpeEExSKdyFwTq7MM3rd1ZkAf11C7I-bgppUJ6SXOg,741
 dbt_common/contracts/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_common/contracts/config/base.py,sha256=jWLf6SBUy7wngYs0Z5Zmx1O1v86XRueYaABlZ0W2Bxc,8356
@@ -25,19 +26,19 @@ dbt_common/contracts/config/metadata.py,sha256=X47-tEA8q2ZfSMcYv0godUwTSVjt8NI77
 dbt_common/contracts/config/properties.py,sha256=gWt6xsP4rVOqRKhmagiUhWnDynzD9mykfMYMTviwpEU,2281
 dbt_common/events/README.md,sha256=CSwVajoxCAqOug2UCnXldH1EUK7Kjf3rcq7z9ACjrss,3023
 dbt_common/events/__init__.py,sha256=av08vfpxo0ek7PqZNtMxY8FODJ3xwph4ehRxgInx4LA,383
-dbt_common/events/base_types.py,sha256=E--Fl-KMdJd_UZCN93AuLxnJcQoys2MJjiJxkV03HpM,5448
+dbt_common/events/base_types.py,sha256=1l4Yx8zuma7jABB1fcPvL20ltpQ46w0mlYxn48kHykY,5415
 dbt_common/events/contextvars.py,sha256=Jx2J_Nkx0DH8EE1Sno_mbv7PMLBfCzm7byeFlUeflLA,3079
 dbt_common/events/event_handler.py,sha256=jfi0PyqIOGnXCG9HEa0VIVULqNvXs1RYmAg0b50ChQs,1385
-dbt_common/events/event_manager.py,sha256=ZXJ-N4NsfQTnkEpvuedTjHD8Gt8DgYHbz601eTVCm-o,2175
-dbt_common/events/event_manager_client.py,sha256=etDlUv-3iIwM5IXXuzc1cmQID2fHOXw8dE9snp39-jk,1014
+dbt_common/events/event_manager.py,sha256=IIUwSyt_RcBbUI_iE5mnpmZt2uW7lG49RXOWz2VlUv0,2300
+dbt_common/events/event_manager_client.py,sha256=VKlIYJPcexmDKnidkyrs8BIuNZ1_CwDFGz-gBM2SAvo,1193
 dbt_common/events/format.py,sha256=x1RWDZ8G7ZMHmxdld6Q4VXca4kvnhiQOIaQXkC6Uo0Q,1609
 dbt_common/events/functions.py,sha256=K-R-FBTeO03U51gtMBu1EUcNsIAsgw_e5spWxLJ44VE,4762
 dbt_common/events/helpers.py,sha256=CfsWwNDjsLJkPIgOtAfuLEnZ3rGUKeYsH8aDtCW12OA,410
 dbt_common/events/interfaces.py,sha256=hEDeDoB0FW2RYHVZBG7gebEt_mUVBzkn1yPubpaxs-s,147
-dbt_common/events/logger.py,sha256=6LLH8aLoRziFLBmwu-TCR5-EMpBtD28pSaL0FmKpeGA,6159
-dbt_common/events/types.proto,sha256=SujcfPOPAfyHzeRXkn9_uKEDeQ-andSW1pI6fpWpQdo,1885
-dbt_common/events/types.py,sha256=Bq-EvKQ8IPcRLwf_ukjfqjpYvakOcg4RzOL2zbPttbM,3538
-dbt_common/events/types_pb2.py,sha256=5DHt8X_ejqOuRiP-GrnVw8wDFUOTfBRlZQ2In1L1LOw,5569
+dbt_common/events/logger.py,sha256=mAUNLZlIIOl3T2u7KOe8FF_deTNNe1CRJqmkPw4YH1U,6728
+dbt_common/events/types.proto,sha256=nsOE3XFYBPovT9Th8WMkDWxBXa-adqiL23zCYfOdVk0,2013
+dbt_common/events/types.py,sha256=quE22Kp78J51_8f1Si_K-xg0gA2Sg-fw9XDjNrcy81M,3905
+dbt_common/events/types_pb2.py,sha256=Gn3exMla0FjoA-5OQTjOeKCT_DLxzvcA3YHPfbFjAck,6563
 dbt_common/exceptions/__init__.py,sha256=X_Uw7BxOzXev_9JMYfs5Cm-_i_Qf2PJim8_-dDJI7Y8,361
 dbt_common/exceptions/base.py,sha256=uuI_2y_BQrjCyjHKR2pWeCica1dyoo1cc4e1Tq0de7M,7583
 dbt_common/exceptions/cache.py,sha256=0z4fBcdNZMAR41YbPRo2GN0__xAMaYs8Uc-t3hjmVio,2532
@@ -55,7 +56,7 @@ dbt_common/utils/encoding.py,sha256=6_kSY2FvGNYMg7oX7PrbvVioieydih3Kl7Ii802LaHI,
 dbt_common/utils/executor.py,sha256=Zyzd1wML3aN-iYn9ZG2Gc_jj5vknmvQNyH-c0RaPIpo,2446
 dbt_common/utils/formatting.py,sha256=JUn5rzJ-uajs9wPCN0-f2iRFY1pOJF5YjTD9dERuLoc,165
 dbt_common/utils/jinja.py,sha256=XNfZHuZhLM_R_yPmzYojPm6bF7QOoxIjSWrkJRw6wks,965
-dbt_common-1.0.4.dist-info/METADATA,sha256=HgrDiDH28wvDXD8aJGX_XRNAlBQvnHySqjOBNxy_ALw,5220
-dbt_common-1.0.4.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-dbt_common-1.0.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dbt_common-1.0.4.dist-info/RECORD,,
+dbt_common-1.2.0.dist-info/METADATA,sha256=7rA7to-AQn0UQvVJVAy14wx7uhcyB8D_1wHmTTtEHDo,5264
+dbt_common-1.2.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+dbt_common-1.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dbt_common-1.2.0.dist-info/RECORD,,