openstack/openstacksdk
Code Issues Proposed changes

Reindentation of the docstrings

Browse Source 
Change-Id: Id4ed39b3bef56b8bf55dbb9d3d72b1ba747c0898
This commit is contained in:
Thomas Bucaioni 2021-10-18 12:20:36 +02:00 committed by Artem Goncharov
parent 433d2d8902
commit c746567a67
1 changed files with 59 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
openstack/key_manager/v1/_proxy.py
View File

@ -22,8 +22,8 @@ class Proxy(proxy.Proxy):
"""Create a new container from attributes """Create a new container from attributes
:param dict attrs: Keyword arguments which will be used to create :param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.key_manager.v1.container.Container`, a :class:`~openstack.key_manager.v1.container.Container`,
comprised of the properties on the Container class. comprised of the properties on the Container class.
:returns: The results of container creation :returns: The results of container creation
:rtype: :class:`~openstack.key_manager.v1.container.Container` :rtype: :class:`~openstack.key_manager.v1.container.Container`
@ -34,13 +34,13 @@ class Proxy(proxy.Proxy):
"""Delete a container """Delete a container
:param container: The value can be either the ID of a container or a :param container: The value can be either the ID of a container or a
:class:`~openstack.key_manager.v1.container.Container` :class:`~openstack.key_manager.v1.container.Container`
instance. instance.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the container does not exist. raised when the container does not exist.
When set to ``True``, no exception will be set when When set to ``True``, no exception will be set when
attempting to delete a nonexistent container. attempting to delete a nonexistent container.
:returns: ``None`` :returns: ``None``
""" """
@ -52,12 +52,12 @@ class Proxy(proxy.Proxy):
:param name_or_id: The name or ID of a container. :param name_or_id: The name or ID of a container.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the resource does not exist. raised when the resource does not exist.
When set to ``True``, None will be returned when When set to ``True``, None will be returned when
attempting to find a nonexistent resource. attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_manager.v1.container.Container` :returns: One :class:`~openstack.key_manager.v1.container.Container`
or None or None
""" """
return self._find(_container.Container, name_or_id, return self._find(_container.Container, name_or_id,
ignore_missing=ignore_missing) ignore_missing=ignore_missing)
@ -66,12 +66,12 @@ class Proxy(proxy.Proxy):
"""Get a single container """Get a single container
:param container: The value can be the ID of a container or a :param container: The value can be the ID of a container or a
:class:`~openstack.key_manager.v1.container.Container` :class:`~openstack.key_manager.v1.container.Container`
instance. instance.
:returns: One :class:`~openstack.key_manager.v1.container.Container` :returns: One :class:`~openstack.key_manager.v1.container.Container`
:raises: :class:`~openstack.exceptions.ResourceNotFound` :raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found. when no resource can be found.
""" """
return self._get(_container.Container, container) return self._get(_container.Container, container)
@ -79,7 +79,7 @@ class Proxy(proxy.Proxy):
"""Return a generator of containers """Return a generator of containers
:param kwargs query: Optional query parameters to be sent to limit :param kwargs query: Optional query parameters to be sent to limit
the resources being returned. the resources being returned.
:returns: A generator of container objects :returns: A generator of container objects
:rtype: :class:`~openstack.key_manager.v1.container.Container` :rtype: :class:`~openstack.key_manager.v1.container.Container`
@ -90,10 +90,10 @@ class Proxy(proxy.Proxy):
"""Update a container """Update a container
:param container: Either the id of a container or a :param container: Either the id of a container or a
:class:`~openstack.key_manager.v1.container.Container` :class:`~openstack.key_manager.v1.container.Container`
instance. instance.
:attrs kwargs: The attributes to update on the container represented :attrs kwargs: The attributes to update on the container represented
by ``value``. by ``value``.
:returns: The updated container :returns: The updated container
:rtype: :class:`~openstack.key_manager.v1.container.Container` :rtype: :class:`~openstack.key_manager.v1.container.Container`
@ -104,8 +104,8 @@ class Proxy(proxy.Proxy):
"""Create a new order from attributes """Create a new order from attributes
:param dict attrs: Keyword arguments which will be used to create :param dict attrs: Keyword arguments which will be used to create
a :class:`~openstack.key_manager.v1.order.Order`, a :class:`~openstack.key_manager.v1.order.Order`,
comprised of the properties on the Order class. comprised of the properties on the Order class.
:returns: The results of order creation :returns: The results of order creation
:rtype: :class:`~openstack.key_manager.v1.order.Order` :rtype: :class:`~openstack.key_manager.v1.order.Order`
@ -116,13 +116,13 @@ class Proxy(proxy.Proxy):
"""Delete an order """Delete an order
:param order: The value can be either the ID of a order or a :param order: The value can be either the ID of a order or a
:class:`~openstack.key_manager.v1.order.Order` :class:`~openstack.key_manager.v1.order.Order`
instance. instance.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the order does not exist. raised when the order does not exist.
When set to ``True``, no exception will be set when When set to ``True``, no exception will be set when
attempting to delete a nonexistent order. attempting to delete a nonexistent order.
:returns: ``None`` :returns: ``None``
""" """
@ -133,10 +133,10 @@ class Proxy(proxy.Proxy):
:param name_or_id: The name or ID of a order. :param name_or_id: The name or ID of a order.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the resource does not exist. raised when the resource does not exist.
When set to ``True``, None will be returned when When set to ``True``, None will be returned when
attempting to find a nonexistent resource. attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_manager.v1.order.Order` or None :returns: One :class:`~openstack.key_manager.v1.order.Order` or None
""" """
return self._find(_order.Order, name_or_id, return self._find(_order.Order, name_or_id,
@ -146,12 +146,12 @@ class Proxy(proxy.Proxy):
"""Get a single order """Get a single order
:param order: The value can be the ID of an order or a :param order: The value can be the ID of an order or a
:class:`~openstack.key_manager.v1.order.Order` :class:`~openstack.key_manager.v1.order.Order`
instance. instance.
:returns: One :class:`~openstack.key_manager.v1.order.Order` :returns: One :class:`~openstack.key_manager.v1.order.Order`
:raises: :class:`~openstack.exceptions.ResourceNotFound` :raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found. when no resource can be found.
""" """
return self._get(_order.Order, order) return self._get(_order.Order, order)
@ -159,7 +159,7 @@ class Proxy(proxy.Proxy):
"""Return a generator of orders """Return a generator of orders
:param kwargs query: Optional query parameters to be sent to limit :param kwargs query: Optional query parameters to be sent to limit
the resources being returned. the resources being returned.
:returns: A generator of order objects :returns: A generator of order objects
:rtype: :class:`~openstack.key_manager.v1.order.Order` :rtype: :class:`~openstack.key_manager.v1.order.Order`
@ -170,10 +170,10 @@ class Proxy(proxy.Proxy):
"""Update a order """Update a order
:param order: Either the id of a order or a :param order: Either the id of a order or a
:class:`~openstack.key_manager.v1.order.Order` :class:`~openstack.key_manager.v1.order.Order`
instance. instance.
:attrs kwargs: The attributes to update on the order represented :attrs kwargs: The attributes to update on the order represented
by ``value``. by ``value``.
:returns: The updated order :returns: The updated order
:rtype: :class:`~openstack.key_manager.v1.order.Order` :rtype: :class:`~openstack.key_manager.v1.order.Order`
@ -184,8 +184,8 @@ class Proxy(proxy.Proxy):
"""Create a new secret from attributes """Create a new secret from attributes
:param dict attrs: Keyword arguments which will be used to create a :param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.key_manager.v1.secret.Secret`, :class:`~openstack.key_manager.v1.secret.Secret`,
comprised of the properties on the Order class. comprised of the properties on the Order class.
:returns: The results of secret creation :returns: The results of secret creation
:rtype: :class:`~openstack.key_manager.v1.secret.Secret` :rtype: :class:`~openstack.key_manager.v1.secret.Secret`
@ -196,13 +196,13 @@ class Proxy(proxy.Proxy):
"""Delete a secret """Delete a secret
:param secret: The value can be either the ID of a secret or a :param secret: The value can be either the ID of a secret or a
:class:`~openstack.key_manager.v1.secret.Secret` :class:`~openstack.key_manager.v1.secret.Secret`
instance. instance.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the secret does not exist. raised when the secret does not exist.
When set to ``True``, no exception will be set when When set to ``True``, no exception will be set when
attempting to delete a nonexistent secret. attempting to delete a nonexistent secret.
:returns: ``None`` :returns: ``None``
""" """
@ -213,12 +213,12 @@ class Proxy(proxy.Proxy):
:param name_or_id: The name or ID of a secret. :param name_or_id: The name or ID of a secret.
:param bool ignore_missing: When set to ``False`` :param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound` will be :class:`~openstack.exceptions.ResourceNotFound` will be
raised when the resource does not exist. raised when the resource does not exist.
When set to ``True``, None will be returned when When set to ``True``, None will be returned when
attempting to find a nonexistent resource. attempting to find a nonexistent resource.
:returns: One :class:`~openstack.key_manager.v1.secret.Secret` or :returns: One :class:`~openstack.key_manager.v1.secret.Secret` or
None None
""" """
return self._find(_secret.Secret, name_or_id, return self._find(_secret.Secret, name_or_id,
ignore_missing=ignore_missing) ignore_missing=ignore_missing)
@ -227,12 +227,12 @@ class Proxy(proxy.Proxy):
"""Get a single secret """Get a single secret
:param secret: The value can be the ID of a secret or a :param secret: The value can be the ID of a secret or a
:class:`~openstack.key_manager.v1.secret.Secret` :class:`~openstack.key_manager.v1.secret.Secret`
instance. instance.
:returns: One :class:`~openstack.key_manager.v1.secret.Secret` :returns: One :class:`~openstack.key_manager.v1.secret.Secret`
:raises: :class:`~openstack.exceptions.ResourceNotFound` :raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found. when no resource can be found.
""" """
return self._get(_secret.Secret, secret) return self._get(_secret.Secret, secret)
@ -240,7 +240,7 @@ class Proxy(proxy.Proxy):
"""Return a generator of secrets """Return a generator of secrets
:param kwargs query: Optional query parameters to be sent to limit :param kwargs query: Optional query parameters to be sent to limit
the resources being returned. the resources being returned.
:returns: A generator of secret objects :returns: A generator of secret objects
:rtype: :class:`~openstack.key_manager.v1.secret.Secret` :rtype: :class:`~openstack.key_manager.v1.secret.Secret`
@ -251,10 +251,10 @@ class Proxy(proxy.Proxy):
"""Update a secret """Update a secret
:param secret: Either the id of a secret or a :param secret: Either the id of a secret or a
:class:`~openstack.key_manager.v1.secret.Secret` :class:`~openstack.key_manager.v1.secret.Secret`
instance. instance.
:attrs kwargs: The attributes to update on the secret represented :attrs kwargs: The attributes to update on the secret represented
by ``value``. by ``value``.
:returns: The updated secret :returns: The updated secret
:rtype: :class:`~openstack.key_manager.v1.secret.Secret` :rtype: :class:`~openstack.key_manager.v1.secret.Secret`