From 0b0fddb614cb49932c7c5d775a978ad963a62e79 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 2 Jan 2025 17:06:56 +1100 Subject: [PATCH] Cleanup: use type hints for the QtCreator project generator Also resolve some warnings for project_info.py. --- tools/check_source/check_mypy_config.py | 3 +- tools/utils_ide/cmake_qtcreator_project.py | 45 ++++++++++++++-------- tools/utils_ide/project_info.py | 7 ++-- 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/tools/check_source/check_mypy_config.py b/tools/check_source/check_mypy_config.py index f8ebb859ce4..2bdee0a795a 100644 --- a/tools/check_source/check_mypy_config.py +++ b/tools/check_source/check_mypy_config.py @@ -43,8 +43,6 @@ PATHS_EXCLUDE = set( os.path.join(SOURCE_DIR, p.replace("/", os.sep)) for p in ( - "tools/check_source/clang_array_check.py", - "tools/utils_ide/cmake_qtcreator_project.py", "release/datafiles/blender_icons_geom.py", # Uses `bpy` too much. "tests/utils/bl_run_operators.py", # Uses `bpy` too much. "tests/utils/bl_run_operators_event_simulate.py", # Uses `bpy` too much. @@ -58,6 +56,7 @@ PATHS_EXCLUDE = set( "tools/check_blender_release/scripts/requests_basic_access.py", "tools/check_blender_release/scripts/requests_import.py", "tools/check_source/check_descriptions.py", + "tools/check_source/clang_array_check.py", "tools/utils/blend2json.py", "tools/utils/blender_keyconfig_export_permutations.py", "tools/utils/blender_merge_format_changes.py", diff --git a/tools/utils_ide/cmake_qtcreator_project.py b/tools/utils_ide/cmake_qtcreator_project.py index 82359fa8dd6..11edae4bef8 100755 --- a/tools/utils_ide/cmake_qtcreator_project.py +++ b/tools/utils_ide/cmake_qtcreator_project.py @@ -11,18 +11,25 @@ Example Win32 usage: c:\Python32\python.exe c:\blender_dev\blender\build_files\cmake\cmake_qtcreator_project.py --build-dir c:\blender_dev\cmake_build """ +__all__ = ( + "main", +) +import argparse import os +import sys + +project_name_default = "Unknown" -def quote_define(define): +def quote_define(define: str) -> str: if " " in define.strip(): return '"%s"' % define else: return define -def create_qtc_project_main(name): +def create_qtc_project_main(name: str) -> None: from project_info import ( SIMPLE_PROJECTFILE, SOURCE_DIR, @@ -43,7 +50,7 @@ def create_qtc_project_main(name): # --- qtcreator specific, simple format if SIMPLE_PROJECTFILE: # --- qtcreator specific, simple format - PROJECT_NAME = name or "Blender" + PROJECT_NAME = name or project_name_default FILE_NAME = PROJECT_NAME.lower() with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f: f.write("\n".join(files_rel)) @@ -61,18 +68,21 @@ def create_qtc_project_main(name): with open(qtc_cfg, 'w') as f: f.write("// ADD PREDEFINED MACROS HERE!\n") else: - includes, defines = cmake_advanced_info() - - if (includes, defines) == (None, None): + if (includes_and_defines := cmake_advanced_info()) is None: return + includes, defines = includes_and_defines # for some reason it doesn't give all internal includes - includes = list(set(includes) | set(os.path.dirname(f) - for f in files_rel if is_c_header(f))) + includes = list( + set(includes) | { + os.path.dirname(f) + for f in files_rel if is_c_header(f) + } + ) includes.sort() # be tricky, get the project name from CMake if we can! - PROJECT_NAME = name or project_name_get() + PROJECT_NAME = name or project_name_get() or project_name_default FILE_NAME = PROJECT_NAME.lower() with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f: @@ -97,14 +107,14 @@ def create_qtc_project_main(name): defines_final = [("#define %s %s" % (item[0], quote_define(item[1]))) for item in defines] if os.name != "nt": - defines_final += cmake_compiler_defines() + defines_final.extend(cmake_compiler_defines() or []) f.write("\n".join(defines_final)) print("Blender project file written to: %r" % qtc_prj) # --- end -def create_qtc_project_python(name): +def create_qtc_project_python(name: str) -> None: from project_info import ( SOURCE_DIR, # CMAKE_DIR, @@ -120,7 +130,7 @@ def create_qtc_project_python(name): # --- qtcreator specific, simple format # be tricky, get the project name from git if we can! - PROJECT_NAME = (name or project_name_get()) + "_Python" + PROJECT_NAME = (name or project_name_get() or project_name_default) + "_Python" FILE_NAME = PROJECT_NAME.lower() with open(os.path.join(PROJECT_DIR, "%s.files" % FILE_NAME), 'w') as f: @@ -138,8 +148,7 @@ def create_qtc_project_python(name): print("Python project file written to: %r" % qtc_prj) -def argparse_create(): - import argparse +def argparse_create() -> argparse.ArgumentParser: parser = argparse.ArgumentParser( description="This script generates Qt Creator project files for Blender", @@ -164,18 +173,20 @@ def argparse_create(): return parser -def main(): +def main() -> int: parser = argparse_create() args = parser.parse_args() name = args.name import project_info if not project_info.init(args.build_dir): - return + return 1 create_qtc_project_main(name) create_qtc_project_python(name) + return 0 + if __name__ == "__main__": - main() + sys.exit(main()) diff --git a/tools/utils_ide/project_info.py b/tools/utils_ide/project_info.py index 17f12b9ded2..6cf9e060b3a 100755 --- a/tools/utils_ide/project_info.py +++ b/tools/utils_ide/project_info.py @@ -129,8 +129,7 @@ def is_project_file(filename: str) -> bool: def cmake_advanced_info() -> ( - tuple[list[str], list[tuple[str, str]]] | - tuple[None, None] + tuple[list[str], list[tuple[str, str]]] | None ): """ Extract includes and defines from cmake. """ @@ -138,7 +137,7 @@ def cmake_advanced_info() -> ( make_exe = cmake_cache_var("CMAKE_MAKE_PROGRAM") if make_exe is None: print("Make command not found: CMAKE_MAKE_PROGRAM") - return None, None + return None make_exe_basename = os.path.basename(make_exe) @@ -164,7 +163,7 @@ def cmake_advanced_info() -> ( if not exists(project_path): print("Generating Eclipse Project File Failed: %r not found" % project_path) - return None, None + return None from xml.dom.minidom import parse tree = parse(project_path)