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

Pass exceptions directly to docutils reporter

Browse Source 
The docutils reporter supports an exception as an argument. It is
converted to a string internally.
This commit is contained in:
Jon Dufresne 2018-12-16 09:21:55 -08:00
parent 6461ea233b
commit d414471eed
4 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sphinx/directives/code.py
View File

@ -14,7 +14,6 @@ from difflib import unified_diff
from docutils import nodes from docutils import nodes
from docutils.parsers.rst import directives from docutils.parsers.rst import directives
from docutils.statemachine import StringList from docutils.statemachine import StringList
from six import text_type
from sphinx import addnodes from sphinx import addnodes
from sphinx.deprecation import RemovedInSphinx40Warning from sphinx.deprecation import RemovedInSphinx40Warning
@ -143,7 +142,7 @@ class CodeBlock(SphinxDirective):
hl_lines = [x + 1 for x in hl_lines if x < nlines] hl_lines = [x + 1 for x in hl_lines if x < nlines]
except ValueError as err: except ValueError as err:
return [document.reporter.warning(str(err), line=self.lineno)] return [document.reporter.warning(err, line=self.lineno)]
else: else:
hl_lines = None hl_lines = None
@ -170,7 +169,7 @@ class CodeBlock(SphinxDirective):
try: try:
literal = container_wrapper(self, literal, caption) literal = container_wrapper(self, literal, caption)
except ValueError as exc: except ValueError as exc:
return [document.reporter.warning(text_type(exc), line=self.lineno)] return [document.reporter.warning(exc, line=self.lineno)]
# literal will be note_implicit_target that is linked from caption and numref. # literal will be note_implicit_target that is linked from caption and numref.
# when options['name'] is provided, it should be primary ID. # when options['name'] is provided, it should be primary ID.
@ -465,7 +464,7 @@ class LiteralInclude(SphinxDirective):
return [retnode] return [retnode]
except Exception as exc: except Exception as exc:
return [document.reporter.warning(text_type(exc), line=self.lineno)] return [document.reporter.warning(exc, line=self.lineno)]
def setup(app): def setup(app):

2
sphinx/directives/patches.py
View File

@ -162,7 +162,7 @@ class MathDirective(SphinxDirective):
self.state.document.note_explicit_target(target) self.state.document.note_explicit_target(target)
ret.insert(0, target) ret.insert(0, target)
except UserWarning as exc: except UserWarning as exc:
self.state_machine.reporter.warning(exc.args[0], line=self.lineno) self.state_machine.reporter.warning(exc, line=self.lineno)
def setup(app): def setup(app):

14
sphinx/domains/cpp.py
View File

@ -6288,7 +6288,7 @@ class CPPObject(ObjectDescription):
option_spec['tparam-line-spec'] = directives.flag option_spec['tparam-line-spec'] = directives.flag
def warn(self, msg): def warn(self, msg):
# type: (str) -> None # type: (Union[str, Exception]) -> None
self.state_machine.reporter.warning(msg, line=self.lineno) self.state_machine.reporter.warning(msg, line=self.lineno)
def _add_enumerator_to_parent(self, ast): def _add_enumerator_to_parent(self, ast):
@ -6443,7 +6443,7 @@ class CPPObject(ObjectDescription):
ast = self.parse_definition(parser) ast = self.parse_definition(parser)
parser.assert_end() parser.assert_end()
except DefinitionError as e: except DefinitionError as e:
self.warn(e.description) self.warn(e)
# It is easier to assume some phony name than handling the error in # It is easier to assume some phony name than handling the error in
# the possibly inner declarations. # the possibly inner declarations.
name = _make_phony_error_name() name = _make_phony_error_name()
@ -6588,7 +6588,7 @@ class CPPNamespaceObject(SphinxDirective):
option_spec = {} # type: Dict option_spec = {} # type: Dict
def warn(self, msg): def warn(self, msg):
# type: (str) -> None # type: (Union[str, Exception]) -> None
self.state_machine.reporter.warning(msg, line=self.lineno) self.state_machine.reporter.warning(msg, line=self.lineno)
def run(self): def run(self):
@ -6603,7 +6603,7 @@ class CPPNamespaceObject(SphinxDirective):
ast = parser.parse_namespace_object() ast = parser.parse_namespace_object()
parser.assert_end() parser.assert_end()
except DefinitionError as e: except DefinitionError as e:
self.warn(e.description) self.warn(e)
name = _make_phony_error_name() name = _make_phony_error_name()
ast = ASTNamespace(name, None) ast = ASTNamespace(name, None)
symbol = rootSymbol.add_name(ast.nestedName, ast.templatePrefix) symbol = rootSymbol.add_name(ast.nestedName, ast.templatePrefix)
@ -6622,7 +6622,7 @@ class CPPNamespacePushObject(SphinxDirective):
option_spec = {} # type: Dict option_spec = {} # type: Dict
def warn(self, msg): def warn(self, msg):
# type: (str) -> None # type: (Union[str, Exception]) -> None
self.state_machine.reporter.warning(msg, line=self.lineno) self.state_machine.reporter.warning(msg, line=self.lineno)
def run(self): def run(self):
@ -6634,7 +6634,7 @@ class CPPNamespacePushObject(SphinxDirective):
ast = parser.parse_namespace_object() ast = parser.parse_namespace_object()
parser.assert_end() parser.assert_end()
except DefinitionError as e: except DefinitionError as e:
self.warn(e.description) self.warn(e)
name = _make_phony_error_name() name = _make_phony_error_name()
ast = ASTNamespace(name, None) ast = ASTNamespace(name, None)
oldParent = self.env.temp_data.get('cpp:parent_symbol', None) oldParent = self.env.temp_data.get('cpp:parent_symbol', None)
@ -6657,7 +6657,7 @@ class CPPNamespacePopObject(SphinxDirective):
option_spec = {} # type: Dict option_spec = {} # type: Dict
def warn(self, msg): def warn(self, msg):
# type: (str) -> None # type: (Union[str, Exception]) -> None
self.state_machine.reporter.warning(msg, line=self.lineno) self.state_machine.reporter.warning(msg, line=self.lineno)
def run(self): def run(self):

3
sphinx/ext/inheritance_diagram.py
View File

@ -363,8 +363,7 @@ class InheritanceDiagram(SphinxDirective):
aliases=self.config.inheritance_alias, aliases=self.config.inheritance_alias,
top_classes=node['top-classes']) top_classes=node['top-classes'])
except InheritanceException as err: except InheritanceException as err:
return [node.document.reporter.warning(err.args[0], return [node.document.reporter.warning(err, line=self.lineno)]
line=self.lineno)]
# Create xref nodes for each target of the graph's image map and # Create xref nodes for each target of the graph's image map and
# add them to the doc tree so that Sphinx can resolve the # add them to the doc tree so that Sphinx can resolve the