piecrust2: piecrust/appconfig.py annotate

annotate piecrust/appconfig.py @ 683:ec384174b8b2

internal: More work/fixes on how default/theme/user configs are merged. Change how the code is organized to have better data flow. Add some tests.

author	Ludovic Chabant <ludovic@chabant.com>
date	Wed, 09 Mar 2016 00:23:51 -0800
parents	894d286b348f
children	1a6c4c2683fd

rev	line source
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 import re
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2 import os.path
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 import copy
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import json
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5 import urllib
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 import logging
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7 import hashlib
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	8 import collections
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 import yaml
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10 from piecrust import (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11 APP_VERSION, CACHE_VERSION,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12 DEFAULT_FORMAT, DEFAULT_TEMPLATE_ENGINE, DEFAULT_POSTS_FS,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13 DEFAULT_DATE_FORMAT, DEFAULT_THEME_SOURCE)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 from piecrust.cache import NullCache
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 from piecrust.configuration import (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 Configuration, ConfigurationError, ConfigurationLoader,
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	17 try_get_dict_value, set_dict_value, merge_dicts, visit_dict)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18 from piecrust.sources.base import REALM_USER, REALM_THEME
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	20
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21 logger = logging.getLogger(__name__)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24 class VariantNotFoundError(Exception):
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	25 def __init__(self, variant_name, message=None):
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 super(VariantNotFoundError, self).__init__(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27 message or ("No such configuration variant: %s" %
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	28 variant_name))
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	29
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	30
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	31 class PieCrustConfiguration(Configuration):
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	32 def __init__(self, *, path=None, theme_path=None, values=None,
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	33 cache=None, validate=True, theme_config=False):
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	34 if theme_config and theme_path:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	35 raise Exception("Can't be a theme site config and still have a "
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	36 "theme applied.")
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	37 super(PieCrustConfiguration, self).__init__()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	38 self._path = path
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	39 self._theme_path = theme_path
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	40 self._cache = cache or NullCache()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	41 self._custom_paths = []
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	42 self._post_fixups = []
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	43 self.theme_config = theme_config
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	44 # Set the values after we set the rest, since our validation needs
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	45 # our attributes.
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	46 if values:
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	47 self.setAll(values, validate=validate)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	49 def addPath(self, p):
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	50 self._ensureNotLoaded()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	51 self._custom_paths.append(p)
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	52
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	53 def addVariant(self, variant_path, raise_if_not_found=True):
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	54 self._ensureNotLoaded()
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	55 if os.path.isfile(variant_path):
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	56 self.addPath(variant_path)
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	57 elif raise_if_not_found:
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	58 logger.error(
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	59 "Configuration variants should now be `.yml` files "
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	60 "located in the `configs/` directory of your website.")
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	61 raise VariantNotFoundError(variant_path)
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	62
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	63
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	64 def addVariantValue(self, path, value):
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	65 def _fixup(config):
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	66 set_dict_value(config, path, value)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	67
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	68 self._post_fixups.append(_fixup)
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	69
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	70 def setAll(self, values, validate=False):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	71 # Override base class implementation
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	72 values = self._combineConfigs({}, values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	73 if validate:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	74 values = self._validateAll(values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	75 self._values = values
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	76
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	77 def _ensureNotLoaded(self):
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	78 if self._values is not None:
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	79 raise Exception("The configurations has been loaded.")
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	80
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	81 def _load(self):
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	82 # Figure out where to load this configuration from.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	83 paths = [self._theme_path, self._path] + self._custom_paths
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	84 paths = list(filter(lambda i: i is not None, paths))
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	85
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	86 # Build the cache-key.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	87 path_times = [os.path.getmtime(p[0]) for p in paths]
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	88 cache_key_hash = hashlib.md5(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	89 ("version=%s&cache=%d" % (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 APP_VERSION, CACHE_VERSION)).encode('utf8'))
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	91 for p in paths:
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	92 cache_key_hash.update(("&path=%s" % p).encode('utf8'))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	93 cache_key = cache_key_hash.hexdigest()
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	95 # Check the cache for a valid version.
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	96 if self._cache.isValid('config.json', path_times):
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 logger.debug("Loading configuration from cache...")
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	98 config_text = self._cache.read('config.json')
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99 self._values = json.loads(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 config_text,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101 object_pairs_hook=collections.OrderedDict)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103 actual_cache_key = self._values.get('__cache_key')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104 if actual_cache_key == cache_key:
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	105 # The cached version has the same key! Awesome!
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106 self._values['__cache_valid'] = True
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 return
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108 logger.debug("Outdated cache key '%s' (expected '%s')." % (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	109 actual_cache_key, cache_key))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	110
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	111 # Nope, load from the paths.
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	112 try:
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	113 # Theme config.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	114 theme_values = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	115 if self._theme_path:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	116 theme_values = self._loadFrom(self._theme_path)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	117
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	118 # Site config.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	119 site_values = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	120 if self._path:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	121 site_values = self._loadFrom(self._path)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	122
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	123 # Combine!
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	124 logger.debug("Processing loaded configurations...")
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	125 values = self._combineConfigs(theme_values, site_values)
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	126
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	127 # Load additional paths.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	128 if self._custom_paths:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	129 logger.debug("Loading %d additional configuration paths." %
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	130 len(self._custom_paths))
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	131 for p in self._custom_paths:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	132 loaded = self._loadFrom(p)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	133 if loaded:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	134 merge_dicts(values, loaded)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	135
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	136 # Run final fixups
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	137 if self._post_fixups:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	138 logger.debug("Applying %d configuration fixups." %
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	139 len(self._post_fixups))
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	140 for f in self._post_fixups:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	141 f(values)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	143 self._values = self._validateAll(values)
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	144 except Exception as ex:
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	145 raise Exception(
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	146 "Error loading configuration from: %s" %
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	147 ', '.join(paths)) from ex
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 logger.debug("Caching configuration...")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 self._values['__cache_key'] = cache_key
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	151 config_text = json.dumps(self._values)
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	152 self._cache.write('config.json', config_text)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154 self._values['__cache_valid'] = False
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	156 def _loadFrom(self, path):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	157 logger.debug("Loading configuration from: %s" % path)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	158 with open(path, 'r', encoding='utf-8') as fp:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	159 values = yaml.load(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	160 fp.read(),
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	161 Loader=ConfigurationLoader)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	162 if values is None:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	163 values = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	164 return values
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	165
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	166 def _combineConfigs(self, theme_values, site_values):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	167 # Start with the default configuration.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	168 values = copy.deepcopy(default_configuration)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	169
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	170 if not self.theme_config:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	171 # If the theme config wants the default model, add it.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	172 theme_sitec = theme_values.setdefault(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	173 'site', collections.OrderedDict())
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	174 gen_default_theme_model = bool(theme_sitec.setdefault(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	175 'use_default_theme_content', True))
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	176 if gen_default_theme_model:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	177 self._generateDefaultThemeModel(values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	178
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	179 # Now override with the actual theme config values.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	180 values = merge_dicts(values, theme_values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	181
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	182 # Make all sources belong to the "theme" realm at this point.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	183 srcc = values['site'].get('sources')
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	184 if srcc:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	185 for sn, sc in srcc.items():
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	186 sc['realm'] = REALM_THEME
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	187
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	188 # If the site config wants the default model, add it.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	189 site_sitec = site_values.setdefault(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	190 'site', collections.OrderedDict())
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	191 gen_default_site_model = bool(site_sitec.setdefault(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	192 'use_default_content', True))
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	193 if gen_default_site_model:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	194 self._generateDefaultSiteModel(values, site_values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	195
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	196 # And override with the actual site config values.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	197 values = merge_dicts(values, site_values)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	198
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	199 # Set the theme site flag.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	200 if self.theme_config:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	201 values['site']['theme_site'] = True
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	202
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	203 return values
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	204
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	205 def _validateAll(self, values):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	206 if values is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	207 values = {}
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	208
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	209 # Add a section for our cached information, and start visiting
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	210 # the configuration tree, calling validation functions as we
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	211 # find them.
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	212 cachec = collections.OrderedDict()
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	213 values['__cache'] = cachec
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	214 cache_writer = _ConfigCacheWriter(cachec)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	215 globs = globals()
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	216
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	217 def _visitor(path, val, parent_val, parent_key):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	218 callback_name = '_validate_' + path.replace('/', '_')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	219 callback = globs.get(callback_name)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	220 if callback:
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	221 try:
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	222 val2 = callback(val, values, cache_writer)
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	223 except Exception as ex:
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	224 raise Exception("Error raised in validator '%s'." %
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	225 callback_name) from ex
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	226 if val2 is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	227 raise Exception("Validator '%s' isn't returning a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	228 "coerced value." % callback_name)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	229 parent_val[parent_key] = val2
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	230
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	231 visit_dict(values, _visitor)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	232
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	233 return values
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	234
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	235 def _generateDefaultThemeModel(self, values):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	236 logger.debug("Generating default theme content model...")
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	237 cc = copy.deepcopy(default_theme_content_model_base)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	238 merge_dicts(values, cc)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	239
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	240 def _generateDefaultSiteModel(self, values, user_overrides):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	241 logger.debug("Generating default content model...")
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	242 cc = copy.deepcopy(default_content_model_base)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	243 merge_dicts(values, cc)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	244
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	245 dcm = get_default_content_model(values, user_overrides)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	246 merge_dicts(values, dcm)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	248 blogsc = try_get_dict_value(user_overrides, 'site/blogs')
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	249 if blogsc is None:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	250 blogsc = ['posts']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	251 set_dict_value(user_overrides, 'site/blogs', blogsc)
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	252
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	253 is_only_blog = (len(blogsc) == 1)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	254 for blog_name in blogsc:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	255 blog_cfg = get_default_content_model_for_blog(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	256 blog_name, is_only_blog, values, user_overrides,
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	257 theme_site=self.theme_config)
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	258 merge_dicts(values, blog_cfg)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	259
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	260
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	261 class _ConfigCacheWriter(object):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	262 def __init__(self, cache_dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	263 self._cache_dict = cache_dict
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	264
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	265 def write(self, name, val):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	266 logger.debug("Caching configuration item '%s' = %s" % (name, val))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	267 self._cache_dict[name] = val
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	268
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	269
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	270 default_theme_content_model_base = collections.OrderedDict({
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	271 'site': collections.OrderedDict({
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	272 'sources': collections.OrderedDict({
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	273 'theme_pages': {
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	274 'type': 'default',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	275 'ignore_missing_dir': True,
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	276 'fs_endpoint': 'pages',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	277 'data_endpoint': 'site.pages',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	278 'default_layout': 'default',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	279 'item_name': 'page',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	280 'realm': REALM_THEME
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	281 }
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	282 }),
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	283 'routes': [
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	284 {
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	285 'url': '/%path:slug%',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	286 'source': 'theme_pages',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	287 'func': 'pcurl(slug)'
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	288 }
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	289 ],
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	290 'theme_tag_page': 'theme_pages:_tag.%ext%',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	291 'theme_category_page': 'theme_pages:_category.%ext%'
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	292 })
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	293 })
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	294
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	295
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	296 default_configuration = collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	297 'site': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	298 'title': "Untitled PieCrust website",
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	299 'root': '/',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	300 'default_format': DEFAULT_FORMAT,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	301 'default_template_engine': DEFAULT_TEMPLATE_ENGINE,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	302 'enable_gzip': True,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	303 'pretty_urls': False,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	304 'trailing_slash': False,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	305 'date_format': DEFAULT_DATE_FORMAT,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306 'auto_formats': collections.OrderedDict([
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307 ('html', ''),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	308 ('md', 'markdown'),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	309 ('textile', 'textile')]),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	310 'default_auto_format': 'md',
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	311 'default_pagination_source': None,
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	312 'pagination_suffix': '/%num%',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	313 'slugify_mode': 'encode',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	314 'themes_sources': [DEFAULT_THEME_SOURCE],
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	315 'cache_time': 28800,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	316 'enable_debug_info': True,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 'show_debug_info': False,
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	318 'use_default_content': True,
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	319 'use_default_theme_content': True,
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	320 'theme_site': False
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	321 }),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	322 'baker': collections.OrderedDict({
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	323 'no_bake_setting': 'draft',
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	324 'workers': None,
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	325 'batch_size': None
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	326 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	327 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	328
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	329
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	330 default_content_model_base = collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331 'site': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	332 'posts_fs': DEFAULT_POSTS_FS,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	333 'default_page_layout': 'default',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	334 'default_post_layout': 'post',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	335 'post_url': '%year%/%month%/%day%/%slug%',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 'tag_url': 'tag/%tag%',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 'category_url': '%category%',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338 'posts_per_page': 5
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	339 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	340 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	341
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	342
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	343 def get_default_content_model(values, user_overrides):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	344 default_layout = try_get_dict_value(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	345 user_overrides, 'site/default_page_layout',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	346 values['site']['default_page_layout'])
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	347 return collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	348 'site': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	349 'sources': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	350 'pages': {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 'type': 'default',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352 'ignore_missing_dir': True,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 'data_endpoint': 'site.pages',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 'default_layout': default_layout,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355 'item_name': 'page'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 }
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	357 }),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	358 'routes': [
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	359 {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	360 'url': '/%path:slug%',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361 'source': 'pages',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	362 'func': 'pcurl(slug)'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 }
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	364 ],
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	365 'taxonomies': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	366 'tags': {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367 'multiple': True,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368 'term': 'tag'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	369 },
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	370 'categories': {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	371 'term': 'category'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	372 }
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	373 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	374 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	375 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	376
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	377
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	378 def get_default_content_model_for_blog(
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	379 blog_name, is_only_blog, values, user_overrides, theme_site=False):
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	380 # Get the global values for various things we're interested in.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	381 defs = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	382 names = ['posts_fs', 'posts_per_page', 'date_format',
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	383 'default_post_layout', 'post_url', 'tag_url', 'category_url']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	384 for n in names:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	385 defs[n] = try_get_dict_value(
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	386 user_overrides, 'site/%s' % n,
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	387 values['site'][n])
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	388
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	389 # More stuff we need.
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	390 if is_only_blog:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	391 url_prefix = ''
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	392 tax_page_prefix = ''
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	393 fs_endpoint = 'posts'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	394 data_endpoint = 'blog'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	395 item_name = 'post'
675 3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	396
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	397 if theme_site:
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	398 # If this is a theme site, show posts from a `sample` directory
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	399 # so it's clearer that those won't show up when the theme is
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	400 # actually applied to a normal site.
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	401 fs_endpoint = 'sample/posts'
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	402 else:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	403 url_prefix = blog_name + '/'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	404 tax_page_prefix = blog_name + '/'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	405 fs_endpoint = 'posts/%s' % blog_name
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	406 data_endpoint = blog_name
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	407 item_name = '%s-post' % blog_name
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	408
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	409 # Figure out the settings values for this blog, specifically.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	410 # The value could be set on the blog config itself, globally, or left at
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	411 # its default. We already handle the "globally vs. default" with the
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	412 # `defs` map that we computed above.
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	413 blog_cfg = user_overrides.get(blog_name, {})
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	414 blog_values = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	415 for n in names:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	416 blog_values[n] = blog_cfg.get(n, defs[n])
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	417 if n in ['post_url', 'tag_url', 'category_url']:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	418 blog_values[n] = url_prefix + blog_values[n]
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	419
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	420 posts_fs = blog_values['posts_fs']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	421 posts_per_page = blog_values['posts_per_page']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	422 date_format = blog_values['date_format']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	423 default_layout = blog_values['default_post_layout']
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	424 post_url = '/' + blog_values['post_url'].lstrip('/')
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	425 tag_url = '/' + blog_values['tag_url'].lstrip('/')
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	426 category_url = '/' + blog_values['category_url'].lstrip('/')
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	427
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	428 tags_taxonomy = 'pages:%s_tag.%%ext%%' % tax_page_prefix
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	429 category_taxonomy = 'pages:%s_category.%%ext%%' % tax_page_prefix
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	430 if not theme_site:
675 3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	431 theme_tag_page = values['site'].get('theme_tag_page')
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	432 if theme_tag_page:
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	433 tags_taxonomy += ';' + theme_tag_page
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	434 theme_category_page = values['site'].get('theme_category_page')
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	435 if theme_category_page:
3df808b133f8 internal: Improve how theme configuration is validated and merged. Ludovic Chabant <ludovic@chabant.com> parents: 666 diff changeset	436 category_taxonomy += ';' + theme_category_page
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	437
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	438 return collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	439 'site': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	440 'sources': collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	441 blog_name: collections.OrderedDict({
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	442 'type': 'posts/%s' % posts_fs,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	443 'fs_endpoint': fs_endpoint,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	444 'data_endpoint': data_endpoint,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	445 'item_name': item_name,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	446 'ignore_missing_dir': True,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	447 'data_type': 'blog',
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	448 'items_per_page': posts_per_page,
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	449 'date_format': date_format,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	450 'default_layout': default_layout,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	451 'taxonomy_pages': collections.OrderedDict({
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	452 'tags': tags_taxonomy,
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	453 'categories': category_taxonomy
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	454 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	455 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	456 }),
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	457 'routes': [
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	458 {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	459 'url': post_url,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	460 'source': blog_name,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	461 'func': 'pcposturl(year,month,day,slug)'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	462 },
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	463 {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	464 'url': tag_url,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	465 'source': blog_name,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466 'taxonomy': 'tags',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467 'func': 'pctagurl(tag)'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	468 },
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	469 {
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	470 'url': category_url,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	471 'source': blog_name,
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	472 'taxonomy': 'categories',
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	473 'func': 'pccaturl(category)'
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	474 }
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	475 ]
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	476 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	477 })
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	478
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	479
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	480 # Configuration value validators.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	481 #
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	482 # Make sure we have basic site stuff.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	483 def _validate_site(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	484 sources = v.get('sources')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	485 if not sources:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	486 raise ConfigurationError("No sources were defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	487 routes = v.get('routes')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	488 if not routes:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	489 raise ConfigurationError("No routes were defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	490 taxonomies = v.get('taxonomies')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	491 if taxonomies is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	492 v['taxonomies'] = {}
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	493 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	494
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	495 # Make sure the site root starts and ends with a slash.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	496 def _validate_site_root(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	497 if not v.startswith('/'):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	498 raise ConfigurationError("The `site/root` setting must start "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	499 "with a slash.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	500 root_url = urllib.parse.quote(v.rstrip('/') + '/')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	501 return root_url
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	502
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	503
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	504 # Cache auto-format regexes, check that `.html` is in there.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	505 def _validate_site_auto_formats(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	506 if not isinstance(v, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	507 raise ConfigurationError("The 'site/auto_formats' setting must be "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	508 "a dictionary.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	509
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	510 v.setdefault('html', values['site']['default_format'])
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	511 auto_formats_re = r"\.(%s)$" % (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	512 '\|'.join(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	513 [re.escape(i) for i in list(v.keys())]))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	514 cache.write('auto_formats_re', auto_formats_re)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	515 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	516
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	517
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	518 # Check that the default auto-format is known.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	519 def _validate_site_default_auto_format(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	520 if v not in values['site']['auto_formats']:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	521 raise ConfigurationError(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	522 "Default auto-format '%s' is not declared." % v)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	523 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	524
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	525
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	526 # Cache pagination suffix regex and format.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	527 def _validate_site_pagination_suffix(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	528 if len(v) == 0 or v[0] != '/':
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	529 raise ConfigurationError("The 'site/pagination_suffix' setting "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	530 "must start with a slash.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	531 if '%num%' not in v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	532 raise ConfigurationError("The 'site/pagination_suffix' setting "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	533 "must contain the '%num%' placeholder.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	534
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	535 pgn_suffix_fmt = v.replace('%num%', '%(num)d')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	536 cache.write('pagination_suffix_format', pgn_suffix_fmt)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	537
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	538 pgn_suffix_re = re.escape(v)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	539 pgn_suffix_re = (pgn_suffix_re.replace("\\%num\\%", "(?P<num>\\d+)") +
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	540 '$')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	541 cache.write('pagination_suffix_re', pgn_suffix_re)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	542 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	543
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	544
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	545 # Make sure theme sources is a list.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	546 def _validate_site_theme_sources(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	547 if not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	548 v = [v]
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	549 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	550
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	551
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	552 def _validate_site_sources(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	553 # Basic checks.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	554 if not v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	555 raise ConfigurationError("There are no sources defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	556 if not isinstance(v, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	557 raise ConfigurationError("The 'site/sources' setting must be a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	558 "dictionary.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	559
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	560 # Sources have the `default` scanner by default, duh. Also, a bunch
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	561 # of other default values for other configuration stuff.
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	562 reserved_endpoints = set(['piecrust', 'site', 'page', 'route',
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	563 'assets', 'pagination', 'siblings',
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	564 'family'])
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	565 for sn, sc in v.items():
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	566 if not isinstance(sc, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	567 raise ConfigurationError("All sources in 'site/sources' must "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	568 "be dictionaries.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	569 sc.setdefault('type', 'default')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	570 sc.setdefault('fs_endpoint', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	571 sc.setdefault('ignore_missing_dir', False)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	572 sc.setdefault('data_endpoint', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	573 sc.setdefault('data_type', 'iterator')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	574 sc.setdefault('item_name', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	575 sc.setdefault('items_per_page', 5)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	576 sc.setdefault('date_format', DEFAULT_DATE_FORMAT)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	577 sc.setdefault('realm', REALM_USER)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	578
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	579 # Validate endpoints.
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	580 endpoint = sc['data_endpoint']
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	581 if endpoint in reserved_endpoints:
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	582 raise ConfigurationError(
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	583 "Source '%s' is using a reserved endpoint name: %s" %
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	584 (sn, endpoint))
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	585
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	586 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	587
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	588
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	589 def _validate_site_routes(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	590 if not v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	591 raise ConfigurationError("There are no routes defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	592 if not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	593 raise ConfigurationError("The 'site/routes' setting must be a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	594 "list.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	595
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	596 # Check routes are referencing correct sources, have default
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	597 # values, etc.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	598 for rc in v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	599 if not isinstance(rc, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	600 raise ConfigurationError("All routes in 'site/routes' must be "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	601 "dictionaries.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	602 rc_url = rc.get('url')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	603 if not rc_url:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	604 raise ConfigurationError("All routes in 'site/routes' must "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	605 "have an 'url'.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	606 if rc_url[0] != '/':
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	607 raise ConfigurationError("Route URLs must start with '/'.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	608 if rc.get('source') is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	609 raise ConfigurationError("Routes must specify a source.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	610 if rc['source'] not in list(values['site']['sources'].keys()):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	611 raise ConfigurationError("Route is referencing unknown "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	612 "source: %s" % rc['source'])
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	613 rc.setdefault('taxonomy', None)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	614 rc.setdefault('page_suffix', '/%num%')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	615
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	616 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	617
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	618
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	619 def _validate_site_taxonomies(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	620 for tn, tc in v.items():
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	621 tc.setdefault('multiple', False)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	622 tc.setdefault('term', tn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	623 tc.setdefault('page', '_%s.%%ext%%' % tc['term'])
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	624
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	625 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	626
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	627
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	628 def _validate_site_plugins(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	629 if isinstance(v, str):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	630 v = v.split(',')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	631 elif not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	632 raise ConfigurationError(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	633 "The 'site/plugins' setting must be an array, or a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	634 "comma-separated list.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	635 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	636

Mercurial > piecrust2

annotate piecrust/appconfig.py @ 683:ec384174b8b2