Deprecate methods that refer to a computer's label as name (#4309)

All entities use `label` as the human readable string identifier, but
`Computer` was using `name`. This was already changed in the front-end
ORM in a previous commit where a `label` property was introduced and
the old `name` properties were deprecated, however, a few derivative
methods in other classes were missed and still use contain "name".
These methods are now also deprecated:

  * `verdi computer rename`: use `verdi computer relabel` instead
  * `Code.get_computer_name`: use `self.computer.label` instead
  * `Code.get_full_text_info`: will be removed
  * `RemoteData.get_computer_name`: use `self.computer.label` instead
  * `Transport.get_valid_transports`: `get_entry_point_names` instead

Finally, deprecations of `Computer` getters and setters as introduced
in commit 592dd36 were still being used internally leading to
a lot of deprecation warnings. These have now been properly replaced.

aiida/cmdline/commands/cmd_calcjob.py

@@ -271,4 +271,4 @@ def calcjob_cleanworkdir(calcjobs, past_days, older_than, computers, force):
                 clean_remote(transport, path)
                 counter += 1
 
-        echo.echo_success('{} remote folders cleaned on {}'.format(counter, computer.name))
+        echo.echo_success('{} remote folders cleaned on {}'.format(counter, computer.label))

aiida/cmdline/commands/cmd_code.py

@@ -45,7 +45,7 @@ def get_default(key, ctx):
 
 
 def get_computer_name(ctx):
-    return getattr(ctx.code_builder, 'computer').name
+    return getattr(ctx.code_builder, 'computer').label
 
 
 def get_on_computer(ctx):
@@ -168,7 +168,36 @@ def code_duplicate(ctx, code, non_interactive, **kwargs):
 @with_dbenv()
 def show(code, verbose):
     """Display detailed information for a code."""
-    click.echo(tabulate.tabulate(code.get_full_text_info(verbose)))
+    from aiida.orm.utils.repository import FileType
+
+    table = []
+    table.append(['PK', code.pk])
+    table.append(['UUID', code.uuid])
+    table.append(['Label', code.label])
+    table.append(['Description', code.description])
+    table.append(['Default plugin', code.get_input_plugin_name()])
+
+    if code.is_local():
+        table.append(['Type', 'local'])
+        table.append(['Exec name', code.get_execname()])
+        table.append(['List of files/folders:', ''])
+        for obj in code.list_objects():
+            if obj.type == FileType.DIRECTORY:
+                table.append(['directory', obj.name])
+            else:
+                table.append(['file', obj.name])
+    else:
+        table.append(['Type', 'remote'])
+        table.append(['Remote machine', code.get_remote_computer().label])
+        table.append(['Remote absolute path', code.get_remote_exec_path()])
+
+    table.append(['Prepend text', code.get_prepend_text()])
+    table.append(['Append text', code.get_append_text()])
+
+    if verbose:
+        table.append(['Calculations', len(code.get_outgoing().all())])
+
+    click.echo(tabulate.tabulate(table))
 
 
 @verdi_code.command()
@@ -225,7 +254,7 @@ def relabel(code, label):
     try:
         code.relabel(label)
     except InputValidationError as exception:
-        echo.echo_critical('invalid code name: {}'.format(exception))
+        echo.echo_critical('invalid code label: {}'.format(exception))
     else:
         echo.echo_success('Code<{}> relabeled from {} to {}'.format(code.pk, old_label, code.full_label))
 
@@ -249,7 +278,7 @@ def code_list(computer, input_plugin, all_entries, all_users, show_owner):
 
     qb_computer_filters = dict()
     if computer is not None:
-        qb_computer_filters['name'] = computer.name
+        qb_computer_filters['name'] = computer.label
 
     qb_code_filters = dict()
     if input_plugin is not None:

aiida/cmdline/commands/cmd_computer.py

@@ -9,16 +9,16 @@
 ###########################################################################
 # pylint: disable=invalid-name,too-many-statements,too-many-branches
 """`verdi computer` command."""
-
 from functools import partial
 
 import click
+import tabulate
 
 from aiida.cmdline.commands.cmd_verdi import verdi
 from aiida.cmdline.params import options, arguments
 from aiida.cmdline.params.options.commands import computer as options_computer
 from aiida.cmdline.utils import echo
-from aiida.cmdline.utils.decorators import with_dbenv
+from aiida.cmdline.utils.decorators import with_dbenv, deprecated_command
 from aiida.cmdline.utils.multi_line_input import ensure_scripts
 from aiida.common.exceptions import ValidationError, InputValidationError
 from aiida.plugins.entry_point import get_entry_points
@@ -260,10 +260,10 @@ def computer_setup(ctx, non_interactive, **kwargs):
     except ValidationError as err:
         echo.echo_critical('unable to store the computer: {}. Exiting...'.format(err))
     else:
-        echo.echo_success('Computer<{}> {} created'.format(computer.pk, computer.name))
+        echo.echo_success('Computer<{}> {} created'.format(computer.pk, computer.label))
 
     echo.echo_info('Note: before the computer can be used, it has to be configured with the command:')
-    echo.echo_info('  verdi computer configure {} {}'.format(computer.get_transport_type(), computer.name))
+    echo.echo_info('  verdi computer configure {} {}'.format(computer.transport_type, computer.label))
 
 
 @verdi_computer.command('duplicate')
@@ -316,20 +316,20 @@ def computer_duplicate(ctx, computer, non_interactive, **kwargs):
     except (ComputerBuilder.ComputerValidationError, ValidationError) as e:
         echo.echo_critical('{}: {}'.format(type(e).__name__, e))
     else:
-        echo.echo_success('stored computer {}<{}>'.format(computer.name, computer.pk))
+        echo.echo_success('stored computer {}<{}>'.format(computer.label, computer.pk))
 
     try:
         computer.store()
     except ValidationError as err:
         echo.echo_critical('unable to store the computer: {}. Exiting...'.format(err))
     else:
-        echo.echo_success('Computer<{}> {} created'.format(computer.pk, computer.name))
+        echo.echo_success('Computer<{}> {} created'.format(computer.pk, computer.label))
 
     is_configured = computer.is_user_configured(orm.User.objects.get_default())
 
     if not is_configured:
         echo.echo_info('Note: before the computer can be used, it has to be configured with the command:')
-        echo.echo_info('  verdi computer configure {} {}'.format(computer.get_transport_type(), computer.name))
+        echo.echo_info('  verdi computer configure {} {}'.format(computer.transport_type, computer.label))
 
 
 @verdi_computer.command('enable')
@@ -344,15 +344,15 @@ def computer_enable(computer, user):
         authinfo = computer.get_authinfo(user)
     except NotExistent:
         echo.echo_critical(
-            "User with email '{}' is not configured for computer '{}' yet.".format(user.email, computer.name)
+            "User with email '{}' is not configured for computer '{}' yet.".format(user.email, computer.label)
         )
 
     if not authinfo.enabled:
         authinfo.enabled = True
-        echo.echo_info("Computer '{}' enabled for user {}.".format(computer.name, user.get_full_name()))
+        echo.echo_info("Computer '{}' enabled for user {}.".format(computer.label, user.get_full_name()))
     else:
         echo.echo_info(
-            "Computer '{}' was already enabled for user {} {}.".format(computer.name, user.first_name, user.last_name)
+            "Computer '{}' was already enabled for user {} {}.".format(computer.label, user.first_name, user.last_name)
         )
 
 
@@ -370,15 +370,17 @@ def computer_disable(computer, user):
         authinfo = computer.get_authinfo(user)
     except NotExistent:
         echo.echo_critical(
-            "User with email '{}' is not configured for computer '{}' yet.".format(user.email, computer.name)
+            "User with email '{}' is not configured for computer '{}' yet.".format(user.email, computer.label)
         )
 
     if authinfo.enabled:
         authinfo.enabled = False
-        echo.echo_info("Computer '{}' disabled for user {}.".format(computer.name, user.get_full_name()))
+        echo.echo_info("Computer '{}' disabled for user {}.".format(computer.label, user.get_full_name()))
     else:
         echo.echo_info(
-            "Computer '{}' was already disabled for user {} {}.".format(computer.name, user.first_name, user.last_name)
+            "Computer '{}' was already disabled for user {} {}.".format(
+                computer.label, user.first_name, user.last_name
+            )
         )
 
 
@@ -400,7 +402,7 @@ def computer_list(all_entries, raw):
     if not computers:
         echo.echo_info("No computers configured yet. Use 'verdi computer setup'")
 
-    sort = lambda computer: computer.name
+    sort = lambda computer: computer.label
     highlight = lambda comp: comp.is_user_configured(user) and comp.is_user_enabled(user)
     hide = lambda comp: not (comp.is_user_configured(user) and comp.is_user_enabled(user)) and not all_entries
     echo.echo_formatted_list(computers, ['name'], sort=sort, highlight=highlight, hide=hide)
@@ -411,36 +413,57 @@ def computer_list(all_entries, raw):
 @with_dbenv()
 def computer_show(computer):
     """Show detailed information for a computer."""
-    echo.echo(computer.full_text_info)
+    table = []
+    table.append(['Label', computer.label])
+    table.append(['PK', computer.pk])
+    table.append(['UUID', computer.uuid])
+    table.append(['Description', computer.description])
+    table.append(['Hostname', computer.hostname])
+    table.append(['Transport type', computer.transport_type])
+    table.append(['Scheduler type', computer.scheduler_type])
+    table.append(['Work directory', computer.get_workdir()])
+    table.append(['Shebang', computer.get_shebang()])
+    table.append(['Mpirun command', ' '.join(computer.get_mpirun_command())])
+    table.append(['Prepend text', computer.get_prepend_text()])
+    table.append(['Append text', computer.get_append_text()])
+    echo.echo(tabulate.tabulate(table))
 
 
 @verdi_computer.command('rename')
 @arguments.COMPUTER()
 @arguments.LABEL('NEW_NAME')
+@deprecated_command("This command has been deprecated. Please use 'verdi computer relabel' instead.")
+@click.pass_context
 @with_dbenv()
-def computer_rename(computer, new_name):
+def computer_rename(ctx, computer, new_name):
     """Rename a computer."""
+    ctx.invoke(computer_relabel, computer=computer, label=new_name)
+
+
+@verdi_computer.command('relabel')
+@arguments.COMPUTER()
+@arguments.LABEL('LABEL')
+@with_dbenv()
+def computer_relabel(computer, label):
+    """Relabel a computer."""
     from aiida.common.exceptions import UniquenessError
 
-    old_name = computer.get_name()
+    old_label = computer.label
 
-    if old_name == new_name:
-        echo.echo_critical('The old and new names are the same.')
+    if old_label == label:
+        echo.echo_critical('The old and new labels are the same.')
 
     try:
-        computer.set_name(new_name)
+        computer.label = label
         computer.store()
     except ValidationError as error:
         echo.echo_critical('Invalid input! {}'.format(error))
     except UniquenessError as error:
         echo.echo_critical(
-            'Uniqueness error encountered! Probably a '
-            "computer with name '{}' already exists"
-            ''.format(new_name)
+            "Uniqueness error encountered! Probably a computer with label '{}' already exists: {}".format(label, error)
         )
-        echo.echo_critical('(Message was: {})'.format(error))
 
-    echo.echo_success("Computer '{}' renamed to '{}'".format(old_name, new_name))
+    echo.echo_success("Computer '{}' relabeled to '{}'".format(old_label, label))
 
 
 @verdi_computer.command('test')
@@ -472,15 +495,15 @@ def computer_test(user, print_traceback, computer):
     if user is None:
         user = orm.User.objects.get_default()
 
-    echo.echo_info('Testing computer<{}> for user<{}>...'.format(computer.name, user.email))
+    echo.echo_info('Testing computer<{}> for user<{}>...'.format(computer.label, user.email))
 
     try:
         authinfo = computer.get_authinfo(user)
     except NotExistent:
-        echo.echo_critical('Computer<{}> is not yet configured for user<{}>'.format(computer.name, user.email))
+        echo.echo_critical('Computer<{}> is not yet configured for user<{}>'.format(computer.label, user.email))
 
     if not authinfo.enabled:
-        echo.echo_warning('Computer<{}> is disabled for user<{}>'.format(computer.name, user.email))
+        echo.echo_warning('Computer<{}> is disabled for user<{}>'.format(computer.label, user.email))
         click.confirm('Do you really want to test it?', abort=True)
 
     scheduler = authinfo.computer.get_scheduler()
@@ -568,14 +591,14 @@ def computer_delete(computer):
     from aiida.common.exceptions import InvalidOperation
     from aiida import orm
 
-    compname = computer.name
+    label = computer.label
 
     try:
         orm.Computer.objects.delete(computer.id)
     except InvalidOperation as error:
         echo.echo_critical(str(error))
 
-    echo.echo_success("Computer '{}' deleted.".format(compname))
+    echo.echo_success("Computer '{}' deleted.".format(label))
 
 
 @verdi_computer.group('configure')
@@ -594,12 +617,11 @@ def computer_configure():
 @arguments.COMPUTER()
 def computer_config_show(computer, user, defaults, as_option_string):
     """Show the current configuration for a computer."""
-    import tabulate
     from aiida.common.escaping import escape_for_bash
 
     transport_cls = computer.get_transport_class()
     option_list = [
-        param for param in transport_cli.create_configure_cmd(computer.get_transport_type()).params
+        param for param in transport_cli.create_configure_cmd(computer.transport_type).params
         if isinstance(param, click.core.Option)
     ]
     option_list = [option for option in option_list if option.name in transport_cls.get_valid_auth_params()]

aiida/cmdline/commands/cmd_data/cmd_remote.py

@@ -85,6 +85,6 @@ def remote_cat(datum, path):
 def remote_show(datum):
     """Show information for a RemoteData object."""
     click.echo('- Remote computer name:')
-    click.echo('  {}'.format(datum.get_computer_name()))
+    click.echo('  {}'.format(datum.computer.label))
     click.echo('- Remote folder full path:')
     click.echo('  {}'.format(datum.get_remote_path()))

aiida/cmdline/utils/common.py

@@ -123,7 +123,7 @@ def get_node_summary(node):
         pass
     else:
         if computer is not None:
-            table.append(['computer', '[{}] {}'.format(node.computer.pk, node.computer.name)])
+            table.append(['computer', '[{}] {}'.format(node.computer.pk, node.computer.label)])
 
     return tabulate(table, headers=table_headers)
 

aiida/engine/daemon/execmanager.py

@@ -74,7 +74,7 @@ def upload_calculation(node, transport, calc_info, folder, inputs=None, dry_run=
         if not remote_working_directory.strip():
             raise exceptions.ConfigurationError(
                 "[submission of calculation {}] No remote_working_directory configured for computer '{}'".format(
-                    node.pk, computer.name
+                    node.pk, computer.label
                 )
             )
 
@@ -94,7 +94,7 @@ def upload_calculation(node, transport, calc_info, folder, inputs=None, dry_run=
                 raise exceptions.ConfigurationError(
                     '[submission of calculation {}] '
                     'Unable to create the remote directory {} on '
-                    "computer '{}': {}".format(node.pk, remote_working_directory, computer.name, exc)
+                    "computer '{}': {}".format(node.pk, remote_working_directory, computer.label, exc)
                 )
         # Store remotely with sharding (here is where we choose
         # the folder structure of remote jobs; then I store this
@@ -211,7 +211,7 @@ def find_data_node(inputs, uuid):
                 for remote_computer_uuid, remote_abs_path, dest_rel_path in remote_copy_list:
                     handle.write(
                         'would have copied {} to {} in working directory on remote {}'.format(
-                            remote_abs_path, dest_rel_path, computer.name
+                            remote_abs_path, dest_rel_path, computer.label
                         )
                     )
 
@@ -220,7 +220,7 @@ def find_data_node(inputs, uuid):
                 for remote_computer_uuid, remote_abs_path, dest_rel_path in remote_symlink_list:
                     handle.write(
                         'would have created symlinks from {} to {} in working directory on remote {}'.format(
-                            remote_abs_path, dest_rel_path, computer.name
+                            remote_abs_path, dest_rel_path, computer.label
                         )
                     )
 
@@ -230,7 +230,7 @@ def find_data_node(inputs, uuid):
             if remote_computer_uuid == computer.uuid:
                 logger.debug(
                     '[submission of calculation {}] copying {} remotely, directly on the machine {}'.format(
-                        node.pk, dest_rel_path, computer.name
+                        node.pk, dest_rel_path, computer.label
                     )
                 )
                 try:
@@ -251,7 +251,7 @@ def find_data_node(inputs, uuid):
             if remote_computer_uuid == computer.uuid:
                 logger.debug(
                     '[submission of calculation {}] copying {} remotely, directly on the machine {}'.format(
-                        node.pk, dest_rel_path, computer.name
+                        node.pk, dest_rel_path, computer.label
                     )
                 )
                 try:

aiida/engine/processes/calcjobs/calcjob.py

@@ -329,7 +329,7 @@ def presubmit(self, folder):
         for code in codes:
             if not code.can_run_on(computer):
                 raise InputValidationError('The selected code {} for calculation {} cannot run on computer {}'.format(
-                    code.pk, self.node.pk, computer.name))
+                    code.pk, self.node.pk, computer.label))
 
             if code.is_local() and code.get_local_executable() in folder.get_content_list():
                 raise PluginInternalError('The plugin created a file {} that is also the executable name!'.format(

aiida/orm/authinfos.py

@@ -50,9 +50,9 @@ def __init__(self, computer, user, backend=None):
 
     def __str__(self):
         if self.enabled:
-            return 'AuthInfo for {} on {}'.format(self.user.email, self.computer.name)
+            return 'AuthInfo for {} on {}'.format(self.user.email, self.computer.label)
 
-        return 'AuthInfo for {} on {} [DISABLED]'.format(self.user.email, self.computer.name)
+        return 'AuthInfo for {} on {} [DISABLED]'.format(self.user.email, self.computer.label)
 
     @property
     def enabled(self):
@@ -138,7 +138,7 @@ def get_transport(self):
         :rtype: :class:`aiida.transports.Transport`
         """
         computer = self.computer
-        transport_type = computer.get_transport_type()
+        transport_type = computer.transport_type
 
         try:
             transport_class = TransportFactory(transport_type)