Files
doc-forge/docforge/models/object.pyi

24 lines
582 B
Python

from collections.abc import Iterable
class DocObject:
"""Represents a documented Python object."""
name: str
kind: str
path: str
signature: str | None
docstring: str | None
members: dict[str, DocObject]
def __init__(
self,
name: str,
kind: str,
path: str,
signature: str | None = ...,
docstring: str | None = ...,
) -> None: ...
def add_member(self, obj: DocObject) -> None: ...
def get_member(self, name: str) -> DocObject: ...
def get_all_members(self) -> Iterable[DocObject]: ...