piecrust2: piecrust/configuration.py annotate

annotate piecrust/configuration.py @ 142:0bdd938d6b9f

Better date/time handling for pages: - Date can be specified in the page config. - Fall back to timestamp 0 (which is fixed) instead of the timestamp of the file (which could vary). Sources can return additional config values to merge with the page's YAML front matter.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sat, 29 Nov 2014 18:33:29 -0800
parents	b540d431f2da
children	f98451237371

rev	line source
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 import re
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	2 import logging
67 563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	3 import collections
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import yaml
67 563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	5 from yaml.constructor import ConstructorError
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	8 logger = logging.getLogger(__name__)
40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	9
40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	10
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	11 class ConfigurationError(Exception):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	12 pass
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	13
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	14
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 class Configuration(object):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 def __init__(self, values=None, validate=True):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17 if values is not None:
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	18 self.setAll(values, validate)
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	19 else:
40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	20 self._values = None
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21
138 b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	22 def __contains__(self, key):
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	23 return self.has(key)
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	24
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	25 def __getitem__(self, key):
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	26 value = self.get(key)
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	27 if value is None:
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	28 raise KeyError()
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	29 return value
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	30
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	31 def __setitem__(self, key, value):
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	32 return self.set(key, value)
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	33
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	34 def setAll(self, values, validate=True):
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35 if validate:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	36 self._validateAll(values)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	37 self._values = values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	39 def getAll(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	40 return self.get()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	41
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 def get(self, key_path=None):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43 self._ensureLoaded()
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44 if key_path is None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	45 return self._values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46 bits = key_path.split('/')
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47 cur = self._values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 for b in bits:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	49 cur = cur.get(b)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 if cur is None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 return None
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 return cur
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	53
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54 def set(self, key_path, value):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	55 self._ensureLoaded()
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	56 value = self._validateValue(key_path, value)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57 bits = key_path.split('/')
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	58 bitslen = len(bits)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	59 cur = self._values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	60 for i, b in enumerate(bits):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	61 if i == bitslen - 1:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	62 cur[b] = value
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	63 else:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64 if b not in cur:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 cur[b] = {}
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 cur = cur[b]
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	67
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	68 def has(self, key_path):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	69 self._ensureLoaded()
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	70 bits = key_path.split('/')
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	71 cur = self._values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	72 for b in bits:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	73 cur = cur.get(b)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	74 if cur is None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	75 return False
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	76 return True
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	77
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	78 def merge(self, other):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	79 self._ensureLoaded()
138 b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	80
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	81 if isinstance(other, dict):
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	82 other_values = other
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	83 elif isinstance(other, Configuration):
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	84 other_values = other._values
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	85 else:
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	86 raise Exception(
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	87 "Unsupported value type to merge: %s" % type(other))
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	88
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	89 merge_dicts(self._values, other_values,
b540d431f2da Make configuration class more like `dict`, add support for merging `dicts`. Ludovic Chabant <ludovic@chabant.com> parents: 107 diff changeset	90 validator=self._validateValue)
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	92 def _ensureLoaded(self):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	93 if self._values is None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94 self._load()
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	95
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	96 def _load(self):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 self._values = self._validateAll({})
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99 def _validateAll(self, values):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 return values
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102 def _validateValue(self, key_path, value):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103 return value
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	105
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	106 def merge_dicts(source, merging, validator=None, *args):
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 if validator is None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108 validator = lambda k, v: v
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	109 _recurse_merge_dicts(source, merging, None, validator)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	110 for other in args:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: 2 diff changeset	111 _recurse_merge_dicts(source, other, None, validator)
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	112
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	113
40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	114 def _recurse_merge_dicts(local_cur, incoming_cur, parent_path, validator):
5 474c9882decf Upgrade to Python 3. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	115 for k, v in incoming_cur.items():
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	116 key_path = k
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	117 if parent_path is not None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	118 key_path = parent_path + '/' + k
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	119
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120 local_v = local_cur.get(k)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 if local_v is not None:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122 if isinstance(v, dict) and isinstance(local_v, dict):
2 40fa08b261b9 Added unit tests (using `py.test`) for `Configuration`. Ludovic Chabant <ludovic@chabant.com> parents: 0 diff changeset	123 _recurse_merge_dicts(local_v, v, key_path, validator)
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124 elif isinstance(v, list) and isinstance(local_v, list):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	125 local_cur[k] = v + local_v
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126 else:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	127 local_cur[k] = validator(key_path, v)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128 else:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	129 local_cur[k] = validator(key_path, v)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	131
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	132 header_regex = re.compile(
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133 r'(---\s\n)(?P<header>(.\n)?)^(---\s\n)', re.MULTILINE)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136 def parse_config_header(text):
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 m = header_regex.match(text)
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138 if m is not None:
5 474c9882decf Upgrade to Python 3. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	139 header = str(m.group('header'))
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	140 config = yaml.load(header, Loader=ConfigurationLoader)
0 a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141 offset = m.end()
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 else:
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 config = {}
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 offset = 0
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 return config, offset
a212a3f2e3ee Initial commit. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146
67 563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	147
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	148 class ConfigurationLoader(yaml.SafeLoader):
67 563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	149 """ A YAML loader that loads mappings into ordered dictionaries.
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	150 """
81 d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	151 def __init__(self, args, *kwargs):
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	152 super(ConfigurationLoader, self).__init__(args, *kwargs)
81 d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	153
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	154 self.add_constructor('tag:yaml.org,2002:map',
81 d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	155 type(self).construct_yaml_map)
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	156 self.add_constructor('tag:yaml.org,2002:omap',
81 d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	157 type(self).construct_yaml_map)
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	158 self.add_constructor('tag:yaml.org,2002:sexagesimal',
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	159 type(self).construct_yaml_time)
81 d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	160
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	161 def construct_yaml_map(self, node):
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	162 data = collections.OrderedDict()
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	163 yield data
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	164 value = self.construct_mapping(node)
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	165 data.update(value)
d64e4703f5e6 Propertly create `OrderedDict`s when loading YAML. Ludovic Chabant <ludovic@chabant.com> parents: 68 diff changeset	166
67 563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	167 def construct_mapping(self, node, deep=False):
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	168 if not isinstance(node, yaml.MappingNode):
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	169 raise ConstructorError(None, None,
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	170 "expected a mapping node, but found %s" % node.id,
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	171 node.start_mark)
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	172 mapping = collections.OrderedDict()
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	173 for key_node, value_node in node.value:
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	174 key = self.construct_object(key_node, deep=deep)
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	175 if not isinstance(key, collections.Hashable):
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	176 raise ConstructorError("while constructing a mapping", node.start_mark,
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	177 "found unhashable key", key_node.start_mark)
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	178 value = self.construct_object(value_node, deep=deep)
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	179 mapping[key] = value
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	180 return mapping
563ce5dd02af I don't care what the YAML spec says, ordered maps are the only sane way. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	181
107 10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	182 time_regexp = re.compile(
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	183 r'''^(?P<hour>[0-9][0-9]?)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	184 :(?P<minute>[0-9][0-9])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	185 (:(?P<second>[0-9][0-9])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	186 (\.(?P<fraction>[0-9]+))?)?$''', re.X)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	187
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	188 def construct_yaml_time(self, node):
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	189 self.construct_scalar(node)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	190 match = self.time_regexp.match(node.value)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	191 values = match.groupdict()
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	192 hour = int(values['hour'])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	193 minute = int(values['minute'])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	194 second = 0
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	195 if values['second']:
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	196 second = int(values['second'])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	197 usec = 0
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	198 if values['fraction']:
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	199 usec = float('0.' + values['fraction'])
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	200 return second + minute * 60 + hour * 60 * 60 + usec
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	201
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	202
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	203 ConfigurationLoader.add_implicit_resolver(
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	204 'tag:yaml.org,2002:sexagesimal',
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	205 re.compile(r'''^[0-9][0-9]?:[0-9][0-9]
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	206 (:[0-9][0-9](\.[0-9]+)?)?$''', re.X),
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	207 list('0123456789'))
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	208
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	209
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	210 # We need to add our `sexagesimal` resolver before the `int` one, which
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	211 # already supports sexagesimal notation in YAML 1.1 (but not 1.2). However,
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	212 # because we know we pretty much always want it for representing time, we
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	213 # need a simple `12:30` to mean 45000, not 750. So that's why we override
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	214 # the default behaviour.
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	215 for ch in list('0123456789'):
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	216 ch_resolvers = ConfigurationLoader.yaml_implicit_resolvers[ch]
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	217 ch_resolvers.insert(0, ch_resolvers.pop())
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	218
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	219
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	220 class ConfigurationDumper(yaml.SafeDumper):
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	221 def represent_ordered_dict(self, data):
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	222 return self.represent_mapping('tag:yaml.org,2002:omap', data)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	223
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	224
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	225 ConfigurationDumper.add_representer(collections.OrderedDict,
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	226 ConfigurationDumper.represent_ordered_dict)
10fc9c8bf682 Better support for times in YAML interop. Ludovic Chabant <ludovic@chabant.com> parents: 81 diff changeset	227

Mercurial > piecrust2

annotate piecrust/configuration.py @ 142:0bdd938d6b9f