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

* Fix: autodoc, autosummary: importing setup.py will invoke setup process and execute sys.exit(). Now sphinx avoids SystemExit exception and emits warnings without unexpected termination. Closes #1226

Browse Source
This commit is contained in:
Takayuki Shimizukawa 2014-07-05 00:11:59 +09:00
parent b3aa4aa81b
commit 4d69072f44
3 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -18,6 +18,9 @@ Bugs fixed
* #1499: With non-callable `setup` in a conf.py, now sphinx-build emits * #1499: With non-callable `setup` in a conf.py, now sphinx-build emits
user-friendly error message. user-friendly error message.
* #1502: In autodoc, fix display of parameter defaults containing backslashes. * #1502: In autodoc, fix display of parameter defaults containing backslashes.
* #1226: autodoc, autosummary: importing setup.py by automodule will invoke
setup process and execute `sys.exit()`. Now sphinx avoids SystemExit
exception and emits warnings without unexpected termination.
Release 1.2.2 (released Mar 2, 2014) Release 1.2.2 (released Mar 2, 2014)
==================================== ====================================

10
sphinx/ext/autodoc.py
View File

@ -347,15 +347,19 @@ class Documenter(object):
return True return True
# this used to only catch SyntaxError, ImportError and AttributeError, # this used to only catch SyntaxError, ImportError and AttributeError,
# but importing modules with side effects can raise all kinds of errors # but importing modules with side effects can raise all kinds of errors
except Exception: except (Exception, SystemExit) as e:
if self.objpath: if self.objpath:
errmsg = 'autodoc: failed to import %s %r from module %r' % \ errmsg = 'autodoc: failed to import %s %r from module %r' % \
(self.objtype, '.'.join(self.objpath), self.modname) (self.objtype, '.'.join(self.objpath), self.modname)
else: else:
errmsg = 'autodoc: failed to import %s %r' % \ errmsg = 'autodoc: failed to import %s %r' % \
(self.objtype, self.fullname) (self.objtype, self.fullname)
errmsg += '; the following exception was raised:\n%s' % \ if isinstance(e, SystemExit):
traceback.format_exc() errmsg += ('; the module executes module level statement ' +
'and it might call sys.exit().')
else:
errmsg += '; the following exception was raised:\n%s' % \
traceback.format_exc()
dbg(errmsg) dbg(errmsg)
self.directive.warn(errmsg) self.directive.warn(errmsg)
self.env.note_reread() self.env.note_reread()

3
sphinx/ext/autosummary/generate.py
View File

@ -242,6 +242,9 @@ def find_autosummary_in_docstring(name, module=None, filename=None):
pass pass
except ImportError, e: except ImportError, e:
print "Failed to import '%s': %s" % (name, e) print "Failed to import '%s': %s" % (name, e)
except SystemExit, e:
print("Failed to import '%s'; the module executes module level "
"statement and it might call sys.exit()." % name)
return [] return []
def find_autosummary_in_lines(lines, module=None, filename=None): def find_autosummary_in_lines(lines, module=None, filename=None):