Skip to content

AbstractDocumentationParser

Bases: ABC

Source code in library_analyzer/processing/api/documentation_parsing/_AbstractDocumentationParser.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class AbstractDocumentationParser(ABC):
    @abstractmethod
    def get_class_documentation(
        self, class_node: astroid.ClassDef
    ) -> ClassDocumentation:
        pass

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

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

get_class_documentation(class_node) abstractmethod

Source code in library_analyzer/processing/api/documentation_parsing/_AbstractDocumentationParser.py 
15
16
17
18
19
@abstractmethod
def get_class_documentation(
    self, class_node: astroid.ClassDef
) -> ClassDocumentation:
    pass

get_function_documentation(function_node) abstractmethod

Source code in library_analyzer/processing/api/documentation_parsing/_AbstractDocumentationParser.py 
21
22
23
24
25
@abstractmethod
def get_function_documentation(
    self, function_node: astroid.FunctionDef
) -> FunctionDocumentation:
    pass

get_parameter_documentation(function_node, parameter_name, parameter_assigned_by) abstractmethod

Source code in library_analyzer/processing/api/documentation_parsing/_AbstractDocumentationParser.py 
27
28
29
30
31
32
33
34
@abstractmethod
def get_parameter_documentation(
    self,
    function_node: astroid.FunctionDef,
    parameter_name: str,
    parameter_assigned_by: ParameterAssignment,
) -> ParameterDocumentation:
    pass