Skip to content
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.

Sign up for GitHub

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

Generate docutils.core and type publish_parts's return type #13118

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Generate docutils.core and type publish_parts's return type #13118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e087a21
Generated docutils.core
Avasam Nov 25, 2024
bf85ab6
Type writer.Writer.parts and core.publish_parts's return type
Avasam Nov 25, 2024
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
217 changes: 216 additions & 1 deletion stubs/docutils/docutils/core.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,218 @@
from _typeshed import Incomplete

def __getattr__(name: str) -> Incomplete: ...
from docutils.writers import _WriterParts

__docformat__: str

class Publisher:
document: Incomplete
reader: Incomplete
parser: Incomplete
writer: Incomplete
source: Incomplete
source_class: Incomplete
destination: Incomplete
destination_class: Incomplete
settings: Incomplete
def __init__(
self,
reader: Incomplete | None = None,
parser: Incomplete | None = None,
writer: Incomplete | None = None,
source: Incomplete | None = None,
source_class=...,
destination: Incomplete | None = None,
destination_class=...,
settings: Incomplete | None = None,
) -> None: ...
def set_reader(self, reader_name, parser, parser_name) -> None: ...
def set_writer(self, writer_name) -> None: ...
def set_components(self, reader_name, parser_name, writer_name) -> None: ...
def setup_option_parser(
self,
usage: Incomplete | None = None,
description: Incomplete | None = None,
settings_spec: Incomplete | None = None,
config_section: Incomplete | None = None,
**defaults,
): ...
def get_settings(
self,
usage: Incomplete | None = None,
description: Incomplete | None = None,
settings_spec: Incomplete | None = None,
config_section: Incomplete | None = None,
**defaults,
): ...
def process_programmatic_settings(self, settings_spec, settings_overrides, config_section) -> None: ...
def process_command_line(
self,
argv: Incomplete | None = None,
usage: Incomplete | None = None,
description: Incomplete | None = None,
settings_spec: Incomplete | None = None,
config_section: Incomplete | None = None,
**defaults,
) -> None: ...
def set_io(self, source_path: Incomplete | None = None, destination_path: Incomplete | None = None) -> None: ...
def set_source(self, source: Incomplete | None = None, source_path: Incomplete | None = None) -> None: ...
def set_destination(self, destination: Incomplete | None = None, destination_path: Incomplete | None = None) -> None: ...
def apply_transforms(self) -> None: ...
def publish(
self,
argv: Incomplete | None = None,
usage: Incomplete | None = None,
description: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
): ...
def debugging_dumps(self) -> None: ...
def prompt(self) -> None: ...
def report_Exception(self, error) -> None: ...
def report_SystemMessage(self, error) -> None: ...
def report_UnicodeError(self, error) -> None: ...

default_usage: str
default_description: str

def publish_cmdline(
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = True,
argv: Incomplete | None = None,
usage=...,
description=...,
): ...
def publish_file(
source: Incomplete | None = None,
source_path: Incomplete | None = None,
destination: Incomplete | None = None,
destination_path: Incomplete | None = None,
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
): ...
def publish_string(
source,
source_path: Incomplete | None = None,
destination_path: Incomplete | None = None,
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
): ...
def publish_parts(
source,
source_path: Incomplete | None = None,
source_class=...,
destination_path: Incomplete | None = None,
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
) -> _WriterParts: ...
def publish_doctree(
source,
source_path: Incomplete | None = None,
source_class=...,
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
): ...
def publish_from_doctree(
document,
destination_path: Incomplete | None = None,
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = False,
): ...
def publish_cmdline_to_binary(
reader: Incomplete | None = None,
reader_name: str = "standalone",
parser: Incomplete | None = None,
parser_name: str = "restructuredtext",
writer: Incomplete | None = None,
writer_name: str = "pseudoxml",
settings: Incomplete | None = None,
settings_spec: Incomplete | None = None,
settings_overrides: Incomplete | None = None,
config_section: Incomplete | None = None,
enable_exit_status: bool = True,
argv: Incomplete | None = None,
usage=...,
description=...,
destination: Incomplete | None = None,
destination_class=...,
): ...
def publish_programmatically(
source_class,
source,
source_path,
destination_class,
destination,
destination_path,
reader,
reader_name,
parser,
parser_name,
writer,
writer_name,
settings,
settings_spec,
settings_overrides,
config_section,
enable_exit_status,
): ...
def rst2something(writer, documenttype, doc_path: str = "") -> None: ...
def rst2html() -> None: ...
def rst2html4() -> None: ...
def rst2html5() -> None: ...
def rst2latex() -> None: ...
def rst2man() -> None: ...
def rst2odt() -> None: ...
def rst2pseudoxml() -> None: ...
def rst2s5() -> None: ...
def rst2xetex() -> None: ...
def rst2xml() -> None: ...
62 changes: 60 additions & 2 deletions stubs/docutils/docutils/writers/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,71 @@
from typing import Any, Generic, TypeVar
from typing import Any, Generic, TypedDict, TypeVar, type_check_only
from typing_extensions import Required

from docutils import Component, nodes
from docutils.io import Output
from docutils.languages import LanguageImporter

_S = TypeVar("_S")

# It would probably be better to specialize writers for subclasses,
# but this gives us all possible Writer items w/o instance checks
@type_check_only
class _WriterParts(TypedDict, total=False):
# Parts Provided by All Writers https://docutils.sourceforge.io/docs/api/publisher.html#parts-provided-by-all-writers

# See Writer.assemble_parts
whole: Required[str | bytes]
encoding: Required[str]
errors: Required[str]
version: Required[str]

# Parts Provided by the HTML Writers https://docutils.sourceforge.io/docs/api/publisher.html#parts-provided-by-the-html-writers

# HTML4 Writer https://docutils.sourceforge.io/docs/api/publisher.html#html4-writer
# + HTML5 Writer https://docutils.sourceforge.io/docs/api/publisher.html#html5-writer
body: str
body_prefix: str
body_pre_docinfo: str
body_suffix: str
docinfo: str
footer: str
fragment: str
head: str
head_prefix: str
header: str
html_body: str
html_head: str
html_prolog: str
html_subtitle: str
html_title: str
meta: str
stylesheet: str
subtitle: str
title: str
# PEP/HTML Writer https://docutils.sourceforge.io/docs/api/publisher.html#pep-html-writer
# + S5/HTML Writer https://docutils.sourceforge.io/docs/api/publisher.html#s5-html-writer
pepnum: str

# Parts Provided by the (Xe)LaTeX Writers https://docutils.sourceforge.io/docs/api/publisher.html#parts-provided-by-the-xe-latex-writers

# (commenting out those already included)
abstract: str
# body: str
# body_pre_docinfo: str
dedication: str
# docinfo: str
fallbacks: str
# head_prefix: str
latex_preamble: str
pdfsetup: str
requirements: str
# stylesheet: str
# subtitle: str
# title: str
titledata: str

class Writer(Component, Generic[_S]):
parts: dict[str, Any]
parts: _WriterParts
language: LanguageImporter | None = None
def __init__(self) -> None: ...
document: nodes.document | None = None
Expand Down