https://github.com/jkfran/docstring-extractor

Get a python file doctrings
https://github.com/jkfran/docstring-extractor

Last synced: about 1 month ago
JSON representation

Get a python file doctrings

• Host: GitHub
• URL: https://github.com/jkfran/docstring-extractor
• Owner: jkfran
• License: gpl-3.0
• Created: 2020-10-27T13:08:27.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-01T12:47:47.000Z (7 months ago)
• Last Synced: 2024-11-10T20:51:47.715Z (about 2 months ago)
• Language: Python
• Size: 61.5 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docstring-extractor

This library allows parsing docstrings of an entire Python file. It uses [ast](https://docs.python.org/3/library/ast.html) and [docstring-parser](https://github.com/rr-/docstring_parser).

The main difference between this library and docstring-parser is that this one is able to parse entire Python files.

## Installation:

`pip install docstring-extractor`

## Usage

```python

>>> from docstring_extractor import get_docstrings

>>>

>>> with open("example.py") as file:

...     docstrings = get_docstrings(file)

```

Imaging you have the following Python code:

```python

"""

Example module.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod

tempor incididunt ut labore et dolore magna aliqua.

"""

def test_function():

    """

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod

    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim

    veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea

    commodo consequat. Duis aute irure dolor in reprehenderit in voluptate

    velit esse cillum dolore eu fugiat nulla pariatur.

    Parameters:

        a (int): A decimal integer

        b (int): Another decimal integer

    Returns:

        str: A string containing "foo"

    """

    return "foo"

```

The output of the `get_docstrings` function will be the following dict object:

```python

{'type': 'Module',

 'name': 'example',

 'line': 0,

 'docstring': ,

 'docstring_text': 'Example module.\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod\ntempor incididunt ut labore et dolore magna aliqua.',

 'content': [

    {'type': 'Function',

       'name': 'test_function',

       'line': 9,

       'docstring': ,

       'docstring_text': 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod\ntempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim\nveniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea\ncommodo consequat. Duis aute irure dolor in reprehenderit in voluptate\nvelit esse cillum dolore eu fugiat nulla pariatur.\n\nParameters:\n    a (int): A decimal integer\n    b (int): Another decimal integer\n\nReturns:\n    str: A string containing "foo"',

    'content': []

    }

 ]

}

```

You can see the different properties of the Docstring object [here](https://github.com/rr-/docstring_parser/blob/master/docstring_parser/common.py), as an example if you are interested in obtaining the return type and return description of the first function:

```python

>>> docstrings["content"][0]["docstring"].returns.type_name

'str'

>>> docstrings["content"][0]["docstring"].returns.description

'A string containing "foo"'

```