Merge pull request #6237 from tk0miya/6220_napoleon_AttributeError

Fix #6220, #6225: napoleon: AttributeError is raised for raised section having references
sphinx-doc · Apr 4, 2019 · d34302a · d34302a
2 parents cbefc01 + 8e356c3
commit d34302a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/CHANGES b/CHANGES
@@ -22,6 +22,9 @@ Bugs fixed
   - sphinx.application.CONFIG_FILENAME
   - :confval:`viewcode_import`
 
+* #6220, #6225: napoleon: AttributeError is raised for raised section having
+  references
+
 Testing
 --------
 

diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py
@@ -100,7 +100,7 @@ class GoogleDocstring:
 
     """
 
-    _name_rgx = re.compile(r"^\s*(:(?P<role>\w+):`(?P<name>[a-zA-Z0-9_.-]+)`|"
+    _name_rgx = re.compile(r"^\s*((?::(?P<role>\S+):)?`(?P<name>[a-zA-Z0-9_.-]+)`|"
                            r" (?P<name2>[a-zA-Z0-9_.-]+))\s*", re.X)
 
     def __init__(self, docstring, config=None, app=None, what='', name='',
@@ -700,9 +700,9 @@ def _parse_raises_section(self, section):
         fields = self._consume_fields(parse_type=False, prefer_type=True)
         lines = []  # type: List[str]
         for _name, _type, _desc in fields:
-            m = self._name_rgx.match(_type).groupdict()
-            if m['role']:
-                _type = m['name']
+            m = self._name_rgx.match(_type)
+            if m and m.group('name'):
+                _type = m.group('name')
             _type = ' ' + _type if _type else ''
             _desc = self._strip_empty(_desc)
             _descs = ' ' + '\n    '.join(_desc) if any(_desc) else ''

diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py
@@ -473,12 +473,21 @@ def test_raises_types(self):
         A setting wasn't specified, or was invalid.
     ValueError:
         Something something value error.
+    :py:class:`AttributeError`
+        errors for missing attributes.
+    ~InvalidDimensionsError
+        If the dimensions couldn't be parsed.
+    `InvalidArgumentsError`
+        If the arguments are invalid.
 
 """, """
 Example Function
 
 :raises RuntimeError: A setting wasn't specified, or was invalid.
 :raises ValueError: Something something value error.
+:raises AttributeError: errors for missing attributes.
+:raises ~InvalidDimensionsError: If the dimensions couldn't be parsed.
+:raises InvalidArgumentsError: If the arguments are invalid.
 """),
                       ################################
                       ("""