157a11550f
This patch adds a utility function for checking the int type parameters passed to the API layer. A test case is included for this utility function. To exemplify how to use it, the events controller is revised to make use of this function. The plan is to add this checking to all int type parameters at API layer. Change-Id: If4a1e2e5e7adbc272e2cfa5b1918cdf733926013
56 lines
2.0 KiB
Python
56 lines
2.0 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 oslo_utils import strutils
|
|
|
|
from heat.common.i18n import _
|
|
|
|
|
|
def extract_bool(subject):
|
|
'''
|
|
Convert any true/false string to its corresponding boolean value,
|
|
regardless of case.
|
|
'''
|
|
if str(subject).lower() not in ('true', 'false'):
|
|
raise ValueError(_('Unrecognized value "%(value)s", acceptable '
|
|
'values are: true, false.') % {'value': subject})
|
|
return strutils.bool_from_string(subject, strict=True)
|
|
|
|
|
|
def extract_int(name, value, allow_zero=True, allow_negative=False):
|
|
if value is None:
|
|
return None
|
|
|
|
if not strutils.is_int_like(value):
|
|
raise ValueError(_("Only integer is acceptable by "
|
|
"'%(name)s'.") % {'name': name})
|
|
|
|
if value in ('0', 0):
|
|
if allow_zero:
|
|
return int(value)
|
|
raise ValueError(_("Only non-zero integer is acceptable by "
|
|
"'%(name)s'.") % {'name': name})
|
|
try:
|
|
result = int(value)
|
|
except (TypeError, ValueError):
|
|
raise ValueError(_("Value '%(value)s' is invalid for '%(name)s' "
|
|
"which only accepts integer.") %
|
|
{'name': name, 'value': value})
|
|
|
|
if allow_negative is False and result < 0:
|
|
raise ValueError(_("Value '%(value)s' is invalid for '%(name)s' "
|
|
"which only accepts non-negative integer.") %
|
|
{'name': name, 'value': value})
|
|
|
|
return result
|