You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 lines
2.3 KiB
59 lines
2.3 KiB
# |
|
# 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 heat.common.i18n import _ |
|
|
|
SUPPORT_STATUSES = (UNKNOWN, SUPPORTED, DEPRECATED, UNSUPPORTED, HIDDEN |
|
) = ('UNKNOWN', 'SUPPORTED', 'DEPRECATED', 'UNSUPPORTED', |
|
'HIDDEN') |
|
|
|
|
|
class SupportStatus(object): |
|
|
|
def __init__(self, status=SUPPORTED, message=None, version=None, |
|
previous_status=None): |
|
"""Use SupportStatus for current status of object. |
|
|
|
:param status: current status of object. |
|
:param version: version of OpenStack, from which current status is |
|
valid. It may be None, but need to be defined for correct |
|
doc generating. |
|
:param message: specific status message for object. |
|
""" |
|
self.status = status |
|
self.message = message |
|
self.version = version |
|
self.previous_status = previous_status |
|
|
|
self.validate() |
|
|
|
def validate(self): |
|
if (self.previous_status is not None and |
|
not isinstance(self.previous_status, SupportStatus)): |
|
raise ValueError(_('previous_status must be SupportStatus ' |
|
'instead of %s') % type(self.previous_status)) |
|
|
|
if self.status not in SUPPORT_STATUSES: |
|
self.status = UNKNOWN |
|
self.message = _("Specified status is invalid, defaulting to" |
|
" %s") % UNKNOWN |
|
|
|
self.version = None |
|
self.previous_status = None |
|
|
|
def to_dict(self): |
|
return {'status': self.status, |
|
'message': self.message, |
|
'version': self.version, |
|
'previous_status': self.previous_status.to_dict() |
|
if self.previous_status is not None else None}
|
|
|