autosummary: catch all exceptions when importing modules #4212
Conversation
sphinx/ext/autosummary/__init__.py
Outdated
| Call __import__(modname), convert exceptions to ImportError | ||
| """ | ||
| try: | ||
| return __import__(modname) |
There was a problem hiding this comment.
We also have similar process on sphinx.ext.autodoc. There are additional process for handling warnings. It would be nice if integrated.
with warnings.catch_warnings():
warnings.filterwarnings("ignore", category=ImportWarning)
with logging.skip_warningiserror(not self.env.config.autodoc_warningiserror):
__import__(self.modname)
There was a problem hiding this comment.
If we do this, please do it in sphinx.ext.autodoc or a separate utils module: we don't want sphinx.ext.autodoc depending on sphinx.ext.autosummary
sphinx/ext/autosummary/__init__.py
Outdated
| @@ -502,6 +503,20 @@ def import_by_name(name, prefixes=[None]): | |||
| raise ImportError('no module named %s' % ' or '.join(tried)) | |||
|
|
|||
|
|
|||
| def _import_or_importerror(modname): | |||
There was a problem hiding this comment.
How about renaming this to import_module? I think the function name should represent its purpose, not behavior.
Module imports may raise any exceptions, including SystemExit, which need to be caught.
pv
force-pushed
the
autosummary-importsafe
branch
from
144ec4b
to
d5bea6b
Compare
|
Changed function name + added catch_warnings, but not the logging suppression (which uses autodoc settings). As it is now, the autosummary import handling remains separate from autodoc. In principle it could be nice to combine them, but that is more of a bigger refactoring than bugfix. |
|
Manually merged (see #4232). Thank you for contribution! |
Subject: autosummary: catch all exceptions when importing modules
Feature or Bugfix
Purpose
Similarly to autodoc, autosummary/autolink try to import modules.
Module import may, in addition to ImportError, raise any exception,
including SystemExit. These need to be caught, since failing module
import should not cause a documentation build to fail.
Tests updated with examples that failed previously.
autodoc already does similar catching of exceptions.