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.
2024-12-02 11:29:05 +11:00
parent a590fa749b
commit 6ca1417103
22 changed files with 97 additions and 12 deletions
@@ -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
@@ -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
@@ -13,6 +13,7 @@ __all__ = (
    "reset_all",
    "module_bl_info",
    "extensions_refresh",
+    "stale_pending_remove_paths",
    "stale_pending_stage_paths",
 )

@@ -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.
@@ -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
@@ -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
@@ -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
@@ -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 = []
@@ -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()
@@ -8,6 +8,8 @@ __all__ = (

    "bake_action_iter",
    "bake_action_objects_iter",
+
+    "BakeOptions",
 )

 import bpy
@@ -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
@@ -9,6 +9,7 @@ __all__ = (
    "axis_conversion",
    "axis_conversion_ensure",
    "create_derived_objects",
+    "poll_file_object_drop",
    "unpack_list",
    "unpack_face_list",
    "path_reference",
@@ -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.
@@ -3,6 +3,8 @@
 # SPDX-License-Identifier: GPL-2.0-or-later

 __all__ = (
+    "connect_sockets",
+    "find_base_socket_type",
    "find_node_input",
 )

@@ -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()
@@ -2,6 +2,13 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later

+__all__ = (
+    "autocomplete",
+    "banner",
+    "execute",
+    "language_id",
+)
+
 import sys
 import bpy

@@ -2,6 +2,13 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later

+__all__ = (
+    "autocomplete",
+    "banner",
+    "execute",
+    "language_id",
+)
+
 import os
 import bpy

@@ -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.
@@ -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",
@@ -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


@@ -2,6 +2,11 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later

+__all__ = (
+    "xml_file_run",
+    "xml_file_write",
+)
+
 import bpy


@@ -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