python-openstackclient 7.3.1__py3-none-any.whl → 8.0.0__py3-none-any.whl

openstackclient/compute/v2/server.py

@@ -34,6 +34,7 @@ from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient.api import compute_v2
+from openstackclient.common import envvars
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -324,48 +325,6 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
     return info
 
 
-def bool_from_str(value, strict=False):
-    true_strings = ('1', 't', 'true', 'on', 'y', 'yes')
-    false_strings = ('0', 'f', 'false', 'off', 'n', 'no')
-
-    if isinstance(value, bool):
-        return value
-
-    lowered = value.strip().lower()
-    if lowered in true_strings:
-        return True
-    elif lowered in false_strings or not strict:
-        return False
-
-    msg = _(
-        "Unrecognized value '%(value)s'; acceptable values are: %(valid)s"
-    ) % {
-        'value': value,
-        'valid': ', '.join(
-            f"'{s}'" for s in sorted(true_strings + false_strings)
-        ),
-    }
-    raise ValueError(msg)
-
-
-def boolenv(*vars, default=False):
-    """Search for the first defined of possibly many bool-like env vars.
-
-    Returns the first environment variable defined in vars, or returns the
-    default.
-
-    :param vars: Arbitrary strings to search for. Case sensitive.
-    :param default: The default to return if no value found.
-    :returns: A boolean corresponding to the value found, else the default if
-        no value found.
-    """
-    for v in vars:
-        value = os.environ.get(v, None)
-        if value:
-            return bool_from_str(value)
-    return default
-
-
 class AddFixedIP(command.ShowOne):
     _description = _("Add fixed IP address to server")
 
@@ -399,7 +358,7 @@ class AddFixedIP(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -430,7 +389,7 @@ class AddFixedIP(command.ShowOne):
 
         interface = compute_client.create_server_interface(server.id, **kwargs)
 
-        columns = (
+        columns: tuple[str, ...] = (
             'port_id',
             'server_id',
             'net_id',
@@ -438,7 +397,7 @@ class AddFixedIP(command.ShowOne):
             'port_state',
             'fixed_ips',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Port ID',
             'Server ID',
             'Network ID',
@@ -493,7 +452,7 @@ class AddFloatingIP(network_common.NetworkAndComputeCommand):
         return parser
 
     def take_action_network(self, client, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         attrs = {}
         obj = client.find_ip(
@@ -586,7 +545,7 @@ class AddPort(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -640,7 +599,7 @@ class AddNetwork(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -691,7 +650,7 @@ class AddServerSecurityGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -793,7 +752,7 @@ with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         volume_client = self.app.client_manager.sdk_connection.volume
 
         server = compute_client.find_server(
@@ -842,8 +801,13 @@ with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
             **kwargs,
         )
 
-        columns = ('id', 'server id', 'volume id', 'device')
-        column_headers = ('ID', 'Server ID', 'Volume ID', 'Device')
+        columns: tuple[str, ...] = ('id', 'server id', 'volume id', 'device')
+        column_headers: tuple[str, ...] = (
+            'ID',
+            'Server ID',
+            'Volume ID',
+            'Device',
+        )
         if sdk_utils.supports_microversion(compute_client, '2.49'):
             columns += ('tag',)
             column_headers += ('Tag',)
@@ -1027,7 +991,6 @@ class BDMLegacyAction(argparse.Action):
 
 class BDMAction(parseractions.MultiKeyValueAction):
     def __init__(self, option_strings, dest, **kwargs):
-        required_keys = []
         optional_keys = [
             'uuid',
             'source_type',
@@ -1045,7 +1008,7 @@ class BDMAction(parseractions.MultiKeyValueAction):
         super().__init__(
             option_strings,
             dest,
-            required_keys=required_keys,
+            required_keys=[],
             optional_keys=optional_keys,
             **kwargs,
         )
@@ -1402,7 +1365,7 @@ class CreateServer(command.ShowOne):
             default=[],
             help=_(
                 'File(s) to inject into image before boot '
-                '(repeat option to set multiple files)'
+                '(repeat option to set multiple files) '
                 '(supported by --os-compute-api-version 2.57 or below)'
             ),
         )
@@ -1554,7 +1517,7 @@ class CreateServer(command.ShowOne):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         volume_client = self.app.client_manager.volume
         image_client = self.app.client_manager.image
 
@@ -1617,8 +1580,7 @@ class CreateServer(command.ShowOne):
                 image = images[0]
             else:
                 msg = _(
-                    'No images match the property expected by '
-                    '--image-property'
+                    'No images match the property expected by --image-property'
                 )
                 raise exceptions.CommandError(msg)
 
@@ -1873,7 +1835,7 @@ class CreateServer(command.ShowOne):
 
             if 'delete_on_termination' in mapping:
                 try:
-                    value = bool_from_str(
+                    value = envvars.bool_from_str(
                         mapping['delete_on_termination'],
                         strict=True,
                     )
@@ -1902,7 +1864,7 @@ class CreateServer(command.ShowOne):
 
         # Default to empty list if nothing was specified and let nova
         # decide the default behavior.
-        networks: ty.Union[str, ty.List[ty.Dict[str, str]], None] = []
+        networks: ty.Union[str, list[dict[str, str]], None] = []
 
         if 'auto' in parsed_args.nics or 'none' in parsed_args.nics:
             if len(parsed_args.nics) > 1:
@@ -1967,7 +1929,7 @@ class CreateServer(command.ShowOne):
 
                 # convert from the novaclient-derived "NIC" view to the actual
                 # "network" view
-                network = {}
+                network: dict[str, str] = {}
 
                 if nic['net-id']:
                     network['uuid'] = nic['net-id']
@@ -1983,7 +1945,7 @@ class CreateServer(command.ShowOne):
                 if nic.get('tag'):  # tags are optional
                     network['tag'] = nic['tag']
 
-                networks.append(network)
+                networks.append(network)  # type: ignore[union-attr]
 
         if not parsed_args.nics and sdk_utils.supports_microversion(
             compute_client, '2.37'
@@ -2195,7 +2157,7 @@ class CreateServerDump(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for name_or_id in parsed_args.server:
             server = compute_client.find_server(name_or_id)
             server.trigger_crash_dump(compute_client)
@@ -2220,7 +2182,7 @@ class DeleteServer(command.Command):
         parser.add_argument(
             '--all-projects',
             action='store_true',
-            default=boolenv('ALL_PROJECTS'),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_(
                 'Delete server(s) in another project by name (admin only)'
                 '(can be specified using the ALL_PROJECTS envvar)'
@@ -2239,7 +2201,7 @@ class DeleteServer(command.Command):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_obj = compute_client.find_server(
                 server,
@@ -2386,7 +2348,7 @@ class ListServer(command.Lister):
         parser.add_argument(
             '--all-projects',
             action='store_true',
-            default=boolenv('ALL_PROJECTS'),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_(
                 'Include all projects (admin only) '
                 '(can be specified using the ALL_PROJECTS envvar)'
@@ -2424,8 +2386,7 @@ class ListServer(command.Lister):
         parser.add_argument(
             '--key-name',
             help=_(
-                'Search by keypair name '
-                '(admin only before microversion 2.83)'
+                'Search by keypair name (admin only before microversion 2.83)'
             ),
         )
         config_drive_group = parser.add_mutually_exclusive_group()
@@ -2648,7 +2609,7 @@ class ListServer(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         identity_client = self.app.client_manager.identity
         image_client = self.app.client_manager.image
 
@@ -2804,12 +2765,12 @@ class ListServer(command.Lister):
                     msg % search_opts['changes-since']
                 )
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'name',
             'status',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Name',
             'Status',
@@ -3124,7 +3085,7 @@ A non-admin user will not be able to execute actions."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         kwargs = {}
         if parsed_args.reason:
@@ -3222,7 +3183,7 @@ revert to release the new server and restart the old one."""
             action='store_true',
             default=None,
             help=_(
-                'Allow disk over-commit on the destination host'
+                'Allow disk over-commit on the destination host '
                 '(supported with --os-compute-api-version 2.24 or below)'
             ),
         )
@@ -3231,7 +3192,7 @@ revert to release the new server and restart the old one."""
             dest='disk_overcommit',
             action='store_false',
             help=_(
-                'Do not over-commit disk on the destination host (default)'
+                'Do not over-commit disk on the destination host (default) '
                 '(supported with --os-compute-api-version 2.24 or below)'
             ),
         )
@@ -3248,7 +3209,7 @@ revert to release the new server and restart the old one."""
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -3351,7 +3312,7 @@ class PauseServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -3400,7 +3361,7 @@ class RebootServer(command.Command):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server_id = compute_client.find_server(
             parsed_args.server,
             ignore_missing=False,
@@ -3434,7 +3395,7 @@ class RebuildServer(command.ShowOne):
             '--image',
             metavar='<image>',
             help=_(
-                'Recreate server from the specified image (name or ID).'
+                'Recreate server from the specified image (name or ID). '
                 'Defaults to the currently used one.'
             ),
         )
@@ -3605,7 +3566,7 @@ class RebuildServer(command.ShowOne):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
         server = compute_client.find_server(
@@ -3866,7 +3827,7 @@ host."""
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
         if parsed_args.host:
@@ -3931,7 +3892,7 @@ class RemoveFixedIP(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -3960,14 +3921,12 @@ class RemoveFloatingIP(network_common.NetworkAndComputeCommand):
         return parser
 
     def take_action_network(self, client, parsed_args):
-        attrs = {}
         obj = client.find_ip(
             parsed_args.ip_address,
             ignore_missing=False,
         )
-        attrs['port_id'] = None
 
-        client.update_ip(obj, **attrs)
+        client.update_ip(obj, port_id=None)
 
     def take_action_compute(self, client, parsed_args):
         server = client.find_server(parsed_args.server, ignore_missing=False)
@@ -3992,7 +3951,7 @@ class RemovePort(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -4031,7 +3990,7 @@ class RemoveNetwork(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -4075,7 +4034,7 @@ class RemoveServerSecurityGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -4145,7 +4104,7 @@ volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         volume_client = self.app.client_manager.sdk_connection.volume
 
         server = compute_client.find_server(
@@ -4198,7 +4157,7 @@ server booted from a volume."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
         image_ref = None
@@ -4252,7 +4211,7 @@ release the new server and restart the old one."""
             '--revert',
             action="store_true",
             help=_(
-                '**Deprecated** Restore server state before resize'
+                '**Deprecated** Restore server state before resize. '
                 "Replaced by the 'openstack server resize revert' and "
                 "'openstack server migration revert' commands"
             ),
@@ -4270,7 +4229,7 @@ release the new server and restart the old one."""
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -4332,7 +4291,7 @@ Confirm (verify) success of resize operation and release the old server."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -4380,7 +4339,7 @@ one."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -4424,7 +4383,7 @@ class RestoreServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -4447,7 +4406,7 @@ class ResumeServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -4475,8 +4434,7 @@ class SetServer(command.Command):
         password_group.add_argument(
             '--password',
             help=_(
-                'Set the server password. '
-                'This option requires cloud support.'
+                'Set the server password. This option requires cloud support.'
             ),
         )
         password_group.add_argument(
@@ -4548,7 +4506,7 @@ class SetServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -4666,7 +4624,7 @@ class ShelveServer(command.Command):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server_ids = []
 
         for server in parsed_args.servers:
@@ -4761,7 +4719,7 @@ information for the server."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
         server = compute_client.find_server(
@@ -4891,7 +4849,7 @@ class SshServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -4968,7 +4926,7 @@ class StartServer(command.Command):
         parser.add_argument(
             '--all-projects',
             action='store_true',
-            default=boolenv('ALL_PROJECTS'),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_(
                 'Start server(s) in another project by name (admin only) '
                 '(can be specified using the ALL_PROJECTS envvar)'
@@ -4977,7 +4935,7 @@ class StartServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -5003,16 +4961,16 @@ class StopServer(command.Command):
         parser.add_argument(
             '--all-projects',
             action='store_true',
-            default=boolenv('ALL_PROJECTS'),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_(
-                'Stop server(s) in another project by name (admin only)'
+                'Stop server(s) in another project by name (admin only) '
                 '(can be specified using the ALL_PROJECTS envvar)'
             ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -5037,7 +4995,7 @@ class SuspendServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -5060,7 +5018,7 @@ class UnlockServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -5083,7 +5041,7 @@ class UnpauseServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         for server in parsed_args.server:
             server_id = compute_client.find_server(
                 server,
@@ -5105,7 +5063,7 @@ class UnrescueServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
@@ -5172,7 +5130,7 @@ class UnsetServer(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
@@ -5263,7 +5221,7 @@ class UnshelveServer(command.Command):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         kwargs = {}
 
         if parsed_args.availability_zone:

openstackclient/compute/v2/server_backup.py

@@ -71,7 +71,7 @@ class CreateServerBackup(command.ShowOne):
                 self.app.stderr.write(f'\rProgress: {progress}')
                 self.app.stderr.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False