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.
 
 
 
 

393 lines
15 KiB

  1. from __future__ import annotations
  2. import re
  3. if False: # MYPY
  4. from typing import Any, Dict, List, Union, Text, Optional # NOQA
  5. from ruamel.yaml.compat import VersionType # NOQA
  6. from ruamel.yaml.tag import Tag
  7. from ruamel.yaml.compat import _DEFAULT_YAML_VERSION # NOQA
  8. from ruamel.yaml.error import * # NOQA
  9. from ruamel.yaml.nodes import MappingNode, ScalarNode, SequenceNode # NOQA
  10. from ruamel.yaml.util import RegExp # NOQA
  11. __all__ = ['BaseResolver', 'Resolver', 'VersionedResolver']
  12. # fmt: off
  13. # resolvers consist of
  14. # - a list of applicable version
  15. # - a tag
  16. # - a regexp
  17. # - a list of first characters to match
  18. implicit_resolvers = [
  19. ([(1, 2)],
  20. 'tag:yaml.org,2002:bool',
  21. RegExp('''^(?:true|True|TRUE|false|False|FALSE)$''', re.X),
  22. list('tTfF')),
  23. ([(1, 1)],
  24. 'tag:yaml.org,2002:bool',
  25. RegExp('''^(?:y|Y|yes|Yes|YES|n|N|no|No|NO
  26. |true|True|TRUE|false|False|FALSE
  27. |on|On|ON|off|Off|OFF)$''', re.X),
  28. list('yYnNtTfFoO')),
  29. ([(1, 2)],
  30. 'tag:yaml.org,2002:float',
  31. RegExp('''^(?:
  32. [-+]?(?:[0-9][0-9_]*)\\.[0-9_]*(?:[eE][-+]?[0-9]+)?
  33. |[-+]?(?:[0-9][0-9_]*)(?:[eE][-+]?[0-9]+)
  34. |[-+]?\\.[0-9_]+(?:[eE][-+][0-9]+)?
  35. |[-+]?\\.(?:inf|Inf|INF)
  36. |\\.(?:nan|NaN|NAN))$''', re.X),
  37. list('-+0123456789.')),
  38. ([(1, 1)],
  39. 'tag:yaml.org,2002:float',
  40. RegExp('''^(?:
  41. [-+]?(?:[0-9][0-9_]*)\\.[0-9_]*(?:[eE][-+]?[0-9]+)?
  42. |[-+]?(?:[0-9][0-9_]*)(?:[eE][-+]?[0-9]+)
  43. |\\.[0-9_]+(?:[eE][-+][0-9]+)?
  44. |[-+]?[0-9][0-9_]*(?::[0-5]?[0-9])+\\.[0-9_]* # sexagesimal float
  45. |[-+]?\\.(?:inf|Inf|INF)
  46. |\\.(?:nan|NaN|NAN))$''', re.X),
  47. list('-+0123456789.')),
  48. ([(1, 2)],
  49. 'tag:yaml.org,2002:int',
  50. RegExp('''^(?:[-+]?0b[0-1_]+
  51. |[-+]?0o?[0-7_]+
  52. |[-+]?[0-9_]+
  53. |[-+]?0x[0-9a-fA-F_]+)$''', re.X),
  54. list('-+0123456789')),
  55. ([(1, 1)],
  56. 'tag:yaml.org,2002:int',
  57. RegExp('''^(?:[-+]?0b[0-1_]+
  58. |[-+]?0?[0-7_]+
  59. |[-+]?(?:0|[1-9][0-9_]*)
  60. |[-+]?0x[0-9a-fA-F_]+
  61. |[-+]?[1-9][0-9_]*(?::[0-5]?[0-9])+)$''', re.X), # sexagesimal int
  62. list('-+0123456789')),
  63. ([(1, 2), (1, 1)],
  64. 'tag:yaml.org,2002:merge',
  65. RegExp('^(?:<<)$'),
  66. ['<']),
  67. ([(1, 2), (1, 1)],
  68. 'tag:yaml.org,2002:null',
  69. RegExp('''^(?: ~
  70. |null|Null|NULL
  71. | )$''', re.X),
  72. ['~', 'n', 'N', '']),
  73. ([(1, 2), (1, 1)],
  74. 'tag:yaml.org,2002:timestamp',
  75. RegExp('''^(?:[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]
  76. |[0-9][0-9][0-9][0-9] -[0-9][0-9]? -[0-9][0-9]?
  77. (?:[Tt]|[ \\t]+)[0-9][0-9]?
  78. :[0-9][0-9] :[0-9][0-9] (?:\\.[0-9]*)?
  79. (?:[ \\t]*(?:Z|[-+][0-9][0-9]?(?::[0-9][0-9])?))?)$''', re.X),
  80. list('0123456789')),
  81. ([(1, 2), (1, 1)],
  82. 'tag:yaml.org,2002:value',
  83. RegExp('^(?:=)$'),
  84. ['=']),
  85. # The following resolver is only for documentation purposes. It cannot work
  86. # because plain scalars cannot start with '!', '&', or '*'.
  87. ([(1, 2), (1, 1)],
  88. 'tag:yaml.org,2002:yaml',
  89. RegExp('^(?:!|&|\\*)$'),
  90. list('!&*')),
  91. ]
  92. # fmt: on
  93. class ResolverError(YAMLError):
  94. pass
  95. class BaseResolver:
  96. DEFAULT_SCALAR_TAG = Tag(suffix='tag:yaml.org,2002:str')
  97. DEFAULT_SEQUENCE_TAG = Tag(suffix='tag:yaml.org,2002:seq')
  98. DEFAULT_MAPPING_TAG = Tag(suffix='tag:yaml.org,2002:map')
  99. yaml_implicit_resolvers: Dict[Any, Any] = {}
  100. yaml_path_resolvers: Dict[Any, Any] = {}
  101. def __init__(self: Any, loadumper: Any = None) -> None:
  102. self.loadumper = loadumper
  103. if self.loadumper is not None and getattr(self.loadumper, '_resolver', None) is None:
  104. self.loadumper._resolver = self.loadumper
  105. self._loader_version: Any = None
  106. self.resolver_exact_paths: List[Any] = []
  107. self.resolver_prefix_paths: List[Any] = []
  108. @property
  109. def parser(self) -> Any:
  110. if self.loadumper is not None:
  111. if hasattr(self.loadumper, 'typ'):
  112. return self.loadumper.parser
  113. return self.loadumper._parser
  114. return None
  115. @classmethod
  116. def add_implicit_resolver_base(cls, tag: Any, regexp: Any, first: Any) -> None:
  117. if 'yaml_implicit_resolvers' not in cls.__dict__:
  118. # deepcopy doesn't work here
  119. cls.yaml_implicit_resolvers = {
  120. k: cls.yaml_implicit_resolvers[k][:] for k in cls.yaml_implicit_resolvers
  121. }
  122. if first is None:
  123. first = [None]
  124. for ch in first:
  125. cls.yaml_implicit_resolvers.setdefault(ch, []).append((tag, regexp))
  126. @classmethod
  127. def add_implicit_resolver(cls, tag: Any, regexp: Any, first: Any) -> None:
  128. if 'yaml_implicit_resolvers' not in cls.__dict__:
  129. # deepcopy doesn't work here
  130. cls.yaml_implicit_resolvers = {
  131. k: cls.yaml_implicit_resolvers[k][:] for k in cls.yaml_implicit_resolvers
  132. }
  133. if first is None:
  134. first = [None]
  135. for ch in first:
  136. cls.yaml_implicit_resolvers.setdefault(ch, []).append((tag, regexp))
  137. implicit_resolvers.append(([(1, 2), (1, 1)], tag, regexp, first))
  138. # @classmethod
  139. # def add_implicit_resolver(cls, tag, regexp, first):
  140. @classmethod
  141. def add_path_resolver(cls, tag: Any, path: Any, kind: Any = None) -> None:
  142. # Note: `add_path_resolver` is experimental. The API could be changed.
  143. # `new_path` is a pattern that is matched against the path from the
  144. # root to the node that is being considered. `node_path` elements are
  145. # tuples `(node_check, index_check)`. `node_check` is a node class:
  146. # `ScalarNode`, `SequenceNode`, `MappingNode` or `None`. `None`
  147. # matches any kind of a node. `index_check` could be `None`, a boolean
  148. # value, a string value, or a number. `None` and `False` match against
  149. # any _value_ of sequence and mapping nodes. `True` matches against
  150. # any _key_ of a mapping node. A string `index_check` matches against
  151. # a mapping value that corresponds to a scalar key which content is
  152. # equal to the `index_check` value. An integer `index_check` matches
  153. # against a sequence value with the index equal to `index_check`.
  154. if 'yaml_path_resolvers' not in cls.__dict__:
  155. cls.yaml_path_resolvers = cls.yaml_path_resolvers.copy()
  156. new_path: List[Any] = []
  157. for element in path:
  158. if isinstance(element, (list, tuple)):
  159. if len(element) == 2:
  160. node_check, index_check = element
  161. elif len(element) == 1:
  162. node_check = element[0]
  163. index_check = True
  164. else:
  165. raise ResolverError(f'Invalid path element: {element!s}')
  166. else:
  167. node_check = None
  168. index_check = element
  169. if node_check is str:
  170. node_check = ScalarNode
  171. elif node_check is list:
  172. node_check = SequenceNode
  173. elif node_check is dict:
  174. node_check = MappingNode
  175. elif (
  176. node_check not in [ScalarNode, SequenceNode, MappingNode]
  177. and not isinstance(node_check, str)
  178. and node_check is not None
  179. ):
  180. raise ResolverError(f'Invalid node checker: {node_check!s}')
  181. if not isinstance(index_check, (str, int)) and index_check is not None:
  182. raise ResolverError(f'Invalid index checker: {index_check!s}')
  183. new_path.append((node_check, index_check))
  184. if kind is str:
  185. kind = ScalarNode
  186. elif kind is list:
  187. kind = SequenceNode
  188. elif kind is dict:
  189. kind = MappingNode
  190. elif kind not in [ScalarNode, SequenceNode, MappingNode] and kind is not None:
  191. raise ResolverError(f'Invalid node kind: {kind!s}')
  192. cls.yaml_path_resolvers[tuple(new_path), kind] = tag
  193. def descend_resolver(self, current_node: Any, current_index: Any) -> None:
  194. if not self.yaml_path_resolvers:
  195. return
  196. exact_paths = {}
  197. prefix_paths = []
  198. if current_node:
  199. depth = len(self.resolver_prefix_paths)
  200. for path, kind in self.resolver_prefix_paths[-1]:
  201. if self.check_resolver_prefix(depth, path, kind, current_node, current_index):
  202. if len(path) > depth:
  203. prefix_paths.append((path, kind))
  204. else:
  205. exact_paths[kind] = self.yaml_path_resolvers[path, kind]
  206. else:
  207. for path, kind in self.yaml_path_resolvers:
  208. if not path:
  209. exact_paths[kind] = self.yaml_path_resolvers[path, kind]
  210. else:
  211. prefix_paths.append((path, kind))
  212. self.resolver_exact_paths.append(exact_paths)
  213. self.resolver_prefix_paths.append(prefix_paths)
  214. def ascend_resolver(self) -> None:
  215. if not self.yaml_path_resolvers:
  216. return
  217. self.resolver_exact_paths.pop()
  218. self.resolver_prefix_paths.pop()
  219. def check_resolver_prefix(
  220. self, depth: int, path: Any, kind: Any, current_node: Any, current_index: Any,
  221. ) -> bool:
  222. node_check, index_check = path[depth - 1]
  223. if isinstance(node_check, str):
  224. if current_node.tag != node_check:
  225. return False
  226. elif node_check is not None:
  227. if not isinstance(current_node, node_check):
  228. return False
  229. if index_check is True and current_index is not None:
  230. return False
  231. if (index_check is False or index_check is None) and current_index is None:
  232. return False
  233. if isinstance(index_check, str):
  234. if not (
  235. isinstance(current_index, ScalarNode) and index_check == current_index.value
  236. ):
  237. return False
  238. elif isinstance(index_check, int) and not isinstance(index_check, bool):
  239. if index_check != current_index:
  240. return False
  241. return True
  242. def resolve(self, kind: Any, value: Any, implicit: Any) -> Any:
  243. if kind is ScalarNode and implicit[0]:
  244. if value == "":
  245. resolvers = self.yaml_implicit_resolvers.get("", [])
  246. else:
  247. resolvers = self.yaml_implicit_resolvers.get(value[0], [])
  248. resolvers += self.yaml_implicit_resolvers.get(None, [])
  249. for tag, regexp in resolvers:
  250. if regexp.match(value):
  251. return Tag(suffix=tag)
  252. implicit = implicit[1]
  253. if bool(self.yaml_path_resolvers):
  254. exact_paths = self.resolver_exact_paths[-1]
  255. if kind in exact_paths:
  256. return Tag(suffix=exact_paths[kind])
  257. if None in exact_paths:
  258. return Tag(suffix=exact_paths[None])
  259. if kind is ScalarNode:
  260. return self.DEFAULT_SCALAR_TAG
  261. elif kind is SequenceNode:
  262. return self.DEFAULT_SEQUENCE_TAG
  263. elif kind is MappingNode:
  264. return self.DEFAULT_MAPPING_TAG
  265. @property
  266. def processing_version(self) -> Any:
  267. return None
  268. class Resolver(BaseResolver):
  269. pass
  270. for ir in implicit_resolvers:
  271. if (1, 2) in ir[0]:
  272. Resolver.add_implicit_resolver_base(*ir[1:])
  273. class VersionedResolver(BaseResolver):
  274. """
  275. contrary to the "normal" resolver, the smart resolver delays loading
  276. the pattern matching rules. That way it can decide to load 1.1 rules
  277. or the (default) 1.2 rules, that no longer support octal without 0o, sexagesimals
  278. and Yes/No/On/Off booleans.
  279. """
  280. def __init__(
  281. self, version: Optional[VersionType] = None, loader: Any = None, loadumper: Any = None,
  282. ) -> None:
  283. if loader is None and loadumper is not None:
  284. loader = loadumper
  285. BaseResolver.__init__(self, loader)
  286. self._loader_version = self.get_loader_version(version)
  287. self._version_implicit_resolver: Dict[Any, Any] = {}
  288. def add_version_implicit_resolver(
  289. self, version: VersionType, tag: Any, regexp: Any, first: Any,
  290. ) -> None:
  291. if first is None:
  292. first = [None]
  293. impl_resolver = self._version_implicit_resolver.setdefault(version, {})
  294. for ch in first:
  295. impl_resolver.setdefault(ch, []).append((tag, regexp))
  296. def get_loader_version(self, version: Optional[VersionType]) -> Any:
  297. if version is None or isinstance(version, tuple):
  298. return version
  299. if isinstance(version, list):
  300. return tuple(version)
  301. # assume string
  302. assert isinstance(version, str)
  303. return tuple(map(int, version.split('.')))
  304. @property
  305. def versioned_resolver(self) -> Any:
  306. """
  307. select the resolver based on the version we are parsing
  308. """
  309. version = self.processing_version
  310. if isinstance(version, str):
  311. version = tuple(map(int, version.split('.')))
  312. if version not in self._version_implicit_resolver:
  313. for x in implicit_resolvers:
  314. if version in x[0]:
  315. self.add_version_implicit_resolver(version, x[1], x[2], x[3])
  316. return self._version_implicit_resolver[version]
  317. def resolve(self, kind: Any, value: Any, implicit: Any) -> Any:
  318. if kind is ScalarNode and implicit[0]:
  319. if value == "":
  320. resolvers = self.versioned_resolver.get("", [])
  321. else:
  322. resolvers = self.versioned_resolver.get(value[0], [])
  323. resolvers += self.versioned_resolver.get(None, [])
  324. for tag, regexp in resolvers:
  325. if regexp.match(value):
  326. return Tag(suffix=tag)
  327. implicit = implicit[1]
  328. if bool(self.yaml_path_resolvers):
  329. exact_paths = self.resolver_exact_paths[-1]
  330. if kind in exact_paths:
  331. return Tag(suffix=exact_paths[kind])
  332. if None in exact_paths:
  333. return Tag(suffix=exact_paths[None])
  334. if kind is ScalarNode:
  335. return self.DEFAULT_SCALAR_TAG
  336. elif kind is SequenceNode:
  337. return self.DEFAULT_SEQUENCE_TAG
  338. elif kind is MappingNode:
  339. return self.DEFAULT_MAPPING_TAG
  340. @property
  341. def processing_version(self) -> Any:
  342. try:
  343. version = self.loadumper._scanner.yaml_version
  344. except AttributeError:
  345. try:
  346. if hasattr(self.loadumper, 'typ'):
  347. version = self.loadumper.version
  348. else:
  349. version = self.loadumper._serializer.use_version # dumping
  350. except AttributeError:
  351. version = None
  352. if version is None:
  353. version = self._loader_version
  354. if version is None:
  355. version = _DEFAULT_YAML_VERSION
  356. return version