From b48d0b8c9680c7ff4fc3ee9838eac91d3f823500 Mon Sep 17 00:00:00 2001 From: Thomas Bucaioni Date: Fri, 5 Nov 2021 10:58:12 +0100 Subject: [PATCH] Database service - reindentation of the docstrings Change-Id: I1aa073f1a49db5d5a4dd0cff154cd30e2090d8f1 --- openstack/database/v1/_proxy.py | 146 ++++++++++++++++---------------- openstack/workflow/v2/_proxy.py | 40 ++++----- 2 files changed, 93 insertions(+), 93 deletions(-) diff --git a/openstack/database/v1/_proxy.py b/openstack/database/v1/_proxy.py index f5684506a..724b42b6e 100644 --- a/openstack/database/v1/_proxy.py +++ b/openstack/database/v1/_proxy.py @@ -23,10 +23,10 @@ class Proxy(proxy.Proxy): """Create a new database from attributes :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + or a :class:`~openstack.database.v1.instance.Instance` :param dict attrs: Keyword arguments which will be used to create - a :class:`~openstack.database.v1.database.Database`, - comprised of the properties on the Database class. + a :class:`~openstack.database.v1.database.Database`, + comprised of the properties on the Database class. :returns: The results of server creation :rtype: :class:`~openstack.database.v1.database.Database` @@ -39,16 +39,16 @@ class Proxy(proxy.Proxy): """Delete a database :param database: The value can be either the ID of a database or a - :class:`~openstack.database.v1.database.Database` instance. + :class:`~openstack.database.v1.database.Database` instance. :param instance: This parameter needs to be specified when - an ID is given as `database`. - It can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + an ID is given as `database`. + It can be either the ID of an instance + or a :class:`~openstack.database.v1.instance.Instance` :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the database does not exist. - When set to ``True``, no exception will be set when - attempting to delete a nonexistent database. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the database does not exist. + When set to ``True``, no exception will be set when + attempting to delete a nonexistent database. :returns: ``None`` """ @@ -62,12 +62,12 @@ class Proxy(proxy.Proxy): :param name_or_id: The name or ID of a database. :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + or a :class:`~openstack.database.v1.instance.Instance` :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the resource does not exist. - When set to ``True``, None will be returned when - attempting to find a nonexistent resource. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the resource does not exist. + When set to ``True``, None will be returned when + attempting to find a nonexistent resource. :returns: One :class:`~openstack.database.v1.database.Database` or None """ instance = self._get_resource(_instance.Instance, instance) @@ -79,10 +79,10 @@ class Proxy(proxy.Proxy): """Return a generator of databases :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` - instance that the interface belongs to. + or a :class:`~openstack.database.v1.instance.Instance` + instance that the interface belongs to. :param kwargs query: Optional query parameters to be sent to limit - the resources being returned. + the resources being returned. :returns: A generator of database objects :rtype: :class:`~openstack.database.v1.database.Database` @@ -94,16 +94,16 @@ class Proxy(proxy.Proxy): """Get a single database :param instance: This parameter needs to be specified when - an ID is given as `database`. - It can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + an ID is given as `database`. + It can be either the ID of an instance + or a :class:`~openstack.database.v1.instance.Instance` :param database: The value can be the ID of a database or a - :class:`~openstack.database.v1.database.Database` - instance. + :class:`~openstack.database.v1.database.Database` + instance. :returns: One :class:`~openstack.database.v1.database.Database` :raises: :class:`~openstack.exceptions.ResourceNotFound` - when no resource can be found. + when no resource can be found. """ return self._get(_database.Database, database) @@ -112,10 +112,10 @@ class Proxy(proxy.Proxy): :param name_or_id: The name or ID of a flavor. :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the resource does not exist. - When set to ``True``, None will be returned when - attempting to find a nonexistent resource. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the resource does not exist. + When set to ``True``, None will be returned when + attempting to find a nonexistent resource. :returns: One :class:`~openstack.database.v1.flavor.Flavor` or None """ return self._find(_flavor.Flavor, name_or_id, @@ -125,11 +125,11 @@ class Proxy(proxy.Proxy): """Get a single flavor :param flavor: The value can be the ID of a flavor or a - :class:`~openstack.database.v1.flavor.Flavor` instance. + :class:`~openstack.database.v1.flavor.Flavor` instance. :returns: One :class:`~openstack.database.v1.flavor.Flavor` :raises: :class:`~openstack.exceptions.ResourceNotFound` - when no resource can be found. + when no resource can be found. """ return self._get(_flavor.Flavor, flavor) @@ -137,7 +137,7 @@ class Proxy(proxy.Proxy): """Return a generator of flavors :param kwargs query: Optional query parameters to be sent to limit - the resources being returned. + the resources being returned. :returns: A generator of flavor objects :rtype: :class:`~openstack.database.v1.flavor.Flavor` @@ -148,8 +148,8 @@ class Proxy(proxy.Proxy): """Create a new instance from attributes :param dict attrs: Keyword arguments which will be used to create - a :class:`~openstack.database.v1.instance.Instance`, - comprised of the properties on the Instance class. + a :class:`~openstack.database.v1.instance.Instance`, + comprised of the properties on the Instance class. :returns: The results of server creation :rtype: :class:`~openstack.database.v1.instance.Instance` @@ -160,12 +160,12 @@ class Proxy(proxy.Proxy): """Delete an instance :param instance: The value can be either the ID of an instance or a - :class:`~openstack.database.v1.instance.Instance` instance. + :class:`~openstack.database.v1.instance.Instance` instance. :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the instance does not exist. - When set to ``True``, no exception will be set when - attempting to delete a nonexistent instance. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the instance does not exist. + When set to ``True``, no exception will be set when + attempting to delete a nonexistent instance. :returns: ``None`` """ @@ -177,10 +177,10 @@ class Proxy(proxy.Proxy): :param name_or_id: The name or ID of a instance. :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the resource does not exist. - When set to ``True``, None will be returned when - attempting to find a nonexistent resource. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the resource does not exist. + When set to ``True``, None will be returned when + attempting to find a nonexistent resource. :returns: One :class:`~openstack.database.v1.instance.Instance` or None """ return self._find(_instance.Instance, name_or_id, @@ -190,12 +190,12 @@ class Proxy(proxy.Proxy): """Get a single instance :param instance: The value can be the ID of an instance or a - :class:`~openstack.database.v1.instance.Instance` - instance. + :class:`~openstack.database.v1.instance.Instance` + instance. :returns: One :class:`~openstack.database.v1.instance.Instance` :raises: :class:`~openstack.exceptions.ResourceNotFound` - when no resource can be found. + when no resource can be found. """ return self._get(_instance.Instance, instance) @@ -203,7 +203,7 @@ class Proxy(proxy.Proxy): """Return a generator of instances :param kwargs query: Optional query parameters to be sent to limit - the resources being returned. + the resources being returned. :returns: A generator of instance objects :rtype: :class:`~openstack.database.v1.instance.Instance` @@ -214,10 +214,10 @@ class Proxy(proxy.Proxy): """Update a instance :param instance: Either the id of a instance or a - :class:`~openstack.database.v1.instance.Instance` - instance. + :class:`~openstack.database.v1.instance.Instance` + instance. :attrs kwargs: The attributes to update on the instance represented - by ``value``. + by ``value``. :returns: The updated instance :rtype: :class:`~openstack.database.v1.instance.Instance` @@ -228,10 +228,10 @@ class Proxy(proxy.Proxy): """Create a new user from attributes :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + or a :class:`~openstack.database.v1.instance.Instance` :param dict attrs: Keyword arguments which will be used to create - a :class:`~openstack.database.v1.user.User`, - comprised of the properties on the User class. + a :class:`~openstack.database.v1.user.User`, + comprised of the properties on the User class. :returns: The results of server creation :rtype: :class:`~openstack.database.v1.user.User` @@ -243,16 +243,16 @@ class Proxy(proxy.Proxy): """Delete a user :param user: The value can be either the ID of a user or a - :class:`~openstack.database.v1.user.User` instance. + :class:`~openstack.database.v1.user.User` instance. :param instance: This parameter needs to be specified when - an ID is given as `user`. - It can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + an ID is given as `user`. + It can be either the ID of an instance + or a :class:`~openstack.database.v1.instance.Instance` :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the user does not exist. - When set to ``True``, no exception will be set when - attempting to delete a nonexistent user. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the user does not exist. + When set to ``True``, no exception will be set when + attempting to delete a nonexistent user. :returns: ``None`` """ @@ -265,12 +265,12 @@ class Proxy(proxy.Proxy): :param name_or_id: The name or ID of a user. :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + or a :class:`~openstack.database.v1.instance.Instance` :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the resource does not exist. - When set to ``True``, None will be returned when - attempting to find a nonexistent resource. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the resource does not exist. + When set to ``True``, None will be returned when + attempting to find a nonexistent resource. :returns: One :class:`~openstack.database.v1.user.User` or None """ instance = self._get_resource(_instance.Instance, instance) @@ -281,9 +281,9 @@ class Proxy(proxy.Proxy): """Return a generator of users :param instance: This can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + or a :class:`~openstack.database.v1.instance.Instance` :param kwargs query: Optional query parameters to be sent to limit - the resources being returned. + the resources being returned. :returns: A generator of user objects :rtype: :class:`~openstack.database.v1.user.User` @@ -295,15 +295,15 @@ class Proxy(proxy.Proxy): """Get a single user :param user: The value can be the ID of a user or a - :class:`~openstack.database.v1.user.User` instance. + :class:`~openstack.database.v1.user.User` instance. :param instance: This parameter needs to be specified when - an ID is given as `database`. - It can be either the ID of an instance - or a :class:`~openstack.database.v1.instance.Instance` + an ID is given as `database`. + It can be either the ID of an instance + or a :class:`~openstack.database.v1.instance.Instance` :returns: One :class:`~openstack.database.v1.user.User` :raises: :class:`~openstack.exceptions.ResourceNotFound` - when no resource can be found. + when no resource can be found. """ instance = self._get_resource(_instance.Instance, instance) return self._get(_user.User, user) diff --git a/openstack/workflow/v2/_proxy.py b/openstack/workflow/v2/_proxy.py index e0e5e5ced..784fd8644 100644 --- a/openstack/workflow/v2/_proxy.py +++ b/openstack/workflow/v2/_proxy.py @@ -21,8 +21,8 @@ class Proxy(proxy.Proxy): """Create a new workflow from attributes :param dict attrs: Keyword arguments which will be used to create - a :class:`~openstack.workflow.v2.workflow.Workflow`, - comprised of the properties on the Workflow class. + a :class:`~openstack.workflow.v2.workflow.Workflow`, + comprised of the properties on the Workflow class. :returns: The results of workflow creation :rtype: :class:`~openstack.workflow.v2.workflow.Workflow` @@ -33,11 +33,11 @@ class Proxy(proxy.Proxy): """Get a workflow :param workflow: The value can be the name of a workflow or - :class:`~openstack.workflow.v2.workflow.Workflow` instance. + :class:`~openstack.workflow.v2.workflow.Workflow` instance. :returns: One :class:`~openstack.workflow.v2.workflow.Workflow` :raises: :class:`~openstack.exceptions.ResourceNotFound` when no - workflow matching the name could be found. + workflow matching the name could be found. """ return self._get(_workflow.Workflow, *attrs) @@ -49,11 +49,11 @@ class Proxy(proxy.Proxy): include: * limit: Requests at most the specified number of items be - returned from the query. + returned from the query. * marker: Specifies the ID of the last-seen workflow. Use the - limit parameter to make an initial limited request and use - the ID of the last-seen workflow from the response as the - marker parameter value in a subsequent limited request. + limit parameter to make an initial limited request and use + the ID of the last-seen workflow from the response as the + marker parameter value in a subsequent limited request. :returns: A generator of workflow instances. """ @@ -63,8 +63,8 @@ class Proxy(proxy.Proxy): """Delete a workflow :param value: The value can be either the name of a workflow or a - :class:`~openstack.workflow.v2.workflow.Workflow` - instance. + :class:`~openstack.workflow.v2.workflow.Workflow` + instance. :param bool ignore_missing: When set to ``False`` :class:`~openstack.exceptions.ResourceNotFound` will be raised when the workflow does not exist. @@ -125,11 +125,11 @@ class Proxy(proxy.Proxy): include: * limit: Requests at most the specified number of items be - returned from the query. + returned from the query. * marker: Specifies the ID of the last-seen execution. Use the - limit parameter to make an initial limited request and use - the ID of the last-seen execution from the response as the - marker parameter value in a subsequent limited request. + limit parameter to make an initial limited request and use + the ID of the last-seen execution from the response as the + marker parameter value in a subsequent limited request. :returns: A generator of execution instances. """ @@ -139,13 +139,13 @@ class Proxy(proxy.Proxy): """Delete an execution :param value: The value can be either the name of a execution or a - :class:`~openstack.workflow.v2.execute.Execution` - instance. + :class:`~openstack.workflow.v2.execute.Execution` + instance. :param bool ignore_missing: When set to ``False`` - :class:`~openstack.exceptions.ResourceNotFound` will be - raised when the execution does not exist. - When set to ``True``, no exception will be set when - attempting to delete a nonexistent execution. + :class:`~openstack.exceptions.ResourceNotFound` will be + raised when the execution does not exist. + When set to ``True``, no exception will be set when + attempting to delete a nonexistent execution. :returns: ``None`` """