From e3ca7b11b5927d69c38b69ca952a68e6355f6a48 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:14:37 +0000 Subject: [PATCH 01/12] improve type annotations in 'docutils.readers.standalone' --- stubs/docutils/docutils/readers/standalone.pyi | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/standalone.pyi b/stubs/docutils/docutils/readers/standalone.pyi index 0f6820f054ea..da0752895007 100644 --- a/stubs/docutils/docutils/readers/standalone.pyi +++ b/stubs/docutils/docutils/readers/standalone.pyi @@ -1,3 +1,15 @@ -from _typeshed import Incomplete +__docformat__: str -def __getattr__(name: str) -> Incomplete: ... + +from typing import ClassVar, Literal, TypeVar +from docutils import readers + + +_S = TypeVar("_S") + +class Reader(readers.Reader[_S]): + + supported: ClassVar[tuple[Literal["standalone"]]] + + config_section: ClassVar[Literal["standalone reader"]] + config_section_dependencies: ClassVar[tuple[Literal["readers"]]] From 8ac23e9ebcbb7688d577b6850c0821f6ca86e313 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 28 Dec 2024 16:16:38 +0000 Subject: [PATCH 02/12] [pre-commit.ci] auto fixes from pre-commit.com hooks --- stubs/docutils/docutils/readers/standalone.pyi | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/standalone.pyi b/stubs/docutils/docutils/readers/standalone.pyi index da0752895007..476863228819 100644 --- a/stubs/docutils/docutils/readers/standalone.pyi +++ b/stubs/docutils/docutils/readers/standalone.pyi @@ -1,9 +1,8 @@ __docformat__: str - from typing import ClassVar, Literal, TypeVar -from docutils import readers +from docutils import readers _S = TypeVar("_S") From 85312ac722933fc26b43e6dee6c8fbaf5c638b2b Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:21:39 +0000 Subject: [PATCH 03/12] fixup --- stubs/docutils/@tests/stubtest_allowlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/stubs/docutils/@tests/stubtest_allowlist.txt b/stubs/docutils/@tests/stubtest_allowlist.txt index 7e7784921b80..7f5ca35344b6 100644 --- a/stubs/docutils/@tests/stubtest_allowlist.txt +++ b/stubs/docutils/@tests/stubtest_allowlist.txt @@ -12,6 +12,7 @@ docutils.nodes.Text.__new__ docutils.parsers.recommonmark_wrapper docutils.parsers.rst.directives.admonitions.BaseAdmonition.node_class # must be overridden by base classes (pseudo-abstract) docutils.parsers.rst.directives.misc.MetaBody.__getattr__ +docutils.readers.standalone.document docutils.statemachine.State.nested_sm # is initialised in __init__ docutils.statemachine.State.nested_sm_kwargs # is initialised in __init__ docutils.statemachine.ViewList.__iter__ # doesn't exist at runtime, but the class is iterable due to __getitem__ From 6e5ad43dc15535e1d150890e6cd0ec79f2b1f80f Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:24:40 +0000 Subject: [PATCH 04/12] fixup --- stubs/docutils/@tests/stubtest_allowlist.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stubs/docutils/@tests/stubtest_allowlist.txt b/stubs/docutils/@tests/stubtest_allowlist.txt index 7f5ca35344b6..d23da52973a1 100644 --- a/stubs/docutils/@tests/stubtest_allowlist.txt +++ b/stubs/docutils/@tests/stubtest_allowlist.txt @@ -12,7 +12,7 @@ docutils.nodes.Text.__new__ docutils.parsers.recommonmark_wrapper docutils.parsers.rst.directives.admonitions.BaseAdmonition.node_class # must be overridden by base classes (pseudo-abstract) docutils.parsers.rst.directives.misc.MetaBody.__getattr__ -docutils.readers.standalone.document +docutils.readers.standalone.Reader.document docutils.statemachine.State.nested_sm # is initialised in __init__ docutils.statemachine.State.nested_sm_kwargs # is initialised in __init__ docutils.statemachine.ViewList.__iter__ # doesn't exist at runtime, but the class is iterable due to __getitem__ From cee1eb16bfb7cbc27d6833629715718eb756f7d3 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:53:41 +0000 Subject: [PATCH 05/12] fixup --- stubs/docutils/docutils/readers/standalone.pyi | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/stubs/docutils/docutils/readers/standalone.pyi b/stubs/docutils/docutils/readers/standalone.pyi index 476863228819..57e1fda2b3af 100644 --- a/stubs/docutils/docutils/readers/standalone.pyi +++ b/stubs/docutils/docutils/readers/standalone.pyi @@ -1,6 +1,6 @@ __docformat__: str -from typing import ClassVar, Literal, TypeVar +from typing import ClassVar, TypeVar from docutils import readers @@ -8,7 +8,6 @@ _S = TypeVar("_S") class Reader(readers.Reader[_S]): - supported: ClassVar[tuple[Literal["standalone"]]] + supported: ClassVar[tuple[str]] - config_section: ClassVar[Literal["standalone reader"]] - config_section_dependencies: ClassVar[tuple[Literal["readers"]]] + config_section_dependencies: ClassVar[tuple[str]] From f55e281e245f9015f6aedc0cd7062b43a7bd97ee Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 15:49:58 +0000 Subject: [PATCH 06/12] improve type annotations in 'docutils.readers.pep' --- stubs/docutils/docutils/readers/pep.pyi | 27 +++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index 0f6820f054ea..bdea69da2df9 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -1,3 +1,26 @@ -from _typeshed import Incomplete +__docformat__: str -def __getattr__(name: str) -> Incomplete: ... + +from typing import Any, ClassVar +from docutils.parsers.rst.states import Inliner +from docutils.readers import standalone +from docutils.transforms import Transform +from docutils.parsers import Parser + + +class Reader(standalone.Reader): + + supported: ClassVar[tuple[str]] = ('pep',) + + settings_spec: ClassVar[tuple[Any, ...]] + + config_section: ClassVar[str] + config_section_dependencies: ClassVar[tuple[str]] + + def get_transforms(self) -> list[type[Transform]]: ... + + settings_default_overrides = {'pep_references': 1, 'rfc_references': 1} + + inliner_class: ClassVar[type[Inliner]] + + def __init__(self, parser: Parser | None=None, parser_name: str | None=None): ... From 1d83a361f8f44127a13ebb903c0c0611e0737253 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 28 Dec 2024 15:51:48 +0000 Subject: [PATCH 07/12] [pre-commit.ci] auto fixes from pre-commit.com hooks --- stubs/docutils/docutils/readers/pep.pyi | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index bdea69da2df9..e40c1a9d4eaa 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -1,16 +1,15 @@ __docformat__: str - from typing import Any, ClassVar + +from docutils.parsers import Parser from docutils.parsers.rst.states import Inliner from docutils.readers import standalone from docutils.transforms import Transform -from docutils.parsers import Parser - class Reader(standalone.Reader): - supported: ClassVar[tuple[str]] = ('pep',) + supported: ClassVar[tuple[str]] = ("pep",) settings_spec: ClassVar[tuple[Any, ...]] @@ -19,8 +18,8 @@ class Reader(standalone.Reader): def get_transforms(self) -> list[type[Transform]]: ... - settings_default_overrides = {'pep_references': 1, 'rfc_references': 1} + settings_default_overrides = {"pep_references": 1, "rfc_references": 1} inliner_class: ClassVar[type[Inliner]] - def __init__(self, parser: Parser | None=None, parser_name: str | None=None): ... + def __init__(self, parser: Parser | None = None, parser_name: str | None = None): ... From d911000530b6ab34fc533baedc18fbe0ba15d520 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 15:53:56 +0000 Subject: [PATCH 08/12] fixup --- stubs/docutils/docutils/readers/pep.pyi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index e40c1a9d4eaa..38823c0f3fb3 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -1,6 +1,6 @@ __docformat__: str -from typing import Any, ClassVar +from typing import Any, ClassVar, Literal from docutils.parsers import Parser from docutils.parsers.rst.states import Inliner @@ -14,7 +14,7 @@ class Reader(standalone.Reader): settings_spec: ClassVar[tuple[Any, ...]] config_section: ClassVar[str] - config_section_dependencies: ClassVar[tuple[str]] + config_section_dependencies: ClassVar[tuple[Literal['readers'], Literal['standalone reader']]] def get_transforms(self) -> list[type[Transform]]: ... From 18f8cc408fdf5be21b04efab44e49677613ea9a7 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 15:59:01 +0000 Subject: [PATCH 09/12] fixup --- stubs/docutils/docutils/readers/pep.pyi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index 38823c0f3fb3..d00e3a193242 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -9,7 +9,7 @@ from docutils.transforms import Transform class Reader(standalone.Reader): - supported: ClassVar[tuple[str]] = ("pep",) + supported: ClassVar[tuple[Literal["pep"]]] settings_spec: ClassVar[tuple[Any, ...]] @@ -18,7 +18,7 @@ class Reader(standalone.Reader): def get_transforms(self) -> list[type[Transform]]: ... - settings_default_overrides = {"pep_references": 1, "rfc_references": 1} + settings_default_overrides: ClassVar[dict[str, int]] inliner_class: ClassVar[type[Inliner]] From 6b4e01e5fd9af34d99bca6a07176d5f424f15a66 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:18:06 +0000 Subject: [PATCH 10/12] rebase on readers.standalone --- stubs/docutils/docutils/readers/pep.pyi | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index d00e3a193242..46759f312660 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -1,23 +1,20 @@ __docformat__: str -from typing import Any, ClassVar, Literal +from typing import ClassVar, Literal, TypeVar from docutils.parsers import Parser from docutils.parsers.rst.states import Inliner from docutils.readers import standalone -from docutils.transforms import Transform -class Reader(standalone.Reader): +_S = TypeVar("_S") - supported: ClassVar[tuple[Literal["pep"]]] +class Reader(standalone.Reader[_S]): - settings_spec: ClassVar[tuple[Any, ...]] + supported: ClassVar[tuple[Literal["pep"]]] - config_section: ClassVar[str] + config_section: ClassVar[Literal['pep reader']] config_section_dependencies: ClassVar[tuple[Literal['readers'], Literal['standalone reader']]] - def get_transforms(self) -> list[type[Transform]]: ... - settings_default_overrides: ClassVar[dict[str, int]] inliner_class: ClassVar[type[Inliner]] From 47e254e4d4e15815450f936cec54e1fe94c4704b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 28 Dec 2024 16:19:50 +0000 Subject: [PATCH 11/12] [pre-commit.ci] auto fixes from pre-commit.com hooks --- stubs/docutils/docutils/readers/pep.pyi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index 46759f312660..052276787652 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -12,8 +12,8 @@ class Reader(standalone.Reader[_S]): supported: ClassVar[tuple[Literal["pep"]]] - config_section: ClassVar[Literal['pep reader']] - config_section_dependencies: ClassVar[tuple[Literal['readers'], Literal['standalone reader']]] + config_section: ClassVar[Literal["pep reader"]] + config_section_dependencies: ClassVar[tuple[Literal["readers"], Literal["standalone reader"]]] settings_default_overrides: ClassVar[dict[str, int]] From e32a4eec1273b4a85aecfb51ff5c0418ada3a390 Mon Sep 17 00:00:00 2001 From: Daniel Eades Date: Sat, 28 Dec 2024 16:54:18 +0000 Subject: [PATCH 12/12] fixup --- stubs/docutils/docutils/readers/pep.pyi | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/stubs/docutils/docutils/readers/pep.pyi b/stubs/docutils/docutils/readers/pep.pyi index 052276787652..0e1521137022 100644 --- a/stubs/docutils/docutils/readers/pep.pyi +++ b/stubs/docutils/docutils/readers/pep.pyi @@ -1,6 +1,6 @@ __docformat__: str -from typing import ClassVar, Literal, TypeVar +from typing import ClassVar, TypeVar from docutils.parsers import Parser from docutils.parsers.rst.states import Inliner @@ -10,11 +10,6 @@ _S = TypeVar("_S") class Reader(standalone.Reader[_S]): - supported: ClassVar[tuple[Literal["pep"]]] - - config_section: ClassVar[Literal["pep reader"]] - config_section_dependencies: ClassVar[tuple[Literal["readers"], Literal["standalone reader"]]] - settings_default_overrides: ClassVar[dict[str, int]] inliner_class: ClassVar[type[Inliner]]