8bad5bbac3
The docstrings here were all giving WARNINGs or ERRORs during the docs build, and were generally making unappealing looking developer documentation. I corrected the syntax and did what was neccessary to make the build come out clean. Change-Id: I74b00a7f125770b0468cff3bdf26d0d52cd054d7 (cherry picked from commit c0921cdff372ce1fd6df1c4ab4eb5463e2cba0e4)
74 lines
2.0 KiB
Python
74 lines
2.0 KiB
Python
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
import six
|
|
from wsme import types as wtypes
|
|
|
|
|
|
class ExceptionType(wtypes.UserType):
|
|
basetype = wtypes.DictType
|
|
name = 'exception'
|
|
|
|
def validate(self, value):
|
|
if not isinstance(value, BaseException):
|
|
raise ValueError('Value is not an exception')
|
|
return value
|
|
|
|
def tobasetype(self, value):
|
|
"""Turn a RESTError into a dict."""
|
|
return {
|
|
'type': value.__class__.__name__,
|
|
'code': value.status_code,
|
|
'message': value.message,
|
|
'details': value.details,
|
|
}
|
|
|
|
frombasetype = tobasetype
|
|
|
|
|
|
exception_type = ExceptionType()
|
|
|
|
|
|
class MultiType(wtypes.UserType):
|
|
"""A complex type that represents one or more types.
|
|
|
|
Used for validating that a value is an instance of one of the types.
|
|
|
|
:param \*types: Variable-length list of types.
|
|
|
|
"""
|
|
def __init__(self, *types):
|
|
self.types = types
|
|
|
|
def __str__(self):
|
|
return ' | '.join(map(str, self.types))
|
|
|
|
def validate(self, value):
|
|
for t in self.types:
|
|
if t is wtypes.text and isinstance(value, wtypes.bytes):
|
|
value = value.decode()
|
|
if isinstance(value, t):
|
|
return value
|
|
else:
|
|
raise ValueError(
|
|
"Wrong type. Expected '{type}', got '{value}'".format(
|
|
type=self.types, value=type(value)))
|
|
|
|
|
|
json_type = MultiType(list, dict, six.integer_types, wtypes.text)
|
|
|
|
|
|
class APIBase(wtypes.Base):
|
|
pass
|