Add Mergeable to contract utils

.changes/unreleased/Features-20240201-101851.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Add dataclass utility `Mergeable`
+time: 2024-02-01T10:18:51.474231-08:00
+custom:
+  Author: QMalcolm
+  Issue: "58"

dbt_common/contracts/util.py

@@ -5,3 +5,19 @@
 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)

tests/unit/test_contracts_util.py

@@ -0,0 +1,26 @@
+import unittest
+
+from dataclasses import dataclass
+from dbt_common.contracts.util import Mergeable
+from typing import List, Optional
+
+
+@dataclass
+class ExampleMergableClass(Mergeable):
+    attr_a: str
+    attr_b: Optional[int]
+    attr_c: Optional[List[str]]
+
+
+class TestMergableClass(unittest.TestCase):
+    def test_mergeability(self):
+        mergeable1 = ExampleMergableClass(
+            attr_a="loses", attr_b=None, attr_c=["I'll", "still", "exist"]
+        )
+        mergeable2 = ExampleMergableClass(attr_a="Wins", attr_b=1, attr_c=None)
+        merge_result: ExampleMergableClass = mergeable1.merged(mergeable2)
+        assert (
+            merge_result.attr_a == mergeable2.attr_a
+        )  # mergeable2's attr_a is the "last" non None value
+        assert merge_result.attr_b == mergeable2.attr_b  # mergeable1's attrb_b value was None
+        assert merge_result.attr_c == mergeable1.attr_c  # mergeable2's attr_c value was None