Preferences: Allow add-on to report and apply pip dependencies updates

Author: ros-dorian

mitsuba-blender/__init__.py

@@ -18,21 +18,32 @@
 
 import os
 import sys
-import subprocess
 
 from . import (
     engine, nodes, properties, operators, ui
 )
 
+from .utils import pip_ensure, pip_has_package, pip_install_package, pip_is_package_up_to_date
+
 def get_addon_preferences(context):
     return context.preferences.addons[__name__].preferences
 
-def init_mitsuba(context):
-    # Make sure we can load mitsuba from blender
+def get_addon_version_string():
+    return f'{".".join(str(e) for e in bl_info["version"])}{bl_info["warning"] if "warning" in bl_info else ""}'
+
+def get_mitsuba_version_string():
+    import mitsuba
+    return mitsuba.__version__
+
+def get_addon_info_string():
+    return f'mitsuba-blender v{get_addon_version_string()} registered (with mitsuba v{get_mitsuba_version_string()})'
+
+def init_mitsuba():
+    # Make sure we can load Mitsuba from Blender
     try:
         should_reload_mitsuba = 'mitsuba' in sys.modules
         import mitsuba
-        # If mitsuba was already loaded and we change the path, we need to reload it, since the import above will be ignored
+        # If Mitsuba was already loaded and we change the path, we need to reload it, since the import above will be ignored
         if should_reload_mitsuba:
             import importlib
             importlib.reload(mitsuba)
@@ -44,29 +55,26 @@ def init_mitsuba(context):
     except ModuleNotFoundError:
         return False
 
-def try_register_mitsuba(context):
+def register_addon(context):
     prefs = get_addon_preferences(context)
-    prefs.mitsuba_dependencies_status_message = ''
+    prefs.status_message = ''
 
-    could_init_mitsuba = False
     if prefs.using_mitsuba_custom_path:
-        update_additional_custom_paths(prefs, context)
-        could_init_mitsuba = init_mitsuba(context)
+        prefs.update_additional_custom_paths(context)
+        could_init_mitsuba = init_mitsuba()
         prefs.has_valid_mitsuba_custom_path = could_init_mitsuba
         if could_init_mitsuba:
-            import mitsuba
-            prefs.mitsuba_dependencies_status_message = f'Found custom Mitsuba v{mitsuba.__version__}.'
+            prefs.status_message = f'Found custom Mitsuba v{get_mitsuba_version_string()}.'
         else:
-            prefs.mitsuba_dependencies_status_message = 'Failed to load custom Mitsuba. Please verify the path to the build directory.'
-    elif prefs.has_pip_package:
-        could_init_mitsuba = init_mitsuba(context)
+            prefs.status_message = 'Failed to load custom Mitsuba. Please verify the path to the build directory.'
+    elif prefs.is_mitsuba_installed:
+        could_init_mitsuba = init_mitsuba()
         if could_init_mitsuba:
-            import mitsuba
-            prefs.mitsuba_dependencies_status_message = f'Found pip Mitsuba v{mitsuba.__version__}.'
+            prefs.status_message = f'Found pip Mitsuba v{get_mitsuba_version_string()}.'
         else:
-            prefs.mitsuba_dependencies_status_message = 'Failed to load Mitsuba package.'
+            prefs.status_message = 'Failed to load Mitsuba package.'
     else:
-        prefs.mitsuba_dependencies_status_message = 'Mitsuba dependencies not installed.'
+        prefs.status_message = 'Mitsuba dependencies not installed.'
 
     prefs.is_mitsuba_initialized = could_init_mitsuba
 
@@ -79,7 +87,7 @@ def try_register_mitsuba(context):
 
     return could_init_mitsuba
 
-def try_unregister_mitsuba():
+def unregister_addon():
     '''
     Try unregistering Addon classes.
     This may fail if Mitsuba wasn't found, hence the try catch guard
@@ -94,108 +102,107 @@ def try_unregister_mitsuba():
     except RuntimeError:
         return False
 
-def try_reload_mitsuba(context):
-    try_unregister_mitsuba()
-    if try_register_mitsuba(context):
+def reload_addon(context):
+    unregister_addon()
+    if register_addon(context):
         # Save user preferences
         bpy.ops.wm.save_userpref()
 
-def ensure_pip():
-    result = subprocess.run([sys.executable, '-m', 'ensurepip'], capture_output=True)
-    return result.returncode == 0
-
-def check_pip_dependencies(context):
-    prefs = get_addon_preferences(context)
-    result = subprocess.run([sys.executable, '-m', 'pip', 'show', 'mitsuba'], capture_output=True)
-    prefs.has_pip_package = result.returncode == 0
-
-def clean_additional_custom_paths(self, context):
-    # Remove old values from system PATH and sys.path
-    if self.additional_python_path in sys.path:
-        sys.path.remove(self.additional_python_path)
-    if self.additional_path and self.additional_path in os.environ['PATH']:
-        items = os.environ['PATH'].split(os.pathsep)
-        items.remove(self.additional_path)
-        os.environ['PATH'] = os.pathsep.join(items)
-
-def update_additional_custom_paths(self, context):
-    build_path = bpy.path.abspath(self.mitsuba_custom_path)
-    if len(build_path) > 0:
-        clean_additional_custom_paths(self, context)
-
-        # Add path to the binaries to the system PATH
-        self.additional_path = build_path
-        if self.additional_path not in os.environ['PATH']:
-            os.environ['PATH'] += os.pathsep + self.additional_path
-        
-        # Add path to python libs to sys.path
-        self.additional_python_path = os.path.join(build_path, 'python')
-        if self.additional_python_path not in sys.path:
-            # NOTE: We insert in the first position here, so that the custom path
-            #       supersede the pip version
-            sys.path.insert(0, self.additional_python_path)
-
-class MITSUBA_OT_install_pip_dependencies(Operator):
-    bl_idname = 'mitsuba.install_pip_dependencies'
-    bl_label = 'Install Mitsuba pip dependencies'
-    bl_description = 'Use pip to install the add-on\'s required dependencies'
+class MITSUBA_OT_download_package_dependencies(Operator):
+    bl_idname = 'mitsuba.download_package_dependencies'
+    bl_label = 'Download the latest package dependencies'
+    bl_description = 'Use pip to download the add-on\'s latest required dependencies'
 
     @classmethod
     def poll(cls, context):
         prefs = get_addon_preferences(context)
-        return not prefs.has_pip_package
+        return not prefs.is_mitsuba_installed or not prefs.is_mitsuba_uptodate
 
     def execute(self, context):
-        result = subprocess.run([sys.executable, '-m', 'pip', 'install', 'mitsuba'], capture_output=True)
-        if result.returncode != 0:
-            self.report({'ERROR'}, f'Failed to install Mitsuba with return code {result.returncode}.')
+        if not pip_install_package('mitsuba'):
+            self.report({'ERROR'}, 'Failed to download Mitsuba package with pip.')
             return {'CANCELLED'} 
 
         prefs = get_addon_preferences(context)
-        prefs.has_pip_package = True
-
-        try_reload_mitsuba(context)
+        if prefs.is_mitsuba_initialized and not prefs.is_mitsuba_uptodate:
+            # If the package was updated, require a restart to use the new version.
+            prefs.is_restart_required = True
+        else:
+            reload_addon(context)
+        
+        prefs.is_mitsuba_installed = True
+        prefs.is_mitsuba_uptodate = True
 
         return {'FINISHED'}
 
-def update_using_mitsuba_custom_path(self, context):
-    if self.is_mitsuba_initialized:
-        self.require_restart = True
-    if self.using_mitsuba_custom_path:
-        update_mitsuba_custom_path(self, context)
-    else:
-        clean_additional_custom_paths(self, context)
-
-def update_mitsuba_custom_path(self, context):
-    if self.is_mitsuba_initialized:
-        self.require_restart = True
-    if self.using_mitsuba_custom_path and len(self.mitsuba_custom_path) > 0:
-        update_additional_custom_paths(self, context)
-        if not self.is_mitsuba_initialized:
-            try_reload_mitsuba(context)
-
 class MitsubaPreferences(AddonPreferences):
     bl_idname = __name__
 
     is_mitsuba_initialized : BoolProperty(
         name = 'Is Mitsuba initialized',
     )
 
-    has_pip_package : BoolProperty(
-        name = 'Has pip dependencies installed',
+    is_mitsuba_installed : BoolProperty(
+        name = 'Is the Mitsuba package installed',
     )
 
-    mitsuba_dependencies_status_message : StringProperty(
-        name = 'Mitsuba dependencies status message',
-        default = '',
+    is_mitsuba_uptodate : BoolProperty(
+        name = 'Is the Mitsuba package up-to-date',
     )
 
-    require_restart : BoolProperty(
-        name = 'Require a Blender restart',
+    is_restart_required : BoolProperty(
+        name = 'Is a Blender restart required',
+    )
+
+    status_message : StringProperty(
+        name = 'Add-on status message',
+        default = '',
     )
 
     # Advanced settings
 
+    def clean_additional_custom_paths(self, context):
+        # Remove old values from system PATH and sys.path
+        if self.additional_python_path in sys.path:
+            sys.path.remove(self.additional_python_path)
+        if self.additional_path and self.additional_path in os.environ['PATH']:
+            items = os.environ['PATH'].split(os.pathsep)
+            items.remove(self.additional_path)
+            os.environ['PATH'] = os.pathsep.join(items)
+
+    def update_additional_custom_paths(self, context):
+        build_path = bpy.path.abspath(self.mitsuba_custom_path)
+        if len(build_path) > 0:
+            self.clean_additional_custom_paths(context)
+
+            # Add path to the binaries to the system PATH
+            self.additional_path = build_path
+            if self.additional_path not in os.environ['PATH']:
+                os.environ['PATH'] += os.pathsep + self.additional_path
+            
+            # Add path to python libs to sys.path
+            self.additional_python_path = os.path.join(build_path, 'python')
+            if self.additional_python_path not in sys.path:
+                # NOTE: We insert in the first position here, so that the custom path
+                #       supersede the pip version
+                sys.path.insert(0, self.additional_python_path)
+
+    def update_mitsuba_custom_path(self, context):
+        if self.is_mitsuba_initialized:
+            self.is_restart_required = True
+        if self.using_mitsuba_custom_path and len(self.mitsuba_custom_path) > 0:
+            self.update_additional_custom_paths(context)
+            if not self.is_mitsuba_initialized:
+                reload_addon(context)
+
+    def update_using_mitsuba_custom_path(self, context):
+        if self.is_mitsuba_initialized:
+            self.is_restart_required = True
+        if self.using_mitsuba_custom_path:
+            self.update_mitsuba_custom_path(context)
+        else:
+            self.clean_additional_custom_paths(context)
+
     using_mitsuba_custom_path : BoolProperty(
         name = 'Using custom Mitsuba path',
         update = update_using_mitsuba_custom_path,
@@ -229,18 +236,23 @@ def draw(self, context):
         layout = self.layout
 
         row = layout.row()
-        if self.require_restart:
-            self.mitsuba_dependencies_status_message = 'A restart is required to apply the changes.'
+        if self.is_restart_required:
+            self.status_message = 'A restart is required to apply the changes.'
             row.alert = True
             icon = 'ERROR'
-        elif self.has_pip_package or self.has_valid_mitsuba_custom_path:
+        elif self.is_mitsuba_initialized:
             icon = 'CHECKMARK'
         else:
             icon = 'CANCEL'
             row.alert = True
-        row.label(text=self.mitsuba_dependencies_status_message, icon=icon)
+        row.label(text=self.status_message, icon=icon)
 
-        layout.operator(MITSUBA_OT_install_pip_dependencies.bl_idname, text='Install dependencies using pip')
+        if not self.is_mitsuba_installed:
+            download_operator_text = 'Install Mitsuba'
+        else:
+            download_operator_text = 'Update Mitsuba'
+
+        layout.operator(MITSUBA_OT_download_package_dependencies.bl_idname, text=download_operator_text)
 
         box = layout.box()
         box.label(text='Advanced Settings')
@@ -249,27 +261,35 @@ def draw(self, context):
             box.prop(self, 'mitsuba_custom_path')
 
 classes = (
-    MITSUBA_OT_install_pip_dependencies,
+    MITSUBA_OT_download_package_dependencies,
     MitsubaPreferences,
 )
 
 def register():
     for cls in classes:
         register_class(cls)
 
+    if not pip_ensure():
+        raise RuntimeError('Cannot activate mitsuba-blender add-on. Python pip module cannot be initialized.')
+
     context = bpy.context
     prefs = get_addon_preferences(context)
-    prefs.require_restart = False
+    prefs.is_mitsuba_initialized = False
+    prefs.is_mitsuba_uptodate = False
+    prefs.is_restart_required = False
+    prefs.has_valid_mitsuba_custom_path = False
+    prefs.is_mitsuba_installed = pip_has_package('mitsuba')
 
-    if not ensure_pip():
-        raise RuntimeError('Cannot activate mitsuba-blender add-on. Python pip module cannot be initialized.')
+    if prefs.is_mitsuba_installed:
+        prefs.is_mitsuba_uptodate = pip_is_package_up_to_date('mitsuba')
 
-    check_pip_dependencies(context)
-    if try_register_mitsuba(context):
-        import mitsuba
-        print(f'mitsuba-blender v{".".join(str(e) for e in bl_info["version"])}{bl_info["warning"] if "warning" in bl_info else ""} registered (with mitsuba v{mitsuba.__version__})')
+    if register_addon(context):
+        print(get_addon_info_string())
 
 def unregister():
     for cls in classes:
         unregister_class(cls)
-    try_unregister_mitsuba()
+    unregister_addon()
+
+if __name__ == '__main__':
+    register()

mitsuba-blender/utils/__init__.py

@@ -1,6 +1,9 @@
 
 import bpy
 
+import sys
+import subprocess
+
 def init_empty_scene(bl_context, name='Scene', clear_all_scenes=False):
     ''' Create an empty Blender scene with a specific name.
     
@@ -97,4 +100,35 @@ def init_empty_collection(bl_scene, name='Collection'):
         bl_collection = bpy.data.collections.new(name)
     # Link the collection to the scene
     bl_scene.collection.children.link(bl_collection)
-    return bl_collection
+    return bl_collection
+
+#####################
+##  PIP Utilities  ##
+#####################
+
+def pip_ensure():
+    ''' Ensure that pip is available in the executing Python environment. '''
+    result = subprocess.run([sys.executable, '-m', 'ensurepip'], capture_output=True)
+    return result.returncode == 0
+
+def pip_has_package(package: str):
+    ''' Check if the executing Python environment has a specified package. '''
+    result = subprocess.run([sys.executable, '-m', 'pip', 'show', package], capture_output=True)
+    return result.returncode == 0
+
+def pip_install_package(package: str):
+    ''' Install a specified package in the executing Python environment. '''
+    result = subprocess.run([sys.executable, '-m', 'pip', 'install', '--upgrade', package], capture_output=True)
+    return result.returncode == 0
+
+def pip_is_package_up_to_date(package: str):
+    ''' Check if a given package is up-to-date. '''
+    result = subprocess.run([sys.executable, '-m', 'pip', 'list', '--uptodate'], capture_output=True)
+    if result.returncode != 0:
+        return False
+    for line in result.stdout.splitlines():
+        line = line.decode('utf-8')
+        parts = line.split(' ')
+        if parts[0] == package:
+            return True
+    return False