dbt-common 1.0.4__tar.gz → 1.1.0__tar.gz

{dbt_common-1.0.4 → dbt_common-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbt-common
-Version: 1.0.4
+Version: 1.1.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.1.0/dbt_common/__about__.py

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

{dbt_common-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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-1.0.4 → dbt_common-1.1.0}/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

dbt_common-1.1.0/docs/README.md

@@ -0,0 +1,5 @@
+## Documentation
+
+The documentation is divided into the following sub-folders:
+* arch: Architecture Decision Records (ADRs) which explain and justify major architectural decisions
+* guides: Informal documents which describe the code or our development practices at a high level

dbt_common-1.1.0/docs/guides/record_replay.md

@@ -0,0 +1,41 @@
+# The Record/Replay Subsystem
+The `dbt_common.record` module provides a semi-experimental mechanism for recording dbt's interaction with external systems during a command invocation. The recording can be used as a record of how dbt behaved during an invocation, or it "replayed" later by a different version of dbt to compare its behavior to the original, without actually interacting with a data warehouse, the filesystem, or any other external process.
+
+For now, this mechanism should be regarded as an unstable preview. Details of how it works, which functions are annotated, and how annotations are made, are subject to arbitrary changes.
+
+If dbt's internal behavior is sufficiently deterministic, we will be able to use the record/replay mechanism in several interesting test and debugging scenarios, but our plan is to start by developing a robust record capability, since it would immediately support the testing scenarios we are most interested in. 
+
+This mechanism is a work in progress. Not all of dbt's interactions are recorded as of this writing. The rest of this document explains how the mechanism works and how to improve its coverage, so that more people can help with the effort.
+  
+
+## How it Works
+  
+We assume that every interaction between dbt and an external system is performed via a function call, and that all of those function calls are marked with the `@record_function` decorator. When recording, the parameters passed to and results returned from these annotated functions are recorded, so that they can be persisted to file for later comparison or for use with replay.
+  
+Now, suppose you recorded the data warehouse interactions while running v1 of `dbt-core` and you want to make sure that refactorizations you have done for v2 did not change the way dbt interacts with the warehouse. You can simply record a run with the same command using v2 and compare the two recordings to see if any of the SQL sent to the warehouse has changed. This may mean ignoring certain changes to whitespace or formatting which is also handled by the record/replay mechanism.
+  
+One problem which might arise in the scenario just described is that the results of introspective queries returned from the warehouse differ between runs, subtly changing dbt's behavior. This is where the replay mechanism will help us. When replay is enabled, an existing recording is used to mock out the function calls annotated with @record_function. The parameters to the function will be used to locate the corresponding call in the recording, and the recorded return value for that call is returned. In principle, all interaction with external systems can be mocked out this way, allowing dbt to be isolated and any deviation from its behavior in the recording can be noted.
+  
+## How to Use It
+  
+An example of how the mechanism is applied can be found in ./clients/system.py with the load_file_contents() function. Notice the decorator applied to this function:
+```python
+@record_function(LoadFileRecord)
+```
+When record and replay are disabled, this decorator is a no-op, but when one of them is enabled it implements the behaviors described above.  
+  
+Note also the `LoadFileRecord` class passed as a parameter to this decorator. This is (and must be) a class with the two properties `params_cls`, and `result_cls` specified. The class itself is registered with the record/replay mechanism by annotating it with `@Recorder.register_record_type`.  
+  
+The final detail needed is to define the classes specified by `params_cls` and `result_cls`, which must be dataclasses with properties whose order and names correspond to the parameters passed to the recorded function. In this case those are the `LoadFileParams` and `LoadFileResult` classes, respectively.
+
+With these decorators applied and classes defined, dbt is able to record all file access during a run, and mock out the accesses during replay, isolating dbt from actually loading files. At least it would if dbt only used this function for all file access, which is only mostly true. We hope to continue improving the usefulness of this mechanism by adding more recorded functions and routing more operations through them.  
+
+## Final Thoughts
+  
+We are aware of the potential limitations of this mechanism, since it makes several strong assumptions, not least of which are:
+  
+1. Every important interaction with an external system can be modeled as a function call.  
+2. Every important interaction can be recorded without creating an impractically large output file.  
+3. The recorded functions do not have important side effects within dbt itself which would not be duplicated during replay.
+
+Nonetheless, we are excited to see how far the experiment takes us and how we can apply it to automatically detect changes in dbt's behavior during testing and upgrades.

{dbt_common-1.0.4 → dbt_common-1.1.0}/pyproject.toml

@@ -58,6 +58,7 @@ lint = [
 ]
 test = [
     "pytest>=7.3,<8.0",
+    "pytest-mock",
     "pytest-xdist>=3.2,<4.0",
     "pytest-cov>=4.1,<5.0",
     "hypothesis>=6.87,<7.0",

dbt_common-1.0.4/dbt_common/__about__.py

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