Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

serializer.py 13KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. import builtins
  2. import collections.abc
  3. import datetime
  4. import decimal
  5. import enum
  6. import functools
  7. import math
  8. import re
  9. import types
  10. import uuid
  11. from django.db import models
  12. from django.db.migrations.operations.base import Operation
  13. from django.db.migrations.utils import COMPILED_REGEX_TYPE, RegexObject
  14. from django.utils import datetime_safe
  15. from django.utils.functional import LazyObject, Promise
  16. from django.utils.timezone import utc
  17. from django.utils.version import get_docs_version
  18. class BaseSerializer:
  19. def __init__(self, value):
  20. self.value = value
  21. def serialize(self):
  22. raise NotImplementedError('Subclasses of BaseSerializer must implement the serialize() method.')
  23. class BaseSequenceSerializer(BaseSerializer):
  24. def _format(self):
  25. raise NotImplementedError('Subclasses of BaseSequenceSerializer must implement the _format() method.')
  26. def serialize(self):
  27. imports = set()
  28. strings = []
  29. for item in self.value:
  30. item_string, item_imports = serializer_factory(item).serialize()
  31. imports.update(item_imports)
  32. strings.append(item_string)
  33. value = self._format()
  34. return value % (", ".join(strings)), imports
  35. class BaseSimpleSerializer(BaseSerializer):
  36. def serialize(self):
  37. return repr(self.value), set()
  38. class DatetimeSerializer(BaseSerializer):
  39. def serialize(self):
  40. if self.value.tzinfo is not None and self.value.tzinfo != utc:
  41. self.value = self.value.astimezone(utc)
  42. value_repr = repr(self.value).replace("<UTC>", "utc")
  43. if isinstance(self.value, datetime_safe.datetime):
  44. value_repr = "datetime.%s" % value_repr
  45. imports = ["import datetime"]
  46. if self.value.tzinfo is not None:
  47. imports.append("from django.utils.timezone import utc")
  48. return value_repr, set(imports)
  49. class DateSerializer(BaseSerializer):
  50. def serialize(self):
  51. value_repr = repr(self.value)
  52. if isinstance(self.value, datetime_safe.date):
  53. value_repr = "datetime.%s" % value_repr
  54. return value_repr, {"import datetime"}
  55. class DecimalSerializer(BaseSerializer):
  56. def serialize(self):
  57. return repr(self.value), {"from decimal import Decimal"}
  58. class DeconstructableSerializer(BaseSerializer):
  59. @staticmethod
  60. def serialize_deconstructed(path, args, kwargs):
  61. name, imports = DeconstructableSerializer._serialize_path(path)
  62. strings = []
  63. for arg in args:
  64. arg_string, arg_imports = serializer_factory(arg).serialize()
  65. strings.append(arg_string)
  66. imports.update(arg_imports)
  67. for kw, arg in sorted(kwargs.items()):
  68. arg_string, arg_imports = serializer_factory(arg).serialize()
  69. imports.update(arg_imports)
  70. strings.append("%s=%s" % (kw, arg_string))
  71. return "%s(%s)" % (name, ", ".join(strings)), imports
  72. @staticmethod
  73. def _serialize_path(path):
  74. module, name = path.rsplit(".", 1)
  75. if module == "django.db.models":
  76. imports = {"from django.db import models"}
  77. name = "models.%s" % name
  78. else:
  79. imports = {"import %s" % module}
  80. name = path
  81. return name, imports
  82. def serialize(self):
  83. return self.serialize_deconstructed(*self.value.deconstruct())
  84. class DictionarySerializer(BaseSerializer):
  85. def serialize(self):
  86. imports = set()
  87. strings = []
  88. for k, v in sorted(self.value.items()):
  89. k_string, k_imports = serializer_factory(k).serialize()
  90. v_string, v_imports = serializer_factory(v).serialize()
  91. imports.update(k_imports)
  92. imports.update(v_imports)
  93. strings.append((k_string, v_string))
  94. return "{%s}" % (", ".join("%s: %s" % (k, v) for k, v in strings)), imports
  95. class EnumSerializer(BaseSerializer):
  96. def serialize(self):
  97. enum_class = self.value.__class__
  98. module = enum_class.__module__
  99. v_string, v_imports = serializer_factory(self.value.value).serialize()
  100. imports = {'import %s' % module, *v_imports}
  101. return "%s.%s(%s)" % (module, enum_class.__name__, v_string), imports
  102. class FloatSerializer(BaseSimpleSerializer):
  103. def serialize(self):
  104. if math.isnan(self.value) or math.isinf(self.value):
  105. return 'float("{}")'.format(self.value), set()
  106. return super().serialize()
  107. class FrozensetSerializer(BaseSequenceSerializer):
  108. def _format(self):
  109. return "frozenset([%s])"
  110. class FunctionTypeSerializer(BaseSerializer):
  111. def serialize(self):
  112. if getattr(self.value, "__self__", None) and isinstance(self.value.__self__, type):
  113. klass = self.value.__self__
  114. module = klass.__module__
  115. return "%s.%s.%s" % (module, klass.__name__, self.value.__name__), {"import %s" % module}
  116. # Further error checking
  117. if self.value.__name__ == '<lambda>':
  118. raise ValueError("Cannot serialize function: lambda")
  119. if self.value.__module__ is None:
  120. raise ValueError("Cannot serialize function %r: No module" % self.value)
  121. module_name = self.value.__module__
  122. if '<' not in self.value.__qualname__: # Qualname can include <locals>
  123. return '%s.%s' % (module_name, self.value.__qualname__), {'import %s' % self.value.__module__}
  124. raise ValueError(
  125. 'Could not find function %s in %s.\n' % (self.value.__name__, module_name)
  126. )
  127. class FunctoolsPartialSerializer(BaseSerializer):
  128. def serialize(self):
  129. # Serialize functools.partial() arguments
  130. func_string, func_imports = serializer_factory(self.value.func).serialize()
  131. args_string, args_imports = serializer_factory(self.value.args).serialize()
  132. keywords_string, keywords_imports = serializer_factory(self.value.keywords).serialize()
  133. # Add any imports needed by arguments
  134. imports = {'import functools', *func_imports, *args_imports, *keywords_imports}
  135. return (
  136. 'functools.%s(%s, *%s, **%s)' % (
  137. self.value.__class__.__name__,
  138. func_string,
  139. args_string,
  140. keywords_string,
  141. ),
  142. imports,
  143. )
  144. class IterableSerializer(BaseSerializer):
  145. def serialize(self):
  146. imports = set()
  147. strings = []
  148. for item in self.value:
  149. item_string, item_imports = serializer_factory(item).serialize()
  150. imports.update(item_imports)
  151. strings.append(item_string)
  152. # When len(strings)==0, the empty iterable should be serialized as
  153. # "()", not "(,)" because (,) is invalid Python syntax.
  154. value = "(%s)" if len(strings) != 1 else "(%s,)"
  155. return value % (", ".join(strings)), imports
  156. class ModelFieldSerializer(DeconstructableSerializer):
  157. def serialize(self):
  158. attr_name, path, args, kwargs = self.value.deconstruct()
  159. return self.serialize_deconstructed(path, args, kwargs)
  160. class ModelManagerSerializer(DeconstructableSerializer):
  161. def serialize(self):
  162. as_manager, manager_path, qs_path, args, kwargs = self.value.deconstruct()
  163. if as_manager:
  164. name, imports = self._serialize_path(qs_path)
  165. return "%s.as_manager()" % name, imports
  166. else:
  167. return self.serialize_deconstructed(manager_path, args, kwargs)
  168. class OperationSerializer(BaseSerializer):
  169. def serialize(self):
  170. from django.db.migrations.writer import OperationWriter
  171. string, imports = OperationWriter(self.value, indentation=0).serialize()
  172. # Nested operation, trailing comma is handled in upper OperationWriter._write()
  173. return string.rstrip(','), imports
  174. class RegexSerializer(BaseSerializer):
  175. def serialize(self):
  176. regex_pattern, pattern_imports = serializer_factory(self.value.pattern).serialize()
  177. # Turn off default implicit flags (e.g. re.U) because regexes with the
  178. # same implicit and explicit flags aren't equal.
  179. flags = self.value.flags ^ re.compile('').flags
  180. regex_flags, flag_imports = serializer_factory(flags).serialize()
  181. imports = {'import re', *pattern_imports, *flag_imports}
  182. args = [regex_pattern]
  183. if flags:
  184. args.append(regex_flags)
  185. return "re.compile(%s)" % ', '.join(args), imports
  186. class SequenceSerializer(BaseSequenceSerializer):
  187. def _format(self):
  188. return "[%s]"
  189. class SetSerializer(BaseSequenceSerializer):
  190. def _format(self):
  191. # Serialize as a set literal except when value is empty because {}
  192. # is an empty dict.
  193. return '{%s}' if self.value else 'set(%s)'
  194. class SettingsReferenceSerializer(BaseSerializer):
  195. def serialize(self):
  196. return "settings.%s" % self.value.setting_name, {"from django.conf import settings"}
  197. class TimedeltaSerializer(BaseSerializer):
  198. def serialize(self):
  199. return repr(self.value), {"import datetime"}
  200. class TimeSerializer(BaseSerializer):
  201. def serialize(self):
  202. value_repr = repr(self.value)
  203. if isinstance(self.value, datetime_safe.time):
  204. value_repr = "datetime.%s" % value_repr
  205. return value_repr, {"import datetime"}
  206. class TupleSerializer(BaseSequenceSerializer):
  207. def _format(self):
  208. # When len(value)==0, the empty tuple should be serialized as "()",
  209. # not "(,)" because (,) is invalid Python syntax.
  210. return "(%s)" if len(self.value) != 1 else "(%s,)"
  211. class TypeSerializer(BaseSerializer):
  212. def serialize(self):
  213. special_cases = [
  214. (models.Model, "models.Model", []),
  215. ]
  216. for case, string, imports in special_cases:
  217. if case is self.value:
  218. return string, set(imports)
  219. if hasattr(self.value, "__module__"):
  220. module = self.value.__module__
  221. if module == builtins.__name__:
  222. return self.value.__name__, set()
  223. else:
  224. return "%s.%s" % (module, self.value.__name__), {"import %s" % module}
  225. class UUIDSerializer(BaseSerializer):
  226. def serialize(self):
  227. return "uuid.%s" % repr(self.value), {"import uuid"}
  228. def serializer_factory(value):
  229. from django.db.migrations.writer import SettingsReference
  230. if isinstance(value, Promise):
  231. value = str(value)
  232. elif isinstance(value, LazyObject):
  233. # The unwrapped value is returned as the first item of the arguments
  234. # tuple.
  235. value = value.__reduce__()[1][0]
  236. if isinstance(value, models.Field):
  237. return ModelFieldSerializer(value)
  238. if isinstance(value, models.manager.BaseManager):
  239. return ModelManagerSerializer(value)
  240. if isinstance(value, Operation):
  241. return OperationSerializer(value)
  242. if isinstance(value, type):
  243. return TypeSerializer(value)
  244. # Anything that knows how to deconstruct itself.
  245. if hasattr(value, 'deconstruct'):
  246. return DeconstructableSerializer(value)
  247. # Unfortunately some of these are order-dependent.
  248. if isinstance(value, frozenset):
  249. return FrozensetSerializer(value)
  250. if isinstance(value, list):
  251. return SequenceSerializer(value)
  252. if isinstance(value, set):
  253. return SetSerializer(value)
  254. if isinstance(value, tuple):
  255. return TupleSerializer(value)
  256. if isinstance(value, dict):
  257. return DictionarySerializer(value)
  258. if isinstance(value, enum.Enum):
  259. return EnumSerializer(value)
  260. if isinstance(value, datetime.datetime):
  261. return DatetimeSerializer(value)
  262. if isinstance(value, datetime.date):
  263. return DateSerializer(value)
  264. if isinstance(value, datetime.time):
  265. return TimeSerializer(value)
  266. if isinstance(value, datetime.timedelta):
  267. return TimedeltaSerializer(value)
  268. if isinstance(value, SettingsReference):
  269. return SettingsReferenceSerializer(value)
  270. if isinstance(value, float):
  271. return FloatSerializer(value)
  272. if isinstance(value, (bool, int, type(None), bytes, str)):
  273. return BaseSimpleSerializer(value)
  274. if isinstance(value, decimal.Decimal):
  275. return DecimalSerializer(value)
  276. if isinstance(value, (functools.partial, functools.partialmethod)):
  277. return FunctoolsPartialSerializer(value)
  278. if isinstance(value, (types.FunctionType, types.BuiltinFunctionType, types.MethodType)):
  279. return FunctionTypeSerializer(value)
  280. if isinstance(value, collections.abc.Iterable):
  281. return IterableSerializer(value)
  282. if isinstance(value, (COMPILED_REGEX_TYPE, RegexObject)):
  283. return RegexSerializer(value)
  284. if isinstance(value, uuid.UUID):
  285. return UUIDSerializer(value)
  286. raise ValueError(
  287. "Cannot serialize: %r\nThere are some values Django cannot serialize into "
  288. "migration files.\nFor more, see https://docs.djangoproject.com/en/%s/"
  289. "topics/migrations/#migration-serializing" % (value, get_docs_version())
  290. )