From db45323809b208cc098f2a60fd9ddf4b66790ea9 Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Thu, 16 Mar 2017 12:17:51 +0100 Subject: [PATCH] Update sphinx and turn on warnings-is-error In order to do that, fix the warnings that are now errors. Change-Id: I1e582a6763fc82496e4ab33f60ced193b0534f28 --- doc/source/model.rst | 6 +-- ...removed-glanceclient-105c7fba9481b9be.yaml | 2 +- setup.cfg | 1 + shade/openstackcloud.py | 50 ++++++++++++------- shade/operatorcloud.py | 30 +++++------ test-requirements.txt | 2 +- 6 files changed, 52 insertions(+), 39 deletions(-) diff --git a/doc/source/model.rst b/doc/source/model.rst index 4941cf506..37aa5d1db 100644 --- a/doc/source/model.rst +++ b/doc/source/model.rst @@ -89,7 +89,7 @@ A flavor for a Nova Server. Flavor Access ------- +------------- An access entry for a Nova Flavor. @@ -366,7 +366,7 @@ A volume from cinder. VolumeType ------- +---------- A volume type from cinder. @@ -384,7 +384,7 @@ A volume type from cinder. VolumeTypeAccess ------- +---------------- A volume type access from cinder. diff --git a/releasenotes/notes/removed-glanceclient-105c7fba9481b9be.yaml b/releasenotes/notes/removed-glanceclient-105c7fba9481b9be.yaml index 78559f9a3..157e90e83 100644 --- a/releasenotes/notes/removed-glanceclient-105c7fba9481b9be.yaml +++ b/releasenotes/notes/removed-glanceclient-105c7fba9481b9be.yaml @@ -1,7 +1,7 @@ --- prelude: > This release marks the beginning of the path towards removing all - of the 'python-*client' libraries as dependencies. Subsequent releases + of the 'python-\*client' libraries as dependencies. Subsequent releases should expect to have fewer and fewer library depdencies. upgrade: - Removed glanceclient as a dependency. All glance operations diff --git a/setup.cfg b/setup.cfg index 7e7b2c9a5..6223d6a1a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,6 +26,7 @@ console_scripts = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/shade/openstackcloud.py b/shade/openstackcloud.py index c69f21843..781381b64 100644 --- a/shade/openstackcloud.py +++ b/shade/openstackcloud.py @@ -2372,13 +2372,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A keypair ``munch.Munch`` or None if no matching keypair is - found. - + found. """ return _utils._get_entity(self.search_keypairs, name_or_id, filters) @@ -2396,12 +2396,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A network ``munch.Munch`` or None if no matching network is - found. + found. """ return _utils._get_entity(self.search_networks, name_or_id, filters) @@ -2420,12 +2421,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A router ``munch.Munch`` or None if no matching router is - found. + found. """ return _utils._get_entity(self.search_routers, name_or_id, filters) @@ -2446,7 +2448,7 @@ class OpenStackCloud(_normalize.Normalizer): } :returns: A subnet ``munch.Munch`` or None if no matching subnet is - found. + found. """ return _utils._get_entity(self.search_subnets, name_or_id, filters) @@ -2465,6 +2467,7 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" @@ -2488,12 +2491,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A volume ``munch.Munch`` or None if no matching volume is - found. + found. """ return _utils._get_entity(self.search_volumes, name_or_id, filters) @@ -2512,12 +2516,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A volume ``munch.Munch`` or None if no matching volume is - found. + found. """ return _utils._get_entity( @@ -2537,6 +2542,7 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" @@ -2544,9 +2550,8 @@ class OpenStackCloud(_normalize.Normalizer): Whether or not the list_flavors call should get the extra flavor specs. - :returns: A flavor ``munch.Munch`` or None if no matching flavor is - found. + found. """ search_func = functools.partial( @@ -2567,6 +2572,7 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" @@ -2626,12 +2632,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A server ``munch.Munch`` or None if no matching server is - found. + found. """ searchfunc = functools.partial(self.search_servers, @@ -2653,12 +2660,13 @@ class OpenStackCloud(_normalize.Normalizer): { 'policy': 'affinity', } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A server groups dict or None if no matching server group - is found. + is found. """ return _utils._get_entity(self.search_server_groups, name_or_id, @@ -2678,6 +2686,7 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" @@ -2752,12 +2761,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A floating IP ``munch.Munch`` or None if no matching floating - IP is found. + IP is found. """ return _utils._get_entity(self.search_floating_ips, id, filters) @@ -2934,7 +2944,8 @@ class OpenStackCloud(_normalize.Normalizer): :param string port_id: The ID of the port to use for the interface :returns: A ``munch.Munch`` with the router ID (ID), - subnet ID (subnet_id), port ID (port_id) and tenant ID (tenant_id). + subnet ID (subnet_id), port ID (port_id) and tenant ID + (tenant_id). :raises: OpenStackCloudException on operation error. """ @@ -4050,13 +4061,13 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" :returns: A volume ``munch.Munch`` or None if no matching volume is - found. - + found. """ return _utils._get_entity(self.search_volume_snapshots, name_or_id, filters) @@ -4112,8 +4123,7 @@ class OpenStackCloud(_normalize.Normalizer): """Get a volume backup by name or ID. :returns: A backup ``munch.Munch`` or None if no matching backup is - found. - + found. """ return _utils._get_entity(self.search_volume_backups, name_or_id, filters) @@ -4137,12 +4147,14 @@ class OpenStackCloud(_normalize.Normalizer): :param bool detailed: Also list details for each entry :param dict search_opts: Search options A dictionary of meta data to use for further filtering. Example:: + { 'name': 'my-volume-backup', 'status': 'available', 'volume_id': 'e126044c-7b4c-43be-a32a-c9cbbc9ddb56', 'all_tenants': 1 } + :returns: A list of volume backups ``munch.Munch``. """ with _utils.shade_exceptions("Error getting a list of backups"): @@ -6908,8 +6920,7 @@ class OpenStackCloud(_normalize.Normalizer): A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" - :returns: A zone dict or None if no matching zone is - found. + :returns: A zone dict or None if no matching zone is found. """ return _utils._get_entity(self.search_zones, name_or_id, filters) @@ -7174,6 +7185,7 @@ class OpenStackCloud(_normalize.Normalizer): 'gender': 'Female' } } + OR A string containing a jmespath expression for further filtering. Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" diff --git a/shade/operatorcloud.py b/shade/operatorcloud.py index 53a1029da..1b98ee60c 100644 --- a/shade/operatorcloud.py +++ b/shade/operatorcloud.py @@ -1426,23 +1426,23 @@ class OperatorCloud(openstackcloud.OpenStackCloud): def list_role_assignments(self, filters=None): """List Keystone role assignments - :param dict filters: Dict of filter conditions. Acceptable keys are:: + :param dict filters: Dict of filter conditions. Acceptable keys are: - - 'user' (string) - User ID to be used as query filter. - - 'group' (string) - Group ID to be used as query filter. - - 'project' (string) - Project ID to be used as query filter. - - 'domain' (string) - Domain ID to be used as query filter. - - 'role' (string) - Role ID to be used as query filter. - - 'os_inherit_extension_inherited_to' (string) - Return inherited + * 'user' (string) - User ID to be used as query filter. + * 'group' (string) - Group ID to be used as query filter. + * 'project' (string) - Project ID to be used as query filter. + * 'domain' (string) - Domain ID to be used as query filter. + * 'role' (string) - Role ID to be used as query filter. + * 'os_inherit_extension_inherited_to' (string) - Return inherited role assignments for either 'projects' or 'domains' - - 'effective' (boolean) - Return effective role assignments. - - 'include_subtree' (boolean) - Include subtree + * 'effective' (boolean) - Return effective role assignments. + * 'include_subtree' (boolean) - Include subtree 'user' and 'group' are mutually exclusive, as are 'domain' and 'project'. - NOTE: For keystone v2, only user, project, and role are used. - Project and user are both required in filters. + NOTE: For keystone v2, only user, project, and role are used. + Project and user are both required in filters. :returns: a list of ``munch.Munch`` containing the role assignment description. Contains the following attributes:: @@ -1856,7 +1856,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud): } :returns: An aggregate dict or None if no matching aggregate is - found. + found. """ return _utils._get_entity(self.search_aggregates, name_or_id, filters) @@ -2099,7 +2099,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud): :param name_or_id: project name or id :raises: OpenStackCloudException if it's not a valid project or the - nova client call failed + nova client call failed :returns: dict with the quotas """ @@ -2180,7 +2180,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud): :param name_or_id: project name or id :raises: OpenStackCloudException if it's not a valid project or the - cinder client call failed + cinder client call failed :returns: dict with the quotas """ @@ -2233,7 +2233,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud): :param name_or_id: project name or id :raises: OpenStackCloudException if it's not a valid project or the - network client call failed + network client call failed :returns: dict with the quotas """ diff --git a/test-requirements.txt b/test-requirements.txt index b3cd3ae07..e7aa54668 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,7 +6,7 @@ mock>=1.0 python-subunit oslosphinx>=2.2.0 # Apache-2.0 requests-mock -sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +sphinx>=1.5.0 testrepository>=0.0.17 testscenarios>=0.4,<0.5 testtools>=0.9.32