docspec_python_parse_source_code_to_module_structure.py

1import docspec
2import docspec_python
3
4# Parse a Python file or string into a list of docspec objects
5module = docspec_python.parse_python(
6    "def my_function(a: int, b: str = 'hello') -> None:\n"
7    "    '''This is a docstring.'''\n"
8    "    pass",
9    module_name="my_module"
10)
11
12# Print the resulting module structure
13print(module)
14
15# Example: Iterating through the members of the module
16for member in module.members:
17    if isinstance(member, docspec.Function):
18        print(f"Function name: {member.name}")
19        print(f"Docstring: {member.docstring.content if member.docstring else 'No docstring'}")
20        print(f"Arguments: {[arg.name for arg in member.args]}")