Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ci_scripts/check_api_docs_en.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ def check_system_message_in_doc(doc_file):
for i in range(len(py_files)):
if py_files[i].startswith("python/"):
py_files[i] = py_files[i][6:]
api_info = json.load(open(args.api_info_file))
with open(args.api_info_file) as f:
api_info = json.load(f)
output_path = args.output_path
build_source_file_to_doc_file_dict(api_info)
error_files = set()
Expand Down
7 changes: 4 additions & 3 deletions ci_scripts/check_api_label_cn.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ def find_all_api_labels_in_dir(rootdir):
path = str(real_path).removeprefix(rootdir)
if not should_test(path):
continue
for label in find_api_labels_in_one_file(real_path):
all_api_labels.append(label)
# Use extend instead of repeated append for better performance
all_api_labels.extend(find_api_labels_in_one_file(real_path))
return all_api_labels


Expand Down Expand Up @@ -80,7 +80,8 @@ def run_cn_api_label_checking(rootdir, files):
f"The first line in {rootdir}/{file} is not available, please re-check it!"
)
sys.exit(1)
valid_api_labels = find_all_api_labels_in_dir(rootdir)
# Convert to set for O(1) membership tests
valid_api_labels = set(find_all_api_labels_in_dir(rootdir))
for file in files:
if not file.endswith(".rst"):
continue
Expand Down
3 changes: 2 additions & 1 deletion ci_scripts/check_api_parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,8 @@ def check_api_parameters(rstfiles, apiinfo):
if __name__ == "__main__":
args = parse_args()
rstfiles = [fn for fn in args.rst_files.split(" ") if fn]
apiinfo = json.load(open(args.api_info_file))
with open(args.api_info_file) as f:
apiinfo = json.load(f)
check_passed, check_failed, api_notfound = check_api_parameters(
rstfiles=rstfiles, apiinfo=apiinfo
)
Expand Down
3 changes: 2 additions & 1 deletion ci_scripts/hooks/post_filter_htmls.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ def insert_header_and_anchor_for_method(htmlfile):
"""
insert a hide h3 tag and a anchor for every class method.
"""
soup = BeautifulSoup(open(htmlfile, "r"), "lxml")
with open(htmlfile, "r") as f:
soup = BeautifulSoup(f, "lxml")
method_title_tags = soup.find_all("dl", class_="method")
for mtt in method_title_tags:
dt = mtt.find("dt")
Expand Down
6 changes: 4 additions & 2 deletions docs/api/extract_api_from_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,11 @@ def extract_code_blocks_from_file(filename):
r = os.path.splitext(filename)
ext = r[1].lower()
if ext == ".md":
return extract_code_blocks_from_md(open(filename, "r").read())
with open(filename, "r") as f:
return extract_code_blocks_from_md(f.read())
elif ext == ".rst":
return extract_code_blocks_from_rst(open(filename, "r").read())
with open(filename, "r") as f:
return extract_code_blocks_from_rst(f.read())
else:
return []

Expand Down
57 changes: 29 additions & 28 deletions docs/api/gen_doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,8 @@ def parse_module_file(mod):
if len(mod_name) >= 6 and mod_name[:6] == "paddle":
fn_splited = os.path.splitext(src_file)
if len(fn_splited) > 1 and fn_splited[1].lower() == ".py":
mod_ast = ast.parse(open(src_file, "r").read())
with open(src_file, "r") as f:
mod_ast = ast.parse(f.read())
for node in mod_ast.body:
short_names = []
if (
Expand Down Expand Up @@ -425,16 +426,14 @@ def set_display_attr_of_apis():
set the display attr
"""
if os.path.exists(NOT_DISPLAY_DOC_LIST_FILENAME):
display_none_apis = {
line.strip() for line in open(NOT_DISPLAY_DOC_LIST_FILENAME, "r")
}
with open(NOT_DISPLAY_DOC_LIST_FILENAME, "r") as f:
display_none_apis = {line.strip() for line in f}
else:
logger.warning("file not exists: %s", NOT_DISPLAY_DOC_LIST_FILENAME)
display_none_apis = set()
if os.path.exists(DISPLAY_DOC_LIST_FILENAME):
display_yes_apis = {
line.strip() for line in open(DISPLAY_DOC_LIST_FILENAME, "r")
}
with open(DISPLAY_DOC_LIST_FILENAME, "r") as f:
display_yes_apis = {line.strip() for line in f}
else:
logger.warning("file not exists: %s", DISPLAY_DOC_LIST_FILENAME)
display_yes_apis = set()
Expand All @@ -447,21 +446,17 @@ def set_display_attr_of_apis():
# file the same apis
for id_api in api_info_dict:
all_names = api_info_dict[id_api]["all_names"]
display_yes = False
for n in all_names:
if n in display_yes_apis:
display_yes = True
break
# Check if any name is in display_yes_apis (O(1) lookup with set)
display_yes = any(n in display_yes_apis for n in all_names)

if display_yes:
api_info_dict[id_api]["display"] = True
else:
# Check if any name starts with any display_none prefix
display_yes = True
for n in all_names:
for dn in display_none_apis:
if n.startswith(dn):
display_yes = False
break
if not display_yes:
if any(n.startswith(dn) for dn in display_none_apis):
display_yes = False
break
if not display_yes:
api_info_dict[id_api]["display"] = False
Expand Down Expand Up @@ -570,17 +565,22 @@ def set_api_sketch():
for api in apis:
all_api_found[f"{m}.{api}"] = False

# Create a reverse mapping from API name to api_info_dict keys for O(1) lookup
name_to_id_map = {}
for id_api, api_info in api_info_dict.items():
if "all_names" in api_info:
for name in api_info["all_names"]:
name_to_id_map[name] = id_api

# Use the reverse mapping for efficient lookups
for api in all_api_found.keys():
for id_api in api_info_dict.keys():
if ("all_names" in api_info_dict[id_api]) and (
api in api_info_dict[id_api]["all_names"]
):
all_api_found[api] = True
api_info_dict[id_api]["in_api_sketch"] = True
if "api_sketch_names" not in api_info_dict[id_api]:
api_info_dict[id_api]["api_sketch_names"] = []
api_info_dict[id_api]["api_sketch_names"].append(api)
break
if api in name_to_id_map:
id_api = name_to_id_map[api]
all_api_found[api] = True
api_info_dict[id_api]["in_api_sketch"] = True
if "api_sketch_names" not in api_info_dict[id_api]:
api_info_dict[id_api]["api_sketch_names"] = []
api_info_dict[id_api]["api_sketch_names"].append(api)

api_not_in_dict = [api for api in all_api_found if not all_api_found[api]]
if api_not_in_dict:
Expand Down Expand Up @@ -1114,6 +1114,7 @@ def parse_args():
check_cn_en_match()

filter_out_object_of_api_info_dict()
json.dump(api_info_dict, open(jsonfn, "w"), indent=4)
with open(jsonfn, "w") as f:
json.dump(api_info_dict, f, indent=4)

logger.info("done")