piecrust2: piecrust/sources/autoconfig.py annotate

annotate piecrust/sources/autoconfig.py @ 264:74bea91c9630

bake: Don't store internal config values in the bake record. We sometimes store actual objects in the page config (like for instance page linkers) and we don't want that to be pickled.

author	Ludovic Chabant <ludovic@chabant.com>
date	Tue, 24 Feb 2015 23:18:23 -0800
parents	3f740928043a
children	f512905ae812

rev	line source
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	1 import re
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2 import os
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 import os.path
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import logging
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	5 from piecrust.configuration import ConfigurationError
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 from piecrust.sources.base import (
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	7 PageSource, PageFactory, InvalidFileSystemEndpointError)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	8 from piecrust.sources.default import (
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	9 filter_page_dirname, filter_page_filename)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	10 from piecrust.sources.interfaces import IListableSource
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	11 from piecrust.sources.mixins import SimplePaginationSourceMixin
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 logger = logging.getLogger(__name__)
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	17 class AutoConfigSourceBase(PageSource, SimplePaginationSourceMixin,
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	18 IListableSource):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	19 """ Base class for page sources that automatically apply configuration
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	20 settings to their generated pages based on those pages' paths.
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	21 """
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22 def __init__(self, app, name, config):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	23 super(AutoConfigSourceBase, self).__init__(app, name, config)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	24 self.fs_endpoint = config.get('fs_endpoint', name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	25 self.fs_endpoint_path = os.path.join(self.root_dir, self.fs_endpoint)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	26 self.supported_extensions = list(
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	27 app.config.get('site/auto_formats').keys())
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	28 self.default_auto_format = app.config.get('site/default_auto_format')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	29
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	30 self.capture_mode = config.get('capture_mode', 'path')
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	31 if self.capture_mode not in ['path', 'dirname', 'filename']:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	32 raise ConfigurationError("Capture mode in source '%s' must be "
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	33 "one of: path, dirname, filename" %
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	34 name)
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	36 def buildPageFactories(self):
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	37 logger.debug("Scanning for pages in: %s" % self.fs_endpoint_path)
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38 if not os.path.isdir(self.fs_endpoint_path):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	39 raise InvalidFileSystemEndpointError(self.name,
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	40 self.fs_endpoint_path)
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 for dirpath, dirnames, filenames in os.walk(self.fs_endpoint_path):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	43 rel_dirpath = os.path.relpath(dirpath, self.fs_endpoint_path)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	44 dirnames[:] = list(filter(filter_page_dirname, dirnames))
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	45
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	46 # If `capture_mode` is `dirname`, we don't need to recompute it
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	47 # for each filename, so we do it here.
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	48 if self.capture_mode == 'dirname':
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	49 config = self._extractConfigFragment(rel_dirpath)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	50
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	51 for f in filter(filter_page_filename, filenames):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	52 if self.capture_mode == 'path':
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	53 path = os.path.join(rel_dirpath, f)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	54 config = self._extractConfigFragment(path)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	55 elif self.capture_mode == 'filename':
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	56 config = self._extractConfigFragment(f)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	57
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	58 fac_path = f
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	59 if rel_dirpath != '.':
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	60 fac_path = os.path.join(rel_dirpath, f)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	61
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	62 slug = self._makeSlug(fac_path)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	63
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64 metadata = {
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 'slug': slug,
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 'config': config}
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	67 yield PageFactory(self, fac_path, metadata)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	68
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	69 def resolveRef(self, ref_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	70 return os.path.normpath(
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	71 os.path.join(self.fs_endpoint_path, ref_path.lstrip("\\/")))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	72
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	73 def listPath(self, rel_path):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	74 raise NotImplementedError()
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	75
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	76 def getDirpath(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	77 return os.path.dirname(rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	78
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	79 def getBasename(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	80 filename = os.path.basename(rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	81 name, _ = os.path.splitext(filename)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	82 return name
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	83
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	84 def _makeSlug(self, rel_path):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	85 raise NotImplementedError()
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	86
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	87 def _extractConfigFragment(self, rel_path):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	88 raise NotImplementedError()
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	89
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	91 class AutoConfigSource(AutoConfigSourceBase):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	92 """ Page source that extracts configuration settings from the sub-folders
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	93 each page resides in. This is ideal for setting tags or categories
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	94 on pages based on the folders they're in.
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	95 """
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	96 SOURCE_NAME = 'autoconfig'
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	97
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	98 def __init__(self, app, name, config):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	99 config['capture_mode'] = 'dirname'
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	100 super(AutoConfigSource, self).__init__(app, name, config)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	101 self.setting_name = config.get('setting_name', name)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	102 self.only_single_values = config.get('only_single_values', False)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	103 self.collapse_single_values = config.get('collapse_single_values',
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	104 False)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	105 self.supported_extensions = list(
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	106 app.config.get('site/auto_formats').keys())
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	107
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	108 def _makeSlug(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	109 slug, ext = os.path.splitext(os.path.basename(rel_path))
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	110 if ext.lstrip('.') not in self.supported_extensions:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	111 slug += ext
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	112 return slug
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	113
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	114 def _extractConfigFragment(self, rel_path):
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	115 if rel_path == '.':
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	116 values = []
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	117 else:
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	118 values = rel_path.split(os.sep)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	119
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	120 if self.only_single_values:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	121 if len(values) > 1:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	122 raise Exception("Only one folder level is allowed for pages "
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	123 "in source '%s'." % self.name)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	124 elif len(values) == 1:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	125 values = values[0]
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	126 else:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	127 values = None
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	128
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	129 if self.collapse_single_values:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	130 if len(values) == 1:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	131 values = values[0]
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	132 elif len(values) == 0:
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	133 values = None
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	134
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 return {self.setting_name: values}
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 def findPagePath(self, metadata, mode):
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	138 # Pages from this source are effectively flattened, so we need to
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	139 # find pages using a brute-force kinda way.
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 for dirpath, dirnames, filenames in os.walk(self.fs_endpoint_path):
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141 for f in filenames:
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 slug, _ = os.path.splitext(f)
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 if slug == metadata['slug']:
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 path = os.path.join(dirpath, f)
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 rel_path = os.path.relpath(path, self.fs_endpoint_path)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	146 config = self._extractConfigFragment(rel_path)
148 432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147 metadata = {'slug': slug, 'config': config}
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148 return rel_path, metadata
432cd534ce08 Add `autoconfig` page source. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	150 def listPath(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	151 rel_path = rel_path.lstrip('\\/')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	152 path = os.path.join(self.fs_endpoint_path, rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	153 names = sorted(os.listdir(path))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	154 items = []
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	155 for name in names:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	156 if os.path.isdir(os.path.join(path, name)):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	157 if filter_page_dirname(name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	158 rel_subdir = os.path.join(rel_path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	159 items.append((True, name, rel_subdir))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	160 else:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	161 if filter_page_filename(name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	162 cur_rel_path = os.path.join(rel_path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	163 slug = self._makeSlug(cur_rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	164 config = self._extractConfigFragment(cur_rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	165 metadata = {'slug': slug, 'config': config}
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	166 fac = PageFactory(self, cur_rel_path, metadata)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	167
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	168 name, _ = os.path.splitext(name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	169 items.append((False, name, fac))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	170 return items
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	171
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	172
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	173 class OrderedPageSource(AutoConfigSourceBase):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	174 """ A page source that assigns an "order" to its pages based on a
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	175 numerical prefix in their filename. Page iterators will automatically
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	176 sort pages using that order.
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	177 """
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	178 SOURCE_NAME = 'ordered'
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	179
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	180 re_pattern = re.compile(r'(^\|/)(?P<num>\d+)_')
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	181
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	182 def __init__(self, app, name, config):
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	183 config['capture_mode'] = 'path'
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	184 super(OrderedPageSource, self).__init__(app, name, config)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	185 self.setting_name = config.get('setting_name', 'order')
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	186 self.default_value = config.get('default_value', 0)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	187 self.supported_extensions = list(
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	188 app.config.get('site/auto_formats').keys())
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	189
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	190 def findPagePath(self, metadata, mode):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	191 uri_path = metadata.get('slug', '')
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	192 if uri_path == '':
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	193 uri_path = '_index'
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	194
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	195 path = self.fs_endpoint_path
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	196 uri_parts = uri_path.split('/')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	197 for i, p in enumerate(uri_parts):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	198 if i == len(uri_parts) - 1:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	199 # Last part, this is the filename. We need to check for either
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	200 # the name, or the name with the prefix, but also handle a
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	201 # possible extension.
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	202 p_pat = r'(\d+_)?' + re.escape(p)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	203
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	204 _, ext = os.path.splitext(uri_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	205 if ext == '':
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	206 p_pat += r'\.[\w\d]+'
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	207
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	208 found = False
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	209 for name in os.listdir(path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	210 if re.match(p_pat, name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	211 path = os.path.join(path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	212 found = True
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	213 break
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	214 if not found:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	215 return None, None
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	216 else:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	217 # Find each sub-directory. It can either be a directory with
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	218 # the name itself, or the name with a number prefix.
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	219 p_pat = r'(\d+_)?' + re.escape(p)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	220 found = False
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	221 for name in os.listdir(path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	222 if re.match(p_pat, name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	223 path = os.path.join(path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	224 found = True
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	225 break
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	226 if not found:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	227 return None, None
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	228
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	229 fac_path = os.path.relpath(path, self.fs_endpoint_path)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	230 config = self._extractConfigFragment(fac_path)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	231 metadata = {'slug': uri_path, 'config': config}
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	232
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	233 return fac_path, metadata
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	234
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	235 def getSorterIterator(self, it):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	236 accessor = self.getSettingAccessor()
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	237 return OrderTrailSortIterator(it, self.setting_name + '_trail',
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	238 value_accessor=accessor)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	239
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	240 def listPath(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	241 rel_path = rel_path.lstrip('/')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	242 path = self.fs_endpoint_path
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	243 if rel_path != '':
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	244 parts = rel_path.split('/')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	245 for p in parts:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	246 p_pat = r'(\d+_)?' + re.escape(p)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	247 for name in os.listdir(path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	248 if re.match(p_pat, name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	249 path = os.path.join(path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	250 break
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	251 else:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	252 raise Exception("No such path: %s" % rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	253
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	254 items = []
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	255 names = sorted(os.listdir(path))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	256 for name in names:
248 3f740928043a sources: The ordered source returns names without prefixes in `listPath`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	257 clean_name = self.re_pattern.sub('', name)
3f740928043a sources: The ordered source returns names without prefixes in `listPath`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	258 clean_name, _ = os.path.splitext(clean_name)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	259 if os.path.isdir(os.path.join(path, name)):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	260 if filter_page_dirname(name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	261 rel_subdir = os.path.join(rel_path, name)
248 3f740928043a sources: The ordered source returns names without prefixes in `listPath`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	262 items.append((True, clean_name, rel_subdir))
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	263 else:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	264 if filter_page_filename(name):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	265 slug = self._makeSlug(os.path.join(rel_path, name))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	266
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	267 fac_path = name
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	268 if rel_path != '.':
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	269 fac_path = os.path.join(rel_path, name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	270 fac_path = fac_path.replace('\\', '/')
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	271
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	272 config = self._extractConfigFragment(fac_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	273 metadata = {'slug': slug, 'config': config}
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	274 fac = PageFactory(self, fac_path, metadata)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	275
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	276 name, _ = os.path.splitext(name)
248 3f740928043a sources: The ordered source returns names without prefixes in `listPath`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	277 items.append((False, clean_name, fac))
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	278 return items
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	279
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	280 def _makeSlug(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	281 slug, ext = os.path.splitext(rel_path)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	282 if ext.lstrip('.') not in self.supported_extensions:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	283 slug += ext
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	284 slug = self.re_pattern.sub(r'\1', slug)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	285 return slug
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	286
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	287 def _extractConfigFragment(self, rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	288 values = []
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	289 for m in self.re_pattern.finditer(rel_path):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	290 val = int(m.group('num'))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	291 values.append(val)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	292
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	293 if len(values) == 0:
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	294 values.append(self.default_value)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	295
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	296 return {
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	297 self.setting_name: values[-1],
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	298 self.setting_name + '_trail': values}
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	299
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	300 def _populateMetadata(self, rel_path, metadata, mode=None):
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	301 _, filename = os.path.split(rel_path)
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	302 config = self._extractConfigFragment(filename)
239 f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	303 metadata['config'] = config
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	304 slug = metadata['slug']
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	305 metadata['slug'] = self.re_pattern.sub(r'\1', slug)
f43f19975671 sources: Refactor `autoconfig` source, add `OrderedPageSource`. Ludovic Chabant <ludovic@chabant.com> parents: 156 diff changeset	306
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	307
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	308 class OrderTrailSortIterator(object):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	309 def __init__(self, it, trail_name, value_accessor):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	310 self.it = it
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	311 self.trail_name = trail_name
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	312 self.value_accessor = value_accessor
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	313
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	314 def __iter__(self):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	315 return iter(sorted(self.it, key=self._key_getter))
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	316
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	317 def _key_getter(self, item):
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	318 values = self.value_accessor(item, self.trail_name)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	319 key = ''.join(values)
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	320 return key
f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 239 diff changeset	321

Mercurial > piecrust2

annotate piecrust/sources/autoconfig.py @ 264:74bea91c9630