Tweak exporter default_config merging behavior (#1981)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
jupyter · May 6, 2023 · d113388 · d113388
1 parent f0d86bc
commit d113388
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 7 deletions.
diff --git a/nbconvert/exporters/asciidoc.py b/nbconvert/exporters/asciidoc.py
@@ -48,5 +48,8 @@ def default_config(self):
                 "HighlightMagicsPreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
diff --git a/nbconvert/exporters/html.py b/nbconvert/exporters/html.py
@@ -187,7 +187,10 @@ def default_config(self):
                 "HighlightMagicsPreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
 
     @contextfilter

diff --git a/nbconvert/exporters/latex.py b/nbconvert/exporters/latex.py
@@ -62,7 +62,10 @@ def default_config(self):
                 "HighlightMagicsPreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
 
     def from_notebook_node(self, nb, resources=None, **kw):

diff --git a/nbconvert/exporters/markdown.py b/nbconvert/exporters/markdown.py
@@ -50,5 +50,8 @@ def default_config(self):
                 "HighlightMagicsPreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
diff --git a/nbconvert/exporters/rst.py b/nbconvert/exporters/rst.py
@@ -33,5 +33,8 @@ def default_config(self):
                 "HighlightMagicsPreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
diff --git a/nbconvert/exporters/templateexporter.py b/nbconvert/exporters/templateexporter.py
@@ -183,7 +183,10 @@ def default_config(self):
                 "TagRemovePreprocessor": {"enabled": True},
             }
         )
-        c.merge(super().default_config)
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
         return c
 
     template_name = Unicode(help="Name of the template to use").tag(

diff --git a/nbconvert/exporters/tests/test_exporter.py b/nbconvert/exporters/tests/test_exporter.py
@@ -19,8 +19,8 @@
 from traitlets.config import Config
 
 from ...preprocessors.base import Preprocessor
+from .. import Exporter, TemplateExporter
 from ..base import get_export_names
-from ..exporter import Exporter
 from .base import ExportersTestsBase
 
 # -----------------------------------------------------------------------------
@@ -38,6 +38,21 @@ def preprocess(self, nb, resources):
         return nb, resources
 
 
+class DummyExporter(TemplateExporter):
+    """
+    Dummy exporter to check that parent default_config gets overwritten properly
+    """
+
+    @property
+    def default_config(self):
+        c = Config({"TagRemovePreprocessor": {"enabled": False}})
+        if super().default_config:
+            c2 = super().default_config.copy()
+            c2.merge(c)
+            c = c2
+        return c
+
+
 class TestExporter(ExportersTestsBase):
     """Contains test functions for exporter.py"""
 
@@ -87,3 +102,12 @@ def test_get_exporter_disable_config_exporters(self):
         del os.environ["NBCONVERT_DISABLE_CONFIG_EXPORTERS"]
         export_names = get_export_names(config=config)
         self.assertEqual(export_names, ["notebook"])
+
+    def test_default_config_merge(self):
+        """
+        Do default_configs merge properly?
+        Class config should overwrite parent config
+        """
+        e = DummyExporter()
+        self.assertFalse(e.default_config["TagRemovePreprocessor"]["enabled"])
+        self.assertTrue(e.default_config["RegexRemovePreprocessor"]["enabled"])