Skip to content

Single quoted word in argument breaks docstring parsing #7

@jamesbraza

Description

@jamesbraza

The below code with Python 3.12 and python-cdd==0.0.99rc47:

import cdd.docstring.parse

def my_function(arg: str) -> None:
    """Summary.

    Args:
        arg: A 'quoted' word. 
    """

cdd.docstring.parse.docstring(my_function.__doc__)

Will crash _parse_adhoc_doc_for_typ_phase0 with TypeError: unhashable type: 'list'

Traceback (most recent call last):
...
  File "/path/to/venv/lib/python3.12/site-packages/cdd/docstring/utils/parse_utils.py", line 263, in parse_adhoc_doc_for_typ
    candidate_type, fst_sentence, sentence = _parse_adhoc_doc_for_typ_phase0(doc, words)
                                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/path/to/venv/lib/python3.12/site-packages/cdd/docstring/utils/parse_utils.py", line 410, in _parse_adhoc_doc_for_typ_phase0
    candidate_type: Optional[str] = next(
                                    ^^^^^
TypeError: unhashable type: 'list'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions