~

Author: zeyi2

clang-tools-extra/clang-tidy/tool/check_alphabetical_order.py

@@ -25,30 +25,43 @@
 """
 
 import argparse
+from collections import defaultdict
 import io
+from operator import itemgetter
 import os
 import re
 import sys
-from typing import List, Optional, Sequence, Tuple, NamedTuple, DefaultDict
-from collections import defaultdict
-from operator import itemgetter
+from typing import (
+    List,
+    Optional,
+    Sequence,
+    Tuple,
+    NamedTuple,
+    DefaultDict,
+    Final,
+    Pattern,
+)
 
 # Matches a :doc:`label <path>` or :doc:`label` reference anywhere in text and
 # captures the label. Used to sort bullet items alphabetically in ReleaseNotes
 # items by their label.
-DOC_LABEL_RN_RE = re.compile(r":doc:`(?P<label>[^`<]+)\s*(?:<[^>]+>)?`")
+DOC_LABEL_RN_RE: Final[Pattern[str]] = re.compile(
+    r":doc:`(?P<label>[^`<]+)\s*(?:<[^>]+>)?`"
+)
 
 # Matches a single csv-table row line in list.rst that begins with a :doc:
 # reference, capturing the label. Used to extract the sort key per row.
-DOC_LINE_RE = re.compile(r"^\s*:doc:`(?P<label>[^`<]+?)\s*<[^>]+>`.*$")
+DOC_LINE_RE: Final[Pattern[str]] = re.compile(
+    r"^\s*:doc:`(?P<label>[^`<]+?)\s*<[^>]+>`.*$"
+)
 
 
-EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")
-DOCS_DIR = os.path.join(EXTRA_DIR, "docs")
-CLANG_TIDY_DOCS_DIR = os.path.join(DOCS_DIR, "clang-tidy")
-CHECKS_DOCS_DIR = os.path.join(CLANG_TIDY_DOCS_DIR, "checks")
-LIST_DOC = os.path.join(CHECKS_DOCS_DIR, "list.rst")
-RELEASE_NOTES_DOC = os.path.join(DOCS_DIR, "ReleaseNotes.rst")
+EXTRA_DIR: Final[str] = os.path.join(os.path.dirname(__file__), "../..")
+DOCS_DIR: Final[str] = os.path.join(EXTRA_DIR, "docs")
+CLANG_TIDY_DOCS_DIR: Final[str] = os.path.join(DOCS_DIR, "clang-tidy")
+CHECKS_DOCS_DIR: Final[str] = os.path.join(CLANG_TIDY_DOCS_DIR, "checks")
+LIST_DOC: Final[str] = os.path.join(CHECKS_DOCS_DIR, "list.rst")
+RELEASE_NOTES_DOC: Final[str] = os.path.join(DOCS_DIR, "ReleaseNotes.rst")
 
 
 # Label extracted from :doc:`...`.
@@ -133,7 +146,7 @@ def _normalize_list_rst_lines(lines: Sequence[str]) -> List[str]:
     i = 0
     n = len(lines)
 
-    def check_name(line: str):
+    def check_name(line: str) -> Tuple[int, CheckLabel]:
         if m := DOC_LINE_RE.match(line):
             return (0, m.group("label"))
         return (1, "")
@@ -192,8 +205,9 @@ def find_heading(lines: Sequence[str], title: str) -> Optional[int]:
 
 
 def extract_label(text: str) -> str:
-    m = DOC_LABEL_RN_RE.search(text)
-    return m.group("label") if m else text
+    if m := DOC_LABEL_RN_RE.search(text):
+        return m.group("label")
+    return text
 
 
 def _is_bullet_start(line: str) -> bool:

clang-tools-extra/clang-tidy/tool/check_alphabetical_order_test.py

@@ -5,20 +5,18 @@
 # To run these tests:
 # python3 check_alphabetical_order_test.py -v
 
+import check_alphabetical_order as _mod
+from contextlib import redirect_stderr
 import io
 import os
 import tempfile
-import unittest
-from contextlib import redirect_stderr
-from typing import cast
 import textwrap
-
-
-import check_alphabetical_order as _mod
+from typing import cast
+import unittest
 
 
 class TestAlphabeticalOrderCheck(unittest.TestCase):
-    def test_normalize_list_rst_sorts_rows(self):
+    def test_normalize_list_rst_sorts_rows(self) -> None:
         input_text = textwrap.dedent(
             """\
             .. csv-table:: Clang-Tidy checks
@@ -46,7 +44,7 @@ def test_normalize_list_rst_sorts_rows(self):
         out_str = _mod.normalize_list_rst(input_text)
         self.assertEqual(out_str, expected_text)
 
-    def test_find_heading(self):
+    def test_find_heading(self) -> None:
         text = textwrap.dedent(
             """\
             - Deprecated the :program:`clang-tidy` ``zircon`` module. All checks have been
@@ -63,7 +61,7 @@ def test_find_heading(self):
         idx = _mod.find_heading(lines, "New checks")
         self.assertEqual(idx, 4)
 
-    def test_duplicate_detection_and_report(self):
+    def test_duplicate_detection_and_report(self) -> None:
         # Ensure duplicate detection works properly when sorting is incorrect.
         text = textwrap.dedent(
             """\
@@ -113,7 +111,7 @@ def test_duplicate_detection_and_report(self):
         )
         self.assertEqual(report_str, expected_report)
 
-    def test_process_release_notes_with_unsorted_content(self):
+    def test_process_release_notes_with_unsorted_content(self) -> None:
         # When content is not normalized, the function writes normalized text and returns 0.
         rn_text = textwrap.dedent(
             """\
@@ -168,7 +166,7 @@ def test_process_release_notes_with_unsorted_content(self):
             self.assertEqual(out, expected_out)
             self.assertIn("not normalized", buf.getvalue())
 
-    def test_process_release_notes_prioritizes_sorting_over_duplicates(self):
+    def test_process_release_notes_prioritizes_sorting_over_duplicates(self) -> None:
         # Sorting is incorrect and duplicates exist, should report ordering issues first.
         rn_text = textwrap.dedent(
             """\
@@ -234,7 +232,7 @@ def test_process_release_notes_prioritizes_sorting_over_duplicates(self):
             )
             self.assertEqual(out, expected_out)
 
-    def test_process_release_notes_with_duplicates_fails(self):
+    def test_process_release_notes_with_duplicates_fails(self) -> None:
         # Sorting is already correct but duplicates exist, should return 3 and report.
         rn_text = textwrap.dedent(
             """\
@@ -295,7 +293,7 @@ def test_process_release_notes_with_duplicates_fails(self):
                 out = f.read()
             self.assertEqual(out, rn_text)
 
-    def test_release_notes_handles_nested_sub_bullets(self):
+    def test_release_notes_handles_nested_sub_bullets(self) -> None:
         rn_text = textwrap.dedent(
             """\
             Changes in existing checks
@@ -355,7 +353,7 @@ def test_release_notes_handles_nested_sub_bullets(self):
         )
         self.assertEqual(out, expected_out)
 
-    def test_process_checks_list_normalizes_output(self):
+    def test_process_checks_list_normalizes_output(self) -> None:
         list_text = textwrap.dedent(
             """\
             .. csv-table:: List