ea4b3cdfc6
Update error messages so they follow the same format. Also, add i18n where it is missing, fix typo and grammatical errors in messages, and fix vague messages so they are more clear. Change-Id: I06d29b4d8448f8c08fa199a316942f373b968d22 Closes-Bug: #1517271
130 lines
4.6 KiB
Python
130 lines
4.6 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.
|
|
|
|
import logging
|
|
import re
|
|
|
|
from toscaparser.common.exception import ExceptionCollector
|
|
from toscaparser.utils.gettextutils import _
|
|
from toscaparser.utils import validateutils
|
|
|
|
log = logging.getLogger('tosca')
|
|
|
|
|
|
class ScalarUnit(object):
|
|
'''Parent class for scalar-unit type.'''
|
|
|
|
SCALAR_UNIT_TYPES = (
|
|
SCALAR_UNIT_SIZE, SCALAR_UNIT_FREQUENCY, SCALAR_UNIT_TIME
|
|
) = (
|
|
'scalar-unit.size', 'scalar-unit.frequency', 'scalar-unit.time'
|
|
)
|
|
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
def _check_unit_in_scalar_standard_units(self, input_unit):
|
|
"""Check whether the input unit is following specified standard
|
|
|
|
If unit is not following specified standard, convert it to standard
|
|
unit after displaying a warning message.
|
|
"""
|
|
if input_unit in self.SCALAR_UNIT_DICT.keys():
|
|
return input_unit
|
|
else:
|
|
for key in self.SCALAR_UNIT_DICT.keys():
|
|
if key.upper() == input_unit.upper():
|
|
log.warning(_('The unit "%(unit)s" does not follow '
|
|
'scalar unit standards; using "%(key)s" '
|
|
'instead.') % {'unit': input_unit,
|
|
'key': key})
|
|
return key
|
|
msg = (_('The unit "%(unit)s" is not valid. Valid units are '
|
|
'"%(valid_units)s".') %
|
|
{'unit': input_unit,
|
|
'valid_units': sorted(self.SCALAR_UNIT_DICT.keys())})
|
|
ExceptionCollector.appendException(ValueError(msg))
|
|
|
|
def validate_scalar_unit(self):
|
|
regex = re.compile('([0-9.]+)\s*(\w+)')
|
|
try:
|
|
result = regex.match(str(self.value)).groups()
|
|
validateutils.str_to_num(result[0])
|
|
scalar_unit = self._check_unit_in_scalar_standard_units(result[1])
|
|
self.value = ' '.join([result[0], scalar_unit])
|
|
return self.value
|
|
|
|
except Exception:
|
|
ExceptionCollector.appendException(
|
|
ValueError(_('"%s" is not a valid scalar-unit.')
|
|
% self.value))
|
|
|
|
def get_num_from_scalar_unit(self, unit=None):
|
|
if unit:
|
|
unit = self._check_unit_in_scalar_standard_units(unit)
|
|
else:
|
|
unit = self.SCALAR_UNIT_DEFAULT
|
|
self.validate_scalar_unit()
|
|
|
|
regex = re.compile('([0-9.]+)\s*(\w+)')
|
|
result = regex.match(str(self.value)).groups()
|
|
converted = (float(validateutils.str_to_num(result[0]))
|
|
* self.SCALAR_UNIT_DICT[result[1]]
|
|
/ self.SCALAR_UNIT_DICT[unit])
|
|
if converted - int(converted) < 0.0000000000001:
|
|
converted = int(converted)
|
|
return converted
|
|
|
|
|
|
class ScalarUnit_Size(ScalarUnit):
|
|
|
|
SCALAR_UNIT_DEFAULT = 'B'
|
|
SCALAR_UNIT_DICT = {'B': 1, 'kB': 1000, 'KiB': 1024, 'MB': 1000000,
|
|
'MiB': 1048576, 'GB': 1000000000,
|
|
'GiB': 1073741824, 'TB': 1000000000000,
|
|
'TiB': 1099511627776}
|
|
|
|
|
|
class ScalarUnit_Time(ScalarUnit):
|
|
|
|
SCALAR_UNIT_DEFAULT = 'ms'
|
|
SCALAR_UNIT_DICT = {'d': 86400, 'h': 3600, 'm': 60, 's': 1,
|
|
'ms': 0.001, 'us': 0.000001, 'ns': 0.000000001}
|
|
|
|
|
|
class ScalarUnit_Frequency(ScalarUnit):
|
|
|
|
SCALAR_UNIT_DEFAULT = 'GHz'
|
|
SCALAR_UNIT_DICT = {'Hz': 1, 'kHz': 1000,
|
|
'MHz': 1000000, 'GHz': 1000000000}
|
|
|
|
|
|
scalarunit_mapping = {
|
|
ScalarUnit.SCALAR_UNIT_FREQUENCY: ScalarUnit_Frequency,
|
|
ScalarUnit.SCALAR_UNIT_SIZE: ScalarUnit_Size,
|
|
ScalarUnit.SCALAR_UNIT_TIME: ScalarUnit_Time,
|
|
}
|
|
|
|
|
|
def get_scalarunit_class(type):
|
|
return scalarunit_mapping.get(type)
|
|
|
|
|
|
def get_scalarunit_value(type, value, unit=None):
|
|
if type in ScalarUnit.SCALAR_UNIT_TYPES:
|
|
ScalarUnit_Class = get_scalarunit_class(type)
|
|
return (ScalarUnit_Class(value).
|
|
get_num_from_scalar_unit(unit))
|
|
else:
|
|
ExceptionCollector.appendException(
|
|
TypeError(_('"%s" is not a valid scalar-unit type.') % type))
|