IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4299 from tk0miya/refactor_MockImporter

Browse Source 
autodoc: refactor MockImporter
This commit is contained in:
Takeshi KOMIYA 2017-12-14 22:13:16 +09:00 committed by GitHub
commit 9d44cb5952
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 53 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
sphinx/ext/autodoc/__init__.py
View File

@ -24,7 +24,8 @@ from docutils.parsers.rst import Directive
from docutils.statemachine import ViewList from docutils.statemachine import ViewList
import sphinx import sphinx
from sphinx.ext.autodoc.importer import _MockImporter, import_module from sphinx.ext.autodoc.importer import mock, import_module
from sphinx.ext.autodoc.importer import _MockImporter # to keep compatibility # NOQA
from sphinx.ext.autodoc.inspector import format_annotation, formatargspec # to keep compatibility # NOQA from sphinx.ext.autodoc.inspector import format_annotation, formatargspec # to keep compatibility # NOQA
from sphinx.util import rpartition, force_decode from sphinx.util import rpartition, force_decode
from sphinx.locale import _ from sphinx.locale import _
@ -388,47 +389,45 @@ class Documenter(object):
self.modname, '.'.join(self.objpath)) self.modname, '.'.join(self.objpath))
# always enable mock import hook # always enable mock import hook
# it will do nothing if autodoc_mock_imports is empty # it will do nothing if autodoc_mock_imports is empty
import_hook = _MockImporter(self.env.config.autodoc_mock_imports) with mock(self.env.config.autodoc_mock_imports):
try: try:
logger.debug('[autodoc] import %s', self.modname) logger.debug('[autodoc] import %s', self.modname)
obj = import_module(self.modname, self.env.config.autodoc_warningiserror) obj = import_module(self.modname, self.env.config.autodoc_warningiserror)
parent = None parent = None
self.module = obj self.module = obj
logger.debug('[autodoc] => %r', obj)
for part in self.objpath:
parent = obj
logger.debug('[autodoc] getattr(_, %r)', part)
obj = self.get_attr(obj, part)
logger.debug('[autodoc] => %r', obj) logger.debug('[autodoc] => %r', obj)
self.object_name = part for part in self.objpath:
self.parent = parent parent = obj
self.object = obj logger.debug('[autodoc] getattr(_, %r)', part)
return True obj = self.get_attr(obj, part)
# this used to only catch SyntaxError, ImportError and AttributeError, logger.debug('[autodoc] => %r', obj)
# but importing modules with side effects can raise all kinds of errors self.object_name = part
except (Exception, SystemExit) as e: self.parent = parent
if self.objpath: self.object = obj
errmsg = 'autodoc: failed to import %s %r from module %r' % \ return True
(self.objtype, '.'.join(self.objpath), self.modname) # this used to only catch SyntaxError, ImportError and AttributeError,
else: # but importing modules with side effects can raise all kinds of errors
errmsg = 'autodoc: failed to import %s %r' % \ except (Exception, SystemExit) as e:
(self.objtype, self.fullname) if self.objpath:
if isinstance(e, SystemExit): errmsg = 'autodoc: failed to import %s %r from module %r' % \
errmsg += ('; the module executes module level statement ' + (self.objtype, '.'.join(self.objpath), self.modname)
'and it might call sys.exit().') else:
elif isinstance(e, ImportError): errmsg = 'autodoc: failed to import %s %r' % \
errmsg += '; the following exception was raised:\n%s' % e.args[0] (self.objtype, self.fullname)
else: if isinstance(e, SystemExit):
errmsg += '; the following exception was raised:\n%s' % \ errmsg += ('; the module executes module level statement ' +
traceback.format_exc() 'and it might call sys.exit().')
if PY2: elif isinstance(e, ImportError):
errmsg = errmsg.decode('utf-8') # type: ignore errmsg += '; the following exception was raised:\n%s' % e.args[0]
logger.debug(errmsg) else:
self.directive.warn(errmsg) errmsg += '; the following exception was raised:\n%s' % \
self.env.note_reread() traceback.format_exc()
return False if PY2:
finally: errmsg = errmsg.decode('utf-8') # type: ignore
import_hook.disable() logger.debug(errmsg)
self.directive.warn(errmsg)
self.env.note_reread()
return False
def get_real_modname(self): def get_real_modname(self):
# type: () -> str # type: () -> str

16
sphinx/ext/autodoc/importer.py
View File

@ -10,15 +10,16 @@
""" """
import sys import sys
import traceback
import warnings import warnings
import traceback
import contextlib
from types import FunctionType, MethodType, ModuleType from types import FunctionType, MethodType, ModuleType
from sphinx.util import logging from sphinx.util import logging
if False: if False:
# For type annotation # For type annotation
from typing import Any, List, Set # NOQA from typing import Any, Generator, List, Set # NOQA
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -77,7 +78,6 @@ class _MockModule(ModuleType):
class _MockImporter(object): class _MockImporter(object):
def __init__(self, names): def __init__(self, names):
# type: (List[str]) -> None # type: (List[str]) -> None
self.base_packages = set() # type: Set[str] self.base_packages = set() # type: Set[str]
@ -120,6 +120,16 @@ class _MockImporter(object):
return module return module
@contextlib.contextmanager
def mock(names):
# type: (List[str]) -> Generator
try:
importer = _MockImporter(names)
yield
finally:
importer.disable()
def import_module(modname, warningiserror=False): def import_module(modname, warningiserror=False):
""" """
Call __import__(modname), convert exceptions to ImportError Call __import__(modname), convert exceptions to ImportError