PR: Automatic colorization of SVG icons according to the interface theme (#24199)

Author: conradolandia

binder/environment.yml

@@ -24,6 +24,7 @@ dependencies:
 - ipython >=8.15.0,<10.0.0,!=8.17.1,!=9.1.0,!=9.2.0,!=9.3.0,!=9.4.0
 - ipython_pygments_lexers >=1.0
 - jedi >=0.17.2,<0.20.0
+- lxml >=4.9.0
 - jellyfish >=0.7
 - jsonschema >=3.2.0
 - keyring >=17.0.0

requirements/main.yml

@@ -22,6 +22,7 @@ dependencies:
   - ipython >=8.15.0,<10.0.0,!=8.17.1,!=9.1.0,!=9.2.0,!=9.3.0,!=9.4.0
   - ipython_pygments_lexers >=1.0
   - jedi >=0.17.2,<0.20.0
+  - lxml >=4.9.0
   - jellyfish >=0.7
   - jsonschema >=3.2.0
   - keyring >=17.0.0

setup.py

@@ -285,6 +285,7 @@ def run(self):
     'ipython_pygments_lexers>=1.0',
     'jedi>=0.17.2,<0.20.0',
     'jellyfish>=0.7',
+    'lxml>=4.9.0',
     'jsonschema>=3.2.0',
     'keyring>=17.0.0',
     'nbconvert>=4.0',

spyder/api/widgets/mixins.py

@@ -24,10 +24,7 @@
 )
 
 # Local imports
-from spyder.api.config.mixins import (
-    SpyderConfigurationAccessor,
-    SpyderConfigurationObserver
-)
+from spyder.api.config.mixins import SpyderConfigurationAccessor
 from spyder.api.exceptions import SpyderAPIError
 from spyder.api.shortcuts import SpyderShortcutsMixin
 from spyder.api.widgets.menus import SpyderMenu
@@ -39,6 +36,7 @@
 from spyder.utils.registries import (
     ACTION_REGISTRY, MENU_REGISTRY, TOOLBAR_REGISTRY, TOOLBUTTON_REGISTRY)
 from spyder.utils.stylesheet import PANES_TOOLBAR_STYLESHEET
+from spyder.utils.svg_colorizer import SVGColorize
 
 
 class SpyderToolButtonMixin:
@@ -757,7 +755,7 @@ class SvgToScaledPixmap(SpyderConfigurationAccessor):
     def svg_to_scaled_pixmap(self, svg_file, rescale=None, in_package=True):
         """
         Transform svg to a QPixmap that is scaled according to the factor set
-        by users in Preferences.
+        by users in Preferences. Uses the icon manager for proper colorization.
 
         Parameters
         ----------
@@ -771,6 +769,7 @@ def svg_to_scaled_pixmap(self, svg_file, rescale=None, in_package=True):
         if in_package:
             image_path = get_image_path(svg_file)
 
+        # Get user's DPI scale factor
         if self.get_conf('high_dpi_custom_scale_factor', section='main'):
             scale_factors = self.get_conf(
                 'high_dpi_custom_scale_factors',
@@ -780,6 +779,52 @@ def svg_to_scaled_pixmap(self, svg_file, rescale=None, in_package=True):
         else:
             scale_factor = 1
 
+        # Check if the SVG has colorization classes before colorization
+        should_colorize = False
+        try:
+            svg_paths_data = SVGColorize.get_colored_paths(
+                image_path, ima.ICON_COLORS
+            )
+            if svg_paths_data and svg_paths_data.get('paths'):
+                # Check if any of the paths have colorization classes 
+                # (not just default colors)
+                paths = svg_paths_data.get('paths', [])
+                for path in paths:
+                    # If a path has a color that's not the default color, 
+                    # it means it has a colorization class
+                    default_color = ima.ICON_COLORS.get(
+                        'ICON_1', '#FF0000' # Get default color from palette
+                    )
+                    if path.get('color') != default_color:
+                        should_colorize = True
+                        break
+        except Exception:
+            should_colorize = False
+
+        # Try to use the icon manager for colorization only if SVG supports it
+        if should_colorize:
+            icon = ima.get_icon(svg_file)
+            if icon and not icon.isNull():
+                # Get the original SVG dimensions
+                pm = QPixmap(image_path)
+                width = pm.width()
+                height = pm.height()
+
+                # Apply rescale factor
+                if rescale is not None:
+                    aspect_ratio = width / height
+                    width = int(width * rescale)
+                    height = int(width / aspect_ratio)
+
+                # Get a properly scaled pixmap from the icon
+                # Use the maximum dimension to maintain aspect ratio
+                max_dimension = max(
+                    int(width * scale_factor),
+                    int(height * scale_factor)
+                )
+                return icon.pixmap(max_dimension, max_dimension)
+
+        # Fallback to original method for icons without colorization classes.
         # Get width and height
         pm = QPixmap(image_path)
         width = pm.width()

spyder/dependencies.py

@@ -47,6 +47,7 @@
 JELLYFISH_REQVER = '>=0.7'
 JSONSCHEMA_REQVER = '>=3.2.0'
 KEYRING_REQVER = '>=17.0.0'
+LXML_REQVER = ">=4.9.0"
 NBCONVERT_REQVER = '>=4.0'
 NUMPYDOC_REQVER = '>=0.6.0'
 PACKAGING_REQVER = '>=20.0'
@@ -166,6 +167,10 @@
      'features': _("Save Github credentials to report internal "
                    "errors securely"),
      'required_version': KEYRING_REQVER},
+    {'modname': "lxml",
+     'package_name': "lxml",
+     'features': _("Colorize SVG icons according to the interface theme"),
+     'required_version': LXML_REQVER},
     {'modname': "nbconvert",
      'package_name': "nbconvert",
      'features': _("Manipulate Jupyter notebooks in the Editor"),