representer.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375
  1. # SPDX-License-Identifier: MIT
  2. __all__ = ['BaseRepresenter', 'SafeRepresenter', 'Representer',
  3. 'RepresenterError']
  4. from .error import *
  5. from .nodes import *
  6. import datetime, sys, copyreg, types, base64
  7. class RepresenterError(YAMLError):
  8. pass
  9. class BaseRepresenter:
  10. yaml_representers = {}
  11. yaml_multi_representers = {}
  12. def __init__(self, default_style=None, default_flow_style=None):
  13. self.default_style = default_style
  14. self.default_flow_style = default_flow_style
  15. self.represented_objects = {}
  16. self.object_keeper = []
  17. self.alias_key = None
  18. def represent(self, data):
  19. node = self.represent_data(data)
  20. self.serialize(node)
  21. self.represented_objects = {}
  22. self.object_keeper = []
  23. self.alias_key = None
  24. def represent_data(self, data):
  25. if self.ignore_aliases(data):
  26. self.alias_key = None
  27. else:
  28. self.alias_key = id(data)
  29. if self.alias_key is not None:
  30. if self.alias_key in self.represented_objects:
  31. node = self.represented_objects[self.alias_key]
  32. #if node is None:
  33. # raise RepresenterError("recursive objects are not allowed: %r" % data)
  34. return node
  35. #self.represented_objects[alias_key] = None
  36. self.object_keeper.append(data)
  37. data_types = type(data).__mro__
  38. if data_types[0] in self.yaml_representers:
  39. node = self.yaml_representers[data_types[0]](self, data)
  40. else:
  41. for data_type in data_types:
  42. if data_type in self.yaml_multi_representers:
  43. node = self.yaml_multi_representers[data_type](self, data)
  44. break
  45. else:
  46. if None in self.yaml_multi_representers:
  47. node = self.yaml_multi_representers[None](self, data)
  48. elif None in self.yaml_representers:
  49. node = self.yaml_representers[None](self, data)
  50. else:
  51. node = ScalarNode(None, str(data))
  52. #if alias_key is not None:
  53. # self.represented_objects[alias_key] = node
  54. return node
  55. @classmethod
  56. def add_representer(cls, data_type, representer):
  57. if not 'yaml_representers' in cls.__dict__:
  58. cls.yaml_representers = cls.yaml_representers.copy()
  59. cls.yaml_representers[data_type] = representer
  60. @classmethod
  61. def add_multi_representer(cls, data_type, representer):
  62. if not 'yaml_multi_representers' in cls.__dict__:
  63. cls.yaml_multi_representers = cls.yaml_multi_representers.copy()
  64. cls.yaml_multi_representers[data_type] = representer
  65. def represent_scalar(self, tag, value, style=None):
  66. if style is None:
  67. style = self.default_style
  68. node = ScalarNode(tag, value, style=style)
  69. if self.alias_key is not None:
  70. self.represented_objects[self.alias_key] = node
  71. return node
  72. def represent_sequence(self, tag, sequence, flow_style=None):
  73. value = []
  74. node = SequenceNode(tag, value, flow_style=flow_style)
  75. if self.alias_key is not None:
  76. self.represented_objects[self.alias_key] = node
  77. best_style = True
  78. for item in sequence:
  79. node_item = self.represent_data(item)
  80. if not (isinstance(node_item, ScalarNode) and not node_item.style):
  81. best_style = False
  82. value.append(node_item)
  83. if flow_style is None:
  84. if self.default_flow_style is not None:
  85. node.flow_style = self.default_flow_style
  86. else:
  87. node.flow_style = best_style
  88. return node
  89. def represent_mapping(self, tag, mapping, flow_style=None):
  90. value = []
  91. node = MappingNode(tag, value, flow_style=flow_style)
  92. if self.alias_key is not None:
  93. self.represented_objects[self.alias_key] = node
  94. best_style = True
  95. if hasattr(mapping, 'items'):
  96. mapping = list(mapping.items())
  97. try:
  98. mapping = sorted(mapping)
  99. except TypeError:
  100. pass
  101. for item_key, item_value in mapping:
  102. node_key = self.represent_data(item_key)
  103. node_value = self.represent_data(item_value)
  104. if not (isinstance(node_key, ScalarNode) and not node_key.style):
  105. best_style = False
  106. if not (isinstance(node_value, ScalarNode) and not node_value.style):
  107. best_style = False
  108. value.append((node_key, node_value))
  109. if flow_style is None:
  110. if self.default_flow_style is not None:
  111. node.flow_style = self.default_flow_style
  112. else:
  113. node.flow_style = best_style
  114. return node
  115. def ignore_aliases(self, data):
  116. return False
  117. class SafeRepresenter(BaseRepresenter):
  118. def ignore_aliases(self, data):
  119. if data in [None, ()]:
  120. return True
  121. if isinstance(data, (str, bytes, bool, int, float)):
  122. return True
  123. def represent_none(self, data):
  124. return self.represent_scalar('tag:yaml.org,2002:null', 'null')
  125. def represent_str(self, data):
  126. return self.represent_scalar('tag:yaml.org,2002:str', data)
  127. def represent_binary(self, data):
  128. if hasattr(base64, 'encodebytes'):
  129. data = base64.encodebytes(data).decode('ascii')
  130. else:
  131. data = base64.encodestring(data).decode('ascii')
  132. return self.represent_scalar('tag:yaml.org,2002:binary', data, style='|')
  133. def represent_bool(self, data):
  134. if data:
  135. value = 'true'
  136. else:
  137. value = 'false'
  138. return self.represent_scalar('tag:yaml.org,2002:bool', value)
  139. def represent_int(self, data):
  140. return self.represent_scalar('tag:yaml.org,2002:int', str(data))
  141. inf_value = 1e300
  142. while repr(inf_value) != repr(inf_value*inf_value):
  143. inf_value *= inf_value
  144. def represent_float(self, data):
  145. if data != data or (data == 0.0 and data == 1.0):
  146. value = '.nan'
  147. elif data == self.inf_value:
  148. value = '.inf'
  149. elif data == -self.inf_value:
  150. value = '-.inf'
  151. else:
  152. value = repr(data).lower()
  153. # Note that in some cases `repr(data)` represents a float number
  154. # without the decimal parts. For instance:
  155. # >>> repr(1e17)
  156. # '1e17'
  157. # Unfortunately, this is not a valid float representation according
  158. # to the definition of the `!!float` tag. We fix this by adding
  159. # '.0' before the 'e' symbol.
  160. if '.' not in value and 'e' in value:
  161. value = value.replace('e', '.0e', 1)
  162. return self.represent_scalar('tag:yaml.org,2002:float', value)
  163. def represent_list(self, data):
  164. #pairs = (len(data) > 0 and isinstance(data, list))
  165. #if pairs:
  166. # for item in data:
  167. # if not isinstance(item, tuple) or len(item) != 2:
  168. # pairs = False
  169. # break
  170. #if not pairs:
  171. return self.represent_sequence('tag:yaml.org,2002:seq', data)
  172. #value = []
  173. #for item_key, item_value in data:
  174. # value.append(self.represent_mapping(u'tag:yaml.org,2002:map',
  175. # [(item_key, item_value)]))
  176. #return SequenceNode(u'tag:yaml.org,2002:pairs', value)
  177. def represent_dict(self, data):
  178. return self.represent_mapping('tag:yaml.org,2002:map', data)
  179. def represent_set(self, data):
  180. value = {}
  181. for key in data:
  182. value[key] = None
  183. return self.represent_mapping('tag:yaml.org,2002:set', value)
  184. def represent_date(self, data):
  185. value = data.isoformat()
  186. return self.represent_scalar('tag:yaml.org,2002:timestamp', value)
  187. def represent_datetime(self, data):
  188. value = data.isoformat(' ')
  189. return self.represent_scalar('tag:yaml.org,2002:timestamp', value)
  190. def represent_yaml_object(self, tag, data, cls, flow_style=None):
  191. if hasattr(data, '__getstate__'):
  192. state = data.__getstate__()
  193. else:
  194. state = data.__dict__.copy()
  195. return self.represent_mapping(tag, state, flow_style=flow_style)
  196. def represent_undefined(self, data):
  197. raise RepresenterError("cannot represent an object: %s" % data)
  198. SafeRepresenter.add_representer(type(None),
  199. SafeRepresenter.represent_none)
  200. SafeRepresenter.add_representer(str,
  201. SafeRepresenter.represent_str)
  202. SafeRepresenter.add_representer(bytes,
  203. SafeRepresenter.represent_binary)
  204. SafeRepresenter.add_representer(bool,
  205. SafeRepresenter.represent_bool)
  206. SafeRepresenter.add_representer(int,
  207. SafeRepresenter.represent_int)
  208. SafeRepresenter.add_representer(float,
  209. SafeRepresenter.represent_float)
  210. SafeRepresenter.add_representer(list,
  211. SafeRepresenter.represent_list)
  212. SafeRepresenter.add_representer(tuple,
  213. SafeRepresenter.represent_list)
  214. SafeRepresenter.add_representer(dict,
  215. SafeRepresenter.represent_dict)
  216. SafeRepresenter.add_representer(set,
  217. SafeRepresenter.represent_set)
  218. SafeRepresenter.add_representer(datetime.date,
  219. SafeRepresenter.represent_date)
  220. SafeRepresenter.add_representer(datetime.datetime,
  221. SafeRepresenter.represent_datetime)
  222. SafeRepresenter.add_representer(None,
  223. SafeRepresenter.represent_undefined)
  224. class Representer(SafeRepresenter):
  225. def represent_complex(self, data):
  226. if data.imag == 0.0:
  227. data = '%r' % data.real
  228. elif data.real == 0.0:
  229. data = '%rj' % data.imag
  230. elif data.imag > 0:
  231. data = '%r+%rj' % (data.real, data.imag)
  232. else:
  233. data = '%r%rj' % (data.real, data.imag)
  234. return self.represent_scalar('tag:yaml.org,2002:python/complex', data)
  235. def represent_tuple(self, data):
  236. return self.represent_sequence('tag:yaml.org,2002:python/tuple', data)
  237. def represent_name(self, data):
  238. name = '%s.%s' % (data.__module__, data.__name__)
  239. return self.represent_scalar('tag:yaml.org,2002:python/name:'+name, '')
  240. def represent_module(self, data):
  241. return self.represent_scalar(
  242. 'tag:yaml.org,2002:python/module:'+data.__name__, '')
  243. def represent_object(self, data):
  244. # We use __reduce__ API to save the data. data.__reduce__ returns
  245. # a tuple of length 2-5:
  246. # (function, args, state, listitems, dictitems)
  247. # For reconstructing, we calls function(*args), then set its state,
  248. # listitems, and dictitems if they are not None.
  249. # A special case is when function.__name__ == '__newobj__'. In this
  250. # case we create the object with args[0].__new__(*args).
  251. # Another special case is when __reduce__ returns a string - we don't
  252. # support it.
  253. # We produce a !!python/object, !!python/object/new or
  254. # !!python/object/apply node.
  255. cls = type(data)
  256. if cls in copyreg.dispatch_table:
  257. reduce = copyreg.dispatch_table[cls](data)
  258. elif hasattr(data, '__reduce_ex__'):
  259. reduce = data.__reduce_ex__(2)
  260. elif hasattr(data, '__reduce__'):
  261. reduce = data.__reduce__()
  262. else:
  263. raise RepresenterError("cannot represent object: %r" % data)
  264. reduce = (list(reduce)+[None]*5)[:5]
  265. function, args, state, listitems, dictitems = reduce
  266. args = list(args)
  267. if state is None:
  268. state = {}
  269. if listitems is not None:
  270. listitems = list(listitems)
  271. if dictitems is not None:
  272. dictitems = dict(dictitems)
  273. if function.__name__ == '__newobj__':
  274. function = args[0]
  275. args = args[1:]
  276. tag = 'tag:yaml.org,2002:python/object/new:'
  277. newobj = True
  278. else:
  279. tag = 'tag:yaml.org,2002:python/object/apply:'
  280. newobj = False
  281. function_name = '%s.%s' % (function.__module__, function.__name__)
  282. if not args and not listitems and not dictitems \
  283. and isinstance(state, dict) and newobj:
  284. return self.represent_mapping(
  285. 'tag:yaml.org,2002:python/object:'+function_name, state)
  286. if not listitems and not dictitems \
  287. and isinstance(state, dict) and not state:
  288. return self.represent_sequence(tag+function_name, args)
  289. value = {}
  290. if args:
  291. value['args'] = args
  292. if state or not isinstance(state, dict):
  293. value['state'] = state
  294. if listitems:
  295. value['listitems'] = listitems
  296. if dictitems:
  297. value['dictitems'] = dictitems
  298. return self.represent_mapping(tag+function_name, value)
  299. Representer.add_representer(complex,
  300. Representer.represent_complex)
  301. Representer.add_representer(tuple,
  302. Representer.represent_tuple)
  303. Representer.add_representer(type,
  304. Representer.represent_name)
  305. Representer.add_representer(types.FunctionType,
  306. Representer.represent_name)
  307. Representer.add_representer(types.BuiltinFunctionType,
  308. Representer.represent_name)
  309. Representer.add_representer(types.ModuleType,
  310. Representer.represent_module)
  311. Representer.add_multi_representer(object,
  312. Representer.represent_object)