1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
|
import decimal
import os
from datetime import date, timedelta, datetime, time, timezone
from django.conf import settings
from django.core.validators import EMPTY_VALUES
from django.utils.dateparse import (
parse_duration,
parse_datetime,
parse_date,
parse_time,
)
from django.utils.duration import duration_string
from django.utils.encoding import force_str
from django.utils.timezone import (
is_aware,
make_aware,
make_naive,
get_default_timezone,
)
from django.db.models.fields.files import FieldFile
class UnsetValue(object):
pass
UNSET = UnsetValue()
class SerializationError(Exception):
pass
class BaseSerializer:
"""
A serializer take a Python variable and returns a string that can be stored safely in database
"""
exception = SerializationError
@classmethod
def serialize(cls, value, **kwargs):
"""
Return a string from a Python var
"""
return cls.to_db(value, **kwargs)
@classmethod
def deserialize(cls, value, **kwargs):
"""
Convert a python string to a var
"""
return cls.to_python(value, **kwargs)
@classmethod
def to_python(cls, value, **kwargs):
raise NotImplementedError
@classmethod
def to_db(cls, value, **kwargs):
return str(cls.clean_to_db_value(value))
@classmethod
def clean_to_db_value(cls, value):
return value
class InstanciatedSerializer(BaseSerializer):
"""
In some situations, such as with FileSerializer,
we need the serializer to be an instance and not a class
"""
def serialize(self, value, **kwargs):
return self.to_db(value, **kwargs)
def deserialize(self, value, **kwargs):
return self.to_python(value, **kwargs)
def to_python(self, value, **kwargs):
raise NotImplementedError
def to_db(self, value, **kwargs):
return str(self.clean_to_db_value(value))
def clean_to_db_value(self, value):
return value
class BooleanSerializer(BaseSerializer):
true = (
"True",
"true",
"TRUE",
"1",
"YES",
"Yes",
"yes",
)
false = (
"False",
"false",
"FALSE",
"0",
"No",
"no",
"NO",
)
@classmethod
def clean_to_db_value(cls, value):
if not isinstance(value, bool):
raise cls.exception("{0} is not a boolean".format(value))
return value
@classmethod
def to_python(cls, value, **kwargs):
if value in cls.true:
return True
elif value in cls.false:
return False
else:
raise cls.exception(
"Value {0} can't be deserialized to a Boolean".format(value)
)
class IntegerSerializer(BaseSerializer):
@classmethod
def clean_to_db_value(cls, value):
if not isinstance(value, int):
raise cls.exception("IntSerializer can only serialize int values")
return value
@classmethod
def to_python(cls, value, **kwargs):
try:
return int(value)
except:
raise cls.exception("Value {0} cannot be converted to int".format(value))
IntSerializer = IntegerSerializer
class DecimalSerializer(BaseSerializer):
@classmethod
def clean_to_db_value(cls, value):
if not isinstance(value, decimal.Decimal):
raise cls.exception(
"DecimalSerializer can only serialize Decimal instances"
)
return value
@classmethod
def to_python(cls, value, **kwargs):
try:
return decimal.Decimal(value)
except decimal.InvalidOperation:
raise cls.exception(
"Value {0} cannot be converted to decimal".format(value)
)
class FloatSerializer(BaseSerializer):
@classmethod
def clean_to_db_value(cls, value):
if not isinstance(value, (int, float)):
raise cls.exception(
"FloatSerializer can only serialize float or int values"
)
return float(value)
@classmethod
def to_python(cls, value, **kwargs):
try:
return float(value)
except float.InvalidOperation:
raise cls.exception("Value {0} cannot be converted to float".format(value))
from django.template import defaultfilters
class StringSerializer(BaseSerializer):
@classmethod
def to_db(cls, value, **kwargs):
if not isinstance(value, str):
raise cls.exception(
"Cannot serialize, value {0} is not a string".format(value)
)
if kwargs.get("escape_html", False):
return defaultfilters.force_escape(value)
else:
return value
@classmethod
def to_python(cls, value, **kwargs):
"""String deserialisation just return the value as a string"""
if not value:
return ""
try:
return str(value)
except:
pass
try:
return value.encode("utf-8")
except:
pass
raise cls.exception("Cannot deserialize value {0} tostring".format(value))
class ModelSerializer(InstanciatedSerializer):
model = None
def __init__(self, model):
self.model = model
def to_db(self, value, **kwargs):
if not value or (value == UNSET):
return None
return str(value.pk)
def to_python(self, value, **kwargs):
if value is None:
return
try:
pk = self.model._meta.pk.to_python(value)
return self.model.objects.get(pk=pk)
except:
raise self.exception("Value {0} cannot be converted to pk".format(value))
class ModelMultipleSerializer(ModelSerializer):
separator = ","
sort = True
def to_db(self, value, **kwargs):
if not value:
return
if hasattr(value, "pk"):
# Support single instances in this serializer to allow
# create_deletion_handler to work for model multiple choice preferences
value = [value.pk]
elif hasattr(value, 'values_list'):
value = list(value.values_list("pk", flat=True))
elif isinstance(value, list) and len(value) > 0 and isinstance(value[0], self.model):
# Handle lists of model instances
value = [i.pk for i in value]
else:
raise ValueError(f'Cannot handle value {value} of type {type(value)}')
if value and self.sort:
value = sorted(value)
return self.separator.join(map(str, value))
def to_python(self, value, **kwargs):
if value in EMPTY_VALUES:
return self.model.objects.none()
try:
pks = value.split(",")
pks = [int(i) if str(i).isdigit() else str(i) for i in pks]
return self.model.objects.filter(pk__in=pks)
except:
raise self.exception("Array {0} cannot be converted to int".format(value))
# FieldFile also needs a model instance to save changes.
class FakeInstance(object):
"""
FieldFile needs a model instance to update when file is persisted
or deleted
"""
def save(self):
return
class FakeField(object):
"""
FieldFile needs a field object to generate a filename, persist
and delete files, so we are effectively mocking that.
"""
name = "noop"
attname = "noop"
max_length = 10000
class PreferenceFieldFile(FieldFile):
"""
In order to have the same API that we have with models.FileField,
we must return a FieldFile object. However, there are various
things we have to override, since our files are not bound to a model
field.
"""
def __init__(self, preference, storage, name):
super(FieldFile, self).__init__(None, name)
self.instance = FakeInstance()
self.field = FakeField()
self.field.storage = storage
self.storage = storage
self._committed = True
self.preference = preference
class FileSerializer(InstanciatedSerializer):
"""
Since this serializer requires additional data from the preference
especially the upload path, we cannot do it without binding it
to the preference
it is therefore designed to be explicitely instanciated by the preference
object.
"""
def __init__(self, preference):
self.preference = preference
def to_db(self, f, **kwargs):
if not f:
return
saved_path = f.name
if not hasattr(f, "save"):
path = os.path.join(self.preference.get_upload_path(), f.name)
saved_path = self.preference.get_file_storage().save(path, f)
return saved_path
def to_python(self, value, **kwargs):
if not value:
return
storage = self.preference.get_file_storage()
return PreferenceFieldFile(
preference=self.preference, storage=storage, name=value
)
class DurationSerializer(BaseSerializer):
@classmethod
def to_db(cls, value, **kwargs):
if not isinstance(value, timedelta):
raise cls.exception(
"Cannot serialize, value {0} is not a timedelta".format(value)
)
return duration_string(value)
@classmethod
def to_python(cls, value, **kwargs):
parsed = parse_duration(force_str(value))
if parsed is None:
raise cls.exception(
"Value {0} cannot be converted to timedelta".format(value)
)
return parsed
class DateSerializer(BaseSerializer):
@classmethod
def to_db(cls, value, **kwargs):
if not isinstance(value, date):
raise cls.exception(
"Cannot serialize, value {0} is not a date object".format(value)
)
return value.isoformat()
@classmethod
def to_python(cls, value, **kwargs):
parsed = parse_date(force_str(value))
if parsed is None:
raise cls.exception(
"Value {0} cannot be converted to a date object".format(value)
)
return parsed
class DateTimeSerializer(BaseSerializer):
@classmethod
def to_db(cls, value, **kwargs):
if not isinstance(value, datetime):
raise cls.exception(
"Cannot serialize, value {0} is not a datetime object".format(value)
)
value = cls.enforce_timezone(value)
return value.isoformat()
@classmethod
def enforce_timezone(cls, value):
"""
When `self.default_timezone` is `None`, always return naive datetimes.
When `self.default_timezone` is not `None`, always return aware datetimes.
"""
field_timezone = cls.default_timezone()
if (field_timezone is not None) and not is_aware(value):
return make_aware(value, field_timezone)
elif (field_timezone is None) and is_aware(value):
return make_naive(value, timezone.utc)
return value
@classmethod
def default_timezone(cls):
return get_default_timezone() if settings.USE_TZ else None
@classmethod
def to_python(cls, value, **kwargs):
parsed = parse_datetime(force_str(value))
if parsed is None:
raise cls.exception(
"Value {0} cannot be converted to a datetime object".format(value)
)
return parsed
class TimeSerializer(BaseSerializer):
@classmethod
def to_db(cls, value, **kwargs):
if not isinstance(value, time):
raise cls.exception(
"Cannot serialize, value {0} is not a time object".format(value)
)
return value.isoformat()
@classmethod
def to_python(cls, value, **kwargs):
parsed = parse_time(force_str(value))
if parsed is None:
raise cls.exception(
"Value {0} cannot be converted to a time object".format(value)
)
return parsed
class MultipleSerializer(BaseSerializer):
separator = ","
sort = True
@classmethod
def to_db(cls, value, **kwargs):
if not value:
return
# This makes the use of the separator in choices safe by duplicating
# it in each value before they are joined later on
# Contract: choices keys cannot be empty
value = [str(v).replace(cls.separator, cls.separator * 2) for v in value]
if "" in value:
raise cls.exception("Choices must not be empty")
if cls.sort:
value = sorted(value)
return cls.separator.join(value)
@classmethod
def to_python(cls, value, **kwargs):
if value in EMPTY_VALUES:
return []
ret = value.split(cls.separator)
# Duplication of separator is reverted (cf. to_db)
while "" in ret:
pos = ret.index("")
val = ret[pos - 1] + cls.separator + ret[pos + 1]
ret = ret[0: pos - 1] + [val] + ret[pos + 2:]
return ret
|