Fix union in return type (#1)

.gitignore

@@ -2,3 +2,4 @@
 __pycache__
 *.egg-info
 poetry.lock
+.idea/

CHANGELOG.md

@@ -1,3 +1,7 @@
+# (Fork) 0.0.1 (2023-08-18)
+
+- Google: Fixed a bug where union style return types (such as `int | str`) are not parsed correctly
+
 # 0.15 (2022-09-05)
 
 - Parser: add a new function, `parse_from_object`, that supports scattered

README.md

@@ -1,6 +1,10 @@
-docstring_parser
+docstring_parser_fork
 ================
 
+This is a fork of [docstring_parser](https://github.com/rr-/docstring_parser). The reason I'm forking that is to quickly get some bug fixes out for users of [pydoclint](https://github.com/jsh9/pydoclint).
+
+------
+
 [![Build](https://github.com/rr-/docstring_parser/actions/workflows/build.yml/badge.svg)](https://github.com/rr-/docstring_parser/actions/workflows/build.yml)
 
 Parse Python docstrings. Currently support ReST, Google, Numpydoc-style and
@@ -42,13 +46,13 @@ Read [API Documentation](https://rr-.github.io/docstring_parser/).
 Installation using pip
 
 ```shell
-pip install docstring_parser
+pip install docstring_parser_fork
 
 # or if you want to install it in a virtual environment
 
 python -m venv venv # create environment
 source venv/bin/activate # activate environment
-python -m pip install docstring_parser
+python -m pip install docstring_parser_fork
 ```
 
 Installation using conda

docstring_parser/google.py

@@ -43,7 +43,7 @@ class Section(namedtuple("SectionBase", "title key type")):
 
 GOOGLE_TYPED_ARG_REGEX = re.compile(r"\s*(.+?)\s*\(\s*(.*[^\s]+)\s*\)")
 GOOGLE_ARG_DESC_REGEX = re.compile(r".*\. Defaults to (.+)\.")
-MULTIPLE_PATTERN = re.compile(r"(\s*[^:\s]+:)|([^:]*\]:.*)")
+MULTIPLE_PATTERN = re.compile(r"(\s*[^:\s]+:)|([^:]*\]:.*)|(\s*[^|\s]+(\s*\|\s*[^|\s]+)*:)")  # noqa: E501
 
 DEFAULT_SECTIONS = [
     Section("Arguments", "param", SectionType.MULTIPLE),

docstring_parser/tests/test_google.py

@@ -551,6 +551,20 @@ def test_returns() -> None:
     assert len(docstring.many_returns) == 1
     assert docstring.many_returns[0] == docstring.returns
 
+    docstring = parse(
+        """
+        Short description
+        Returns:
+            str | int|None  | bool: A description: with a colon
+        """
+    )
+    assert docstring.returns is not None
+    assert docstring.returns.type_name == "str | int|None  | bool"
+    assert docstring.returns.description == "A description: with a colon"
+    assert docstring.many_returns is not None
+    assert len(docstring.many_returns) == 1
+    assert docstring.many_returns[0] == docstring.returns
+
     docstring = parse(
         """
         Returns:

pyproject.toml

@@ -3,13 +3,13 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-name = "docstring_parser"
-version = "0.15"
+name = "docstring_parser_fork"
+version = "0.0.1"
 description = "Parse Python docstrings in reST, Google and Numpydoc format"
 authors = ["Marcin Kurczewski <[email protected]>"]
 license = "MIT"
 readme = "README.md"
-repository = "https://github.com/rr-/docstring_parser"
+repository = "https://github.com/jsh9/docstring_parser_fork"
 classifiers = [
     "Environment :: Other Environment",
     "Development Status :: 4 - Beta",
@@ -43,7 +43,7 @@ line-length = 79
 py36 = true
 
 [tool.isort]
-known_third_party = "docstring_parser"
+known_third_party = "docstring_parser_fork"
 multi_line_output = 3
 include_trailing_comma = true