Merge pull request #26 from jepperaskdk/bugfix/sphinx-generics

Bugfix/sphinx generics

pydoctest/parsers/numpy_parser.py

@@ -27,8 +27,8 @@ def __init__(self) -> None:
         ]
         # Split by word, newline, a number of '-' and newline
         self.section_regex = re.compile("([a-zA-Z]+)\n[-]+\n")
-        self.parameter_regex = re.compile(r"(\w+)\s*:\s*(\w+)")
-        self.returns_with_name_regex = re.compile(r"(\w+)\s*:\s*(\w+)")
+        self.parameter_regex = re.compile(r"(\w+)\s*:\s*([\w\[\], ]+)")
+        self.returns_with_name_regex = re.compile(r"(\w+)\s*:\s*([\w\[\], ]+)")
 
     def get_exceptions_raised(self, doc: str) -> List[str]:
         """Returns the exceptions listed as raised in the docstring.

pydoctest/parsers/sphinx_parser.py

@@ -19,8 +19,8 @@ def __init__(self) -> None:
         """Parser for Sphinx docstring style."""
         super().__init__()
         self.parameter_name_regex = re.compile(r":param\s+(\w+):")
-        self.parameter_type_regex = re.compile(r":type\s+\w+:\s*(\w+)")
-        self.return_type_regex = re.compile(r":rtype:\s*(\w+)")
+        self.parameter_type_regex = re.compile(r":type\s+\w+:\s*([\w\[\], ]+)")
+        self.return_type_regex = re.compile(r":rtype:\s*([\w\[\], ]+)")
         self.raises_regex = re.compile(r":raises\s+(\w+):")
 
     def get_exceptions_raised(self, doc: str) -> List[str]:

pydoctest/version.py

@@ -1 +1 @@
-VERSION = "0.1.13"
+VERSION = "0.1.14"

tests/test_parsers/numpy_class.py

@@ -1,3 +1,5 @@
+from typing import Any, Dict
+
 
 def failing_global_function(a: int) -> int:
     """[summary]
@@ -137,6 +139,22 @@ def func_parse_exception(self, a: int) -> int:
 
 
 class CorrectTestClass():
+
+    def func_with_generics(self, a_a: Dict[str, Any]) -> Dict[str, Any]:
+        """[summary]
+
+        Parameters
+        ----------
+        a_a : Dict[str, Any]
+            [description]
+
+        Returns
+        -------
+        Dict[str, Any]
+            [description]
+        """
+        pass
+
     def empty_func(self) -> None:
         """Empty func
         """

tests/test_parsers/sphinx_class.py

@@ -1,3 +1,4 @@
+from typing import Any, Dict
 
 
 def failing_global_function(a: int) -> int:
@@ -105,6 +106,16 @@ def func_parse_exception(self, a: int) -> int:
 
 
 class CorrectTestClass():
+    def func_with_generics(self, a_a: Dict[str, Any]) -> Dict[str, Any]:
+        """[summary]
+
+        :param a_a: [description]
+        :type a_a: Dict[str, Any]
+        :return: [description]
+        :rtype: Dict[str, Any]
+        """
+        pass
+
     def empty_func(self) -> None:
         """Empty func
         """

tests/test_parsers/test_numpy_parser.py

@@ -1,4 +1,5 @@
 import pydoc
+from typing import Any, Dict
 import pytest
 
 from pydoctest.parsers.numpy_parser import NumpyParser
@@ -146,3 +147,14 @@ def test_func_with_raise(self) -> None:
 
         intersection = set(expected_exceptions) - set(actual_exceptions)
         assert len(intersection) == 0
+
+    def test_func_with_generics(self) -> None:
+        parser = NumpyParser()
+        doc = pydoc.getdoc(tests.test_parsers.numpy_class.CorrectTestClass.func_with_generics)
+        parameters = parser.get_parameters(doc, tests.test_parsers.numpy_class)
+        assert len(parameters) == 1
+        assert parameters[0].type == Dict[str, Any]
+        assert parameters[0].name == 'a_a'
+
+        return_type = parser.get_return_type(doc, tests.test_parsers.numpy_class)
+        assert return_type == Dict[str, Any]

tests/test_parsers/test_sphinx_parser.py

@@ -1,4 +1,5 @@
 import pydoc
+from typing import Dict, Any
 import pytest
 
 from pydoctest.parsers.sphinx_parser import SphinxParser
@@ -139,3 +140,14 @@ def test_func_with_raise(self) -> None:
 
         intersection = set(expected_exceptions) - set(actual_exceptions)
         assert len(intersection) == 0
+
+    def test_func_with_generics(self) -> None:
+        parser = SphinxParser()
+        doc = pydoc.getdoc(tests.test_parsers.sphinx_class.CorrectTestClass.func_with_generics)
+        parameters = parser.get_parameters(doc, tests.test_parsers.sphinx_class)
+        assert len(parameters) == 1
+        assert parameters[0].type == Dict[str, Any]
+        assert parameters[0].name == 'a_a'
+
+        return_type = parser.get_return_type(doc, tests.test_parsers.sphinx_class)
+        assert return_type == Dict[str, Any]