python-openstackclient 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/identity/v3/user.py

@@ -22,19 +22,20 @@ import logging
 from typing import Any
 
 from openstack import exceptions as sdk_exc
+from openstack.identity.v3 import user as _user
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_user(user: Any) -> tuple[tuple[str, ...], Any]:
+def _format_user(user: _user.User) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = (
         'default_project_id',
         'domain_id',
@@ -448,11 +449,18 @@ class ListUser(command.Lister):
                 '--project and --group'
             ),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        if parsed_args.project and (
+            parsed_args.limit is not None or parsed_args.marker is not None
+        ):
+            msg = _('--limit and --marker are not supported with --project')
+            raise exceptions.CommandError(msg)
+
         identity_client = sdk_utils.ensure_service_version(
             self.app.client_manager.sdk_connection.identity, '3'
         )
@@ -475,6 +483,15 @@ class ListUser(command.Lister):
         if parsed_args.is_enabled is not None:
             enabled = parsed_args.is_enabled
 
+        pagination_kwargs: dict[str, Any] = {}
+        if parsed_args.limit is not None:
+            pagination_kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            pagination_kwargs['max_items'] = parsed_args.max_items
+        if parsed_args.marker is not None:
+            pagination_kwargs['marker'] = parsed_args.marker
+
+        data: list[_user.User]
         if parsed_args.project:
             if domain is not None:
                 project = identity_client.find_project(
@@ -504,21 +521,28 @@ class ListUser(command.Lister):
             for user_id in user_ids:
                 user = identity_client.find_user(user_id, ignore_missing=False)
                 data.append(user)
-
         elif parsed_args.group:
-            data = identity_client.group_users(
-                domain_id=domain,
-                group=group,
+            assert group is not None
+            data = list(
+                identity_client.group_users(
+                    domain_id=domain, group=group, **pagination_kwargs
+                )
             )
         else:
             if parsed_args.is_enabled is not None:
-                data = identity_client.users(
-                    domain_id=domain,
-                    is_enabled=enabled,
+                data = list(
+                    identity_client.users(
+                        domain_id=domain,
+                        is_enabled=enabled,
+                        **pagination_kwargs,
+                    )
                 )
             else:
-                data = identity_client.users(
-                    domain_id=domain,
+                data = list(
+                    identity_client.users(
+                        domain_id=domain,
+                        **pagination_kwargs,
+                    )
                 )
 
         # Column handling
@@ -718,6 +742,9 @@ class SetPasswordUser(command.Command):
             raise exceptions.CommandError('invalid authentication info')
 
         user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         # FIXME(gyee): there are two scenarios:
         #

openstackclient/image/v2/cache.py

@@ -41,14 +41,14 @@ def _format_image_cache(cached_images: dict[str, Any]) -> list[dict[str, Any]]:
                 image_obj['state'] = 'cached'
                 image_obj['last_accessed'] = (
                     datetime.datetime.fromtimestamp(
-                        image['last_accessed'], tz=datetime.timezone.utc
+                        image['last_accessed'], tz=datetime.UTC
                     )
                     .replace(tzinfo=None)
                     .isoformat()
                 )
                 image_obj['last_modified'] = (
                     datetime.datetime.fromtimestamp(
-                        image['last_modified'], tz=datetime.timezone.utc
+                        image['last_modified'], tz=datetime.UTC
                     )
                     .replace(tzinfo=None)
                     .isoformat()

openstackclient/image/v2/image.py

@@ -27,6 +27,7 @@ import urllib.parse
 
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
+from openstack.image.v2 import image as _image
 from openstack import utils as sdk_utils
 from osc_lib.api import utils as api_utils
 from osc_lib.cli import format_columns
@@ -74,11 +75,13 @@ MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
 LOG = logging.getLogger(__name__)
 
 
-def _format_image(image: Any, human_readable: bool = False) -> dict[str, Any]:
+def _format_image(
+    image: _image.Image, human_readable: bool = False
+) -> dict[str, object]:
     """Format an image to make it more consistent with OSC operations."""
 
     info = {}
-    properties = {}
+    properties: dict[str, object] = {}
 
     # the only fields we're not including is "links", "tags" and the properties
     fields_to_show = [
@@ -106,25 +109,25 @@ def _format_image(image: Any, human_readable: bool = False) -> dict[str, Any]:
 
     # TODO(gtema/anybody): actually it should be possible to drop this method,
     # since SDK already delivers a proper object
-    image = image.to_dict(ignore_none=True, original_names=True)
+    data = image.to_dict(ignore_none=True, original_names=True)
 
     # split out the usual key and the properties which are top-level
-    for key in image:
+    for key in data:
         if key in fields_to_show:
-            info[key] = image.get(key)
+            info[key] = data[key]
         elif key == 'tags':
             continue  # handle this later
         elif key == 'properties':
             # NOTE(gtema): flatten content of properties
-            properties.update(image.get(key))
+            properties.update(data[key])
         elif key != 'location':
-            properties[key] = image.get(key)
+            properties[key] = data[key]
 
     if human_readable:
-        info['size'] = utils.format_size(image['size'])
+        info['size'] = utils.format_size(data['size'])
 
     # format the tags if they are there
-    info['tags'] = format_columns.ListColumn(image.get('tags'))
+    info['tags'] = format_columns.ListColumn(data.get('tags') or [])
 
     # add properties back into the dictionary as a top-level key
     if properties:
@@ -884,6 +887,8 @@ class ListImage(command.Lister):
             kwargs['visibility'] = parsed_args.visibility
         if parsed_args.limit:
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
         if parsed_args.marker:
             kwargs['marker'] = image_client.find_image(
                 parsed_args.marker,
@@ -1358,6 +1363,7 @@ class SetImage(command.Command):
             # our own membership
             if not project_id:
                 project_id = self.app.client_manager.auth_ref.project_id
+                assert project_id is not None, 'this should not happen'
             image_client.update_member(
                 image=image.id,
                 member=project_id,

openstackclient/image/v2/metadef_namespaces.py

@@ -20,6 +20,7 @@ from collections.abc import Iterable, Sequence
 import logging
 from typing import Any
 
+from openstack.image.v2 import metadef_namespace as _metadef_namespace
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
@@ -34,7 +35,9 @@ _formatters = {
 LOG = logging.getLogger(__name__)
 
 
-def _format_namespace(namespace: Any) -> dict[str, Any]:
+def _format_namespace(
+    namespace: _metadef_namespace.MetadefNamespace,
+) -> dict[str, Any]:
     info = {}
 
     fields_to_show = [
@@ -50,18 +53,16 @@ def _format_namespace(namespace: Any) -> dict[str, Any]:
         'visibility',
     ]
 
-    namespace = namespace.to_dict(ignore_none=True, original_names=True)
+    data = namespace.to_dict(ignore_none=True, original_names=True)
 
     # split out the usual key and the properties which are top-level
-    for key in namespace:
+    for key in data:
         if key in fields_to_show:
-            info[key] = namespace.get(key)
+            info[key] = data.get(key)
         elif key == "resource_type_associations":
-            info[key] = [
-                resource_type['name'] for resource_type in namespace.get(key)
-            ]
+            info[key] = [resource_type['name'] for resource_type in data[key]]
         elif key == 'properties':
-            info['properties'] = list(namespace.get(key).keys())
+            info['properties'] = list(data[key].keys())
 
     return info
 
@@ -358,7 +359,7 @@ class ShowMetadefNamespace(command.ShowOne):
 class UnsetMetadefNamespace(command.Command):
     _description = _("Unset metadef namespace tags")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "namespace",
@@ -385,7 +386,7 @@ class UnsetMetadefNamespace(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         namespace = image_client.get_metadef_namespace(parsed_args.namespace)

openstackclient/image/v2/metadef_objects.py

@@ -20,6 +20,7 @@ from collections.abc import Iterable, Sequence
 import logging
 from typing import Any
 
+from openstack.image.v2 import metadef_object as _metadef_object
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -30,7 +31,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_object(md_object: Any) -> tuple[tuple[str, ...], Any]:
+def _format_object(
+    md_object: _metadef_object.MetadefObject,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     fields_to_show = (
         'created_at',
         'description',
@@ -43,10 +46,7 @@ def _format_object(md_object: Any) -> tuple[tuple[str, ...], Any]:
 
     return (
         fields_to_show,
-        utils.get_item_properties(
-            md_object,
-            fields_to_show,
-        ),
+        utils.get_item_properties(md_object, fields_to_show),
     )
 
 

openstackclient/image/v2/metadef_properties.py

@@ -18,6 +18,7 @@ import json
 import logging
 from typing import Any
 
+from openstack.image.v2 import metadef_property as _metadef_property
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -28,10 +29,12 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_property(prop: Any) -> dict[str, Any]:
-    prop = prop.to_dict(ignore_none=True, original_names=True)
+def _format_property(
+    prop: _metadef_property.MetadefProperty,
+) -> dict[str, Any]:
+    data = prop.to_dict(ignore_none=True, original_names=True)
     return {
-        key: prop[key]
+        key: data[key]
         for key in [
             'namespace_name',
             'name',
@@ -53,7 +56,7 @@ def _format_property(prop: Any) -> dict[str, Any]:
             'max_items',
             'allow_additional_items',
         ]
-        if key in prop
+        if key in data
     }
 
 

openstackclient/image/v2/task.py

@@ -14,18 +14,16 @@ import argparse
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.image.v2 import task as _task
 from osc_lib.cli import format_columns
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
-_formatters = {
-    'tags': format_columns.ListColumn,
-}
 
-
-def _format_task(task: Any) -> dict[str, Any]:
+def _format_task(task: _task.Task) -> dict[str, Any]:
     """Format an task to make it more consistent with OSC operations."""
 
     info = {}
@@ -117,22 +115,7 @@ class ListTask(command.Lister):
                 'by comma)'
             ),
         )
-        parser.add_argument(
-            '--limit',
-            metavar='<num-tasks>',
-            type=int,
-            help=_('Maximum number of tasks to display.'),
-        )
-        parser.add_argument(
-            '--marker',
-            metavar='<task>',
-            help=_(
-                'The last task of the previous page. '
-                'Display list of tasks after marker. '
-                'Display all tasks if not specified. '
-                '(name or ID)'
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         parser.add_argument(
             '--type',
             metavar='<type>',
@@ -182,7 +165,13 @@ class ListTask(command.Lister):
         return (
             column_headers,
             (
-                utils.get_item_properties(s, columns, formatters=_formatters)
+                utils.get_item_properties(
+                    s,
+                    columns,
+                    formatters={
+                        'tags': format_columns.ListColumn,
+                    },
+                )
                 for s in data
             ),
         )

openstackclient/network/utils.py

@@ -9,9 +9,7 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
-from collections.abc import Iterable, Sequence
 from typing import Any, cast
 
 from osc_lib import exceptions
@@ -19,37 +17,6 @@ from osc_lib import exceptions
 from openstackclient.i18n import _
 
 
-# Transform compute security group rule for display.
-def transform_compute_security_group_rule(
-    sg_rule: dict[str, Any],
-) -> dict[str, Any]:
-    info = {}
-    info.update(sg_rule)
-    from_port = info.pop('from_port')
-    to_port = info.pop('to_port')
-    if isinstance(from_port, int) and isinstance(to_port, int):
-        port_range = {'port_range': f"{from_port}:{to_port}"}
-    elif from_port is None and to_port is None:
-        port_range = {'port_range': ""}
-    else:
-        port_range = {'port_range': f"{from_port}:{to_port}"}
-    info.update(port_range)
-    if 'cidr' in info['ip_range']:
-        info['ip_range'] = info['ip_range']['cidr']
-    else:
-        info['ip_range'] = ''
-    if info['ip_protocol'] is None:
-        info['ip_protocol'] = ''
-    elif info['ip_protocol'].lower() == 'icmp':
-        info['port_range'] = ''
-    group = info.pop('group')
-    if 'name' in group:
-        info['remote_security_group'] = group['name']
-    else:
-        info['remote_security_group'] = ''
-    return info
-
-
 def str2bool(strbool: str | None) -> bool | None:
     if strbool is None:
         return None
@@ -88,14 +55,6 @@ def str2dict(strdict: str) -> dict[str, str]:
     return result
 
 
-def format_security_group_rule_show(
-    obj: dict[str, Any],
-) -> tuple[Sequence[str], Iterable[Any]]:
-    data = transform_compute_security_group_rule(obj)
-    col_headers, col_data = zip(*sorted(data.items()))
-    return col_headers, col_data
-
-
 def format_network_port_range(rule: dict[str, Any]) -> str:
     # Display port range or ICMP type and code. For example:
     # - ICMP type: 'type=3'

openstackclient/network/v2/address_group.py

@@ -19,10 +19,12 @@ from collections.abc import Iterable, Sequence
 from typing import Any
 
 import netaddr
+from openstack.network.v2 import address_group as _address_group
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -30,7 +32,9 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _address_group.AddressGroup,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -169,6 +173,7 @@ class ListAddressGroup(command.Lister):
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         return parser
 
@@ -201,6 +206,13 @@ class ListAddressGroup(command.Lister):
                 parsed_args.project_domain,
             ).id
             attrs['project_id'] = project_id
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            attrs['max_items'] = parsed_args.max_items
+
         data = client.address_groups(**attrs)
 
         return (

openstackclient/network/v2/address_scope.py

@@ -18,10 +18,12 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import address_scope as _address_scope
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -29,7 +31,9 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _address_scope.AddressScope,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_shared': 'shared',
     }
@@ -61,8 +65,6 @@ def _get_attrs(
     return attrs
 
 
-# TODO(rtheis): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateAddressScope(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new Address Scope")
 
@@ -156,8 +158,6 @@ class DeleteAddressScope(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(yanxing'an): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListAddressScope(command.Lister):
     _description = _("List address scopes")
 
@@ -189,7 +189,7 @@ class ListAddressScope(command.Lister):
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
-
+        pagination.add_marker_pagination_option_to_parser(parser)
         shared_group = parser.add_mutually_exclusive_group()
         shared_group.add_argument(
             '--share',
@@ -201,6 +201,7 @@ class ListAddressScope(command.Lister):
             action='store_true',
             help=_("List only address scopes not shared between projects"),
         )
+
         return parser
 
     def take_action(
@@ -238,6 +239,12 @@ class ListAddressScope(command.Lister):
                 parsed_args.project_domain,
             ).id
             attrs['project_id'] = project_id
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            attrs['max_items'] = parsed_args.max_items
         data = client.address_scopes(**attrs)
 
         return (
@@ -253,8 +260,6 @@ class ListAddressScope(command.Lister):
         )
 
 
-# TODO(rtheis): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetAddressScope(common.NeutronCommandWithExtraArgs):
     _description = _("Set address scope properties")