From 46df0607b3c5237fc17c50b65e33b49ad11a82e9 Mon Sep 17 00:00:00 2001
From: Ryan Moe <ryan.moe@gmail.com>
Date: Fri, 20 Nov 2020 12:32:14 -0800
Subject: [PATCH] Allow get_export_names to skip configuration check

This introduces an environment variable named
NBCONVERT_DISABLE_CONFIG_EXPORTERS that will cause get_export_names to
return all entrypoints instead of checking the "enabled" status of
each one.

Closes: #1439
---
 docs/autogen_config.py                     |  4 +++
 nbconvert/exporters/base.py                |  5 ++++
 nbconvert/exporters/tests/test_exporter.py | 31 +++++++++++++++++++++-
 3 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/autogen_config.py b/docs/autogen_config.py
index 3db045b4c..c4de6c4b7 100644
--- a/docs/autogen_config.py
+++ b/docs/autogen_config.py
@@ -35,6 +35,10 @@
 CLI Flags and Aliases
 ---------------------
 
+The dynamic loading of exporters can be disabled by setting the environment
+variable ``NBCONVERT_DISABLE_CONFIG_EXPORTERS``. This causes all exporters
+to be loaded regardless of the value of their ``enabled`` attribute.
+
 When using Nbconvert from the command line, a number of aliases and flags are
 defined as shortcuts to configuration options for convience.
 
diff --git a/nbconvert/exporters/base.py b/nbconvert/exporters/base.py
index 47f0967cc..25c29aad7 100644
--- a/nbconvert/exporters/base.py
+++ b/nbconvert/exporters/base.py
@@ -3,6 +3,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+import os
 import warnings
 
 import entrypoints
@@ -135,6 +136,10 @@ def get_export_names(config=get_config()):
     them as an nbconvert.exporter entrypoint.
     """
     exporters = sorted(entrypoints.get_group_named('nbconvert.exporters'))
+    if os.environ.get("NBCONVERT_DISABLE_CONFIG_EXPORTERS"):
+        get_logger().info("Config exporter loading disabled, no additional exporters will be automatically included.")
+        return exporters
+
     enabled_exporters = []
     for exporter_name in exporters:
         try:
diff --git a/nbconvert/exporters/tests/test_exporter.py b/nbconvert/exporters/tests/test_exporter.py
index 5fbbc11f8..427b23366 100644
--- a/nbconvert/exporters/tests/test_exporter.py
+++ b/nbconvert/exporters/tests/test_exporter.py
@@ -13,9 +13,11 @@
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
-
+import os
 from traitlets.config import Config
 
+from unittest.mock import patch
+
 from .base import ExportersTestsBase
 from ...preprocessors.base import Preprocessor
 from ..exporter import Exporter
@@ -73,3 +75,30 @@ def test_get_export_names_disable(self):
         })
         export_names = get_export_names(config=config)
         self.assertEqual(export_names, ['notebook'])
+
+    def test_get_exporter_disable_config_exporters(self):
+        """
+        Does get_export_names behave correctly with respect to
+        NBCONVERT_DISABLE_CONFIG_EXPORTERS being set in the
+        environment?
+        """
+        config = Config({
+            'Exporter': {'enabled': False},
+            'NotebookExporter': {'enabled': True}
+        })
+        os.environ["NBCONVERT_DISABLE_CONFIG_EXPORTERS"] = "1"
+        with patch("nbconvert.exporters.base.get_exporter") as exp:
+            export_names = get_export_names(config=config)
+            # get_export_names should not call get_exporter for
+            # any of the entry points because we return before then.
+            exp.assert_not_called()
+
+            # We should have all exporters, not just the ones
+            # enabled in the config
+            self.assertNotEqual(export_names, ['notebook'])
+
+        # In the abscence of this variable we should revert to
+        # the normal behavior.
+        del os.environ["NBCONVERT_DISABLE_CONFIG_EXPORTERS"]
+        export_names = get_export_names(config=config)
+        self.assertEqual(export_names, ['notebook'])