Skip to content

FunctionDocumentation

Source code in library_analyzer/processing/api/model/_documentation.py
@dataclass
class FunctionDocumentation:
    description: str = ""
    full_docstring: str = ""

    @staticmethod
    def from_dict(d: dict) -> FunctionDocumentation:
        return FunctionDocumentation(**d)

    def to_dict(self) -> dict:
        return dataclasses.asdict(self)

    def __hash__(self) -> int:
        return hash(
            (
                self.description,
                self.full_docstring,
            )
        )

description: str = '' class-attribute

full_docstring: str = '' class-attribute

__hash__()

Source code in library_analyzer/processing/api/model/_documentation.py
def __hash__(self) -> int:
    return hash(
        (
            self.description,
            self.full_docstring,
        )
    )

from_dict(d) staticmethod

Source code in library_analyzer/processing/api/model/_documentation.py
@staticmethod
def from_dict(d: dict) -> FunctionDocumentation:
    return FunctionDocumentation(**d)

to_dict()

Source code in library_analyzer/processing/api/model/_documentation.py
def to_dict(self) -> dict:
    return dataclasses.asdict(self)