From 6ca1417103d01cad262c066c12ee3a9012df36b7 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Mon, 2 Dec 2024 11:29:05 +1100 Subject: [PATCH] Cleanup: suppress unused Python warnings Suppress unused warnings using the "vulture" utility. - Include public definitions in the modules `__all__`. - Mark arguments & variables as unused with a "_" prefix. --- build_files/cmake/project_source_info.py | 2 +- build_files/utils/make_bpy_wheel.py | 2 +- scripts/modules/addon_utils.py | 1 + scripts/modules/bl_app_override/__init__.py | 6 ++++++ scripts/modules/bl_app_override/helpers.py | 6 +++++- scripts/modules/bl_i18n_utils/bl_extract_messages.py | 4 ++++ scripts/modules/bl_i18n_utils/utils.py | 12 +++++++++++- scripts/modules/bl_keymap_utils/platform_helpers.py | 5 +++++ scripts/modules/blend_render_info.py | 2 +- scripts/modules/bpy_extras/anim_utils.py | 2 ++ scripts/modules/bpy_extras/asset_utils.py | 10 ++++++---- scripts/modules/bpy_extras/io_utils.py | 1 + scripts/modules/bpy_extras/keyconfig_utils.py | 6 ++++++ scripts/modules/bpy_extras/node_utils.py | 2 ++ .../modules/bpy_extras/wm_utils/progress_report.py | 9 +++++++-- scripts/modules/console_python.py | 7 +++++++ scripts/modules/console_shell.py | 7 +++++++ scripts/modules/gpu_extras/presets.py | 6 ++++++ scripts/modules/keyingsets_utils.py | 1 + scripts/modules/nodeitems_utils.py | 11 +++++++++++ scripts/modules/rna_xml.py | 5 +++++ tests/coverage/coverage_report/parse.py | 2 +- 22 files changed, 97 insertions(+), 12 deletions(-) diff --git a/build_files/cmake/project_source_info.py b/build_files/cmake/project_source_info.py index 90a51c2f11e..aa2d4e0e1ff 100644 --- a/build_files/cmake/project_source_info.py +++ b/build_files/cmake/project_source_info.py @@ -68,7 +68,7 @@ def cmake_cache_var_iter() -> Iterator[tuple[str, str, str]]: def cmake_cache_var(var: str) -> str | None: - for var_iter, type_iter, value_iter in cmake_cache_var_iter(): + for var_iter, _type_iter, value_iter in cmake_cache_var_iter(): if var == var_iter: return value_iter return None diff --git a/build_files/utils/make_bpy_wheel.py b/build_files/utils/make_bpy_wheel.py index 1010bc11112..fac4d35c8c0 100755 --- a/build_files/utils/make_bpy_wheel.py +++ b/build_files/utils/make_bpy_wheel.py @@ -106,7 +106,7 @@ def cmake_cache_var_iter(filepath_cmake_cache: str) -> Iterator[tuple[str, str, def cmake_cache_var(filepath_cmake_cache: str, var: str) -> "str | None": - for var_iter, type_iter, value_iter in cmake_cache_var_iter(filepath_cmake_cache): + for var_iter, _type_iter, value_iter in cmake_cache_var_iter(filepath_cmake_cache): if var == var_iter: return value_iter return None diff --git a/scripts/modules/addon_utils.py b/scripts/modules/addon_utils.py index f8f44800abc..b229dde88af 100644 --- a/scripts/modules/addon_utils.py +++ b/scripts/modules/addon_utils.py @@ -13,6 +13,7 @@ __all__ = ( "reset_all", "module_bl_info", "extensions_refresh", + "stale_pending_remove_paths", "stale_pending_stage_paths", ) diff --git a/scripts/modules/bl_app_override/__init__.py b/scripts/modules/bl_app_override/__init__.py index 39f465e7525..4930a79cf38 100644 --- a/scripts/modules/bl_app_override/__init__.py +++ b/scripts/modules/bl_app_override/__init__.py @@ -8,6 +8,12 @@ Module to manage overriding various parts of Blender. Intended for use with 'app_templates', though it can be used from anywhere. """ +__all__ = ( + "class_filter", + "ui_draw_filter_register", + "ui_draw_filter_unregister", +) + # TODO, how to check these aren't from add-ons. # templates might need to un-register while filtering. diff --git a/scripts/modules/bl_app_override/helpers.py b/scripts/modules/bl_app_override/helpers.py index de68ace36e2..30969f62a11 100644 --- a/scripts/modules/bl_app_override/helpers.py +++ b/scripts/modules/bl_app_override/helpers.py @@ -2,10 +2,14 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "AppOverrideState", +) + + # ----------------------------------------------------------------------------- # AppOverrideState - class AppOverrideState: """ Utility class to encapsulate overriding the application state diff --git a/scripts/modules/bl_i18n_utils/bl_extract_messages.py b/scripts/modules/bl_i18n_utils/bl_extract_messages.py index 27884059178..a45354b8d78 100644 --- a/scripts/modules/bl_i18n_utils/bl_extract_messages.py +++ b/scripts/modules/bl_i18n_utils/bl_extract_messages.py @@ -6,6 +6,10 @@ # XXX: This script is meant to be used from inside Blender! # You should not directly use this script, rather use update_msg.py! +__all__ = ( + "dump_addon_messages", +) + import time import os import re diff --git a/scripts/modules/bl_i18n_utils/utils.py b/scripts/modules/bl_i18n_utils/utils.py index 83cc50b7931..de7907ad185 100644 --- a/scripts/modules/bl_i18n_utils/utils.py +++ b/scripts/modules/bl_i18n_utils/utils.py @@ -4,6 +4,16 @@ # Some misc utilities... +__all__ = ( + "I18n", + "I18nMessage", + "I18nMessages", + "enable_addons", + "find_best_isocode_matches", + "get_po_files_from_dir", + "list_po_dir", +) + import collections import os import platform @@ -1431,7 +1441,7 @@ class I18n: """ txts = [] if os.path.isdir(src): - for root, dnames, fnames in os.walk(src): + for root, _dnames, fnames in os.walk(src): for fname in fnames: if not fname.endswith(".py"): continue diff --git a/scripts/modules/bl_keymap_utils/platform_helpers.py b/scripts/modules/bl_keymap_utils/platform_helpers.py index 3e2a4288c68..e6df38b4dfb 100644 --- a/scripts/modules/bl_keymap_utils/platform_helpers.py +++ b/scripts/modules/bl_keymap_utils/platform_helpers.py @@ -2,6 +2,11 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "keyconfig_data_oskey_from_ctrl", + "keyconfig_data_oskey_from_ctrl_for_macos", +) + def keyconfig_data_oskey_from_ctrl(keyconfig_data_src, *, filter_fn=None): keyconfig_data_dst = [] diff --git a/scripts/modules/blend_render_info.py b/scripts/modules/blend_render_info.py index 65e8bf55eb1..0ba02ab17fc 100755 --- a/scripts/modules/blend_render_info.py +++ b/scripts/modules/blend_render_info.py @@ -56,7 +56,7 @@ class RawBlendFileReader: return self._blendfile - def __exit__(self, exc_type, exc_value, exc_traceback): + def __exit__(self, _exc_type, _exc_value, _exc_traceback): self._blendfile.close() if self._blendfile_base is not None: self._blendfile_base.close() diff --git a/scripts/modules/bpy_extras/anim_utils.py b/scripts/modules/bpy_extras/anim_utils.py index c26062c1ccd..568805866ba 100644 --- a/scripts/modules/bpy_extras/anim_utils.py +++ b/scripts/modules/bpy_extras/anim_utils.py @@ -8,6 +8,8 @@ __all__ = ( "bake_action_iter", "bake_action_objects_iter", + + "BakeOptions", ) import bpy diff --git a/scripts/modules/bpy_extras/asset_utils.py b/scripts/modules/bpy_extras/asset_utils.py index 2442a3c96fc..810878e798c 100644 --- a/scripts/modules/bpy_extras/asset_utils.py +++ b/scripts/modules/bpy_extras/asset_utils.py @@ -6,15 +6,17 @@ Helpers for asset management tasks. """ +__all__ = ( + "AssetBrowserPanel", + "AssetMetaDataPanel", + "SpaceAssetInfo", +) + import bpy from bpy.types import ( Context, ) -__all__ = ( - "SpaceAssetInfo", -) - class SpaceAssetInfo: @classmethod diff --git a/scripts/modules/bpy_extras/io_utils.py b/scripts/modules/bpy_extras/io_utils.py index 1881d026794..dddc868d6cb 100644 --- a/scripts/modules/bpy_extras/io_utils.py +++ b/scripts/modules/bpy_extras/io_utils.py @@ -9,6 +9,7 @@ __all__ = ( "axis_conversion", "axis_conversion_ensure", "create_derived_objects", + "poll_file_object_drop", "unpack_list", "unpack_face_list", "path_reference", diff --git a/scripts/modules/bpy_extras/keyconfig_utils.py b/scripts/modules/bpy_extras/keyconfig_utils.py index 1ffbb932e5b..82c1365444b 100644 --- a/scripts/modules/bpy_extras/keyconfig_utils.py +++ b/scripts/modules/bpy_extras/keyconfig_utils.py @@ -2,6 +2,12 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "addon_keymap_register", + "addon_keymap_unregister", + "keyconfig_test", +) + # ----------------------------------------------------------------------------- # Add-on helpers to properly (un)register their own keymaps. diff --git a/scripts/modules/bpy_extras/node_utils.py b/scripts/modules/bpy_extras/node_utils.py index dd8d09ee0c0..013c3b1a5e7 100644 --- a/scripts/modules/bpy_extras/node_utils.py +++ b/scripts/modules/bpy_extras/node_utils.py @@ -3,6 +3,8 @@ # SPDX-License-Identifier: GPL-2.0-or-later __all__ = ( + "connect_sockets", + "find_base_socket_type", "find_node_input", ) diff --git a/scripts/modules/bpy_extras/wm_utils/progress_report.py b/scripts/modules/bpy_extras/wm_utils/progress_report.py index 61c4ffd94e4..951c2fbd550 100644 --- a/scripts/modules/bpy_extras/wm_utils/progress_report.py +++ b/scripts/modules/bpy_extras/wm_utils/progress_report.py @@ -2,6 +2,11 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "ProgressReport", + "ProgressReportSubstep", +) + import time @@ -50,7 +55,7 @@ class ProgressReport: self.running = True return self - def __exit__(self, exc_type=None, exc_value=None, traceback=None): + def __exit__(self, _exc_type=None, _exc_value=None, _traceback=None): self.running = False if self.wm: self.wm.progress_end() @@ -139,7 +144,7 @@ class ProgressReportSubstep: self.progress.enter_substeps(self.nbr, self.msg) return self - def __exit__(self, exc_type, exc_value, traceback): + def __exit__(self, _exc_type, _exc_value, _traceback): assert len(self.progress.steps) > self.level while len(self.progress.steps) > self.level + 1: self.progress.leave_substeps() diff --git a/scripts/modules/console_python.py b/scripts/modules/console_python.py index 742e2e65929..c596311bfe6 100644 --- a/scripts/modules/console_python.py +++ b/scripts/modules/console_python.py @@ -2,6 +2,13 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "autocomplete", + "banner", + "execute", + "language_id", +) + import sys import bpy diff --git a/scripts/modules/console_shell.py b/scripts/modules/console_shell.py index 1f261435577..16a5c9f6170 100644 --- a/scripts/modules/console_shell.py +++ b/scripts/modules/console_shell.py @@ -2,6 +2,13 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "autocomplete", + "banner", + "execute", + "language_id", +) + import os import bpy diff --git a/scripts/modules/gpu_extras/presets.py b/scripts/modules/gpu_extras/presets.py index 4d55840e13c..22d8746ab66 100644 --- a/scripts/modules/gpu_extras/presets.py +++ b/scripts/modules/gpu_extras/presets.py @@ -2,6 +2,12 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "draw_circle_2d", + "draw_texture_2d", +) + + def draw_circle_2d(position, color, radius, *, segments=None): """ Draw a circle. diff --git a/scripts/modules/keyingsets_utils.py b/scripts/modules/keyingsets_utils.py index 5ff11da02bf..e12d9253a31 100644 --- a/scripts/modules/keyingsets_utils.py +++ b/scripts/modules/keyingsets_utils.py @@ -16,6 +16,7 @@ __all__ = ( "RKS_ITER_selected_bones", "RKS_ITER_selected_item", "RKS_GEN_available", + "RKS_GEN_custom_props", "RKS_GEN_location", "RKS_GEN_rotation", "RKS_GEN_scaling", diff --git a/scripts/modules/nodeitems_utils.py b/scripts/modules/nodeitems_utils.py index f0b0b36b272..e0434e463ac 100644 --- a/scripts/modules/nodeitems_utils.py +++ b/scripts/modules/nodeitems_utils.py @@ -2,6 +2,17 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "NodeCategory", + "NodeItem", + "NodeItemCustom", + "draw_node_categories_menu", + "has_node_categories", + "node_items_iter", + "register_node_categories", + "unregister_node_categories", +) + import bpy diff --git a/scripts/modules/rna_xml.py b/scripts/modules/rna_xml.py index 2ef0fdf71f7..3a0fcac8ca7 100644 --- a/scripts/modules/rna_xml.py +++ b/scripts/modules/rna_xml.py @@ -2,6 +2,11 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +__all__ = ( + "xml_file_run", + "xml_file_write", +) + import bpy diff --git a/tests/coverage/coverage_report/parse.py b/tests/coverage/coverage_report/parse.py index c699a7d4dc1..4d3557a7c71 100644 --- a/tests/coverage/coverage_report/parse.py +++ b/tests/coverage/coverage_report/parse.py @@ -239,7 +239,7 @@ def compute_summary(data_by_source_file, source_file_order): if execution_count > 0: run_lines.add(line_index) - for function_name, instantiation_fdata in fdata["instantiations"].items(): + for _function_name, instantiation_fdata in fdata["instantiations"].items(): num_instantiated_functions += 1 if instantiation_fdata["execution_count"] > 0: num_instantiated_functions_run += 1