| Current File : //usr/lib/python3/dist-packages/uaclient/data_types.py |
import datetime
import json
import logging
from enum import Enum
from typing import Any, Dict, List, Optional, Type, TypeVar, Union
from uaclient import exceptions, messages, util
LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
class IncorrectTypeError(exceptions.UbuntuProError):
_formatted_msg = messages.E_INCORRECT_TYPE_ERROR_MESSAGE
expected_type = None # type: str
got_type = None # type: str
class IncorrectListElementTypeError(IncorrectTypeError):
_formatted_msg = messages.E_INCORRECT_LIST_ELEMENT_TYPE_ERROR_MESSAGE
def __init__(self, *, err: IncorrectTypeError, at_index: int):
super().__init__(index=at_index, nested_msg=err.msg)
self.expected_type = err.expected_type
self.got_type = err.got_type
class IncorrectDictElementTypeError(IncorrectTypeError):
_formatted_msg = messages.E_INCORRECT_DICT_ELEMENT_TYPE_ERROR_MESSAGE
def __init__(self, *, err: IncorrectTypeError, key: str, value: Any):
super().__init__(
key=key, value_type=type(value).__name__, nested_msg=err.msg
)
self.expected_type = err.expected_type
self.got_type = err.got_type
class IncorrectFieldTypeError(IncorrectTypeError):
_formatted_msg = messages.E_INCORRECT_FIELD_TYPE_ERROR_MESSAGE
key = None # type: str
def __init__(self, *, err: IncorrectTypeError, key: str):
super().__init__(key=key, nested_msg=err.msg)
self.expected_type = err.expected_type
self.got_type = err.got_type
class IncorrectEnumValueError(IncorrectTypeError):
_formatted_msg = messages.E_INCORRECT_ENUM_VALUE_ERROR_MESSAGE
def __init__(self, *, values: List[Union[str, int]], enum_class: Any):
super().__init__(values=values, enum_class=enum_class.__name__)
self.expected_type = "one of: {}".format(
", ".join([str(v) for v in values])
)
self.got_type = "<invalid_value>"
class DataValue:
"""
Generic data value to be extended by more specific typed data values.
This establishes the interface of a static/class method called `from_value`
that returns the parsed value if appropriate.
"""
@staticmethod
def from_value(val: Any) -> Any:
return val
E = TypeVar("E", bound="EnumDataValue")
class EnumDataValue(DataValue, Enum):
"""
To be used for parsing enum values
from_value raises an error if the value is not in the enum class values
and returns the value if found.
"""
@classmethod
def from_value(cls: Type[E], val: Any) -> E:
try:
return cls(val)
except ValueError:
values = [i.value for i in cls]
raise IncorrectEnumValueError(values=values, enum_class=cls)
class StringDataValue(DataValue):
"""
To be used for parsing string values
from_value raises an error if the value is not a string and returns
the string itself if it is a string.
"""
python_type_name = "str"
@staticmethod
def from_value(val: Any) -> str:
if not isinstance(val, str):
raise IncorrectTypeError(
expected_type="str", got_type=type(val).__name__
)
return val
class IntDataValue(DataValue):
"""
To be used for parsing int values
from_value raises an error if the value is not a int and returns
the int itself if it is a int.
"""
python_type_name = "int"
@staticmethod
def from_value(val: Any) -> int:
if not isinstance(val, int) or isinstance(val, bool):
raise IncorrectTypeError(
expected_type="int", got_type=type(val).__name__
)
return val
class FloatDataValue(DataValue):
"""
To be used for parsing float values
from_value raises an error if the value is not a float and returns
the float itself if it is a float.
"""
python_type_name = "float"
@staticmethod
def from_value(val: Any) -> float:
if not isinstance(val, float) and not isinstance(val, int):
raise IncorrectTypeError(
expected_type="float", got_type=type(val).__name__
)
return float(val)
class BoolDataValue(DataValue):
"""
To be used for parsing bool values
from_value raises an error if the value is not a bool and returns
the bool itself if it is a bool.
"""
python_type_name = "bool"
@staticmethod
def from_value(val: Any) -> bool:
if not isinstance(val, bool):
raise IncorrectTypeError(
expected_type="bool", got_type=type(val).__name__
)
return val
class DatetimeDataValue(DataValue):
"""
This expects that value is a datetime.
from_value raises an error if the value is not a datetime and returns
the datetime itself if it is a datetime.
"""
python_type_name = "datetime"
@staticmethod
def from_value(val: Any) -> datetime.datetime:
if not isinstance(val, datetime.datetime):
raise IncorrectTypeError(
expected_type="datetime", got_type=type(val).__name__
)
return val
def data_list(data_cls: Type[DataValue]) -> Type[DataValue]:
"""
To be used for parsing lists of a certain DataValue type.
Returns a class that extends DataValue and validates that
each item in a list is the correct type in its from_value.
"""
class _DataList(DataValue):
item_cls = data_cls
@staticmethod
def from_value(val: Any) -> List:
if not isinstance(val, list):
raise IncorrectTypeError(
expected_type="list", got_type=type(val).__name__
)
new_val = []
for i, item in enumerate(val):
try:
new_val.append(data_cls.from_value(item))
except IncorrectTypeError as e:
raise IncorrectListElementTypeError(err=e, at_index=i)
return new_val
return _DataList
def data_dict(value_cls: Type[DataValue]) -> Type[DataValue]:
"""
To be used for parsing dicts of a certain DataValue type.
Returns a class that extends DataValue and validates that
each key, value is the correct type in its from_value.
"""
class _DataDict(DataValue):
python_type_name = "dict"
dict_value_cls = value_cls
@staticmethod
def from_value(val: Any) -> Dict:
if not isinstance(val, dict):
raise IncorrectTypeError(
expected_type="dict", got_type=type(val).__name__
)
new_val = {}
for key, value in val.items():
try:
new_val[StringDataValue.from_value(key)] = (
value_cls.from_value(value)
)
except IncorrectTypeError as e:
raise IncorrectDictElementTypeError(
err=e, key=key, value=value
)
return new_val
return _DataDict
def data_list_to_list(
val: List[Union["DataObject", list, str, int, bool, Enum]],
keep_none: bool = True,
) -> list:
new_val = [] # type: list
for item in val:
if isinstance(item, DataObject):
new_val.append(item.to_dict(keep_none))
elif isinstance(item, list):
new_val.append(data_list_to_list(item, keep_none))
elif isinstance(item, dict):
new_val.append(data_dict_to_dict(item, keep_none))
elif isinstance(item, Enum):
new_val.append(item.value)
else:
new_val.append(item)
return new_val
def data_dict_to_dict(
val: Dict["DataValue", "DataValue"],
keep_none: bool = True,
) -> dict:
new_val = {} # type: Dict[Any, Any]
for key, value in val.items():
if isinstance(value, DataObject):
new_val[key] = value.to_dict(keep_none)
elif isinstance(value, dict):
new_val[key] = data_dict_to_dict(value, keep_none)
elif isinstance(value, list):
new_val[key] = data_list_to_list(value, keep_none)
elif isinstance(value, Enum):
new_val[key] = value.value
else:
new_val[key] = value
return new_val
class Field:
"""
For defining the fields static property of a DataObject.
"""
def __init__(
self,
key: str,
data_cls: Type[DataValue],
required: bool = True,
dict_key: Optional[str] = None,
doc: Optional[str] = None,
):
self.key = key
self.data_cls = data_cls
self.required = required
if dict_key is not None:
self.dict_key = dict_key
else:
self.dict_key = self.key
self.doc = doc
T = TypeVar("T", bound="DataObject")
class DataObject(DataValue):
"""
For defining a python object that can be parsed from a dict.
Validates that a set of expected fields are present in the dict
that is parsed and that the values of those fields are the correct
DataValue by calling from_value on each.
The fields are defined using the `fields` static property.
DataObjects can be used in Fields of other DataObjects.
To define a new DataObject:
1. Create a new class that extends DataObject.
2. Define the `fields` static property to be a list of Field objects
3. Define the constructor to take kwargs that match the list of Field
objects.
a. Example 1: Field("keyname", StringDataValue) -> keyname: str
b. Example 2: Field("keyname", data_list(IntDataValue), required=False) -> keyname: Optional[List[int]] # noqa: E501
4. Use from_value or from_dict to parse a dict into the python object.
"""
fields = [] # type: List[Field]
def __init__(self, **_kwargs):
pass
def __eq__(self, other):
for field in self.fields:
self_val = getattr(self, field.key, None)
other_val = getattr(other, field.key, None)
if self_val != other_val:
return False
return True
def __repr__(self):
return "{}{}".format(
self.__class__.__name__, self.to_dict().__repr__()
)
def to_dict(self, keep_none: bool = True) -> dict:
d = {}
for field in self.fields:
val = getattr(self, field.key, None)
new_val = None # type: Any
if isinstance(val, DataObject):
new_val = val.to_dict(keep_none)
elif isinstance(val, list):
new_val = data_list_to_list(val, keep_none)
elif isinstance(val, dict):
new_val = data_dict_to_dict(val, keep_none)
elif isinstance(val, Enum):
new_val = val.value
else:
# simple type, just copy
new_val = val
if new_val is not None or keep_none:
d[field.dict_key] = new_val
return d
def to_json(self, keep_null: bool = True) -> str:
return json.dumps(
self.to_dict(keep_none=keep_null),
sort_keys=True,
cls=util.DatetimeAwareJSONEncoder,
)
@classmethod
def from_dict(
cls: Type[T], d: dict, optional_type_errors_become_null: bool = False
) -> T:
kwargs = {}
for field in cls.fields:
try:
val = d[field.dict_key]
except KeyError:
if field.required:
raise IncorrectFieldTypeError(
err=IncorrectTypeError(
expected_type=field.data_cls.__name__,
got_type="null",
),
key=field.dict_key,
)
else:
val = None
if val is not None:
try:
val = field.data_cls.from_value(val)
except IncorrectTypeError as e:
if not field.required and optional_type_errors_become_null:
LOG.warning(
"%s is wrong type (expected %s but got %s) but "
"considered optional - treating as null",
field.key,
e.expected_type,
e.got_type,
)
val = None
else:
raise IncorrectFieldTypeError(
err=e, key=field.dict_key
)
kwargs[field.key] = val
return cls(**kwargs)
@classmethod
def from_value(cls, val: Any):
if not isinstance(val, dict):
raise IncorrectTypeError(
expected_type="dict", got_type=type(val).__name__
)
return cls.from_dict(val)
class AttachActionsConfigFile(DataObject):
"""
The format of the yaml file that can be passed with
pro attach --attach-config /path/to/file
"""
fields = [
Field("token", StringDataValue),
Field("enable_services", data_list(StringDataValue), required=False),
]
def __init__(self, *, token: str, enable_services: Optional[List[str]]):
self.token = token
self.enable_services = enable_services