Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-10 06:01:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

scripts: fix all issues reported by pylint

Browse Source 
This patch 1) fixes all the issues (not most) reported by pylint,
2) add the functionability to tackle documents that need translation,
3) add logging to adjust the logging level and log file

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240719041400.3909775-2-dzm91@hust.edu.cn
This commit is contained in:
Dongliang Mu 2024-07-19 12:13:33 +08:00 committed by Jonathan Corbet
parent 565a3041b5
commit 63e96ce050
1 changed files with 140 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

212
scripts/checktransupdate.py
View File

@ -10,31 +10,28 @@ differences occur, report the file and commits that need to be updated.
The usage is as follows: The usage is as follows:
- ./scripts/checktransupdate.py -l zh_CN - ./scripts/checktransupdate.py -l zh_CN
This will print all the files that need to be updated in the zh_CN locale. This will print all the files that need to be updated or translated in the zh_CN locale.
- ./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst - ./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst
This will only print the status of the specified file. This will only print the status of the specified file.
The output is something like: The output is something like:
Documentation/translations/zh_CN/dev-tools/testing-overview.rst (1 commits) Documentation/dev-tools/kfence.rst
No translation in the locale of zh_CN
Documentation/translations/zh_CN/dev-tools/testing-overview.rst
commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs") commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
1 commits needs resolving in total
""" """
import os import os
from argparse import ArgumentParser, BooleanOptionalAction import time
import logging
from argparse import ArgumentParser, ArgumentTypeError, BooleanOptionalAction
from datetime import datetime from datetime import datetime
flag_p_c = False
flag_p_uf = False
flag_debug = False
def dprint(*args, **kwargs):
if flag_debug:
print("[DEBUG] ", end="")
print(*args, **kwargs)
def get_origin_path(file_path): def get_origin_path(file_path):
"""Get the origin path from the translation path"""
paths = file_path.split("/") paths = file_path.split("/")
tidx = paths.index("translations") tidx = paths.index("translations")
opaths = paths[:tidx] opaths = paths[:tidx]
@ -43,17 +40,16 @@ def get_origin_path(file_path):
def get_latest_commit_from(file_path, commit): def get_latest_commit_from(file_path, commit):
command = "git log --pretty=format:%H%n%aD%n%cD%n%n%B {} -1 -- {}".format( """Get the latest commit from the specified commit for the specified file"""
commit, file_path command = f"git log --pretty=format:%H%n%aD%n%cD%n%n%B {commit} -1 -- {file_path}"
) logging.debug(command)
dprint(command)
pipe = os.popen(command) pipe = os.popen(command)
result = pipe.read() result = pipe.read()
result = result.split("\n") result = result.split("\n")
if len(result) <= 1: if len(result) <= 1:
return None return None
dprint("Result: {}".format(result[0])) logging.debug("Result: %s", result[0])
return { return {
"hash": result[0], "hash": result[0],
@ -64,17 +60,19 @@ def get_latest_commit_from(file_path, commit):
def get_origin_from_trans(origin_path, t_from_head): def get_origin_from_trans(origin_path, t_from_head):
"""Get the latest origin commit from the translation commit"""
o_from_t = get_latest_commit_from(origin_path, t_from_head["hash"]) o_from_t = get_latest_commit_from(origin_path, t_from_head["hash"])
while o_from_t is not None and o_from_t["author_date"] > t_from_head["author_date"]: while o_from_t is not None and o_from_t["author_date"] > t_from_head["author_date"]:
o_from_t = get_latest_commit_from(origin_path, o_from_t["hash"] + "^") o_from_t = get_latest_commit_from(origin_path, o_from_t["hash"] + "^")
if o_from_t is not None: if o_from_t is not None:
dprint("tracked origin commit id: {}".format(o_from_t["hash"])) logging.debug("tracked origin commit id: %s", o_from_t["hash"])
return o_from_t return o_from_t
def get_commits_count_between(opath, commit1, commit2): def get_commits_count_between(opath, commit1, commit2):
command = "git log --pretty=format:%H {}...{} -- {}".format(commit1, commit2, opath) """Get the commits count between two commits for the specified file"""
dprint(command) command = f"git log --pretty=format:%H {commit1}...{commit2} -- {opath}"
logging.debug(command)
pipe = os.popen(command) pipe = os.popen(command)
result = pipe.read().split("\n") result = pipe.read().split("\n")
# filter out empty lines # filter out empty lines
@ -83,50 +81,120 @@ def get_commits_count_between(opath, commit1, commit2):
def pretty_output(commit): def pretty_output(commit):
command = "git log --pretty='format:%h (\"%s\")' -1 {}".format(commit) """Pretty print the commit message"""
dprint(command) command = f"git log --pretty='format:%h (\"%s\")' -1 {commit}"
logging.debug(command)
pipe = os.popen(command) pipe = os.popen(command)
return pipe.read() return pipe.read()
def valid_commit(commit):
"""Check if the commit is valid or not"""
msg = pretty_output(commit)
return "Merge tag" not in msg
def check_per_file(file_path): def check_per_file(file_path):
"""Check the translation status for the specified file"""
opath = get_origin_path(file_path) opath = get_origin_path(file_path)
if not os.path.isfile(opath): if not os.path.isfile(opath):
dprint("Error: Cannot find the origin path for {}".format(file_path)) logging.error("Cannot find the origin path for {file_path}")
return return
o_from_head = get_latest_commit_from(opath, "HEAD") o_from_head = get_latest_commit_from(opath, "HEAD")
t_from_head = get_latest_commit_from(file_path, "HEAD") t_from_head = get_latest_commit_from(file_path, "HEAD")
if o_from_head is None or t_from_head is None: if o_from_head is None or t_from_head is None:
print("Error: Cannot find the latest commit for {}".format(file_path)) logging.error("Cannot find the latest commit for %s", file_path)
return return
o_from_t = get_origin_from_trans(opath, t_from_head) o_from_t = get_origin_from_trans(opath, t_from_head)
if o_from_t is None: if o_from_t is None:
print("Error: Cannot find the latest origin commit for {}".format(file_path)) logging.error("Error: Cannot find the latest origin commit for %s", file_path)
return return
if o_from_head["hash"] == o_from_t["hash"]: if o_from_head["hash"] == o_from_t["hash"]:
if flag_p_uf: logging.debug("No update needed for %s", file_path)
print("No update needed for {}".format(file_path))
return
else: else:
print("{}".format(file_path), end="\t") logging.info(file_path)
commits = get_commits_count_between( commits = get_commits_count_between(
opath, o_from_t["hash"], o_from_head["hash"] opath, o_from_t["hash"], o_from_head["hash"]
) )
print("({} commits)".format(len(commits))) count = 0
if flag_p_c: for commit in commits:
for commit in commits: if valid_commit(commit):
msg = pretty_output(commit) logging.info("commit %s", pretty_output(commit))
if "Merge tag" not in msg: count += 1
print("commit", msg) logging.info("%d commits needs resolving in total\n", count)
def valid_locales(locale):
"""Check if the locale is valid or not"""
script_path = os.path.dirname(os.path.abspath(__file__))
linux_path = os.path.join(script_path, "..")
if not os.path.isdir(f"{linux_path}/Documentation/translations/{locale}"):
raise ArgumentTypeError("Invalid locale: {locale}")
return locale
def list_files_with_excluding_folders(folder, exclude_folders, include_suffix):
"""List all files with the specified suffix in the folder and its subfolders"""
files = []
stack = [folder]
while stack:
pwd = stack.pop()
# filter out the exclude folders
if os.path.basename(pwd) in exclude_folders:
continue
# list all files and folders
for item in os.listdir(pwd):
ab_item = os.path.join(pwd, item)
if os.path.isdir(ab_item):
stack.append(ab_item)
else:
if ab_item.endswith(include_suffix):
files.append(ab_item)
return files
class DmesgFormatter(logging.Formatter):
"""Custom dmesg logging formatter"""
def format(self, record):
timestamp = time.time()
formatted_time = f"[{timestamp:>10.6f}]"
log_message = f"{formatted_time} {record.getMessage()}"
return log_message
def config_logging(log_level, log_file="checktransupdate.log"):
"""configure logging based on the log level"""
# set up the root logger
logger = logging.getLogger()
logger.setLevel(log_level)
# Create console handler
console_handler = logging.StreamHandler()
console_handler.setLevel(log_level)
# Create file handler
file_handler = logging.FileHandler(log_file)
file_handler.setLevel(log_level)
# Create formatter and add it to the handlers
formatter = DmesgFormatter()
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
# Add the handler to the logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)
def main(): def main():
"""Main function of the script"""
script_path = os.path.dirname(os.path.abspath(__file__)) script_path = os.path.dirname(os.path.abspath(__file__))
linux_path = os.path.join(script_path, "..") linux_path = os.path.join(script_path, "..")
@ -134,62 +202,62 @@ def main():
parser.add_argument( parser.add_argument(
"-l", "-l",
"--locale", "--locale",
default="zh_CN",
type=valid_locales,
help="Locale to check when files are not specified", help="Locale to check when files are not specified",
) )
parser.add_argument( parser.add_argument(
"--print-commits", "--print-missing-translations",
action=BooleanOptionalAction, action=BooleanOptionalAction,
default=True, default=True,
help="Print commits between the origin and the translation", help="Print files that do not have translations",
) )
parser.add_argument( parser.add_argument(
"--print-updated-files", '--log',
action=BooleanOptionalAction, default='INFO',
default=False, choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
help="Print files that do no need to be updated", help='Set the logging level')
)
parser.add_argument( parser.add_argument(
"--debug", '--logfile',
action=BooleanOptionalAction, default='checktransupdate.log',
help="Print debug information", help='Set the logging file (default: checktransupdate.log)')
default=False,
)
parser.add_argument( parser.add_argument(
"files", nargs="*", help="Files to check, if not specified, check all files" "files", nargs="*", help="Files to check, if not specified, check all files"
) )
args = parser.parse_args() args = parser.parse_args()
global flag_p_c, flag_p_uf, flag_debug # Configure logging based on the --log argument
flag_p_c = args.print_commits log_level = getattr(logging, args.log.upper(), logging.INFO)
flag_p_uf = args.print_updated_files config_logging(log_level)
flag_debug = args.debug
# get files related to linux path # Get files related to linux path
files = args.files files = args.files
if len(files) == 0: if len(files) == 0:
if args.locale is not None: offical_files = list_files_with_excluding_folders(
files = ( os.path.join(linux_path, "Documentation"), ["translations", "output"], "rst"
os.popen( )
"find {}/Documentation/translations/{} -type f".format(
linux_path, args.locale for file in offical_files:
) # split the path into parts
) path_parts = file.split(os.sep)
.read() # find the index of the "Documentation" directory
.split("\n") kindex = path_parts.index("Documentation")
) # insert the translations and locale after the Documentation directory
else: new_path_parts = path_parts[:kindex + 1] + ["translations", args.locale] \
files = ( + path_parts[kindex + 1 :]
os.popen( # join the path parts back together
"find {}/Documentation/translations -type f".format(linux_path) new_file = os.sep.join(new_path_parts)
) if os.path.isfile(new_file):
.read() files.append(new_file)
.split("\n") else:
) if args.print_missing_translations:
logging.info(os.path.relpath(os.path.abspath(file), linux_path))
logging.info("No translation in the locale of %s\n", args.locale)
files = list(filter(lambda x: x != "", files))
files = list(map(lambda x: os.path.relpath(os.path.abspath(x), linux_path), files)) files = list(map(lambda x: os.path.relpath(os.path.abspath(x), linux_path), files))
# cd to linux root directory # cd to linux root directory