Lazy entry points in verdi

aiida/cmdline/__init__.py

@@ -53,6 +53,7 @@
     'echo_info',
     'echo_report',
     'echo_success',
+    'echo_tabulate',
     'echo_warning',
     'format_call_graph',
     'is_verbose',

aiida/cmdline/commands/cmd_code.py

@@ -12,13 +12,12 @@
 from functools import partial
 
 import click
-import tabulate
 
 from aiida.cmdline.commands.cmd_verdi import verdi
 from aiida.cmdline.groups.dynamic import DynamicEntryPointCommandGroup
 from aiida.cmdline.params import arguments, options, types
 from aiida.cmdline.params.options.commands import code as options_code
-from aiida.cmdline.utils import echo
+from aiida.cmdline.utils import echo, echo_tabulate
 from aiida.cmdline.utils.decorators import deprecated_command, with_dbenv
 from aiida.common import exceptions
 
@@ -232,7 +231,7 @@ def show(code):
     if is_verbose():
         table.append(['Calculations', len(code.base.links.get_outgoing().all())])
 
-    echo.echo(tabulate.tabulate(table))
+    echo_tabulate(table)
 
 
 @verdi_code.command()
@@ -419,7 +418,7 @@ def code_list(computer, default_calc_job_plugin, all_entries, all_users, raw, sh
                 row.append('@'.join(str(result[entity][projection]) for entity, projection in VALID_PROJECTIONS[key]))
         table.append(row)
 
-    echo.echo(tabulate.tabulate(table, headers=headers, tablefmt=table_format))
+    echo_tabulate(table, headers=headers, tablefmt=table_format)
 
     if not raw:
         echo.echo_report('\nUse `verdi code show IDENTIFIER` to see details for a code', prefix=False)

aiida/cmdline/commands/cmd_computer.py

@@ -14,12 +14,11 @@
 from math import isclose
 
 import click
-import tabulate
 
 from aiida.cmdline.commands.cmd_verdi import VerdiCommandGroup, verdi
 from aiida.cmdline.params import arguments, options
 from aiida.cmdline.params.options.commands import computer as options_computer
-from aiida.cmdline.utils import echo
+from aiida.cmdline.utils import echo, echo_tabulate
 from aiida.cmdline.utils.decorators import with_dbenv
 from aiida.common.exceptions import EntryPointError, ValidationError
 from aiida.plugins.entry_point import get_entry_point_names
@@ -461,7 +460,7 @@ def computer_show(computer):
         ['Prepend text', computer.get_prepend_text()],
         ['Append text', computer.get_append_text()],
     ]
-    echo.echo(tabulate.tabulate(table))
+    echo_tabulate(table)
 
 
 @verdi_computer.command('relabel')
@@ -697,4 +696,4 @@ def computer_config_show(computer, user, defaults, as_option_string):
                 table.append((f'* {name}', config[name]))
             else:
                 table.append((f'* {name}', '-'))
-        echo.echo(tabulate.tabulate(table, tablefmt='plain'))
+        echo_tabulate(table, tablefmt='plain')

aiida/cmdline/commands/cmd_node.py

@@ -9,15 +9,13 @@
 ###########################################################################
 """`verdi node` command."""
 import pathlib
-import shutil
 
 import click
-import tabulate
 
 from aiida.cmdline.commands.cmd_verdi import verdi
 from aiida.cmdline.params import arguments, options
 from aiida.cmdline.params.types.plugin import PluginParamType
-from aiida.cmdline.utils import decorators, echo, multi_line_input
+from aiida.cmdline.utils import decorators, echo, echo_tabulate, multi_line_input
 from aiida.cmdline.utils.decorators import with_dbenv
 from aiida.common import exceptions, timezone
 from aiida.common.links import GraphTraversalRules
@@ -43,6 +41,7 @@ def repo_cat(node, relative_path):
     For ``SinglefileData`` nodes, the `RELATIVE_PATH` does not have to be specified as it is determined automatically.
     """
     import errno
+    import shutil
     import sys
 
     from aiida.orm import SinglefileData
@@ -92,6 +91,8 @@ def repo_dump(node, output_directory):
     The output directory should not exist. If it does, the command
     will abort.
     """
+    import shutil
+
     from aiida.repository import FileType
 
     output_directory = pathlib.Path(output_directory)
@@ -146,9 +147,9 @@ def node_label(nodes, label, raw, force):
                 table.append([node.pk, node.label])
 
         if raw:
-            echo.echo(tabulate.tabulate(table, tablefmt='plain'))
+            echo_tabulate(table, tablefmt='plain')
         else:
-            echo.echo(tabulate.tabulate(table, headers=['ID', 'Label']))
+            echo_tabulate(table, headers=['ID', 'Label'])
 
     else:
         if not force:
@@ -180,9 +181,9 @@ def node_description(nodes, description, force, raw):
                 table.append([node.pk, node.description])
 
         if raw:
-            echo.echo(tabulate.tabulate(table, tablefmt='plain'))
+            echo_tabulate(table, tablefmt='plain')
         else:
-            echo.echo(tabulate.tabulate(table, headers=['ID', 'Description']))
+            echo_tabulate(table, headers=['ID', 'Description'])
 
     else:
         if not force:
@@ -229,7 +230,7 @@ def node_show(nodes, print_groups):
                 table = [(gr['groups']['id'], gr['groups']['label'], gr['groups']['type_string']) for gr in res]
                 table.sort()
 
-                echo.echo(tabulate.tabulate(table, headers=['PK', 'Label', 'Group type']))
+                echo_tabulate(table, headers=['PK', 'Label', 'Group type'])
 
 
 def echo_node_dict(nodes, keys, fmt, identifier, raw, use_attrs=True):

aiida/cmdline/commands/cmd_plugin.py

@@ -8,7 +8,6 @@
 # For further information please visit http://www.aiida.net               #
 ###########################################################################
 """Command for `verdi plugins`."""
-import inspect
 
 import click
 
@@ -27,6 +26,8 @@ def verdi_plugin():
 @click.argument('entry_point', type=click.STRING, required=False)
 def plugin_list(entry_point_group, entry_point):
     """Display a list of all available plugins."""
+    import inspect
+
     from aiida.cmdline.utils.common import print_process_info
     from aiida.common import EntryPointError
     from aiida.engine import Process

aiida/cmdline/commands/cmd_rabbitmq.py

@@ -16,12 +16,11 @@
 import typing as t
 
 import click
-import tabulate
 import wrapt
 
 from aiida.cmdline.commands.cmd_devel import verdi_devel
 from aiida.cmdline.params import arguments, options
-from aiida.cmdline.utils import decorators, echo
+from aiida.cmdline.utils import decorators, echo, echo_tabulate
 
 if t.TYPE_CHECKING:
     import kiwipy.rmq
@@ -192,7 +191,7 @@ def cmd_queues_list(client, project, raw, filter_name):
 
     headers = [name.capitalize() for name in project] if not raw else []
     tablefmt = None if not raw else 'plain'
-    echo.echo(tabulate.tabulate(output, headers=headers, tablefmt=tablefmt))
+    echo_tabulate(output, headers=headers, tablefmt=tablefmt)
 
 
 @cmd_queues.command('create')

aiida/cmdline/params/options/commands/setup.py

@@ -10,7 +10,6 @@
 """Reusable command line interface options for the setup commands."""
 import functools
 import getpass
-import hashlib
 
 import click
 
@@ -94,6 +93,8 @@ def get_quicksetup_database_name(ctx, param, value):  # pylint: disable=unused-a
     :param ctx: click context which should contain the contextual parameters
     :return: the database name
     """
+    import hashlib
+
     if value is not None:
         return value
 
@@ -114,6 +115,8 @@ def get_quicksetup_username(ctx, param, value):  # pylint: disable=unused-argume
     :param ctx: click context which should contain the contextual parameters
     :return: the username
     """
+    import hashlib
+
     if value is not None:
         return value
 

aiida/cmdline/params/types/identifier.py

@@ -11,6 +11,7 @@
 Module for custom click param type identifier
 """
 from abc import ABC, abstractmethod
+from functools import cached_property
 
 import click
 
@@ -46,24 +47,29 @@ def __init__(self, sub_classes=None):
             will be mapped upon. These classes have to be strict sub classes of the base orm class defined
             by the orm class loader
         """
-        from aiida.common import exceptions
+        if sub_classes is not None and not isinstance(sub_classes, tuple):
+            raise TypeError('sub_classes should be a tuple of entry point strings')
 
         self._sub_classes = None
-        self._entry_points = []
-
-        if sub_classes is not None:
+        self._entry_point_strings = sub_classes
 
-            if not isinstance(sub_classes, tuple):
-                raise TypeError('sub_classes should be a tuple of entry point strings')
+    @cached_property
+    def _entry_points(self):
+        """Allowed entry points, loaded on demand"""
+        from aiida.common import exceptions
 
-            for entry_point_string in sub_classes:
+        if self._entry_point_strings is None:
+            return []
 
-                try:
-                    entry_point = get_entry_point_from_string(entry_point_string)
-                except (ValueError, exceptions.EntryPointError) as exception:
-                    raise ValueError(f'{entry_point_string} is not a valid entry point string: {exception}')
-                else:
-                    self._entry_points.append(entry_point)
+        entry_points = []
+        for entry_point_string in self._entry_point_strings:
+            try:
+                entry_point = get_entry_point_from_string(entry_point_string)
+            except (ValueError, exceptions.EntryPointError) as exception:
+                raise ValueError(f'{entry_point_string} is not a valid entry point string: {exception}')
+            else:
+                entry_points.append(entry_point)
+        return entry_points
 
     @property
     @abstractmethod
@@ -99,7 +105,7 @@ def convert(self, value, param, ctx):
         if not issubclass(loader, OrmEntityLoader):
             raise RuntimeError('the orm class loader should be a subclass of OrmEntityLoader')
 
-        # If entry points where in the constructor, we load their corresponding classes, validate that they are valid
+        # If entry points were in the constructor, we load their corresponding classes, validate that they are valid
         # sub classes of the orm class loader and then pass it as the sub_class parameter to the load_entity call.
         # We store the loaded entry points in an instance variable, such that the loading only has to be done once.
         if self._entry_points and self._sub_classes is None:

aiida/cmdline/params/types/path.py

@@ -9,7 +9,6 @@
 ###########################################################################
 """Click parameter types for paths."""
 import os
-from socket import timeout
 
 import click
 
@@ -86,13 +85,14 @@ def convert(self, value, param, ctx):
 
     def checks_url(self, url, param, ctx):
         """Check whether URL is reachable within timeout."""
+        import socket
         import urllib.error
         import urllib.request
 
         try:
             with urllib.request.urlopen(url, timeout=self.timeout_seconds):
                 pass
-        except (urllib.error.URLError, urllib.error.HTTPError, timeout):
+        except (urllib.error.URLError, urllib.error.HTTPError, socket.timeout):
             self.fail(f'{self.name} "{url}" could not be reached within {self.timeout_seconds} s.\n', param, ctx)
 
         return url
@@ -124,10 +124,11 @@ def convert(self, value, param, ctx):
 
     def get_url(self, url, param, ctx):
         """Retrieve file from URL."""
+        import socket
         import urllib.error
         import urllib.request
 
         try:
             return urllib.request.urlopen(url, timeout=self.timeout_seconds)  # pylint: disable=consider-using-with
-        except (urllib.error.URLError, urllib.error.HTTPError, timeout):
+        except (urllib.error.URLError, urllib.error.HTTPError, socket.timeout):
             self.fail(f'{self.name} "{url}" could not be reached within {self.timeout_seconds} s.\n', param, ctx)

aiida/cmdline/params/types/plugin.py

@@ -11,7 +11,6 @@
 import functools
 
 import click
-from importlib_metadata import EntryPoint
 
 from aiida.common import exceptions
 from aiida.plugins import factories
@@ -68,49 +67,52 @@ def __init__(self, group=None, load=False, *args, **kwargs):
         is not specified use the tuple of all recognized entry point groups.
         """
         # pylint: disable=keyword-arg-before-vararg
+        self.load = load
+        self._input_group = group
+
+        super().__init__(*args, **kwargs)
+
+    def _get_valid_groups(self):
+        """Get allowed groups for this instance"""
+
+        group = self._input_group
         valid_entry_point_groups = get_entry_point_groups()
 
         if group is None:
-            self._groups = tuple(valid_entry_point_groups)
+            return tuple(valid_entry_point_groups)
+
+        if isinstance(group, str):
+            unvalidated_groups = (group,)
+        elif isinstance(group, tuple):
+            unvalidated_groups = group
         else:
-            if isinstance(group, str):
-                invalidated_groups = tuple([group])
-            elif isinstance(group, tuple):
-                invalidated_groups = group
-            else:
-                raise ValueError('invalid type for group')
+            raise ValueError('invalid type for group')
 
-            groups = []
+        groups = []
 
-            for grp in invalidated_groups:
+        for grp in unvalidated_groups:
 
-                if not grp.startswith(ENTRY_POINT_GROUP_PREFIX):
-                    grp = ENTRY_POINT_GROUP_PREFIX + grp
+            if not grp.startswith(ENTRY_POINT_GROUP_PREFIX):
+                grp = ENTRY_POINT_GROUP_PREFIX + grp
 
-                if grp not in valid_entry_point_groups:
-                    raise ValueError(f'entry point group {grp} is not recognized')
+            if grp not in valid_entry_point_groups:
+                raise ValueError(f'entry point group {grp} is not recognized')
 
-                groups.append(grp)
+            groups.append(grp)
 
-            self._groups = tuple(groups)
+        return tuple(groups)
 
-        self._init_entry_points()
-        self.load = load
+    @functools.cached_property
+    def groups(self) -> tuple:
+        return self._get_valid_groups()
 
-        super().__init__(*args, **kwargs)
-
-    def _init_entry_points(self):
-        """
-        Populate entry point information that will be used later on.  This should only be called
-        once in the constructor after setting self.groups because the groups should not be changed
-        after instantiation
-        """
-        self._entry_points = [(group, entry_point) for group in self.groups for entry_point in get_entry_points(group)]
-        self._entry_point_names = [entry_point.name for group in self.groups for entry_point in get_entry_points(group)]
+    @functools.cached_property
+    def _entry_points(self) -> list[tuple]:
+        return [(group, entry_point) for group in self.groups for entry_point in get_entry_points(group)]
 
-    @property
-    def groups(self):
-        return self._groups
+    @functools.cached_property
+    def _entry_point_names(self) -> list[str]:
+        return [entry_point.name for group in self.groups for entry_point in get_entry_points(group)]
 
     @property
     def has_potential_ambiguity(self):
@@ -236,6 +238,8 @@ def convert(self, value, param, ctx):
         Convert the string value to an entry point instance, if the value can be successfully parsed
         into an actual entry point. Will raise click.BadParameter if validation fails.
         """
+        from importlib_metadata import EntryPoint
+
         # If the value is already of the expected return type, simply return it. This behavior is new in `click==8.0`:
         # https://click.palletsprojects.com/en/8.0.x/parameters/#implementing-custom-types
         if isinstance(value, EntryPoint):