Skip to content

AbstractDocstringParser

Bases: ABC

Source code in src/library_analyzer/processing/api/docstring_parsing/_abstract_docstring_parser.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class AbstractDocstringParser(ABC):
    @abstractmethod
    def get_class_documentation(self, class_node: astroid.ClassDef) -> ClassDocstring:
        pass

    @abstractmethod
    def get_function_documentation(self, function_node: astroid.FunctionDef) -> FunctionDocstring:
        pass

    @abstractmethod
    def get_parameter_documentation(
        self,
        function_node: astroid.FunctionDef,
        parameter_name: str,
        parameter_assigned_by: ParameterAssignment,
    ) -> ParameterDocstring:
        pass

get_class_documentation(class_node) abstractmethod

Source code in src/library_analyzer/processing/api/docstring_parsing/_abstract_docstring_parser.py 
18
19
20
@abstractmethod
def get_class_documentation(self, class_node: astroid.ClassDef) -> ClassDocstring:
    pass

get_function_documentation(function_node) abstractmethod

Source code in src/library_analyzer/processing/api/docstring_parsing/_abstract_docstring_parser.py 
22
23
24
@abstractmethod
def get_function_documentation(self, function_node: astroid.FunctionDef) -> FunctionDocstring:
    pass

get_parameter_documentation(function_node, parameter_name, parameter_assigned_by) abstractmethod

Source code in src/library_analyzer/processing/api/docstring_parsing/_abstract_docstring_parser.py 
26
27
28
29
30
31
32
33
@abstractmethod
def get_parameter_documentation(
    self,
    function_node: astroid.FunctionDef,
    parameter_name: str,
    parameter_assigned_by: ParameterAssignment,
) -> ParameterDocstring:
    pass