From d62780cb125d1ac29dab8ee08508851ccf12dae0 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 22 Feb 2025 17:52:47 +0000 Subject: [PATCH] Docs: Test presence of optional extensions with importlib (GH-130445) (cherry picked from commit 3cc9e867eba1ed139cf28c74b4a788bcc4801394) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- Doc/conf.py | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/Doc/conf.py b/Doc/conf.py index 6f85e92550f3f3..40e436a27c7f22 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -6,9 +6,10 @@ # The contents of this file are pickled, so don't put values in the namespace # that aren't pickleable (module imports are okay, they're removed automatically). -import importlib import os import sys +from importlib import import_module +from importlib.util import find_spec # Make our custom extensions available to Sphinx sys.path.append(os.path.abspath('tools/extensions')) @@ -37,19 +38,17 @@ ] # Skip if downstream redistributors haven't installed them -try: - import notfound.extension # noqa: F401 -except ImportError: - pass -else: - extensions.append('notfound.extension') -try: - import sphinxext.opengraph # noqa: F401 -except ImportError: - pass -else: - extensions.append('sphinxext.opengraph') - +_OPTIONAL_EXTENSIONS = ( + 'notfound.extension', + 'sphinxext.opengraph', +) +for optional_ext in _OPTIONAL_EXTENSIONS: + try: + if find_spec(optional_ext) is not None: + extensions.append(optional_ext) + except (ImportError, ValueError): + pass +del _OPTIONAL_EXTENSIONS doctest_global_setup = ''' try: @@ -72,7 +71,7 @@ # We look for the Include/patchlevel.h file in the current Python source tree # and replace the values accordingly. # See Doc/tools/extensions/patchlevel.py -version, release = importlib.import_module('patchlevel').get_version_info() +version, release = import_module('patchlevel').get_version_info() rst_epilog = f""" .. |python_version_literal| replace:: ``Python {version}``