Make deep merge commonly available

Author: dannyadair

src/pdfbaker/__init__.py

@@ -4,6 +4,7 @@
     combine_pdfs,
     compress_pdf,
     convert_svg_to_pdf,
+    deep_merge,
     load_pages,
 )
 from .render import (
@@ -21,19 +22,20 @@
 
 __all__ = [
     # Common functions
-    "load_pages",
-    "compress_pdf",
     "combine_pdfs",
+    "compress_pdf",
     "convert_svg_to_pdf",
+    "deep_merge",
+    "load_pages",
     # Render functions
-    "process_template_data",
     "create_env",
+    "encode_image",
+    "encode_images",
     "highlight",
-    "process_style",
-    "process_text_with_jinja",
     "process_list_item_texts",
     "process_list_items",
+    "process_style",
+    "process_template_data",
+    "process_text_with_jinja",
     "space_bullets",
-    "encode_image",
-    "encode_images",
 ]

src/pdfbaker/__main__.py

@@ -7,26 +7,10 @@
 
 import yaml
 
+from .common import deep_merge
 from .render import create_env
 
 
-def _deep_merge(base, update):
-    """Recursively merge two dictionaries.
-
-    Values in update will override those in base, except for dictionaries
-    which will be merged recursively.
-    """
-    merged = base.copy()
-
-    for key, value in update.items():
-        if key in merged and isinstance(merged[key], dict) and isinstance(value, dict):
-            merged[key] = _deep_merge(merged[key], value)
-        else:
-            merged[key] = value
-
-    return merged
-
-
 def _get_config_path(config_path=None):
     """Get and validate the configuration file path."""
     if config_path is None:
@@ -149,7 +133,7 @@ def _process_document(doc_name, doc_path, config, build_dir, dist_dir):
 
     bake_module.process_document(
         paths=paths,
-        config=_deep_merge(config, doc_config),
+        config=deep_merge(config, doc_config),
         jinja_env=create_env(paths["templates_dir"]),
     )
 

src/pdfbaker/common.py

@@ -13,6 +13,21 @@
     CAIROSVG_AVAILABLE = False
 
 
+def deep_merge(base, update):
+    """Recursively merge two dictionaries.
+
+    Values in update will override those in base, except for dictionaries
+    which will be merged recursively.
+    """
+    merged = base.copy()
+    for key, value in update.items():
+        if key in merged and isinstance(merged[key], dict) and isinstance(value, dict):
+            merged[key] = deep_merge(merged[key], value)
+        else:
+            merged[key] = value
+    return merged
+
+
 def load_pages(pages_dir):
     """Load page configurations from a specific subdirectory."""
     pages = {}