piecrust2: piecrust/appconfig.py annotate

annotate piecrust/appconfig.py @ 845:a3f74fa0c826 2.0.0

cm: Regenerate the CHANGELOG.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sun, 19 Feb 2017 22:28:34 -0800
parents	b8f089092281
children	4850f8c21b6e

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
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	10 from piecrust import APP_VERSION, CACHE_VERSION, DEFAULT_DATE_FORMAT
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	11 from piecrust.appconfigdefaults import (
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	12 default_configuration,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	13 default_theme_content_model_base,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	14 default_content_model_base,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	15 get_default_content_model, get_default_content_model_for_blog)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 from piecrust.cache import NullCache
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17 from piecrust.configuration import (
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	18 Configuration, ConfigurationError, ConfigurationLoader,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	19 try_get_dict_values, try_get_dict_value, set_dict_value,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	20 merge_dicts, visit_dict,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	21 MERGE_NEW_VALUES, MERGE_OVERWRITE_VALUES, MERGE_PREPEND_LISTS,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	22 MERGE_APPEND_LISTS)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23 from piecrust.sources.base import REALM_USER, REALM_THEME
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 logger = logging.getLogger(__name__)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	29 class InvalidConfigurationPathError(Exception):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	30 pass
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	31
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	32
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	33 class VariantNotFoundError(Exception):
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	34 def __init__(self, variant_name, message=None):
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35 super(VariantNotFoundError, self).__init__(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	36 message or ("No such configuration variant: %s" %
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	37 variant_name))
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	38
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	39
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40 class PieCrustConfiguration(Configuration):
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	41 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	42 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	43 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	44 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	45 "theme applied.")
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	46 super(PieCrustConfiguration, self).__init__()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	47 self._path = path
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	48 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	49 self._cache = cache or NullCache()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	50 self._custom_paths = []
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	51 self._post_fixups = []
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	52 self.theme_config = theme_config
3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	53 # 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	54 # our attributes.
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	55 if values is not None:
663 3ceeca7bb71c themes: Add support for a `--theme` argument to `chef`. Ludovic Chabant <ludovic@chabant.com> parents: 585 diff changeset	56 self.setAll(values, validate=validate)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	58 def addPath(self, p):
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	59 if not p:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	60 raise InvalidConfigurationPathError()
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	61 self._ensureNotLoaded()
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	62 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	63
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	64 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	65 self._ensureNotLoaded()
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	66 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	67 self.addPath(variant_path)
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	68 elif raise_if_not_found:
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	69 logger.error(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	70 "Configuration variants should now be `.yml` files "
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	71 "located in the `configs/` directory of your website.")
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	72 raise VariantNotFoundError(variant_path)
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	73
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	74 def addVariantValue(self, path, value):
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	75 def _fixup(config):
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	76 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	77
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	78 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	79
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	80 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	81 # Override base class implementation
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	82 values = self._processConfigs({}, values)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	83 if validate:
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	84 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	85 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	86
666 81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	87 def _ensureNotLoaded(self):
81d9c3a3a0b5 internal: Get rid of the whole "sub cache" business. Ludovic Chabant <ludovic@chabant.com> parents: 663 diff changeset	88 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	89 raise Exception("The configurations has been loaded.")
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91 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	92 # Figure out where to load this configuration from.
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	93 paths = []
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	94 if self._theme_path:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	95 paths.append(self._theme_path)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	96 if self._path:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	97 paths.append(self._path)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	98 paths += self._custom_paths
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	99
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	100 # Build the cache-key.
686 1a6c4c2683fd internal: Fix incorrect check for cache times. Ludovic Chabant <ludovic@chabant.com> parents: 683 diff changeset	101 path_times = [os.path.getmtime(p) for p in paths]
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102 cache_key_hash = hashlib.md5(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	103 ("version=%s&cache=%d" % (
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	104 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	105 for p in paths:
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106 cache_key_hash.update(("&path=%s" % p).encode('utf8'))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 cache_key = cache_key_hash.hexdigest()
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	109 # Check the cache for a valid version.
839 b8f089092281 bug: Fix crashes for commands run outside of a website. Ludovic Chabant <ludovic@chabant.com> parents: 805 diff changeset	110 if path_times and self._cache.isValid('config.json', path_times):
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	111 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	112 config_text = self._cache.read('config.json')
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	113 self._values = json.loads(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	114 config_text,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	115 object_pairs_hook=collections.OrderedDict)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	116
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	117 actual_cache_key = self._values.get('__cache_key')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	118 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	119 # The cached version has the same key! Awesome!
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120 self._values['__cache_valid'] = True
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 return
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122 logger.debug("Outdated cache key '%s' (expected '%s')." % (
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	123 actual_cache_key, cache_key))
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	125 # Nope, load from the paths.
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	126 try:
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	127 # Theme values.
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	128 theme_values = None
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	129 if self._theme_path:
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	130 logger.debug("Loading theme layer from: %s" % self._theme_path)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	131 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	132
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	133 # Site and variant values.
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	134 site_paths = []
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	135 if self._path:
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	136 site_paths.append(self._path)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	137 site_paths += self._custom_paths
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	138
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	139 site_values = {}
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	140 for path in site_paths:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	141 logger.debug("Loading config layer from: %s" % path)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	142 cur_values = self._loadFrom(path)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	143 merge_dicts(site_values, cur_values)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	144
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	145 # Do it!
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	146 values = self._processConfigs(theme_values, site_values)
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	147 self._values = self._validateAll(values)
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	148 except Exception as ex:
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	149 logger.exception(ex)
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	150 raise Exception(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	151 "Error loading configuration from: %s" %
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	152 ', '.join(paths)) from ex
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 logger.debug("Caching configuration...")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155 self._values['__cache_key'] = cache_key
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	156 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	157 self._cache.write('config.json', config_text)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	159 self._values['__cache_valid'] = False
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	160
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	161 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	162 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	163 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	164 values = yaml.load(
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	165 fp.read(),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	166 Loader=ConfigurationLoader)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	167 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	168 values = {}
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	169 return values
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	170
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	171 def _processConfigs(self, theme_values, site_values):
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	172 # 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	173 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	174
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	175 # If we have a theme, apply the theme on that. So stuff like routes
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	176 # will now look like:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	177 # [custom theme] + [default theme] + [default]
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	178 if theme_values is not None:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	179 self._processThemeLayer(theme_values, values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	180 merge_dicts(values, theme_values)
683 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
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	188 # Now we apply the site stuff. We want to end up with:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	189 # [custom site] + [default site] + [custom theme] + [default theme] +
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	190 # [default]
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	191 if site_values is not None:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	192 self._processSiteLayer(site_values, values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	193 merge_dicts(values, site_values)
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	194
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	195 # 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	196 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	197 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	198
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	199 # Run final fixups
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	200 if self._post_fixups:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	201 logger.debug("Applying %d configuration fixups." %
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	202 len(self._post_fixups))
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	203 for f in self._post_fixups:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	204 f(values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	205
683 ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	206 return values
ec384174b8b2 internal: More work/fixes on how default/theme/user configs are merged. Ludovic Chabant <ludovic@chabant.com> parents: 681 diff changeset	207
805 fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	208 def _processThemeLayer(self, theme_values, values):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	209 # Generate the default theme model.
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	210 gen_default_theme_model = bool(try_get_dict_values(
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	211 (theme_values, 'site/use_default_theme_content'),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	212 (values, 'site/use_default_theme_content'),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	213 default=True))
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	214 if gen_default_theme_model:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	215 self._generateDefaultThemeModel(theme_values, values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	216
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	217 def _processSiteLayer(self, site_values, values):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	218 # Default site content.
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	219 gen_default_site_model = bool(try_get_dict_values(
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	220 (site_values, 'site/use_default_content'),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	221 (values, 'site/use_default_content'),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	222 default=True))
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	223 if gen_default_site_model:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	224 self._generateDefaultSiteModel(site_values, values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	225
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	226 def _generateDefaultThemeModel(self, theme_values, values):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	227 logger.debug("Generating default theme content model...")
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	228 cc = copy.deepcopy(default_theme_content_model_base)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	229 merge_dicts(values, cc)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	230
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	231 def _generateDefaultSiteModel(self, site_values, values):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	232 logger.debug("Generating default content model...")
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	233 cc = copy.deepcopy(default_content_model_base)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	234 merge_dicts(values, cc)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	235
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	236 dcm = get_default_content_model(site_values, values)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	237 merge_dicts(values, dcm)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	238
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	239 blogsc = try_get_dict_values(
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	240 (site_values, 'site/blogs'),
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	241 (values, 'site/blogs'))
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	242 if blogsc is None:
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	243 blogsc = ['posts']
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	244 set_dict_value(site_values, 'site/blogs', blogsc)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	245
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	246 is_only_blog = (len(blogsc) == 1)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	247 for blog_name in reversed(blogsc):
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	248 blog_cfg = get_default_content_model_for_blog(
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	249 blog_name, is_only_blog, site_values, values,
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	250 theme_site=self.theme_config)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	251 merge_dicts(values, blog_cfg)
fd694f1297c7 config: Cleanup config loading code. Add support for a `local.yml` config. Ludovic Chabant <ludovic@chabant.com> parents: 792 diff changeset	252
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	253 def _validateAll(self, values):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	254 if values is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	255 values = {}
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	256
681 894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	257 # 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	258 # the configuration tree, calling validation functions as we
894d286b348f internal: Refactor config loading some more. Ludovic Chabant <ludovic@chabant.com> parents: 675 diff changeset	259 # find them.
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	260 cachec = collections.OrderedDict()
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	261 values['__cache'] = cachec
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	262 cache_writer = _ConfigCacheWriter(cachec)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	263 globs = globals()
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 _visitor(path, val, parent_val, parent_key):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	266 callback_name = '_validate_' + path.replace('/', '_')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	267 callback = globs.get(callback_name)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	268 if callback:
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	269 try:
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	270 val2 = callback(val, values, cache_writer)
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	271 except Exception as ex:
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	272 logger.exception(ex)
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	273 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	274 callback_name) from ex
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	275 if val2 is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	276 raise Exception("Validator '%s' isn't returning a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	277 "coerced value." % callback_name)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	278 parent_val[parent_key] = val2
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	279
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	280 visit_dict(values, _visitor)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	281
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	282 return values
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	283
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	284
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	285 class _ConfigCacheWriter(object):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	286 def __init__(self, cache_dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	287 self._cache_dict = cache_dict
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	288
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	289 def write(self, name, val):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	290 logger.debug("Caching configuration item '%s' = %s" % (name, val))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	291 self._cache_dict[name] = val
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	292
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	293
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	294 # Configuration value validators.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	295 #
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	296 # Make sure we have basic site stuff.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	297 def _validate_site(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	298 sources = v.get('sources')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	299 if not sources:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	300 raise ConfigurationError("No sources were defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	301 routes = v.get('routes')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	302 if not routes:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	303 raise ConfigurationError("No routes were defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	304 taxonomies = v.get('taxonomies')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	305 if taxonomies is None:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306 v['taxonomies'] = {}
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	307 generators = v.get('generators')
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	308 if generators is None:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	309 v['generators'] = {}
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	310 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	311
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	312
752 7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	313 # Make sure the site root ends with a slash.
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	314 def _validate_site_root(v, values, cache):
752 7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	315 url_bits = urllib.parse.urlparse(v)
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	316 if url_bits.params or url_bits.query or url_bits.fragment:
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	317 raise ConfigurationError("Root URL is invalid: %s" % v)
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	318
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	319 path = url_bits.path.rstrip('/') + '/'
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	320 if '%' not in path:
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	321 path = urllib.parse.quote(path)
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	322
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	323 root_url = urllib.parse.urlunparse((
7dbddfed8129 config: Fix how we parse the root URL to allow for absolute and user URLs. Ludovic Chabant <ludovic@chabant.com> parents: 743 diff changeset	324 url_bits.scheme, url_bits.netloc, path, '', '', ''))
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	325 return root_url
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 # 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	329 def _validate_site_auto_formats(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	330 if not isinstance(v, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331 raise ConfigurationError("The 'site/auto_formats' setting must be "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	332 "a dictionary.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	333
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	334 v.setdefault('html', values['site']['default_format'])
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	335 auto_formats_re = r"\.(%s)$" % (
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 '\|'.join(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 [re.escape(i) for i in list(v.keys())]))
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338 cache.write('auto_formats_re', auto_formats_re)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	339 return v
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 # Check that the default auto-format is known.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	343 def _validate_site_default_auto_format(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	344 if v not in values['site']['auto_formats']:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	345 raise ConfigurationError(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	346 "Default auto-format '%s' is not declared." % v)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	347 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	348
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	349
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	350 # Cache pagination suffix regex and format.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 def _validate_site_pagination_suffix(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352 if len(v) == 0 or v[0] != '/':
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 raise ConfigurationError("The 'site/pagination_suffix' setting "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 "must start with a slash.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355 if '%num%' not in v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 raise ConfigurationError("The 'site/pagination_suffix' setting "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	357 "must contain the '%num%' placeholder.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	358
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	359 pgn_suffix_fmt = v.replace('%num%', '%(num)d')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	360 cache.write('pagination_suffix_format', pgn_suffix_fmt)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	362 pgn_suffix_re = re.escape(v)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 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	364 '$')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	365 cache.write('pagination_suffix_re', pgn_suffix_re)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	366 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	369 # Make sure theme sources is a list.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	370 def _validate_site_theme_sources(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	371 if not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	372 v = [v]
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	373 return v
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 def _validate_site_sources(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	377 # Basic checks.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	378 if not v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	379 raise ConfigurationError("There are no sources defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	380 if not isinstance(v, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	381 raise ConfigurationError("The 'site/sources' setting must be a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	382 "dictionary.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	383
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	384 # 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	385 # 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	386 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	387 'assets', 'pagination', 'siblings',
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	388 'family'])
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	389 for sn, sc in v.items():
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	390 if not isinstance(sc, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	391 raise ConfigurationError("All sources in 'site/sources' must "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	392 "be dictionaries.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	393 sc.setdefault('type', 'default')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	394 sc.setdefault('fs_endpoint', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	395 sc.setdefault('ignore_missing_dir', False)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	396 sc.setdefault('data_endpoint', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	397 sc.setdefault('data_type', 'iterator')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	398 sc.setdefault('item_name', sn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	399 sc.setdefault('items_per_page', 5)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	400 sc.setdefault('date_format', DEFAULT_DATE_FORMAT)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	401 sc.setdefault('realm', REALM_USER)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	402
585 25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	403 # Validate endpoints.
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	404 endpoint = sc['data_endpoint']
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	405 if endpoint in reserved_endpoints:
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	406 raise ConfigurationError(
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	407 "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	408 (sn, endpoint))
25df894f9ab9 internal: Some fixes to the new app configuration. Ludovic Chabant <ludovic@chabant.com> parents: 584 diff changeset	409
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	410 # Validate generators.
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	411 for gn, gc in sc.get('generators', {}).items():
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	412 if not isinstance(gc, dict):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	413 raise ConfigurationError(
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	414 "Generators for source '%s' should be defined in a "
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	415 "dictionary." % sn)
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	416 gc['source'] = sn
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	417
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	418 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	419
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	420
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	421 def _validate_site_routes(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	422 if not v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	423 raise ConfigurationError("There are no routes defined.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	424 if not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	425 raise ConfigurationError("The 'site/routes' setting must be a "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	426 "list.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	427
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	428 # Check routes are referencing correct sources, have default
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	429 # values, etc.
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	430 for rc in v:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	431 if not isinstance(rc, dict):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	432 raise ConfigurationError("All routes in 'site/routes' must be "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	433 "dictionaries.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	434 rc_url = rc.get('url')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	435 if not rc_url:
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	436 raise ConfigurationError("All routes in 'site/routes' must "
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	437 "have an 'url'.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	438 if rc_url[0] != '/':
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	439 raise ConfigurationError("Route URLs must start with '/'.")
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	440
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	441 r_source = rc.get('source')
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	442 r_generator = rc.get('generator')
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	443 if r_source is None and r_generator is None:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	444 raise ConfigurationError("Routes must specify a source or "
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	445 "generator.")
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	446 if (r_source and
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	447 r_source not in list(values['site']['sources'].keys())):
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	448 raise ConfigurationError("Route is referencing unknown "
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	449 "source: %s" % r_source)
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	450 if (r_generator and
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	451 r_generator not in list(values['site']['generators'].keys())):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	452 raise ConfigurationError("Route is referencing unknown "
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	453 "generator: %s" % r_generator)
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	454
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	455 rc.setdefault('generator', None)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	456 rc.setdefault('page_suffix', '/%num%')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	457
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	458 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	459
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	460
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	461 def _validate_site_taxonomies(v, values, cache):
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	462 if not isinstance(v, dict):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	463 raise ConfigurationError(
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	464 "The 'site/taxonomies' setting must be a mapping.")
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	465 for tn, tc in v.items():
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466 tc.setdefault('multiple', False)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467 tc.setdefault('term', tn)
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	468 tc.setdefault('page', '_%s.%%ext%%' % tc['term'])
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	469 return v
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	470
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	471
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	472 def _validate_site_generators(v, values, cache):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	473 if not isinstance(v, dict):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	474 raise ConfigurationError(
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	475 "The 'site/generators' setting must be a mapping.")
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	476 for gn, gc in v.items():
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	477 if 'type' not in gc:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	478 raise ConfigurationError(
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 686 diff changeset	479 "Generator '%s' doesn't specify a type." % gn)
584 9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	480 return v
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
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	483 def _validate_site_plugins(v, values, cache):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	484 if isinstance(v, str):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	485 v = v.split(',')
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	486 elif not isinstance(v, list):
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	487 raise ConfigurationError(
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	488 "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	489 "comma-separated list.")
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	490 return v
9ccc933ac2c7 internal: Refactor the app configuration class. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	491

Mercurial > piecrust2

annotate piecrust/appconfig.py @ 845:a3f74fa0c826 2.0.0