raises exception

Author: sumansaurabh

PyDocSmith/google.py

@@ -326,7 +326,26 @@ def parse(self, text: str) -> Docstring:
                 part = chunk[start:end].strip("\n")
                 ret.meta.append(self._build_meta(part, title))
         ret.meta = [m for m in ret.meta if m]
-        return ret
+        return remove_non_required_exceptions(ret)
+    
+def remove_non_required_exceptions(docstring: Docstring) -> Docstring:
+    """Remove non-required exceptions from the docstring.
+
+    :param docstring: parsed docstring representation
+    :returns: docstring representation with non-required exceptions removed
+    """
+    # docstring.raises = [r for r in docstring.raises if r.type_name != 'Any']
+    # return docstring
+    for idx, itm in enumerate(docstring.meta):
+
+        if isinstance(itm, DocstringRaises):
+            if itm.type_name == "Any":
+                docstring.meta.pop(idx)
+
+       
+    return docstring
+
+
 
 
 def parse(text: str) -> Docstring:

PyDocSmith/tests/test_google.py

@@ -917,6 +917,34 @@ def test_none_returns() -> None:
     assert len(docstring.many_returns) == 0
     print(compose(docstring))
 
+def test_any_exception() -> None:
+    """Test parsing examples."""
+    docstring = parse(
+        """A sample function
+        
+        A function the demonstrates docstrings
+        
+        Args:
+            arg1 (int): The firsty arg
+
+        Exceptions:
+            Any: Any exception that is coming
+
+        Returns:
+            None
+        """
+    )
+    new_docstring = compose(docstring, rendering_style=RenderingStyle.COMPACT)
+    print(new_docstring)
+    docstring = parse(new_docstring)
+    assert docstring is not None
+    assert len(docstring.params) == 1
+    assert len(docstring.raises) == 0
+
+    assert docstring.returns is None
+    assert len(docstring.many_returns) == 0
+    print(compose(docstring))
+
 
 def test_broken_meta() -> None:
     """Test parsing broken meta."""