Skip to content

PlaintextDocstringParser

Bases: AbstractDocstringParser

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

Source code in src/library_analyzer/processing/api/docstring_parsing/_plaintext_docstring_parser.py 
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
39
class PlaintextDocstringParser(AbstractDocstringParser):
    """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) -> ClassDocstring:
        docstring = get_full_docstring(class_node)

        return ClassDocstring(
            description=docstring,
            full_docstring=docstring,
        )

    def get_function_documentation(self, function_node: astroid.FunctionDef) -> FunctionDocstring:
        docstring = get_full_docstring(function_node)

        return FunctionDocstring(
            description=docstring,
            full_docstring=docstring,
        )

    def get_parameter_documentation(
        self,
        function_node: astroid.FunctionDef,  # noqa: ARG002
        parameter_name: str,  # noqa: ARG002
        parameter_assigned_by: ParameterAssignment,  # noqa: ARG002
    ) -> ParameterDocstring:
        return ParameterDocstring()

get_class_documentation(class_node)

Source code in src/library_analyzer/processing/api/docstring_parsing/_plaintext_docstring_parser.py 
17
18
19
20
21
22
23
def get_class_documentation(self, class_node: astroid.ClassDef) -> ClassDocstring:
    docstring = get_full_docstring(class_node)

    return ClassDocstring(
        description=docstring,
        full_docstring=docstring,
    )

get_function_documentation(function_node)

Source code in src/library_analyzer/processing/api/docstring_parsing/_plaintext_docstring_parser.py 
25
26
27
28
29
30
31
def get_function_documentation(self, function_node: astroid.FunctionDef) -> FunctionDocstring:
    docstring = get_full_docstring(function_node)

    return FunctionDocstring(
        description=docstring,
        full_docstring=docstring,
    )

get_parameter_documentation(function_node, parameter_name, parameter_assigned_by)

Source code in src/library_analyzer/processing/api/docstring_parsing/_plaintext_docstring_parser.py 
33
34
35
36
37
38
39
def get_parameter_documentation(
    self,
    function_node: astroid.FunctionDef,  # noqa: ARG002
    parameter_name: str,  # noqa: ARG002
    parameter_assigned_by: ParameterAssignment,  # noqa: ARG002
) -> ParameterDocstring:
    return ParameterDocstring()