Merge branch 'main' into assembly-suggestions

Author: gonzalocasas

.github/workflows/docs.yml

@@ -47,7 +47,7 @@ jobs:
         with:
           ref: gh-pages
 
-      - uses: compas-dev/[email protected].0
+      - uses: compas-dev/[email protected].1
         with:
           current_version: ${{ needs.build.outputs.current_version }}
 

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added `compas_rhino.DEFAULT_VERSION`.
+* Added `clean` option to `compas_rhino.install` to remove existing symlinks if they cannot be imported from the current environment.
 * Added basic implementation of `compas.datastructures.Assembly`.
 
 ### Changed
@@ -19,6 +21,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Fixed error in parameter list of `compas_rhino.geometry.curves.new_nurbscurve_from_interpolation`.
 * Fixed error in parameter list of `compas_rhino.geometry.curves.new_nurbscurve_from_step`.
 
+* Changed `compas_rhino.install` to remove broken symlinks.
+* Changed `compas_rhino.install` to reinstall broken symlinks if they can be imported from the current environment.
+* Changed `compas_rhino.uninstall` to remove broken symlinks.
+* Changed `compas_rhino.install_plugin` to remove broken symlinks.
+* Changed default Rhino version for installation to `7.0`.
+
 ### Removed
 
 
@@ -40,6 +48,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 * Fixed bug in `compas_rhino.conversions.RhinoPoint.from_geometry`.
+* Changed `compas_rhino.install` to remove broken symlinks.
+* Changed `compas_rhino.install` to reinstall broken symlinks if they can be imported from the current environment.
+* Changed `compas_rhino.uninstall` to remove broken symlinks.
+* Changed `compas_rhino.install_plugin` to remove broken symlinks.
 
 ### Removed
 

src/compas_rhino/__init__.py

@@ -36,6 +36,8 @@
 PURGE_ON_DELETE = True
 
 INSTALLABLE_PACKAGES = ['compas', 'compas_rhino', 'compas_ghpython']
+SUPPORTED_VERSIONS = ['5.0', '6.0', '7.0', '8.0']
+DEFAULT_VERSION = '7.0'
 
 
 def clear():
@@ -49,12 +51,10 @@ def redraw():
 
 
 def _check_rhino_version(version):
-    supported_versions = ['5.0', '6.0', '7.0']
-
     if not version:
-        return '6.0'
+        return DEFAULT_VERSION
 
-    if version not in supported_versions:
+    if version not in SUPPORTED_VERSIONS:
         raise Exception('Unsupported Rhino version: {}'.format(version))
 
     return version
@@ -99,7 +99,8 @@ def _get_ironpython_lib_path_mac(version):
     lib_paths = {
         '5.0': ['/', 'Applications', 'Rhinoceros.app', 'Contents'],
         '6.0': ['/', 'Applications', 'Rhinoceros.app', 'Contents', 'Frameworks', 'RhCore.framework', 'Versions', 'A'],
-        '7.0': ['/', 'Applications', 'Rhino7.app', 'Contents', 'Frameworks', 'RhCore.framework', 'Versions', 'A']
+        '7.0': ['/', 'Applications', 'Rhino7.app', 'Contents', 'Frameworks', 'RhCore.framework', 'Versions', 'A'],
+        '8.0': ['/', 'Applications', 'Rhino8.app', 'Contents', 'Frameworks', 'RhCore.framework', 'Versions', 'A'],
     }
     return os.path.join(*lib_paths.get(version) + ['Resources', 'ManagedPlugIns', 'RhinoDLR_Python.rhp', 'Lib'])
 

src/compas_rhino/install.py

@@ -47,9 +47,7 @@ def install(version=None, packages=None, clean=False):
         python -m compas_rhino.install -v 6.0
 
     """
-
-    if version not in ('5.0', '6.0', '7.0', '8.0'):
-        version = '6.0'
+    version = compas_rhino._check_rhino_version(version)
 
     # We install COMPAS packages in the scripts folder
     # instead of directly as IPy module.
@@ -58,6 +56,9 @@ def install(version=None, packages=None, clean=False):
     # This is for old installs
     ipylib_path = compas_rhino._get_ironpython_lib_path(version)
 
+    # Filter the provided list of packages
+    # If no packages are provided
+    # this first collects all installable packages from the environment.
     packages = _filter_installable_packages(version, packages)
 
     results = []
@@ -87,8 +88,22 @@ def install(version=None, packages=None, clean=False):
         if os.path.islink(path):
             if not os.path.exists(path):
                 symlinks_to_uninstall.append(dict(name=name, link=path))
-            else:
-                if clean:
+                try:
+                    importlib.import_module(name)
+                except ImportError:
+                    pass
+                else:
+                    if name not in packages:
+                        packages.append(name)
+
+    # If the scripts folder is supposed to be cleaned
+    # also remove all existing symlinks that cannot be imported
+    # and reinstall symlinks that can be imported
+    if clean:
+        for name in os.listdir(scripts_path):
+            path = os.path.join(scripts_path, name)
+            if os.path.islink(path):
+                if os.path.exists(path):
                     try:
                         importlib.import_module(name)
                     except ImportError:
@@ -110,16 +125,20 @@ def install(version=None, packages=None, clean=False):
 
         # Handle legacy install location
         # This does not always work,
-        # and especially not in cases where it is in any case not necessary :)
+        # and especially not in cases where it is not necessary :)
         if ipylib_path:
             legacy_path = os.path.join(ipylib_path, package)
             if os.path.exists(legacy_path):
                 symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
 
-    # First uninstall existing copies of packages requested for installation
+    # -------------------------
+    # Uninstall first
+    # -------------------------
+
     symlinks = [link['link'] for link in symlinks_to_uninstall]
     uninstall_results = compas._os.remove_symlinks(symlinks)
 
+    # Let the user know if some symlinks could not be removed.
     for uninstall_data, success in zip(symlinks_to_uninstall, uninstall_results):
         if not success:
             results.append((uninstall_data['name'], 'ERROR: Cannot remove symlink, try to run as administrator.'))
@@ -322,7 +341,13 @@ def _filter_installable_packages(version, packages):
 
     parser = argparse.ArgumentParser()
 
-    parser.add_argument('-v', '--version', choices=['5.0', '6.0', '7.0', '8.0'], default='6.0', help="The version of Rhino to install the packages in.")
+    parser.add_argument(
+        '-v',
+        '--version',
+        choices=compas_rhino.SUPPORTED_VERSIONS,
+        default=compas_rhino.DEFAULT_VERSION,
+        help="The version of Rhino to install the packages in."
+    )
     parser.add_argument('-p', '--packages', nargs='+', help="The packages to install.")
     parser.add_argument('--clean', dest='clean', default=False, action='store_true')
 

src/compas_rhino/install_plugin.py

@@ -58,32 +58,53 @@ def install_plugin(plugin, version=None):
         python -m compas_rhino.install_plugin -v 7.0 ui/Rhino/XXX
 
     """
-    if version not in ('5.0', '6.0', '7.0', '8.0'):
-        version = '6.0'
-
     if not os.path.isdir(plugin):
         raise Exception('Cannot find the plugin: {}'.format(plugin))
 
-    plugin_dir = os.path.abspath(plugin)
-
-    # clean up the plugin directory
+    version = compas_rhino._check_rhino_version(version)
 
-    # # Also remove all broken symlinks
-    # # because ... they're broken!
-    # broken = []
-    # for name in os.listdir(plugin_dir):
-    #     path = os.path.join(plugin_dir, name)
-    #     if os.path.islink(path):
-    #         if not os.path.exists(path):
-    #             broken.append(path)
-    # if broken:
-    #     pass
+    plugin_dir = os.path.abspath(plugin)
 
+    # Clean up the plugin directory
+    # by removing all broken symlinks
+    # because ... they're broken!
+
+    symlinks_to_remove = []
+
+    for name in os.listdir(plugin_dir):
+        path = os.path.join(plugin_dir, name)
+        if os.path.islink(path):
+            if not os.path.exists(path):
+                symlinks_to_remove.append(dict(name=name, link=path))
+
+    symlinks_removed = []
+    symlinks_unremoved = []
+
+    if symlinks_to_remove:
+        symlinks = [link['link'] for link in symlinks_to_remove]
+        removal_results = remove_symlinks(symlinks)
+        for uninstall_data, success in zip(symlinks_to_remove, removal_results):
+            if success:
+                symlinks_removed.append(uninstall_data['name'])
+            else:
+                symlinks_unremoved.append(uninstall_data['name'])
+
+    if symlinks_removed:
+        print('\nThe following package symlinks are broken and were removed:\n')
+        for name in symlinks_removed:
+            print('   {}'.format(name.ljust(20)))
+
+    if symlinks_unremoved:
+        print('\nThe following package symlinks are broken but could not be removed:\n')
+        for name in symlinks_unremoved:
+            print('   {}'.format(name.ljust(20)))
+
+    # -----------------------------
     # proceed with the installation
+    # -----------------------------
 
     plugin_path, plugin_name = os.path.split(plugin_dir)
-    if not plugin_path:
-        plugin_path = os.getcwd()
+    plugin_path = plugin_path or os.getcwd()
 
     plugin_dev = os.path.join(plugin_dir, 'dev')
 
@@ -134,7 +155,13 @@ def install_plugin(plugin, version=None):
         description='COMPAS Rhino Plugin Installation command-line utility.')
 
     parser.add_argument('plugin', help="The path to the plugin directory.")
-    parser.add_argument('-v', '--version', choices=['5.0', '6.0', '7.0', '8.0'], default='6.0', help="The version of Rhino.")
+    parser.add_argument(
+        '-v',
+        '--version',
+        choices=compas_rhino.SUPPORTED_VERSIONS,
+        default=compas_rhino.DEFAULT_VERSION,
+        help="The version of Rhino."
+    )
 
     args = parser.parse_args()
 

src/compas_rhino/uninstall.py

@@ -42,8 +42,7 @@ def uninstall(version=None, packages=None):
         python -m compas_rhino.uninstall -v 6.0
 
     """
-    if version not in ('5.0', '6.0', '7.0', '8.0'):
-        version = '6.0'
+    version = compas_rhino._check_rhino_version(version)
 
     # We install COMPAS packages in the scripts folder
     # instead of directly as IPy module.
@@ -52,6 +51,9 @@ def uninstall(version=None, packages=None):
     # This is for old installs
     ipylib_path = compas_rhino._get_ironpython_lib_path(version)
 
+    # Filter the provided list of packages
+    # If no packages are provided
+    # this first collects all installable packages from the environment.
     packages = _filter_installed_packages(version, packages)
 
     # Also remove all broken symlinks
@@ -63,11 +65,8 @@ def uninstall(version=None, packages=None):
                 if name not in packages:
                     packages.append(name)
 
-    print('Uninstalling COMPAS packages from Rhino {0} scripts folder: \n{1}'.format(version, scripts_path))
-
-    results = []
+    # Collect paths for removal based on package names
     symlinks_to_uninstall = []
-    exit_code = 0
 
     for package in packages:
         symlink_path = os.path.join(scripts_path, package)
@@ -81,55 +80,67 @@ def uninstall(version=None, packages=None):
             if os.path.exists(legacy_path):
                 symlinks_to_uninstall.append(dict(name=package, link=legacy_path))
 
+    # There is nothing to uninstall
     if not symlinks_to_uninstall:
-        print('\nNo packages to uninstall.')
+        print('\nNo packages to uninstall from Rhino {0} scripts folder: \n{1}.'.format(version, scripts_path))
+        return
 
-    else:
-        uninstalled_packages = []
+    # -------------------------
+    # Start uninstalling
+    # -------------------------
+
+    uninstalled_packages = []
+    results = []
+    exit_code = 0
 
-        symlinks = [link['link'] for link in symlinks_to_uninstall]
-        uninstall_results = compas._os.remove_symlinks(symlinks)
+    symlinks = [link['link'] for link in symlinks_to_uninstall]
+    uninstall_results = compas._os.remove_symlinks(symlinks)
 
-        for uninstall_data, success in zip(symlinks_to_uninstall, uninstall_results):
-            if success:
-                uninstalled_packages.append(uninstall_data['name'])
-                result = 'OK'
-            else:
-                result = 'ERROR: Cannot remove symlink, try to run as administrator.'
+    for uninstall_data, success in zip(symlinks_to_uninstall, uninstall_results):
+        if success:
+            uninstalled_packages.append(uninstall_data['name'])
+            result = 'OK'
+        else:
+            result = 'ERROR: Cannot remove symlink, try to run as administrator.'
 
-            results.append((uninstall_data['name'], result))
+        results.append((uninstall_data['name'], result))
 
-        if not all(uninstall_results):
-            exit_code = -1
+    if not all(uninstall_results):
+        exit_code = -1
 
-        if exit_code == -1:
-            results.append(('compas_bootstrapper', 'WARNING: One or more packages failed, will not uninstall bootstrapper.'))
+    if exit_code == -1:
+        results.append(('compas_bootstrapper', 'WARNING: One or more packages failed, will not uninstall bootstrapper.'))
 
+    else:
+        if compas_rhino._try_remove_bootstrapper(scripts_path):
+            results.append(('compas_bootstrapper', 'OK'))
         else:
-            if compas_rhino._try_remove_bootstrapper(scripts_path):
-                results.append(('compas_bootstrapper', 'OK'))
-            else:
-                results.append(('compas_bootstrapper', 'ERROR: Cannot remove compas_bootstrapper, try to run as administrator.'))
+            results.append(('compas_bootstrapper', 'ERROR: Cannot remove compas_bootstrapper, try to run as administrator.'))
+
+        # Handle legacy bootstrapper
+        # Again, only if possible...
+        if ipylib_path:
+            if not compas_rhino._try_remove_bootstrapper(ipylib_path):
+                results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
 
-            # Handle legacy bootstrapper
-            # Again, only if possible...
-            if ipylib_path:
-                if not compas_rhino._try_remove_bootstrapper(ipylib_path):
-                    results.append(('compas_bootstrapper', 'ERROR: Cannot remove legacy compas_bootstrapper, try to run as administrator.'))
+    # -------------------------
+    # Output results
+    # -------------------------
 
-        print('\nThe following packages have been detected and will be uninstalled:\n')
+    print('Uninstalling COMPAS packages from Rhino {0} scripts folder: \n{1}'.format(version, scripts_path))
+    print('\nThe following packages have been detected and will be uninstalled:\n')
 
-        for package, status in results:
-            print('   {} {}'.format(package.ljust(20), status))
+    for package, status in results:
+        print('   {} {}'.format(package.ljust(20), status))
 
-            if status != 'OK':
-                exit_code = -1
+        if status != 'OK':
+            exit_code = -1
 
-        if exit_code == 0 and uninstalled_packages:
-            print('\nRunning post-uninstallation steps...\n')
+    if exit_code == 0 and uninstalled_packages:
+        print('\nRunning post-uninstallation steps...\n')
 
-            if not _run_post_execution_steps(after_rhino_uninstall(uninstalled_packages)):
-                exit_code = -1
+        if not _run_post_execution_steps(after_rhino_uninstall(uninstalled_packages)):
+            exit_code = -1
 
     print('\nUninstall completed.')
 
@@ -207,7 +218,13 @@ def after_rhino_uninstall(uninstalled_packages):
 
     parser = argparse.ArgumentParser()
 
-    parser.add_argument('-v', '--version', choices=['5.0', '6.0', '7.0', '8.0'], default='6.0', help="The version of Rhino to install the packages in.")
+    parser.add_argument(
+        '-v',
+        '--version',
+        choices=compas_rhino.SUPPORTED_VERSIONS,
+        default=compas_rhino.DEFAULT_VERSION,
+        help="The version of Rhino to install the packages in."
+    )
     parser.add_argument('-p', '--packages', nargs='+', help="The packages to uninstall.")
 
     args = parser.parse_args()