Shrink 'any-generics' whitelist for 'writers' module (#10867)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
danieleades
2023-01-02 05:29:46 +00:00
committed by GitHub
parent c2e278520e
commit dbf36f8b37
4 changed files with 11 additions and 9 deletions

View File

@@ -278,7 +278,6 @@ module = [
"sphinx.search.*",
"sphinx.testing.*",
"sphinx.util.*",
"sphinx.writers.*",
]
disallow_any_generics = false

View File

@@ -74,7 +74,7 @@ class LaTeXWriter(writers.Writer):
('Document class', ['--docclass'], {'default': 'manual'}),
('Author', ['--author'], {'default': ''}),
))
settings_defaults: dict = {}
settings_defaults: dict[str, Any] = {}
output = None
@@ -512,7 +512,7 @@ class LaTeXTranslator(SphinxTranslator):
return ''.join(ret)
def render(self, template_name: str, variables: dict) -> str:
def render(self, template_name: str, variables: dict[str, Any]) -> str:
renderer = LaTeXRenderer(latex_engine=self.config.latex_engine)
for template_dir in self.config.templates_path:
template = path.join(self.builder.confdir, template_dir,

View File

@@ -114,9 +114,9 @@ class TexinfoWriter(writers.Writer):
('Category', ['--texinfo-dir-category'], {'default':
'Miscellaneous'})))
settings_defaults: dict = {}
settings_defaults: dict[str, Any] = {}
output: str | None = None # type: ignore[assignment]
output: str
visitor_attributes = ('output', 'fragment')
@@ -391,8 +391,11 @@ class TexinfoTranslator(SphinxTranslator):
textwrap.wrap(desc, width=78 - offset))
return s + wdesc.strip() + '\n'
def add_menu_entries(self, entries: list[str], reg: re.Pattern = re.compile(r'\s+---?\s+')
) -> None:
def add_menu_entries(
self,
entries: list[str],
reg: re.Pattern[str] = re.compile(r'\s+---?\s+'),
) -> None:
for entry in entries:
name = self.node_names[entry]
# special formatting for entries that are divided by an em-dash

View File

@@ -356,7 +356,7 @@ def my_wrap(text: str, width: int = MAXWIDTH, **kwargs: Any) -> list[str]:
class TextWriter(writers.Writer):
supported = ('text',)
settings_spec = ('No options here.', '', ())
settings_defaults: dict = {}
settings_defaults: dict[str, Any] = {}
output: str = None
@@ -371,7 +371,7 @@ class TextWriter(writers.Writer):
class TextTranslator(SphinxTranslator):
builder: TextBuilder = None
builder: TextBuilder
def __init__(self, document: nodes.document, builder: TextBuilder) -> None:
super().__init__(document, builder)