docspec_module_class_creation_and_json_serialization.py

1import docspec
2
3# Create a module with a class and a function
4module = docspec.Module(
5    name='my_module',
6    location=docspec.Location(filename='my_module.py', lineno=1),
7    docstring=None,
8    members=[
9        docspec.Class(
10            name='MyClass',
11            location=docspec.Location(filename='my_module.py', lineno=3),
12            docstring=docspec.Docstring(content='This is a class.'),
13            metaclass=None,
14            bases=None,
15            members=[],
16            decoratrees=[]
17        ),
18        docspec.Function(
19            name='my_function',
20            location=docspec.Location(filename='my_module.py', lineno=7),
21            docstring=docspec.Docstring(content='This is a function.'),
22            args=[],
23            return_type=None,
24            decoratrees=[]
25        )
26    ]
27)
28
29# Dump the module to a JSON-serializable dictionary
30data = docspec.to_dict(module)
31print(data)
32
33# Load the module back from the dictionary
34loaded_module = docspec.from_dict(data)
35print(loaded_module)