support pandas-style default spec by postprocessing tokens

Author: keewis

sphinx/ext/napoleon/docstring.py

@@ -845,10 +845,17 @@ def combine_set(tokens):
 
 
 def _tokenize_type_spec(spec: str) -> List[str]:
+    def postprocess(item):
+        if item.startswith("default"):
+            return [item[:7], item[7:]]
+        else:
+            return [item]
+
     tokens = list(
         item
-        for item in _token_regex.split(spec)
-        if item is not None and item.strip()
+        for raw_token in _token_regex.split(spec)
+        for item in postprocess(raw_token)
+        if item
     )
     return tokens
 

tests/test_ext_napoleon_docstring.py

@@ -2013,6 +2013,7 @@ def test_tokenize_type_spec(self):
             "int or float or None, optional",
             '{"F", "C", "N"}',
             "{'F', 'C', 'N'}, default: 'F'",
+            "{'F', 'C', 'N or C'}, default 'F'",
             '"ma{icious"',
             r"'with \'quotes\''",
         )
@@ -2022,6 +2023,7 @@ def test_tokenize_type_spec(self):
             ["int", " or ", "float", " or ", "None", ", ", "optional"],
             ["{", '"F"', ", ", '"C"', ", ", '"N"', "}"],
             ["{", "'F'", ", ", "'C'", ", ", "'N'", "}", ", ", "default", ": ", "'F'"],
+            ["{", "'F'", ", ", "'C'", ", ", "'N or C'", "}", ", ", "default", " ", "'F'"],
             ['"ma{icious"'],
             [r"'with \'quotes\''"],
         )