basedpyright 1.31.5 → 1.31.6

package/dist/typeshed-fallback/stubs/docutils/docutils/core.pyi

@@ -3,7 +3,6 @@ from typing import Final
 from typing_extensions import deprecated
 
 from docutils import SettingsSpec
-from docutils.frontend import OptionParser
 from docutils.io import FileInput, Input, Output
 from docutils.parsers import Parser
 from docutils.readers import Reader
@@ -33,18 +32,10 @@ class Publisher:
         destination_class=...,
         settings: dict[str, Incomplete] | None = None,
     ) -> None: ...
-    def set_reader(self, reader_name: str, parser: Parser | None, parser_name: str | None) -> None: ...
+    def set_reader(self, reader: str, parser: Parser | None = None, parser_name: str | None = None) -> None: ...
     def set_writer(self, writer_name: str) -> None: ...
+    @deprecated("The `Publisher.set_components()` will be removed in Docutils 2.0.")
     def set_components(self, reader_name: str, parser_name: str, writer_name: str) -> None: ...
-    @deprecated("Publisher.setup_option_parser is deprecated, and will be removed in Docutils 0.21.")
-    def setup_option_parser(
-        self,
-        usage: str | None = None,
-        description: str | None = None,
-        settings_spec: SettingsSpec | None = None,
-        config_section: str | None = None,
-        **defaults,
-    ) -> OptionParser: ...
     def get_settings(
         self,
         usage: str | None = None,
@@ -64,7 +55,7 @@ class Publisher:
         **defaults,
     ) -> None: ...
     def set_io(self, source_path: StrPath | None = None, destination_path: StrPath | None = None) -> None: ...
-    def set_source(self, source=None, source_path: StrPath | None = None) -> None: ...
+    def set_source(self, source: str | None = None, source_path: StrPath | None = None) -> None: ...
     def set_destination(self, destination=None, destination_path: StrPath | None = None) -> None: ...
     def apply_transforms(self) -> None: ...
     def publish(
@@ -88,18 +79,18 @@ default_description: Final[str]
 
 def publish_cmdline(
     reader: Reader[Incomplete] | None = None,
-    reader_name: str = "standalone",
+    reader_name: str | None = None,
     parser: Parser | None = None,
-    parser_name: str = "restructuredtext",
+    parser_name: str | None = None,
     writer: Writer[Incomplete] | None = None,
-    writer_name: str = "pseudoxml",
+    writer_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides=None,
     config_section: str | None = None,
     enable_exit_status: bool = True,
     argv: list[str] | None = None,
-    usage: str = ...,
+    usage: str = "%prog [options] [<source> [<destination>]]",
     description: str = ...,
 ): ...
 def publish_file(
@@ -108,11 +99,11 @@ def publish_file(
     destination=None,
     destination_path: StrPath | None = None,
     reader=None,
-    reader_name: str = "standalone",
+    reader_name: str | None = None,
     parser=None,
-    parser_name: str = "restructuredtext",
+    parser_name: str | None = None,
     writer=None,
-    writer_name: str = "pseudoxml",
+    writer_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides=None,
@@ -124,11 +115,11 @@ def publish_string(
     source_path: StrPath | None = None,
     destination_path: StrPath | None = None,
     reader=None,
-    reader_name: str = "standalone",
+    reader_name: str | None = None,
     parser=None,
-    parser_name: str = "restructuredtext",
+    parser_name: str | None = None,
     writer=None,
-    writer_name: str = "pseudoxml",
+    writer_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides=None,
@@ -141,11 +132,11 @@ def publish_parts(
     source_class=...,
     destination_path: StrPath | None = None,
     reader=None,
-    reader_name: str = "standalone",
+    reader_name: str | None = None,
     parser=None,
-    parser_name: str = "restructuredtext",
+    parser_name: str | None = None,
     writer=None,
-    writer_name: str = "pseudoxml",
+    writer_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides: dict[str, Incomplete] | None = None,
@@ -157,9 +148,9 @@ def publish_doctree(
     source_path: StrPath | None = None,
     source_class=...,
     reader=None,
-    reader_name: str = "standalone",
+    reader_name: str | None = None,
     parser=None,
-    parser_name: str = "restructuredtext",
+    parser_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides=None,
@@ -170,13 +161,14 @@ def publish_from_doctree(
     document,
     destination_path: StrPath | None = None,
     writer=None,
-    writer_name: str = "pseudoxml",
+    writer_name: str | None = None,
     settings=None,
     settings_spec=None,
     settings_overrides=None,
     config_section: str | None = None,
     enable_exit_status: bool = False,
 ): ...
+@deprecated("The `publish_cmdline_to_binary()` is deprecated  by `publish_cmdline()` and will be removed in Docutils 0.24.")
 def publish_cmdline_to_binary(
     reader=None,
     reader_name: str = "standalone",
@@ -190,7 +182,7 @@ def publish_cmdline_to_binary(
     config_section: str | None = None,
     enable_exit_status: bool = True,
     argv: list[str] | None = None,
-    usage: str = ...,
+    usage: str = "%prog [options] [<source> [<destination>]]",
     description: str = ...,
     destination=None,
     destination_class=...,

package/dist/typeshed-fallback/stubs/docutils/docutils/examples.pyi

@@ -1,27 +1,26 @@
-from _typeshed import Incomplete
+from _typeshed import Incomplete, StrPath
 from typing import Literal, overload
 from typing_extensions import TypeAlias
 
 from docutils.core import Publisher
-from docutils.io import FileInput, StringInput
 from docutils.nodes import document
 from docutils.writers import _WriterParts
 
 _HTMLHeaderLevel: TypeAlias = Literal[1, 2, 3, 4, 5, 6]
 
 def html_parts(
-    input_string: str,
-    source_path=None,
-    destination_path=None,
+    input_string: str | bytes,
+    source_path: StrPath | None = None,
+    destination_path: StrPath | None = None,
     input_encoding: str = "unicode",
     doctitle: bool = True,
     initial_header_level: _HTMLHeaderLevel = 1,
 ) -> _WriterParts: ...
 @overload
 def html_body(
-    input_string: str,
-    source_path=None,
-    destination_path=None,
+    input_string: str | bytes,
+    source_path: StrPath | None = None,
+    destination_path: StrPath | None = None,
     input_encoding: str = "unicode",
     output_encoding: Literal["unicode"] = "unicode",
     doctitle: bool = True,
@@ -29,18 +28,17 @@ def html_body(
 ) -> str: ...
 @overload
 def html_body(
-    input_string: str,
-    source_path=None,
-    destination_path=None,
+    input_string: str | bytes,
+    source_path: StrPath | None = None,
+    destination_path: StrPath | None = None,
     input_encoding: str = "unicode",
     output_encoding: str = "unicode",
     doctitle: bool = True,
     initial_header_level: _HTMLHeaderLevel = 1,
 ) -> str | bytes: ...
 def internals(
-    input_string,
-    source_path: FileInput | StringInput | None = None,
-    destination_path: FileInput | StringInput | None = None,
+    source: str,
+    source_path: StrPath | None = None,
     input_encoding: str = "unicode",
     settings_overrides: dict[str, Incomplete] | None = None,
 ) -> tuple[document | None, Publisher]: ...

package/dist/typeshed-fallback/stubs/docutils/docutils/frontend.pyi

@@ -1,68 +1,168 @@
 import optparse
-from _typeshed import Incomplete
-from collections.abc import Iterable, Mapping
+from _typeshed import Incomplete, StrPath
+from collections.abc import Iterable, Mapping, Sequence
 from configparser import RawConfigParser
-from typing import Any, ClassVar, Final
+from typing import Any, ClassVar, Final, Literal, Protocol, overload, type_check_only
+from typing_extensions import deprecated
 
 from docutils import SettingsSpec
 from docutils.utils import DependencyList
 
 __docformat__: Final = "reStructuredText"
 
-def store_multiple(option, opt, value, parser, *args, **kwargs) -> None: ...
-def read_config_file(option, opt, value, parser) -> None: ...
-def validate_encoding(setting, value=None, option_parser=None, config_parser=None, config_section=None): ...
-def validate_encoding_error_handler(setting, value=None, option_parser=None, config_parser=None, config_section=None): ...
-def validate_encoding_and_error_handler(setting, value, option_parser, config_parser=None, config_section=None): ...
-def validate_boolean(setting, value=None, option_parser=None, config_parser=None, config_section=None) -> bool: ...
-def validate_ternary(setting, value=None, option_parser=None, config_parser=None, config_section=None): ...
-def validate_nonnegative_int(setting, value=None, option_parser=None, config_parser=None, config_section=None) -> int: ...
-def validate_threshold(setting, value=None, option_parser=None, config_parser=None, config_section=None) -> int: ...
+@type_check_only
+class _OptionValidator(Protocol):
+    def __call__(
+        self,
+        setting: str,
+        value: str | None,
+        option_parser: OptionParser,
+        /,
+        config_parser: ConfigParser | None = None,
+        config_section: str | None = None,
+    ) -> Any: ...
+
+@deprecated("Deprecated and will be removed with the switch to from optparse to argparse.")
+def store_multiple(option: optparse.Option, opt: str, value, parser: OptionParser, *args: str, **kwargs) -> None: ...
+@deprecated("Deprecated and will be removed with the switch to from optparse to argparse.")
+def read_config_file(option: optparse.Option, opt: str, value, parser: OptionParser) -> None: ...
+def validate_encoding(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> str: ...
+def validate_encoding_error_handler(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> str: ...
+def validate_encoding_and_error_handler(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> str: ...
+def validate_boolean(
+    setting: str | bool,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> bool: ...
+def validate_ternary(
+    setting: str | bool,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> str | bool | None: ...
+def validate_nonnegative_int(
+    setting: str | int,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> int: ...
+def validate_threshold(
+    setting: str | int,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> int: ...
 def validate_colon_separated_string_list(
-    setting, value=None, option_parser=None, config_parser=None, config_section=None
+    setting: str | list[str],
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
 ) -> list[str]: ...
 def validate_comma_separated_list(
-    setting, value=None, option_parser=None, config_parser=None, config_section=None
+    setting: str | list[str],
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
 ) -> list[str]: ...
-def validate_math_output(setting, value=None, option_parser=None, config_parser=None, config_section=None): ...
-def validate_url_trailing_slash(setting, value=None, option_parser=None, config_parser=None, config_section=None) -> str: ...
+def validate_math_output(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> tuple[()] | tuple[str, str]: ...
+def validate_url_trailing_slash(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> str: ...
 def validate_dependency_file(
-    setting, value=None, option_parser=None, config_parser=None, config_section=None
+    setting: str | None,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
 ) -> DependencyList: ...
-def validate_strip_class(setting, value=None, option_parser=None, config_parser=None, config_section=None): ...
+def validate_strip_class(
+    setting: str,
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> list[str]: ...
 def validate_smartquotes_locales(
-    setting, value=None, option_parser=None, config_parser=None, config_section=None
-) -> list[tuple[str, str]]: ...
-def make_paths_absolute(pathdict, keys, base_path=None) -> None: ...
-def make_one_path_absolute(base_path, path) -> str: ...
+    setting: str | list[str | tuple[str, str]],
+    value: str | None = None,
+    option_parser: OptionParser | None = None,
+    config_parser: ConfigParser | None = None,
+    config_section: str | None = None,
+) -> list[tuple[str, Sequence[str]]]: ...
+def make_paths_absolute(
+    pathdict: dict[str, list[StrPath] | StrPath], keys: tuple[str], base_path: StrPath | None = None
+) -> None: ...
+@deprecated("The `frontend.make_one_path_absolute` will be removed in Docutils 2.0 or later.")
+def make_one_path_absolute(base_path: StrPath, path: StrPath) -> str: ...
 def filter_settings_spec(settings_spec, *exclude, **replace) -> tuple[Any, ...]: ...
-
+@deprecated("The `frontend.Values` class will be removed in Docutils 2.0 or later.")
 class Values(optparse.Values):
-    record_dependencies: Incomplete
-    def __init__(self, *args, **kwargs) -> None: ...
-    def update(self, other_dict, option_parser) -> None: ...
+    record_dependencies: DependencyList
+    def __init__(self, defaults: dict[str, Any] | None = None) -> None: ...
+    def update(self, other_dict: Values | Mapping[str, Incomplete], option_parser: OptionParser) -> None: ...
     def copy(self) -> Values: ...
-    def setdefault(self, name, default): ...
+    def setdefault(self, name: str, default): ...
 
+@deprecated("The `frontend.Option` class will be removed in Docutils 2.0 or later.")
 class Option(optparse.Option):
-    ATTRS: Incomplete
-    def __init__(self, *args, **kwargs) -> None: ...
-    def process(self, opt, value, values, parser): ...
+    ATTRS: list[str]
+    validator: _OptionValidator
+    overrides: str | None
+    def __init__(self, *args: str | None, **kwargs) -> None: ...
 
+@deprecated(
+    "The `frontend.OptionParser` class will be replaced by a subclass of `argparse.ArgumentParser` in Docutils 2.0 or later."
+)
 class OptionParser(optparse.OptionParser, SettingsSpec):
     standard_config_files: ClassVar[list[str]]
-    threshold_choices: ClassVar[list[str]]
+    threshold_choices: ClassVar[tuple[str, ...]]
     thresholds: ClassVar[dict[str, int]]
     booleans: ClassVar[dict[str, bool]]
     default_error_encoding: ClassVar[str]
     default_error_encoding_error_handler: ClassVar[str]
     config_section: ClassVar[str]
     version_template: ClassVar[str]
-    lists: Incomplete
-    config_files: Incomplete
+    details: str
+    lists: dict[str, Literal[True]]
+    config_files: list[str]
     relative_path_settings: ClassVar[tuple[str, ...]]
-    version: Incomplete
-    components: Incomplete
+    version: str
+    components: tuple[SettingsSpec, ...]
     def __init__(
         self,
         components: Iterable[SettingsSpec | type[SettingsSpec]] = (),
@@ -71,27 +171,29 @@ class OptionParser(optparse.OptionParser, SettingsSpec):
         *args,
         **kwargs,
     ) -> None: ...
-    def populate_from_components(self, components) -> None: ...
+    def populate_from_components(self, components: Iterable[SettingsSpec]) -> None: ...
     @classmethod
-    def get_standard_config_files(cls): ...
-    def get_standard_config_settings(self): ...
-    def get_config_file_settings(self, config_file): ...
-    def check_values(self, values, args): ...
-    def check_args(self, args): ...
-    def set_defaults_from_dict(self, defaults) -> None: ...
-    def get_default_values(self): ...
-    def get_option_by_dest(self, dest): ...
+    def get_standard_config_files(cls) -> Sequence[StrPath]: ...
+    def get_standard_config_settings(self) -> Values: ...
+    def get_config_file_settings(self, config_file: str) -> dict[str, Incomplete]: ...
+    def check_values(self, values: Values, args: list[str]) -> Values: ...  # type: ignore[override]
+    def check_args(self, args: list[str]) -> tuple[str | None, str | None]: ...
+    def get_default_values(self) -> Values: ...
+    def get_option_by_dest(self, dest: str) -> Option: ...
 
 class ConfigParser(RawConfigParser):
-    old_settings: Incomplete
-    old_warning: str
-    not_utf8_error: str
-    def read(self, filenames, option_parser=None): ...
-    def handle_old_config(self, filename) -> None: ...
-    def validate_settings(self, filename, option_parser) -> None: ...
-    def optionxform(self, optionstr): ...
-    def get_section(self, section): ...
+    old_settings: ClassVar[dict[str, tuple[str, str]]]
+    old_warning: ClassVar[str]
+    not_utf8_error: ClassVar[str]
+    @overload  # type: ignore[override]
+    def read(self, filenames: str | Sequence[str]) -> list[str]: ...
+    @overload
+    @deprecated("The `option_parser` parameter is deprecated and will be removed in Docutils 0.24.")
+    def read(self, filenames: str | Sequence[str], option_parser: OptionParser | None) -> list[str]: ...
+    def handle_old_config(self, filename: str) -> None: ...
+    def validate_settings(self, filename: str, option_parser: OptionParser) -> None: ...
+    def optionxform(self, optionstr: str) -> str: ...
 
 class ConfigDeprecationWarning(FutureWarning): ...
 
-def get_default_settings(*components) -> Values: ...
+def get_default_settings(*components: SettingsSpec) -> Values: ...

package/dist/typeshed-fallback/stubs/docutils/docutils/io.pyi

@@ -8,7 +8,8 @@ from _typeshed import (
     Unused,
 )
 from re import Pattern
-from typing import IO, Any, ClassVar, Final, Generic, Literal, TypeVar
+from typing import IO, Any, ClassVar, Final, Generic, Literal, TextIO, TypeVar
+from typing_extensions import deprecated
 
 from docutils import TransformSpec, nodes
 
@@ -17,7 +18,7 @@ __docformat__: Final = "reStructuredText"
 class InputError(OSError): ...
 class OutputError(OSError): ...
 
-def check_encoding(stream: Any, encoding: str) -> bool | None: ...
+def check_encoding(stream: TextIO, encoding: str) -> bool | None: ...
 def error_string(err: BaseException) -> str: ...
 
 _S = TypeVar("_S")
@@ -31,12 +32,17 @@ class Input(TransformSpec, Generic[_S]):
     source_path: str | None
     successful_encoding: str | None = None
     def __init__(
-        self, source: _S | None = None, source_path: str | None = None, encoding: str | None = None, error_handler: str = "strict"
+        self,
+        source: _S | None = None,
+        source_path: str | None = None,
+        encoding: str | None = "utf-8",
+        error_handler: str = "strict",
     ) -> None: ...
     def read(self) -> str: ...
     def decode(self, data: str | bytes | bytearray) -> str: ...
     coding_slug: ClassVar[Pattern[bytes]]
     byte_order_marks: ClassVar[tuple[tuple[bytes, str], ...]]
+    @deprecated("Deprecated and will be removed in Docutils 1.0.")
     def determine_encoding_from_data(self, data: str | bytes | bytearray) -> str | None: ...
     def isatty(self) -> bool: ...
 
@@ -70,14 +76,12 @@ class ErrorOutput:
     def isatty(self) -> bool: ...
 
 class FileInput(Input[IO[str]]):
-    autoclose: Incomplete
-    source: Incomplete
-    source_path: Incomplete
+    autoclose: bool
     def __init__(
         self,
         source=None,
         source_path=None,
-        encoding: str | None = None,
+        encoding: str | None = "utf-8",
         error_handler: str = "strict",
         autoclose: bool = True,
         mode: OpenTextModeReading | OpenBinaryModeReading = "r",
@@ -107,6 +111,7 @@ class FileOutput(Output):
     def write(self, data): ...
     def close(self) -> None: ...
 
+@deprecated("The `BinaryFileOutput` is deprecated by `FileOutput` and will be removed in Docutils 0.24.")
 class BinaryFileOutput(FileOutput): ...
 
 class StringInput(Input[str]):

package/dist/typeshed-fallback/stubs/docutils/docutils/languages/__init__.pyi

@@ -1,4 +1,5 @@
 from typing import ClassVar, Final, Protocol, type_check_only
+from typing_extensions import Self
 
 from docutils.utils import Reporter
 
@@ -19,5 +20,6 @@ class LanguageImporter:
     def import_from_packages(self, name: str, reporter: Reporter | None = None) -> _LanguageModule: ...
     def check_content(self, module: _LanguageModule) -> None: ...
     def __call__(self, language_code: str, reporter: Reporter | None = None) -> _LanguageModule: ...
+    def __class_getitem__(cls, name) -> type[Self]: ...
 
 get_language: LanguageImporter