openstack/shade
Code Issues Proposed changes

Update sphinx and turn on warnings-is-error

Browse Source 
In order to do that, fix the warnings that are now errors.

Change-Id: I1e582a6763fc82496e4ab33f60ced193b0534f28
This commit is contained in:
Monty Taylor 2017-03-16 12:17:51 +01:00
parent 5458e569fa
commit db45323809
No known key found for this signature in database
GPG Key ID: 7BAE94BC7141A594
6 changed files with 52 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/model.rst
View File

@ -89,7 +89,7 @@ A flavor for a Nova Server.
Flavor Access Flavor Access
------ -------------
An access entry for a Nova Flavor. An access entry for a Nova Flavor.
@ -366,7 +366,7 @@ A volume from cinder.
VolumeType VolumeType
------ ----------
A volume type from cinder. A volume type from cinder.
@ -384,7 +384,7 @@ A volume type from cinder.
VolumeTypeAccess VolumeTypeAccess
------ ----------------
A volume type access from cinder. A volume type access from cinder.

2
releasenotes/notes/removed-glanceclient-105c7fba9481b9be.yaml
View File

@ -1,7 +1,7 @@
--- ---
prelude: > prelude: >
This release marks the beginning of the path towards removing all 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. should expect to have fewer and fewer library depdencies.
upgrade: upgrade:
- Removed glanceclient as a dependency. All glance operations - Removed glanceclient as a dependency. All glance operations

1
setup.cfg
View File

@ -26,6 +26,7 @@ console_scripts =
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1 all_files = 1
warning-is-error = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html

50
shade/openstackcloud.py
View File

@ -2372,13 +2372,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A keypair ``munch.Munch`` or None if no matching keypair is :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) return _utils._get_entity(self.search_keypairs, name_or_id, filters)
@ -2396,12 +2396,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A network ``munch.Munch`` or None if no matching network is :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) return _utils._get_entity(self.search_networks, name_or_id, filters)
@ -2420,12 +2421,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A router ``munch.Munch`` or None if no matching router is :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) 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 :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) return _utils._get_entity(self.search_subnets, name_or_id, filters)
@ -2465,6 +2467,7 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
@ -2488,12 +2491,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A volume ``munch.Munch`` or None if no matching volume is :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) return _utils._get_entity(self.search_volumes, name_or_id, filters)
@ -2512,12 +2516,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A volume ``munch.Munch`` or None if no matching volume is :returns: A volume ``munch.Munch`` or None if no matching volume is
found. found.
""" """
return _utils._get_entity( return _utils._get_entity(
@ -2537,6 +2542,7 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" 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 Whether or not the list_flavors call should get the extra flavor
specs. specs.
:returns: A flavor ``munch.Munch`` or None if no matching flavor is :returns: A flavor ``munch.Munch`` or None if no matching flavor is
found. found.
""" """
search_func = functools.partial( search_func = functools.partial(
@ -2567,6 +2572,7 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
@ -2626,12 +2632,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A server ``munch.Munch`` or None if no matching server is :returns: A server ``munch.Munch`` or None if no matching server is
found. found.
""" """
searchfunc = functools.partial(self.search_servers, searchfunc = functools.partial(self.search_servers,
@ -2653,12 +2660,13 @@ class OpenStackCloud(_normalize.Normalizer):
{ {
'policy': 'affinity', 'policy': 'affinity',
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A server groups dict or None if no matching server group :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, return _utils._get_entity(self.search_server_groups, name_or_id,
@ -2678,6 +2686,7 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
@ -2752,12 +2761,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A floating IP ``munch.Munch`` or None if no matching floating :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) 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 :param string port_id: The ID of the port to use for the interface
:returns: A ``munch.Munch`` with the router ID (ID), :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. :raises: OpenStackCloudException on operation error.
""" """
@ -4050,13 +4061,13 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A volume ``munch.Munch`` or None if no matching volume is :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, return _utils._get_entity(self.search_volume_snapshots, name_or_id,
filters) filters)
@ -4112,8 +4123,7 @@ class OpenStackCloud(_normalize.Normalizer):
"""Get a volume backup by name or ID. """Get a volume backup by name or ID.
:returns: A backup ``munch.Munch`` or None if no matching backup is :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, return _utils._get_entity(self.search_volume_backups, name_or_id,
filters) filters)
@ -4137,12 +4147,14 @@ class OpenStackCloud(_normalize.Normalizer):
:param bool detailed: Also list details for each entry :param bool detailed: Also list details for each entry
:param dict search_opts: Search options :param dict search_opts: Search options
A dictionary of meta data to use for further filtering. Example:: A dictionary of meta data to use for further filtering. Example::
{ {
'name': 'my-volume-backup', 'name': 'my-volume-backup',
'status': 'available', 'status': 'available',
'volume_id': 'e126044c-7b4c-43be-a32a-c9cbbc9ddb56', 'volume_id': 'e126044c-7b4c-43be-a32a-c9cbbc9ddb56',
'all_tenants': 1 'all_tenants': 1
} }
:returns: A list of volume backups ``munch.Munch``. :returns: A list of volume backups ``munch.Munch``.
""" """
with _utils.shade_exceptions("Error getting a list of backups"): 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. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"
:returns: A zone dict or None if no matching zone is :returns: A zone dict or None if no matching zone is found.
found.
""" """
return _utils._get_entity(self.search_zones, name_or_id, filters) return _utils._get_entity(self.search_zones, name_or_id, filters)
@ -7174,6 +7185,7 @@ class OpenStackCloud(_normalize.Normalizer):
'gender': 'Female' 'gender': 'Female'
} }
} }
OR OR
A string containing a jmespath expression for further filtering. A string containing a jmespath expression for further filtering.
Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]" Example:: "[?last_name==`Smith`] | [?other.gender]==`Female`]"

30
shade/operatorcloud.py
View File

@ -1426,23 +1426,23 @@ class OperatorCloud(openstackcloud.OpenStackCloud):
def list_role_assignments(self, filters=None): def list_role_assignments(self, filters=None):
"""List Keystone role assignments """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. * 'user' (string) - User ID to be used as query filter.
- 'group' (string) - Group 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. * 'project' (string) - Project ID to be used as query filter.
- 'domain' (string) - Domain 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. * 'role' (string) - Role ID to be used as query filter.
- 'os_inherit_extension_inherited_to' (string) - Return inherited * 'os_inherit_extension_inherited_to' (string) - Return inherited
role assignments for either 'projects' or 'domains' role assignments for either 'projects' or 'domains'
- 'effective' (boolean) - Return effective role assignments. * 'effective' (boolean) - Return effective role assignments.
- 'include_subtree' (boolean) - Include subtree * 'include_subtree' (boolean) - Include subtree
'user' and 'group' are mutually exclusive, as are 'domain' and 'user' and 'group' are mutually exclusive, as are 'domain' and
'project'. 'project'.
NOTE: For keystone v2, only user, project, and role are used. NOTE: For keystone v2, only user, project, and role are used.
Project and user are both required in filters. Project and user are both required in filters.
:returns: a list of ``munch.Munch`` containing the role assignment :returns: a list of ``munch.Munch`` containing the role assignment
description. Contains the following attributes:: description. Contains the following attributes::
@ -1856,7 +1856,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud):
} }
:returns: An aggregate dict or None if no matching aggregate is :returns: An aggregate dict or None if no matching aggregate is
found. found.
""" """
return _utils._get_entity(self.search_aggregates, name_or_id, filters) 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 :param name_or_id: project name or id
:raises: OpenStackCloudException if it's not a valid project or the :raises: OpenStackCloudException if it's not a valid project or the
nova client call failed nova client call failed
:returns: dict with the quotas :returns: dict with the quotas
""" """
@ -2180,7 +2180,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud):
:param name_or_id: project name or id :param name_or_id: project name or id
:raises: OpenStackCloudException if it's not a valid project or the :raises: OpenStackCloudException if it's not a valid project or the
cinder client call failed cinder client call failed
:returns: dict with the quotas :returns: dict with the quotas
""" """
@ -2233,7 +2233,7 @@ class OperatorCloud(openstackcloud.OpenStackCloud):
:param name_or_id: project name or id :param name_or_id: project name or id
:raises: OpenStackCloudException if it's not a valid project or the :raises: OpenStackCloudException if it's not a valid project or the
network client call failed network client call failed
:returns: dict with the quotas :returns: dict with the quotas
""" """

2
test-requirements.txt
View File

@ -6,7 +6,7 @@ mock>=1.0
python-subunit python-subunit
oslosphinx>=2.2.0 # Apache-2.0 oslosphinx>=2.2.0 # Apache-2.0
requests-mock requests-mock
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 sphinx>=1.5.0
testrepository>=0.0.17 testrepository>=0.0.17
testscenarios>=0.4,<0.5 testscenarios>=0.4,<0.5
testtools>=0.9.32 testtools>=0.9.32