summaryrefslogtreecommitdiff
path: root/doc/exts
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2023-02-12 12:39:21 +0100
committerGitHub <noreply@github.com>2023-02-12 12:39:21 +0100
commit81ed650d4655f65231d9caa0056dc92b0fcc257d (patch)
treed60890107d1304a9e8099a4d97e729b26d7b8ff7 /doc/exts
parenta0b28f9019fabddd8ef428be75659082377abb4c (diff)
downloadpylint-git-81ed650d4655f65231d9caa0056dc92b0fcc257d.tar.gz
[typing] Use __future__ annotations where possible (#8264)
Diffstat (limited to 'doc/exts')
-rw-r--r--doc/exts/pylint_messages.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/exts/pylint_messages.py b/doc/exts/pylint_messages.py
index 1e7440f87..12b6822fd 100644
--- a/doc/exts/pylint_messages.py
+++ b/doc/exts/pylint_messages.py
@@ -4,12 +4,14 @@
"""Script used to generate the messages files."""
+from __future__ import annotations
+
import os
from collections import defaultdict
from inspect import getmodule
from itertools import chain, groupby
from pathlib import Path
-from typing import DefaultDict, Dict, List, NamedTuple, Optional, Tuple
+from typing import DefaultDict, Dict, List, NamedTuple, Tuple
from sphinx.application import Sphinx
@@ -60,7 +62,7 @@ def _register_all_checkers_and_extensions(linter: PyLinter) -> None:
initialize_extensions(linter)
-def _get_message_data(data_path: Path) -> Tuple[str, str, str, str]:
+def _get_message_data(data_path: Path) -> tuple[str, str, str, str]:
"""Get the message data from the specified path."""
good_py_path = data_path / "good.py"
bad_py_path = data_path / "bad.py"
@@ -145,7 +147,7 @@ You can help us make the doc better `by contributing <https://github.com/PyCQA/p
def _get_all_messages(
linter: PyLinter,
-) -> Tuple[MessagesDict, OldMessagesDict]:
+) -> tuple[MessagesDict, OldMessagesDict]:
"""Get all messages registered to a linter and return a dictionary indexed by
message type.
@@ -305,7 +307,7 @@ def _generate_checker_url(message: MessageData) -> str:
def _write_single_shared_message_page(
- category_dir: Path, messages: List[MessageData]
+ category_dir: Path, messages: list[MessageData]
) -> None:
message = messages[0]
with open(category_dir / f"{message.name}.rst", "w", encoding="utf-8") as stream:
@@ -405,8 +407,8 @@ def _write_redirect_pages(old_messages: OldMessagesDict) -> None:
def _write_redirect_old_page(
category_dir: Path,
- old_name: Tuple[str, str],
- new_names: List[Tuple[str, str]],
+ old_name: tuple[str, str],
+ new_names: list[tuple[str, str]],
) -> None:
old_name_file = os.path.join(category_dir, f"{old_name[0]}.rst")
new_names_string = "".join(
@@ -428,7 +430,7 @@ def _write_redirect_old_page(
# pylint: disable-next=unused-argument
-def build_messages_pages(app: Optional[Sphinx]) -> None:
+def build_messages_pages(app: Sphinx | None) -> None:
"""Overwrite messages files by printing the documentation to a stream.
Documentation is written in ReST format.