180 lines
5.2 KiB
Python
180 lines
5.2 KiB
Python
import sys
|
|
|
|
|
|
class Field:
|
|
|
|
"""
|
|
Base field for use in
|
|
:class:`~mopidy.models.immutable.ValidatedImmutableObject`. These fields
|
|
are responsible for type checking and other data sanitation in our models.
|
|
|
|
For simplicity fields use the Python descriptor protocol to store the
|
|
values in the instance dictionary. Also note that fields are mutable if
|
|
the object they are attached to allow it.
|
|
|
|
Default values will be validated with the exception of :class:`None`.
|
|
|
|
:param default: default value for field
|
|
:param type: if set the field value must be of this type
|
|
:param choices: if set the field value must be one of these
|
|
"""
|
|
|
|
def __init__(self, default=None, type=None, choices=None):
|
|
self._name = None # Set by ValidatedImmutableObjectMeta
|
|
self._choices = choices
|
|
self._default = default
|
|
self._type = type
|
|
|
|
if self._default is not None:
|
|
self.validate(self._default)
|
|
|
|
def validate(self, value):
|
|
"""Validate and possibly modify the field value before assignment"""
|
|
if self._type and not isinstance(value, self._type):
|
|
raise TypeError(
|
|
f"Expected {self._name} to be a {self._type}, not {value!r}"
|
|
)
|
|
if self._choices and value not in self._choices:
|
|
raise TypeError(
|
|
f"Expected {self._name} to be a one of {self._choices}, not {value!r}"
|
|
)
|
|
return value
|
|
|
|
def __get__(self, instance, owner):
|
|
if not instance:
|
|
return self
|
|
return getattr(instance, "_" + self._name, self._default)
|
|
|
|
def __set__(self, instance, value):
|
|
if value is not None:
|
|
value = self.validate(value)
|
|
|
|
if value is None or value == self._default:
|
|
self.__delete__(instance)
|
|
else:
|
|
setattr(instance, "_" + self._name, value)
|
|
|
|
def __delete__(self, instance):
|
|
if hasattr(instance, "_" + self._name):
|
|
delattr(instance, "_" + self._name)
|
|
|
|
|
|
class String(Field):
|
|
|
|
"""
|
|
Specialized :class:`Field` which is wired up for bytes and unicode.
|
|
|
|
:param default: default value for field
|
|
"""
|
|
|
|
def __init__(self, default=None):
|
|
# TODO: normalize to unicode?
|
|
# TODO: only allow unicode?
|
|
# TODO: disallow empty strings?
|
|
super().__init__(type=str, default=default)
|
|
|
|
|
|
class Date(String):
|
|
"""
|
|
:class:`Field` for storing ISO 8601 dates as a string.
|
|
|
|
Supported formats are ``YYYY-MM-DD``, ``YYYY-MM`` and ``YYYY``, currently
|
|
not validated.
|
|
|
|
:param default: default value for field
|
|
"""
|
|
|
|
pass # TODO: make this check for YYYY-MM-DD, YYYY-MM, YYYY using strptime.
|
|
|
|
|
|
class Identifier(String):
|
|
"""
|
|
:class:`Field` for storing values such as GUIDs or other identifiers.
|
|
|
|
Values will be interned.
|
|
|
|
:param default: default value for field
|
|
"""
|
|
|
|
def validate(self, value):
|
|
value = super().validate(value)
|
|
if isinstance(value, bytes):
|
|
value = value.decode()
|
|
return sys.intern(value)
|
|
|
|
|
|
class URI(Identifier):
|
|
"""
|
|
:class:`Field` for storing URIs
|
|
|
|
Values will be interned, currently not validated.
|
|
|
|
:param default: default value for field
|
|
"""
|
|
|
|
pass # TODO: validate URIs?
|
|
|
|
|
|
class Integer(Field):
|
|
"""
|
|
:class:`Field` for storing integer numbers.
|
|
|
|
:param default: default value for field
|
|
:param min: field value must be larger or equal to this value when set
|
|
:param max: field value must be smaller or equal to this value when set
|
|
"""
|
|
|
|
def __init__(self, default=None, min=None, max=None):
|
|
self._min = min
|
|
self._max = max
|
|
super().__init__(type=int, default=default)
|
|
|
|
def validate(self, value):
|
|
value = super().validate(value)
|
|
if self._min is not None and value < self._min:
|
|
raise ValueError(
|
|
f"Expected {self._name} to be at least {self._min}, not {value:d}"
|
|
)
|
|
if self._max is not None and value > self._max:
|
|
raise ValueError(
|
|
f"Expected {self._name} to be at most {self._max}, not {value:d}"
|
|
)
|
|
return value
|
|
|
|
|
|
class Boolean(Field):
|
|
"""
|
|
:class:`Field` for storing boolean values
|
|
|
|
:param default: default value for field
|
|
"""
|
|
|
|
def __init__(self, default=None):
|
|
super().__init__(type=bool, default=default)
|
|
|
|
|
|
class Collection(Field):
|
|
"""
|
|
:class:`Field` for storing collections of a given type.
|
|
|
|
:param type: all items stored in the collection must be of this type
|
|
:param container: the type to store the items in
|
|
"""
|
|
|
|
def __init__(self, type, container=tuple):
|
|
super().__init__(type=type, default=container())
|
|
|
|
def validate(self, value):
|
|
if isinstance(value, str):
|
|
raise TypeError(
|
|
f"Expected {self._name} to be a collection of "
|
|
f"{self._type.__name__}, not {value!r}"
|
|
)
|
|
for v in value:
|
|
if not isinstance(v, self._type):
|
|
raise TypeError(
|
|
f"Expected {self._name} to be a collection of "
|
|
f"{self._type.__name__}, not {value!r}"
|
|
)
|
|
return self._default.__class__(value) or None
|