Allowing parse to work with missing __doc__

docstring_parser/epydoc.py

@@ -26,7 +26,7 @@ def _clean_str(string: str) -> T.Optional[str]:
     return None
 
 
-def parse(text: str) -> Docstring:
+def parse(text: T.Optional[str]) -> Docstring:
     """Parse the epydoc-style docstring into its components.
 
     :returns: parsed docstring

docstring_parser/google.py

@@ -202,7 +202,7 @@ def add_section(self, section: Section):
         self.sections[section.title] = section
         self._setup()
 
-    def parse(self, text: str) -> Docstring:
+    def parse(self, text: T.Optional[str]) -> Docstring:
         """Parse the Google-style docstring into its components.
 
         :returns: parsed docstring
@@ -293,7 +293,7 @@ def parse(self, text: str) -> Docstring:
         return ret
 
 
-def parse(text: str) -> Docstring:
+def parse(text: T.Optional[str]) -> Docstring:
     """Parse the Google-style docstring into its components.
 
     :returns: parsed docstring

docstring_parser/numpydoc.py

@@ -325,7 +325,7 @@ def add_section(self, section: Section):
         self.sections[section.title] = section
         self._setup()
 
-    def parse(self, text: str) -> Docstring:
+    def parse(self, text: T.Optional[str]) -> Docstring:
         """Parse the numpy-style docstring into its components.
 
         :returns: parsed docstring
@@ -370,7 +370,7 @@ def parse(self, text: str) -> Docstring:
         return ret
 
 
-def parse(text: str) -> Docstring:
+def parse(text: T.Optional[str]) -> Docstring:
     """Parse the numpy-style docstring into its components.
 
     :returns: parsed docstring

docstring_parser/parser.py

@@ -20,7 +20,9 @@
 }
 
 
-def parse(text: str, style: DocstringStyle = DocstringStyle.AUTO) -> Docstring:
+def parse(
+    text: T.Optional[str], style: DocstringStyle = DocstringStyle.AUTO
+) -> Docstring:
     """Parse the docstring into its components.
 
     :param text: docstring text to parse

docstring_parser/rest.py

@@ -99,7 +99,7 @@ def _build_meta(args: T.List[str], desc: str) -> DocstringMeta:
     return DocstringMeta(args=args, description=desc)
 
 
-def parse(text: str) -> Docstring:
+def parse(text: T.Optional[str]) -> Docstring:
     """Parse the ReST-style docstring into its components.
 
     :returns: parsed docstring

docstring_parser/tests/test_epydoc.py

@@ -10,14 +10,17 @@
 @pytest.mark.parametrize(
     "source, expected",
     [
+        pytest.param(None, None, id="No __doc__"),
         ("", None),
         ("\n", None),
         ("Short description", "Short description"),
         ("\nShort description\n", "Short description"),
         ("\n   Short description\n", "Short description"),
     ],
 )
-def test_short_description(source: str, expected: str) -> None:
+def test_short_description(
+    source: T.Optional[str], expected: T.Optional[str]
+) -> None:
     """Test parsing short description."""
     docstring = parse(source)
     assert docstring.short_description == expected

docstring_parser/tests/test_google.py

@@ -143,14 +143,17 @@ def test_google_parser_custom_sections_after() -> None:
 @pytest.mark.parametrize(
     "source, expected",
     [
+        pytest.param(None, None, id="No __doc__"),
         ("", None),
         ("\n", None),
         ("Short description", "Short description"),
         ("\nShort description\n", "Short description"),
         ("\n   Short description\n", "Short description"),
     ],
 )
-def test_short_description(source: str, expected: str) -> None:
+def test_short_description(
+    source: T.Optional[str], expected: T.Optional[str]
+) -> None:
     """Test parsing short description."""
     docstring = parse(source)
     assert docstring.short_description == expected

docstring_parser/tests/test_numpydoc.py

@@ -9,14 +9,17 @@
 @pytest.mark.parametrize(
     "source, expected",
     [
+        pytest.param(None, None, id="No __doc__"),
         ("", None),
         ("\n", None),
         ("Short description", "Short description"),
         ("\nShort description\n", "Short description"),
         ("\n   Short description\n", "Short description"),
     ],
 )
-def test_short_description(source: str, expected: str) -> None:
+def test_short_description(
+    source: T.Optional[str], expected: T.Optional[str]
+) -> None:
     """Test parsing short description."""
     docstring = parse(source)
     assert docstring.short_description == expected

docstring_parser/tests/test_parser.py

@@ -1,10 +1,34 @@
 """Tests for generic docstring routines."""
 
+import typing as T
+
 import pytest
 from docstring_parser.common import DocstringStyle, ParseError
 from docstring_parser.parser import parse
 
 
+@pytest.mark.parametrize(
+    "source, expected",
+    [
+        pytest.param(None, None, id="No __doc__"),
+        ("", None),
+        ("\n", None),
+        ("Short description", "Short description"),
+        ("\nShort description\n", "Short description"),
+        ("\n   Short description\n", "Short description"),
+    ],
+)
+def test_short_description(
+    source: T.Optional[str], expected: T.Optional[str]
+) -> None:
+    """Test parsing short description."""
+    docstring = parse(source)
+    assert docstring.short_description == expected
+    assert docstring.description == expected
+    assert docstring.long_description is None
+    assert not docstring.meta
+
+
 def test_rest() -> None:
     """Test ReST-style parser autodetection."""
     docstring = parse(

docstring_parser/tests/test_rest.py

@@ -10,14 +10,17 @@
 @pytest.mark.parametrize(
     "source, expected",
     [
+        pytest.param(None, None, id="No __doc__"),
         ("", None),
         ("\n", None),
         ("Short description", "Short description"),
         ("\nShort description\n", "Short description"),
         ("\n   Short description\n", "Short description"),
     ],
 )
-def test_short_description(source: str, expected: str) -> None:
+def test_short_description(
+    source: T.Optional[str], expected: T.Optional[str]
+) -> None:
     """Test parsing short description."""
     docstring = parse(source)
     assert docstring.short_description == expected