Skip to content

DefaultDocumentationParser

Bases: AbstractDocumentationParser

Parses documentation in any format. Should not be used if there is another parser for the specific format.

Source code in library_analyzer/processing/api/documentation_parsing/_DefaultDocumentationParser.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class DefaultDocumentationParser(AbstractDocumentationParser):
    """
    Parses documentation in any format. Should not be used if there is another parser for the specific format.
    """

    def get_class_documentation(
        self, class_node: astroid.ClassDef
    ) -> ClassDocumentation:
        return ClassDocumentation(
            full_docstring=get_full_docstring(class_node),
        )

    def get_function_documentation(
        self, function_node: astroid.FunctionDef
    ) -> FunctionDocumentation:
        return FunctionDocumentation(
            full_docstring=get_full_docstring(function_node),
        )

    def get_parameter_documentation(
        self,
        function_node: astroid.FunctionDef,
        parameter_name: str,
        parameter_assigned_by: ParameterAssignment,
    ) -> ParameterDocumentation:
        return ParameterDocumentation()

get_class_documentation(class_node)

Source code in library_analyzer/processing/api/documentation_parsing/_DefaultDocumentationParser.py 
18
19
20
21
22
23
def get_class_documentation(
    self, class_node: astroid.ClassDef
) -> ClassDocumentation:
    return ClassDocumentation(
        full_docstring=get_full_docstring(class_node),
    )

get_function_documentation(function_node)

Source code in library_analyzer/processing/api/documentation_parsing/_DefaultDocumentationParser.py 
25
26
27
28
29
30
def get_function_documentation(
    self, function_node: astroid.FunctionDef
) -> FunctionDocumentation:
    return FunctionDocumentation(
        full_docstring=get_full_docstring(function_node),
    )

get_parameter_documentation(function_node, parameter_name, parameter_assigned_by)

Source code in library_analyzer/processing/api/documentation_parsing/_DefaultDocumentationParser.py 
32
33
34
35
36
37
38
def get_parameter_documentation(
    self,
    function_node: astroid.FunctionDef,
    parameter_name: str,
    parameter_assigned_by: ParameterAssignment,
) -> ParameterDocumentation:
    return ParameterDocumentation()