dbt-common 0.1.1__py3-none-any.whl → 0.1.5__py3-none-any.whl

dbt_common/contracts/config/base.py

@@ -38,7 +38,9 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
 
     def __delitem__(self, key):
         if hasattr(self, key):
-            msg = ('Error, tried to delete config key "{}": Cannot delete ' "built-in keys").format(key)
+            msg = (
+                'Error, tried to delete config key "{}": Cannot delete ' "built-in keys"
+            ).format(key)
             raise CompilationError(msg)
         else:
             del self._extra[key]
@@ -110,7 +112,9 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
 
     @classmethod
     def _merge_dicts(cls, src: Dict[str, Any], data: Dict[str, Any]) -> Dict[str, Any]:
-        """Find all the items in data that match a target_field on this class,
+        """Mutate input to return merge results.
+
+        Find all the items in data that match a target_field on this class,
         and merge them with the data found in `src` for target_field, using the
         field's specified merge behavior. Matching items will be removed from
         `data` (but _not_ `src`!).
@@ -141,8 +145,12 @@ class BaseConfig(AdditionalPropertiesAllowed, Replaceable):
             )
         return result
 
-    def update_from(self: T, data: Dict[str, Any], config_cls: Type[BaseConfig], validate: bool = True) -> T:
-        """Given a dict of keys, update the current config from them, validate
+    def update_from(
+        self: T, data: Dict[str, Any], config_cls: Type[BaseConfig], validate: bool = True
+    ) -> T:
+        """Update and validate config given a dict.
+
+        Given a dict of keys, update the current config from them, validate
         it, and return a new config with the updated values
         """
         dct = self.to_dict(omit_none=False)

dbt_common/contracts/constraints.py

@@ -30,8 +30,12 @@ class ColumnLevelConstraint(dbtClassMixin):
     # It could be a predicate (check type), or a sequence sql keywords (e.g. unique type),
     # so the vague naming of 'expression' is intended to capture this range.
     expression: Optional[str] = None
-    warn_unenforced: bool = True  # Warn if constraint cannot be enforced by platform but will be in DDL
-    warn_unsupported: bool = True  # Warn if constraint is not supported by the platform and won't be in DDL
+    warn_unenforced: bool = (
+        True  # Warn if constraint cannot be enforced by platform but will be in DDL
+    )
+    warn_unsupported: bool = (
+        True  # Warn if constraint is not supported by the platform and won't be in DDL
+    )
 
 
 @dataclass

dbt_common/contracts/util.py

@@ -5,3 +5,19 @@ import dataclasses
 class Replaceable:
     def replace(self, **kwargs):
         return dataclasses.replace(self, **kwargs)
+
+
+class Mergeable(Replaceable):
+    def merged(self, *args):
+        """Perform a shallow merge, where the last non-None write wins. This is
+        intended to merge dataclasses that are a collection of optional values.
+        """
+        replacements = {}
+        cls = type(self)
+        for arg in args:
+            for field in dataclasses.fields(cls):
+                value = getattr(arg, field.name)
+                if value is not None:
+                    replacements[field.name] = value
+
+        return self.replace(**replacements)

dbt_common/dataclass_schema.py

@@ -47,7 +47,9 @@ class dbtMashConfig(MashBaseConfig):
 # This class pulls in DataClassDictMixin from Mashumaro. The 'to_dict'
 # and 'from_dict' methods come from Mashumaro.
 class dbtClassMixin(DataClassDictMixin):
-    """The Mixin adds methods to generate a JSON schema and
+    """Convert and validate JSON schemas.
+
+    The Mixin adds methods to generate a JSON schema and
     convert to and from JSON encodable dicts with validation
     against the schema
     """

dbt_common/events/__init__.py

@@ -4,4 +4,6 @@ from dbt_common.events.functions import get_stdout_config
 from dbt_common.events.logger import LineFormat
 
 # make sure event manager starts with a logger
-get_event_manager().add_logger(get_stdout_config(LineFormat.PlainText, True, EventLevel.INFO, False))
+get_event_manager().add_logger(
+    get_stdout_config(LineFormat.PlainText, True, EventLevel.INFO, False)
+)

dbt_common/events/base_types.py

@@ -49,7 +49,7 @@ class EventLevel(str, Enum):
 
 
 class BaseEvent:
-    """BaseEvent for proto message generated python events"""
+    """BaseEvent for proto message generated python events."""
 
     PROTO_TYPES_MODULE = types_pb2
 
@@ -59,7 +59,9 @@ class BaseEvent:
         if class_name == "Formatting" and len(args) > 0:
             kwargs["msg"] = args[0]
             args = ()
-        assert len(args) == 0, f"[{class_name}] Don't use positional arguments when constructing logging events"
+        assert (
+            len(args) == 0
+        ), f"[{class_name}] Don't use positional arguments when constructing logging events"
         if "base_msg" in kwargs:
             kwargs["base_msg"] = str(kwargs["base_msg"])
         if "msg" in kwargs:
@@ -92,7 +94,9 @@ class BaseEvent:
             return super().__getattribute__("pb_msg").__getattribute__(key)
 
     def to_dict(self):
-        return MessageToDict(self.pb_msg, preserving_proto_field_name=True, including_default_value_fields=True)
+        return MessageToDict(
+            self.pb_msg, preserving_proto_field_name=True, including_default_value_fields=True
+        )
 
     def to_json(self) -> str:
         return MessageToJson(
@@ -125,7 +129,6 @@ class EventMsg(Protocol):
 
 
 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_handler.py

@@ -17,7 +17,8 @@ _log_level_to_event_level_map = {
 
 
 class DbtEventLoggingHandler(logging.Handler):
-    """A logging handler that wraps the EventManager
+    """A logging handler that wraps the EventManager.
+
     This allows non-dbt packages to log to the dbt event stream.
     All logs are generated as "Note" events.
     """

dbt_common/events/event_manager.py

@@ -20,7 +20,8 @@ class EventManager:
                 msg.SerializeToString()
             except Exception as exc:
                 raise Exception(
-                    f"{msg.info.name} is not serializable to binary. Originating exception: {exc}, {traceback.format_exc()}"
+                    f"{msg.info.name} is not serializable to binary. ",
+                    f"Originating exception: {exc}, {traceback.format_exc()}",
                 )
 
         for logger in self.loggers:
@@ -31,7 +32,9 @@ class EventManager:
             callback(msg)
 
     def add_logger(self, config: LoggerConfig) -> None:
-        logger = _JsonLogger(config) if config.line_format == LineFormat.Json else _TextLogger(config)
+        logger = (
+            _JsonLogger(config) if config.line_format == LineFormat.Json else _TextLogger(config)
+        )
         self.loggers.append(logger)
 
     def flush(self) -> None:

dbt_common/events/format.py

@@ -30,7 +30,9 @@ def format_fancy_output_line(
     else:
         status_time = " in {execution_time:0.2f}s".format(execution_time=execution_time)
 
-    output = "{justified} [{status}{status_time}]".format(justified=justified, status=status, status_time=status_time)
+    output = "{justified} [{status}{status_time}]".format(
+        justified=justified, status=status, status_time=status_time
+    )
 
     return output
 

dbt_common/events/functions.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from dbt_common.events.event_manager_client import get_event_manager
 from dbt_common.invocation import get_invocation_id
 from dbt_common.helper_types import WarnErrorOptions
-from dbt_common.utils import ForgivingJSONEncoder
+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
 from dbt_common.exceptions import scrub_secrets, env_secrets
@@ -94,20 +94,27 @@ def msg_to_dict(msg: EventMsg) -> dict:
     msg_dict = dict()
     try:
         msg_dict = MessageToDict(
-            msg, preserving_proto_field_name=True, including_default_value_fields=True  # type: ignore
+            msg,
+            preserving_proto_field_name=True,
+            including_default_value_fields=True,  # type: ignore
         )
     except Exception as exc:
         event_type = type(msg).__name__
-        fire_event(Note(msg=f"type {event_type} is not serializable. {str(exc)}"), level=EventLevel.WARN)
+        fire_event(
+            Note(msg=f"type {event_type} is not serializable. {str(exc)}"), level=EventLevel.WARN
+        )
     # We don't want an empty NodeInfo in output
-    if "data" in msg_dict and "node_info" in msg_dict["data"] and msg_dict["data"]["node_info"]["node_name"] == "":
+    if (
+        "data" in msg_dict
+        and "node_info" in msg_dict["data"]
+        and msg_dict["data"]["node_info"]["node_name"] == ""
+    ):
         del msg_dict["data"]["node_info"]
     return msg_dict
 
 
 def warn_or_error(event, node=None) -> None:
     if WARN_ERROR or WARN_ERROR_OPTIONS.includes(type(event).__name__):
-
         # TODO: resolve this circular import when at top
         from dbt_common.exceptions import EventCompilationError
 
@@ -118,16 +125,13 @@ def warn_or_error(event, node=None) -> None:
 
 # an alternative to fire_event which only creates and logs the event value
 # if the condition is met. Does nothing otherwise.
-def fire_event_if(conditional: bool, lazy_e: Callable[[], BaseEvent], level: Optional[EventLevel] = None) -> None:
+def fire_event_if(
+    conditional: bool, lazy_e: Callable[[], BaseEvent], level: Optional[EventLevel] = None
+) -> None:
     if conditional:
         fire_event(lazy_e(), level=level)
 
 
-# a special case of fire_event_if, to only fire events in our unit/functional tests
-def fire_event_if_test(lazy_e: Callable[[], BaseEvent], level: Optional[EventLevel] = None) -> None:
-    fire_event_if(conditional=("pytest" in sys.modules), lazy_e=lazy_e, level=level)
-
-
 # top-level method for accessing the new eventing system
 # this is where all the side effects happen branched by event type
 # (i.e. - mutating the event history, printing to stdout, logging
@@ -140,7 +144,9 @@ def get_metadata_vars() -> Dict[str, str]:
     global metadata_vars
     if metadata_vars is None:
         metadata_vars = {
-            k[len(_METADATA_ENV_PREFIX) :]: v for k, v in os.environ.items() if k.startswith(_METADATA_ENV_PREFIX)
+            k[len(_METADATA_ENV_PREFIX) :]: v
+            for k, v in os.environ.items()
+            if k.startswith(_METADATA_ENV_PREFIX)
         }
     return metadata_vars
 

dbt_common/events/logger.py

@@ -11,7 +11,7 @@ from colorama import Style
 
 from dbt_common.events.base_types import EventLevel, EventMsg
 from dbt_common.events.format import timestamp_to_datetime_string
-from dbt_common.utils import ForgivingJSONEncoder
+from dbt_common.utils.encoding import ForgivingJSONEncoder
 
 # A Filter is a function which takes a BaseEvent and returns True if the event
 # should be logged, False otherwise.
@@ -51,19 +51,21 @@ _log_level_map = {
 # We need this function for now because the numeric log severity levels in
 # Python do not match those for logbook, so we have to explicitly call the
 # correct function by name.
-def send_to_logger(l, level: str, log_line: str):
+def send_to_logger(logger, level: str, log_line: str):
     if level == "test":
-        l.debug(log_line)
+        logger.debug(log_line)
     elif level == "debug":
-        l.debug(log_line)
+        logger.debug(log_line)
     elif level == "info":
-        l.info(log_line)
+        logger.info(log_line)
     elif level == "warn":
-        l.warning(log_line)
+        logger.warning(log_line)
     elif level == "error":
-        l.error(log_line)
+        logger.error(log_line)
     else:
-        raise AssertionError(f"While attempting to log {log_line}, encountered the unhandled level: {level}")
+        raise AssertionError(
+            f"While attempting to log {log_line}, encountered the unhandled level: {level}"
+        )
 
 
 @dataclass
@@ -150,7 +152,9 @@ class _TextLogger(_Logger):
             log_line = f"\n\n{separator} {ts} | {self.invocation_id} {separator}\n"
         scrubbed_msg: str = self.scrubber(msg.info.msg)  # type: ignore
         level = msg.info.level
-        log_line += f"{self._get_color_tag()}{ts} [{level:<5}]{self._get_thread_name()} {scrubbed_msg}"
+        log_line += (
+            f"{self._get_color_tag()}{ts} [{level:<5}]{self._get_thread_name()} {scrubbed_msg}"
+        )
         return log_line
 
     def _get_color_tag(self) -> str:

dbt_common/events/types.py

@@ -113,9 +113,12 @@ class Formatting(InfoLevel):
 
 
 class Note(InfoLevel):
-    """The Note event provides a way to log messages which aren't likely to be
+    """Unstructured events.
+
+    The Note event provides a way to log messages which aren't likely to be
     useful as more structured events. For console formatting text like empty
-    lines and separator bars, use the Formatting event instead."""
+    lines and separator bars, use the Formatting event instead.
+    """
 
     def code(self) -> str:
         return "Z050"

dbt_common/events/types_pb2.py

@@ -2,11 +2,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: types.proto
 """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()
@@ -15,58 +14,55 @@ _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'
-)
+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')
 
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "types_pb2", _globals)
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'types_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
-    DESCRIPTOR._options = None
-    _EVENTINFO_EXTRAENTRY._options = None
-    _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
+  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
 # @@protoc_insertion_point(module_scope)

dbt_common/exceptions/base.py

@@ -92,9 +92,7 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
         return "Runtime"
 
     def node_to_string(self, node: Any):
-        """
-        Given a node-like object we attempt to create the best identifier we can
-        """
+        """Given a node-like object we attempt to create the best identifier we can."""
         result = ""
         if hasattr(node, "resource_type"):
             result += node.resource_type
@@ -125,8 +123,9 @@ class DbtRuntimeError(RuntimeError, DbtBaseException):
         return lines
 
     def validator_error_message(self, exc: builtins.Exception):
-        """Given a dbt.dataclass_schema.ValidationError (which is basically a
-        jsonschema.ValidationError), return the relevant parts as a string
+        """Given a dbt.dataclass_schema.ValidationError return the relevant parts as a string.
+
+        dbt.dataclass_schema.ValidationError is basically a jsonschema.ValidationError)
         """
         if not isinstance(exc, ValidationError):
             return str(exc)
@@ -175,9 +174,14 @@ class CompilationError(DbtRuntimeError):
 
     def _fix_dupe_msg(self, path_1: str, path_2: str, name: str, type_name: str) -> str:
         if path_1 == path_2:
-            return f"remove one of the {type_name} entries for {name} in this file:\n - {path_1!s}\n"
+            return (
+                f"remove one of the {type_name} entries for {name} in this file:\n - {path_1!s}\n"
+            )
         else:
-            return f"remove the {type_name} entry for {name} in one of these files:\n" f" - {path_1!s}\n{path_2!s}"
+            return (
+                f"remove the {type_name} entry for {name} in one of these files:\n"
+                f" - {path_1!s}\n{path_2!s}"
+            )
 
 
 class RecursionError(DbtRuntimeError):

dbt_common/exceptions/cache.py

@@ -15,7 +15,9 @@ class NewNameAlreadyInCacheError(CacheInconsistencyError):
     def __init__(self, old_key: str, new_key: str):
         self.old_key = old_key
         self.new_key = new_key
-        msg = f'in rename of "{self.old_key}" -> "{self.new_key}", new name is in the cache already'
+        msg = (
+            f'in rename of "{self.old_key}" -> "{self.new_key}", new name is in the cache already'
+        )
         super().__init__(msg)
 
 
@@ -55,7 +57,10 @@ class TruncatedModelNameCausedCollisionError(CacheInconsistencyError):
         else:
             message_addendum = ""
 
-        msg = f"in rename, new key {self.new_key} already in cache: {list(self.relations.keys())}{message_addendum}"
+        msg = (
+            f"in rename, new key {self.new_key} already in "
+            f"cache: {list(self.relations.keys())}{message_addendum}"
+        )
 
         return msg
 

dbt_common/exceptions/connection.py

@@ -1,7 +1,8 @@
 class ConnectionError(Exception):
-    """
-    There was a problem with the connection that returned a bad response,
-    timed out, or resulted in a file that is corrupt.
+    """ConnectionError.
+
+    Connection that returned a bad response, timed out, or resulted
+    in a file that is corrupt.
     """
 
     pass

dbt_common/exceptions/jinja.py

@@ -24,7 +24,8 @@ class MissingCloseTagError(CompilationError):
 
     def get_message(self) -> str:
         msg = (
-            f"Reached EOF without finding a close tag for {self.block_type_name} (searched from line {self.linecount})"
+            "Reached EOF without finding a close tag for "
+            f"{self.block_type_name} (searched from line {self.linecount})"
         )
         return msg
 

dbt_common/exceptions/macros.py

@@ -4,10 +4,9 @@ from dbt_common.exceptions import CompilationError, DbtBaseException
 
 
 class MacroReturn(DbtBaseException):
-    """
+    """This is how we return a value from a macro, not an exception.
+
     Hack of all hacks
-    This is not actually an exception.
-    It's how we return a value from a macro.
     """
 
     def __init__(self, value) -> None:
@@ -66,7 +65,10 @@ class MacroNameNotStringError(CompilationError):
         super().__init__(msg=self.get_message())
 
     def get_message(self) -> str:
-        msg = f"The macro_name parameter ({self.kwarg_value}) " "to adapter.dispatch was not a string"
+        msg = (
+            f"The macro_name parameter ({self.kwarg_value}) "
+            "to adapter.dispatch was not a string"
+        )
         return msg
 
 
@@ -102,6 +104,9 @@ class MacroResultError(CompilationError):
         super().__init__(msg=self.get_message())
 
     def get_message(self) -> str:
-        msg = f'Got an invalid result from "{self.freshness_macro_name}" macro: {[tuple(r) for r in self.table]}'
+        msg = (
+            f'Got an invalid result from "{self.freshness_macro_name}" '
+            f"macro: {[tuple(r) for r in self.table]}"
+        )
 
         return msg

dbt_common/helper_types.py

@@ -25,7 +25,7 @@ class NVEnum(StrEnum):
 
 @dataclass
 class NoValue(dbtClassMixin):
-    """Sometimes, you want a way to say none that isn't None"""
+    """Sometimes, you want a way to say none that isn't None!"""
 
     novalue: NVEnum = field(default_factory=lambda: NVEnum.novalue)
 
@@ -39,10 +39,14 @@ class IncludeExclude(dbtClassMixin):
 
     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")
+            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}")
+            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)
@@ -51,7 +55,9 @@ class IncludeExclude(dbtClassMixin):
             self._validate_items(self.exclude)
 
     def includes(self, item_name: str):
-        return (item_name in self.include or self.include in self.INCLUDE_ALL) and item_name not in self.exclude
+        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]):
         pass