Skip to content

Commit 4aba20f

Browse files
authored
[NFC][clang-tidy] Add type annotations to rename_check.py (#108443)
``` > python3 -m mypy --strict clang-tools-extra/clang-tidy/rename_check.py Success: no issues found in 1 source file ```
1 parent 0aaac4f commit 4aba20f

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

clang-tools-extra/clang-tidy/rename_check.py

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@
88
#
99
# ===-----------------------------------------------------------------------===#
1010

11-
from __future__ import unicode_literals
12-
1311
import argparse
1412
import glob
1513
import io
1614
import os
1715
import re
16+
import sys
17+
from typing import List
1818

1919

20-
def replaceInFileRegex(fileName, sFrom, sTo):
20+
def replaceInFileRegex(fileName: str, sFrom: str, sTo: str) -> None:
2121
if sFrom == sTo:
2222
return
2323

@@ -35,7 +35,7 @@ def replaceInFileRegex(fileName, sFrom, sTo):
3535
f.write(txt)
3636

3737

38-
def replaceInFile(fileName, sFrom, sTo):
38+
def replaceInFile(fileName: str, sFrom: str, sTo: str) -> None:
3939
if sFrom == sTo:
4040
return
4141
txt = None
@@ -51,7 +51,7 @@ def replaceInFile(fileName, sFrom, sTo):
5151
f.write(txt)
5252

5353

54-
def generateCommentLineHeader(filename):
54+
def generateCommentLineHeader(filename: str) -> str:
5555
return "".join(
5656
[
5757
"//===--- ",
@@ -63,7 +63,7 @@ def generateCommentLineHeader(filename):
6363
)
6464

6565

66-
def generateCommentLineSource(filename):
66+
def generateCommentLineSource(filename: str) -> str:
6767
return "".join(
6868
[
6969
"//===--- ",
@@ -75,7 +75,7 @@ def generateCommentLineSource(filename):
7575
)
7676

7777

78-
def fileRename(fileName, sFrom, sTo):
78+
def fileRename(fileName: str, sFrom: str, sTo: str) -> str:
7979
if sFrom not in fileName or sFrom == sTo:
8080
return fileName
8181
newFileName = fileName.replace(sFrom, sTo)
@@ -84,7 +84,7 @@ def fileRename(fileName, sFrom, sTo):
8484
return newFileName
8585

8686

87-
def deleteMatchingLines(fileName, pattern):
87+
def deleteMatchingLines(fileName: str, pattern: str) -> bool:
8888
lines = None
8989
with io.open(fileName, "r", encoding="utf8") as f:
9090
lines = f.readlines()
@@ -101,7 +101,7 @@ def deleteMatchingLines(fileName, pattern):
101101
return True
102102

103103

104-
def getListOfFiles(clang_tidy_path):
104+
def getListOfFiles(clang_tidy_path: str) -> List[str]:
105105
files = glob.glob(os.path.join(clang_tidy_path, "**"), recursive=True)
106106
files += [
107107
os.path.normpath(os.path.join(clang_tidy_path, "../docs/ReleaseNotes.rst"))
@@ -124,7 +124,7 @@ def getListOfFiles(clang_tidy_path):
124124

125125
# Adapts the module's CMakelist file. Returns 'True' if it could add a new
126126
# entry and 'False' if the entry already existed.
127-
def adapt_cmake(module_path, check_name_camel):
127+
def adapt_cmake(module_path: str, check_name_camel: str) -> bool:
128128
filename = os.path.join(module_path, "CMakeLists.txt")
129129
with io.open(filename, "r", encoding="utf8") as f:
130130
lines = f.readlines()
@@ -153,7 +153,9 @@ def adapt_cmake(module_path, check_name_camel):
153153

154154

155155
# Modifies the module to include the new check.
156-
def adapt_module(module_path, module, check_name, check_name_camel):
156+
def adapt_module(
157+
module_path: str, module: str, check_name: str, check_name_camel: str
158+
) -> None:
157159
modulecpp = next(
158160
iter(
159161
filter(
@@ -204,7 +206,9 @@ def adapt_module(module_path, module, check_name, check_name_camel):
204206

205207

206208
# Adds a release notes entry.
207-
def add_release_notes(clang_tidy_path, old_check_name, new_check_name):
209+
def add_release_notes(
210+
clang_tidy_path: str, old_check_name: str, new_check_name: str
211+
) -> None:
208212
filename = os.path.normpath(
209213
os.path.join(clang_tidy_path, "../docs/ReleaseNotes.rst")
210214
)
@@ -262,7 +266,7 @@ def add_release_notes(clang_tidy_path, old_check_name, new_check_name):
262266
f.write(line)
263267

264268

265-
def main():
269+
def main() -> None:
266270
parser = argparse.ArgumentParser(description="Rename clang-tidy check.")
267271
parser.add_argument("old_check_name", type=str, help="Old check name.")
268272
parser.add_argument("new_check_name", type=str, help="New check name.")
@@ -311,7 +315,7 @@ def main():
311315
"Check name '%s' not found in %s. Exiting."
312316
% (check_name_camel, cmake_lists)
313317
)
314-
return 1
318+
sys.exit(1)
315319

316320
modulecpp = next(
317321
iter(

0 commit comments

Comments
 (0)