a9adca02db
Currently tox ignores D204, D205, and D207. D204: 1 blank required after class docstring. D205: Blank line required between one-line summary and description. D207: Docstring is under-indented. This change removes D204, D205, and D207 ignores in tox and fix violations. Change-Id: Id20d216fbd7647d468859b960088aac61c582d9b
91 lines
3.3 KiB
Python
91 lines
3.3 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# 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 keystoneclient import base
|
|
|
|
|
|
class Region(base.Resource):
|
|
"""Represents a Catalog region.
|
|
|
|
Attributes:
|
|
* id: a string that identifies the region.
|
|
* description: a string that describes the region. Optional.
|
|
* parent_region_id: string that is the id field for a pre-existing
|
|
region in the backend. Allows for hierarchical
|
|
region organization.
|
|
* enabled: determines whether the endpoint appears in the catalog.
|
|
Defaults to True
|
|
"""
|
|
|
|
pass
|
|
|
|
|
|
class RegionManager(base.CrudManager):
|
|
"""Manager class for manipulating Identity regions."""
|
|
|
|
resource_class = Region
|
|
collection_key = 'regions'
|
|
key = 'region'
|
|
|
|
def create(self, id=None, description=None, enabled=True,
|
|
parent_region=None, **kwargs):
|
|
"""Create a Catalog region.
|
|
|
|
:param id: a string that identifies the region. If not specified a
|
|
unique identifier will be assigned to the region.
|
|
:param description: a string that describes the region.
|
|
:param parent_region: string that is the id field for a pre-existing
|
|
region in the backend. Allows for hierarchical
|
|
region organization.
|
|
:param enabled: determines whether the endpoint appears in the catalog.
|
|
|
|
"""
|
|
return super(RegionManager, self).create(
|
|
id=id, description=description, enabled=enabled,
|
|
parent_region_id=base.getid(parent_region), **kwargs)
|
|
|
|
def get(self, region):
|
|
return super(RegionManager, self).get(
|
|
region_id=base.getid(region))
|
|
|
|
def list(self, **kwargs):
|
|
"""List regions.
|
|
|
|
If ``**kwargs`` are provided, then filter regions with
|
|
attributes matching ``**kwargs``.
|
|
"""
|
|
return super(RegionManager, self).list(
|
|
**kwargs)
|
|
|
|
def update(self, region, description=None, enabled=None,
|
|
parent_region=None, **kwargs):
|
|
"""Update a Catalog region.
|
|
|
|
:param region: a string that identifies the region.
|
|
:param description: a string that describes the region.
|
|
:param parent_region: string that is the id field for a pre-existing
|
|
region in the backend. Allows for hierarchical
|
|
region organization.
|
|
:param enabled: determines whether the endpoint appears in the catalog.
|
|
|
|
"""
|
|
return super(RegionManager, self).update(
|
|
region_id=base.getid(region),
|
|
description=description,
|
|
enabled=enabled,
|
|
parent_region_id=base.getid(parent_region),
|
|
**kwargs)
|
|
|
|
def delete(self, region):
|
|
return super(RegionManager, self).delete(
|
|
region_id=base.getid(region))
|