representer.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485
  1. # SPDX-License-Identifier: MIT
  2. __all__ = ['BaseRepresenter', 'SafeRepresenter', 'Representer',
  3. 'RepresenterError']
  4. from error import *
  5. from nodes import *
  6. import datetime
  7. import sys, copy_reg, types
  8. class RepresenterError(YAMLError):
  9. pass
  10. class BaseRepresenter(object):
  11. yaml_representers = {}
  12. yaml_multi_representers = {}
  13. def __init__(self, default_style=None, default_flow_style=None):
  14. self.default_style = default_style
  15. self.default_flow_style = default_flow_style
  16. self.represented_objects = {}
  17. self.object_keeper = []
  18. self.alias_key = None
  19. def represent(self, data):
  20. node = self.represent_data(data)
  21. self.serialize(node)
  22. self.represented_objects = {}
  23. self.object_keeper = []
  24. self.alias_key = None
  25. def get_classobj_bases(self, cls):
  26. bases = [cls]
  27. for base in cls.__bases__:
  28. bases.extend(self.get_classobj_bases(base))
  29. return bases
  30. def represent_data(self, data):
  31. if self.ignore_aliases(data):
  32. self.alias_key = None
  33. else:
  34. self.alias_key = id(data)
  35. if self.alias_key is not None:
  36. if self.alias_key in self.represented_objects:
  37. node = self.represented_objects[self.alias_key]
  38. #if node is None:
  39. # raise RepresenterError("recursive objects are not allowed: %r" % data)
  40. return node
  41. #self.represented_objects[alias_key] = None
  42. self.object_keeper.append(data)
  43. data_types = type(data).__mro__
  44. if type(data) is types.InstanceType:
  45. data_types = self.get_classobj_bases(data.__class__)+list(data_types)
  46. if data_types[0] in self.yaml_representers:
  47. node = self.yaml_representers[data_types[0]](self, data)
  48. else:
  49. for data_type in data_types:
  50. if data_type in self.yaml_multi_representers:
  51. node = self.yaml_multi_representers[data_type](self, data)
  52. break
  53. else:
  54. if None in self.yaml_multi_representers:
  55. node = self.yaml_multi_representers[None](self, data)
  56. elif None in self.yaml_representers:
  57. node = self.yaml_representers[None](self, data)
  58. else:
  59. node = ScalarNode(None, unicode(data))
  60. #if alias_key is not None:
  61. # self.represented_objects[alias_key] = node
  62. return node
  63. def add_representer(cls, data_type, representer):
  64. if not 'yaml_representers' in cls.__dict__:
  65. cls.yaml_representers = cls.yaml_representers.copy()
  66. cls.yaml_representers[data_type] = representer
  67. add_representer = classmethod(add_representer)
  68. def add_multi_representer(cls, data_type, representer):
  69. if not 'yaml_multi_representers' in cls.__dict__:
  70. cls.yaml_multi_representers = cls.yaml_multi_representers.copy()
  71. cls.yaml_multi_representers[data_type] = representer
  72. add_multi_representer = classmethod(add_multi_representer)
  73. def represent_scalar(self, tag, value, style=None):
  74. if style is None:
  75. style = self.default_style
  76. node = ScalarNode(tag, value, style=style)
  77. if self.alias_key is not None:
  78. self.represented_objects[self.alias_key] = node
  79. return node
  80. def represent_sequence(self, tag, sequence, flow_style=None):
  81. value = []
  82. node = SequenceNode(tag, value, flow_style=flow_style)
  83. if self.alias_key is not None:
  84. self.represented_objects[self.alias_key] = node
  85. best_style = True
  86. for item in sequence:
  87. node_item = self.represent_data(item)
  88. if not (isinstance(node_item, ScalarNode) and not node_item.style):
  89. best_style = False
  90. value.append(node_item)
  91. if flow_style is None:
  92. if self.default_flow_style is not None:
  93. node.flow_style = self.default_flow_style
  94. else:
  95. node.flow_style = best_style
  96. return node
  97. def represent_mapping(self, tag, mapping, flow_style=None):
  98. value = []
  99. node = MappingNode(tag, value, flow_style=flow_style)
  100. if self.alias_key is not None:
  101. self.represented_objects[self.alias_key] = node
  102. best_style = True
  103. if hasattr(mapping, 'items'):
  104. mapping = mapping.items()
  105. mapping.sort()
  106. for item_key, item_value in mapping:
  107. node_key = self.represent_data(item_key)
  108. node_value = self.represent_data(item_value)
  109. if not (isinstance(node_key, ScalarNode) and not node_key.style):
  110. best_style = False
  111. if not (isinstance(node_value, ScalarNode) and not node_value.style):
  112. best_style = False
  113. value.append((node_key, node_value))
  114. if flow_style is None:
  115. if self.default_flow_style is not None:
  116. node.flow_style = self.default_flow_style
  117. else:
  118. node.flow_style = best_style
  119. return node
  120. def ignore_aliases(self, data):
  121. return False
  122. class SafeRepresenter(BaseRepresenter):
  123. def ignore_aliases(self, data):
  124. if data in [None, ()]:
  125. return True
  126. if isinstance(data, (str, unicode, bool, int, float)):
  127. return True
  128. def represent_none(self, data):
  129. return self.represent_scalar(u'tag:yaml.org,2002:null',
  130. u'null')
  131. def represent_str(self, data):
  132. tag = None
  133. style = None
  134. try:
  135. data = unicode(data, 'ascii')
  136. tag = u'tag:yaml.org,2002:str'
  137. except UnicodeDecodeError:
  138. try:
  139. data = unicode(data, 'utf-8')
  140. tag = u'tag:yaml.org,2002:str'
  141. except UnicodeDecodeError:
  142. data = data.encode('base64')
  143. tag = u'tag:yaml.org,2002:binary'
  144. style = '|'
  145. return self.represent_scalar(tag, data, style=style)
  146. def represent_unicode(self, data):
  147. return self.represent_scalar(u'tag:yaml.org,2002:str', data)
  148. def represent_bool(self, data):
  149. if data:
  150. value = u'true'
  151. else:
  152. value = u'false'
  153. return self.represent_scalar(u'tag:yaml.org,2002:bool', value)
  154. def represent_int(self, data):
  155. return self.represent_scalar(u'tag:yaml.org,2002:int', unicode(data))
  156. def represent_long(self, data):
  157. return self.represent_scalar(u'tag:yaml.org,2002:int', unicode(data))
  158. inf_value = 1e300
  159. while repr(inf_value) != repr(inf_value*inf_value):
  160. inf_value *= inf_value
  161. def represent_float(self, data):
  162. if data != data or (data == 0.0 and data == 1.0):
  163. value = u'.nan'
  164. elif data == self.inf_value:
  165. value = u'.inf'
  166. elif data == -self.inf_value:
  167. value = u'-.inf'
  168. else:
  169. value = unicode(repr(data)).lower()
  170. # Note that in some cases `repr(data)` represents a float number
  171. # without the decimal parts. For instance:
  172. # >>> repr(1e17)
  173. # '1e17'
  174. # Unfortunately, this is not a valid float representation according
  175. # to the definition of the `!!float` tag. We fix this by adding
  176. # '.0' before the 'e' symbol.
  177. if u'.' not in value and u'e' in value:
  178. value = value.replace(u'e', u'.0e', 1)
  179. return self.represent_scalar(u'tag:yaml.org,2002:float', value)
  180. def represent_list(self, data):
  181. #pairs = (len(data) > 0 and isinstance(data, list))
  182. #if pairs:
  183. # for item in data:
  184. # if not isinstance(item, tuple) or len(item) != 2:
  185. # pairs = False
  186. # break
  187. #if not pairs:
  188. return self.represent_sequence(u'tag:yaml.org,2002:seq', data)
  189. #value = []
  190. #for item_key, item_value in data:
  191. # value.append(self.represent_mapping(u'tag:yaml.org,2002:map',
  192. # [(item_key, item_value)]))
  193. #return SequenceNode(u'tag:yaml.org,2002:pairs', value)
  194. def represent_dict(self, data):
  195. return self.represent_mapping(u'tag:yaml.org,2002:map', data)
  196. def represent_set(self, data):
  197. value = {}
  198. for key in data:
  199. value[key] = None
  200. return self.represent_mapping(u'tag:yaml.org,2002:set', value)
  201. def represent_date(self, data):
  202. value = unicode(data.isoformat())
  203. return self.represent_scalar(u'tag:yaml.org,2002:timestamp', value)
  204. def represent_datetime(self, data):
  205. value = unicode(data.isoformat(' '))
  206. return self.represent_scalar(u'tag:yaml.org,2002:timestamp', value)
  207. def represent_yaml_object(self, tag, data, cls, flow_style=None):
  208. if hasattr(data, '__getstate__'):
  209. state = data.__getstate__()
  210. else:
  211. state = data.__dict__.copy()
  212. return self.represent_mapping(tag, state, flow_style=flow_style)
  213. def represent_undefined(self, data):
  214. raise RepresenterError("cannot represent an object: %s" % data)
  215. SafeRepresenter.add_representer(type(None),
  216. SafeRepresenter.represent_none)
  217. SafeRepresenter.add_representer(str,
  218. SafeRepresenter.represent_str)
  219. SafeRepresenter.add_representer(unicode,
  220. SafeRepresenter.represent_unicode)
  221. SafeRepresenter.add_representer(bool,
  222. SafeRepresenter.represent_bool)
  223. SafeRepresenter.add_representer(int,
  224. SafeRepresenter.represent_int)
  225. SafeRepresenter.add_representer(long,
  226. SafeRepresenter.represent_long)
  227. SafeRepresenter.add_representer(float,
  228. SafeRepresenter.represent_float)
  229. SafeRepresenter.add_representer(list,
  230. SafeRepresenter.represent_list)
  231. SafeRepresenter.add_representer(tuple,
  232. SafeRepresenter.represent_list)
  233. SafeRepresenter.add_representer(dict,
  234. SafeRepresenter.represent_dict)
  235. SafeRepresenter.add_representer(set,
  236. SafeRepresenter.represent_set)
  237. SafeRepresenter.add_representer(datetime.date,
  238. SafeRepresenter.represent_date)
  239. SafeRepresenter.add_representer(datetime.datetime,
  240. SafeRepresenter.represent_datetime)
  241. SafeRepresenter.add_representer(None,
  242. SafeRepresenter.represent_undefined)
  243. class Representer(SafeRepresenter):
  244. def represent_str(self, data):
  245. tag = None
  246. style = None
  247. try:
  248. data = unicode(data, 'ascii')
  249. tag = u'tag:yaml.org,2002:str'
  250. except UnicodeDecodeError:
  251. try:
  252. data = unicode(data, 'utf-8')
  253. tag = u'tag:yaml.org,2002:python/str'
  254. except UnicodeDecodeError:
  255. data = data.encode('base64')
  256. tag = u'tag:yaml.org,2002:binary'
  257. style = '|'
  258. return self.represent_scalar(tag, data, style=style)
  259. def represent_unicode(self, data):
  260. tag = None
  261. try:
  262. data.encode('ascii')
  263. tag = u'tag:yaml.org,2002:python/unicode'
  264. except UnicodeEncodeError:
  265. tag = u'tag:yaml.org,2002:str'
  266. return self.represent_scalar(tag, data)
  267. def represent_long(self, data):
  268. tag = u'tag:yaml.org,2002:int'
  269. if int(data) is not data:
  270. tag = u'tag:yaml.org,2002:python/long'
  271. return self.represent_scalar(tag, unicode(data))
  272. def represent_complex(self, data):
  273. if data.imag == 0.0:
  274. data = u'%r' % data.real
  275. elif data.real == 0.0:
  276. data = u'%rj' % data.imag
  277. elif data.imag > 0:
  278. data = u'%r+%rj' % (data.real, data.imag)
  279. else:
  280. data = u'%r%rj' % (data.real, data.imag)
  281. return self.represent_scalar(u'tag:yaml.org,2002:python/complex', data)
  282. def represent_tuple(self, data):
  283. return self.represent_sequence(u'tag:yaml.org,2002:python/tuple', data)
  284. def represent_name(self, data):
  285. name = u'%s.%s' % (data.__module__, data.__name__)
  286. return self.represent_scalar(u'tag:yaml.org,2002:python/name:'+name, u'')
  287. def represent_module(self, data):
  288. return self.represent_scalar(
  289. u'tag:yaml.org,2002:python/module:'+data.__name__, u'')
  290. def represent_instance(self, data):
  291. # For instances of classic classes, we use __getinitargs__ and
  292. # __getstate__ to serialize the data.
  293. # If data.__getinitargs__ exists, the object must be reconstructed by
  294. # calling cls(**args), where args is a tuple returned by
  295. # __getinitargs__. Otherwise, the cls.__init__ method should never be
  296. # called and the class instance is created by instantiating a trivial
  297. # class and assigning to the instance's __class__ variable.
  298. # If data.__getstate__ exists, it returns the state of the object.
  299. # Otherwise, the state of the object is data.__dict__.
  300. # We produce either a !!python/object or !!python/object/new node.
  301. # If data.__getinitargs__ does not exist and state is a dictionary, we
  302. # produce a !!python/object node . Otherwise we produce a
  303. # !!python/object/new node.
  304. cls = data.__class__
  305. class_name = u'%s.%s' % (cls.__module__, cls.__name__)
  306. args = None
  307. state = None
  308. if hasattr(data, '__getinitargs__'):
  309. args = list(data.__getinitargs__())
  310. if hasattr(data, '__getstate__'):
  311. state = data.__getstate__()
  312. else:
  313. state = data.__dict__
  314. if args is None and isinstance(state, dict):
  315. return self.represent_mapping(
  316. u'tag:yaml.org,2002:python/object:'+class_name, state)
  317. if isinstance(state, dict) and not state:
  318. return self.represent_sequence(
  319. u'tag:yaml.org,2002:python/object/new:'+class_name, args)
  320. value = {}
  321. if args:
  322. value['args'] = args
  323. value['state'] = state
  324. return self.represent_mapping(
  325. u'tag:yaml.org,2002:python/object/new:'+class_name, value)
  326. def represent_object(self, data):
  327. # We use __reduce__ API to save the data. data.__reduce__ returns
  328. # a tuple of length 2-5:
  329. # (function, args, state, listitems, dictitems)
  330. # For reconstructing, we calls function(*args), then set its state,
  331. # listitems, and dictitems if they are not None.
  332. # A special case is when function.__name__ == '__newobj__'. In this
  333. # case we create the object with args[0].__new__(*args).
  334. # Another special case is when __reduce__ returns a string - we don't
  335. # support it.
  336. # We produce a !!python/object, !!python/object/new or
  337. # !!python/object/apply node.
  338. cls = type(data)
  339. if cls in copy_reg.dispatch_table:
  340. reduce = copy_reg.dispatch_table[cls](data)
  341. elif hasattr(data, '__reduce_ex__'):
  342. reduce = data.__reduce_ex__(2)
  343. elif hasattr(data, '__reduce__'):
  344. reduce = data.__reduce__()
  345. else:
  346. raise RepresenterError("cannot represent object: %r" % data)
  347. reduce = (list(reduce)+[None]*5)[:5]
  348. function, args, state, listitems, dictitems = reduce
  349. args = list(args)
  350. if state is None:
  351. state = {}
  352. if listitems is not None:
  353. listitems = list(listitems)
  354. if dictitems is not None:
  355. dictitems = dict(dictitems)
  356. if function.__name__ == '__newobj__':
  357. function = args[0]
  358. args = args[1:]
  359. tag = u'tag:yaml.org,2002:python/object/new:'
  360. newobj = True
  361. else:
  362. tag = u'tag:yaml.org,2002:python/object/apply:'
  363. newobj = False
  364. function_name = u'%s.%s' % (function.__module__, function.__name__)
  365. if not args and not listitems and not dictitems \
  366. and isinstance(state, dict) and newobj:
  367. return self.represent_mapping(
  368. u'tag:yaml.org,2002:python/object:'+function_name, state)
  369. if not listitems and not dictitems \
  370. and isinstance(state, dict) and not state:
  371. return self.represent_sequence(tag+function_name, args)
  372. value = {}
  373. if args:
  374. value['args'] = args
  375. if state or not isinstance(state, dict):
  376. value['state'] = state
  377. if listitems:
  378. value['listitems'] = listitems
  379. if dictitems:
  380. value['dictitems'] = dictitems
  381. return self.represent_mapping(tag+function_name, value)
  382. Representer.add_representer(str,
  383. Representer.represent_str)
  384. Representer.add_representer(unicode,
  385. Representer.represent_unicode)
  386. Representer.add_representer(long,
  387. Representer.represent_long)
  388. Representer.add_representer(complex,
  389. Representer.represent_complex)
  390. Representer.add_representer(tuple,
  391. Representer.represent_tuple)
  392. Representer.add_representer(type,
  393. Representer.represent_name)
  394. Representer.add_representer(types.ClassType,
  395. Representer.represent_name)
  396. Representer.add_representer(types.FunctionType,
  397. Representer.represent_name)
  398. Representer.add_representer(types.BuiltinFunctionType,
  399. Representer.represent_name)
  400. Representer.add_representer(types.ModuleType,
  401. Representer.represent_module)
  402. Representer.add_multi_representer(types.InstanceType,
  403. Representer.represent_instance)
  404. Representer.add_multi_representer(object,
  405. Representer.represent_object)