Skip to content

[docutils] Add missing stubs for readers dir #14242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions stubs/docutils/docutils/readers/__init__.pyi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Any, ClassVar, Generic, TypeVar
from typing import Any, ClassVar, Final, Generic, TypeVar

from docutils import Component, nodes
from docutils.frontend import Values
Expand All @@ -8,15 +8,18 @@ from docutils.transforms import Transform

_S = TypeVar("_S")

__docformat__: Final = "reStructuredText"

class Reader(Component, Generic[_S]):
component_type: ClassVar[str]
config_section: ClassVar[str]
def get_transforms(self) -> list[type[Transform]]: ...
def __init__(self, parser: Parser | None = None, parser_name: str | None = None) -> None: ...
parser: Parser | None
source: Input[_S] | None
input: str | Any | None
input: str | None
def set_parser(self, parser_name: str) -> None: ...
settings: Values
def read(self, source: Input[_S], parser: Parser, settings: Values) -> nodes.document: ...
document: nodes.document
def parse(self) -> None: ...
Expand Down
5 changes: 3 additions & 2 deletions stubs/docutils/docutils/readers/doctree.pyi
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from typing import TypeVar
from typing import ClassVar, TypeVar

from docutils import readers

_S = TypeVar("_S", bound=str | bytes)

class Reader(readers.ReReader[_S]): ...
class Reader(readers.ReReader[_S]):
config_section_dependencies: ClassVar[tuple[str, ...]]
13 changes: 12 additions & 1 deletion stubs/docutils/docutils/readers/pep.pyi
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
def __getattr__(name: str): ... # incomplete module
from typing import ClassVar, Final, TypeVar

from docutils.parsers.rst import states
from docutils.readers import standalone

__docformat__: Final = "reStructuredText"

_S = TypeVar("_S", bound=str | bytes)

class Reader(standalone.Reader[_S]):
settings_default_overrides: ClassVar[dict[str, int]]
inliner_class: ClassVar[type[states.Inliner]]
12 changes: 11 additions & 1 deletion stubs/docutils/docutils/readers/standalone.pyi
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
def __getattr__(name: str): ... # incomplete module
from typing import ClassVar, Final, TypeVar

from docutils import readers

__docformat__: Final = "reStructuredText"

_S = TypeVar("_S", bound=str | bytes)

class Reader(readers.Reader[_S]):
document: None # type: ignore[assignment]
config_section_dependencies: ClassVar[tuple[str, ...]]