from typing import Dict, Iterable, Optional

from docforge.models.object import DocObject


class Module:
    """Represents a documented Python module."""

    path: str
    docstring: Optional[str]
    members: Dict[str, DocObject]

    def __init__(
        self,
        path: str,
        docstring: Optional[str] = ...,
    ) -> None: ...

    def add_object(self, obj: DocObject) -> None: ...

    def get_object(self, name: str) -> DocObject: ...

    def get_all_objects(self) -> Iterable[DocObject]: ...