piecrust2: piecrust/sources/base.py annotate

annotate piecrust/sources/base.py @ 226:e9dc18a275ff

data: Add ability for `IPaginationSource`s to specify how to get settings. The `IPaginationSource` has a new `getSettingAccessor` method that returns how to access settings values on items in the pagination source. A default accessor is also available, which uses standard attribute lookup. Also clean some stuff in `LazyPageConfigData`.

author	Ludovic Chabant <ludovic@chabant.com>
date	Wed, 04 Feb 2015 23:49:52 -0800
parents	0b2d8f6df4ce
children	016d42c23ba9

rev	line source
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 import re
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2 import os
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 import os.path
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import logging
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5 from werkzeug.utils import cached_property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 from piecrust.configuration import ConfigurationError
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	7 from piecrust.data.base import IPaginationSource, PaginationData
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	8 from piecrust.data.filters import PaginationFilter
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 from piecrust.page import Page
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12 REALM_USER = 0
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13 REALM_THEME = 1
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 REALM_NAMES = {
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 REALM_USER: 'User',
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 REALM_THEME: 'Theme'}
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19 MODE_PARSING = 0
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	20 MODE_CREATING = 1
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23 logger = logging.getLogger(__name__)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 page_ref_pattern = re.compile(r'(?P<src>[\w]+)\:(?P<path>.*?)(;\|$)')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28
114 371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	29 def build_pages(app, factories):
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	30 with app.env.page_repository.startBatchGet():
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	31 for f in factories:
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	32 yield f.buildPage()
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	33
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	34
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35 class PageNotFoundError(Exception):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	36 pass
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	37
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	39 class InvalidFileSystemEndpointError(Exception):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40 def __init__(self, source_name, fs_endpoint):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41 super(InvalidFileSystemEndpointError, self).__init__(
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 "Invalid file-system endpoint for source '%s': %s" %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43 (source_name, fs_endpoint))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	45
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46 class PageFactory(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47 """ A class responsible for creating a page.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	49 def __init__(self, source, rel_path, metadata):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 self.source = source
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 self.rel_path = rel_path
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 self.metadata = metadata
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	53
50 2fec3ee1298f Properly override pages between realms. Ludovic Chabant <ludovic@chabant.com> parents: 36 diff changeset	54 @cached_property
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	55 def ref_spec(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	56 return '%s:%s' % (self.source.name, self.rel_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	58 @cached_property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	59 def path(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	60 return self.source.resolveRef(self.rel_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	61
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	62 def buildPage(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	63 repo = self.source.app.env.page_repository
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64 if repo is not None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 cache_key = '%s:%s' % (self.source.name, self.rel_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 return repo.get(cache_key, self._doBuildPage)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	67 return self._doBuildPage()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	68
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	69 def _doBuildPage(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	70 logger.debug("Building page: %s" % self.path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	71 page = Page(self.source, self.metadata, self.rel_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	72 # Load it right away, especially when using the page repository,
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	73 # because we'll be inside a critical scope.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	74 page._load()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	75 return page
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	76
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	77
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	78 class CachedPageFactory(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	79 """ A `PageFactory` (in appearance) that already has a page built.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	80 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	81 def __init__(self, page):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	82 self._page = page
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	83
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	84 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	85 def rel_path(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	86 return self._page.rel_path
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	87
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	88 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	89 def metadata(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 return self._page.source_metadata
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	92 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	93 def ref_spec(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94 return self._page.ref_spec
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	95
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	96 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 def path(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98 return self._page.path
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 def buildPage(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101 return self._page
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104 class PageRef(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	105 """ A reference to a page, with support for looking a page in different
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106 realms.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108 def __init__(self, app, page_ref):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	109 self.app = app
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	110 self._page_ref = page_ref
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	111 self._paths = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	112 self._first_valid_path_index = -2
5 474c9882decf Upgrade to Python 3. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	113 self._exts = list(app.config.get('site/auto_formats').keys())
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	114
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	115 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	116 def exists(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	117 try:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	118 self._checkPaths()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	119 return True
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120 except PageNotFoundError:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 return False
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	123 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124 def source_name(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	125 self._checkPaths()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126 return self._paths[self._first_valid_path_index][0]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	127
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	129 def source(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130 return self.app.getSource(self.source_name)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	131
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	132 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133 def rel_path(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134 self._checkPaths()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 return self._paths[self._first_valid_path_index][1]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138 def path(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	139 self._checkPaths()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 return self._paths[self._first_valid_path_index][2]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 def possible_rel_paths(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 self._load()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 return [p[1] for p in self._paths]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148 def possible_paths(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 self._load()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 return [p[2] for p in self._paths]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	151
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	152 def _load(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153 if self._paths is not None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154 return
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	156 it = list(page_ref_pattern.finditer(self._page_ref))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	157 if len(it) == 0:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158 raise Exception("Invalid page ref: %s" % self._page_ref)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	159
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	160 self._paths = []
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	161 for m in it:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	162 source_name = m.group('src')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	163 source = self.app.getSource(source_name)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	164 if source is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	165 raise Exception("No such source: %s" % source_name)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	166 rel_path = m.group('path')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	167 path = source.resolveRef(rel_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	168 if '%ext%' in rel_path:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	169 for e in self._exts:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	170 self._paths.append((source_name,
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	171 rel_path.replace('%ext%', e),
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	172 path.replace('%ext%', e)))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	173 else:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	174 self._paths.append((source_name, rel_path, path))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	175
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	176 def _checkPaths(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	177 if self._first_valid_path_index >= 0:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	178 return
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	179 if self._first_valid_path_index == -1:
144 8d16ca75075f Fix a bug with page references in cases of failure. Add unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 114 diff changeset	180 raise PageNotFoundError(
8d16ca75075f Fix a bug with page references in cases of failure. Add unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 114 diff changeset	181 "No valid paths were found for page reference: %s" %
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	182 self._page_ref)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	183
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	184 self._load()
144 8d16ca75075f Fix a bug with page references in cases of failure. Add unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 114 diff changeset	185 self._first_valid_path_index = -1
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	186 for i, path_info in enumerate(self._paths):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	187 if os.path.isfile(path_info[2]):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	188 self._first_valid_path_index = i
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	189 break
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	190
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	191
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	192 class PageSource(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	193 """ A source for pages, e.g. a directory with one file per page.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	194 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	195 def __init__(self, app, name, config):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	196 self.app = app
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	197 self.name = name
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	198 self.config = config
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	199 self._factories = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	200 self._provider_type = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	201
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	202 def __getattr__(self, name):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	203 try:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	204 return self.config[name]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	205 except KeyError:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	206 raise AttributeError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	207
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	208 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	209 def is_theme_source(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	210 return self.realm == REALM_THEME
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	211
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	212 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	213 def root_dir(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	214 if self.is_theme_source:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	215 return self.app.theme_dir
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	216 return self.app.root_dir
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	217
114 371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	218 def getPages(self):
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	219 return build_pages(self.app, self.getPageFactories())
371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	220
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	221 def getPageFactories(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	222 if self._factories is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	223 self._factories = list(self.buildPageFactories())
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	224 return self._factories
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	225
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	226 def buildPageFactories(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	227 raise NotImplementedError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	228
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	229 def resolveRef(self, ref_path):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	230 raise NotImplementedError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	231
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	232 def findPagePath(self, metadata, mode):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	233 raise NotImplementedError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	234
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	235 def buildDataProvider(self, page, user_data):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	236 if self._provider_type is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	237 cls = next((pt for pt in self.app.plugin_loader.getDataProviders()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	238 if pt.PROVIDER_NAME == self.data_type),
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	239 None)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	240 if cls is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	241 raise ConfigurationError("Unknown data provider type: %s" %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	242 self.data_type)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	243 self._provider_type = cls
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	244
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	245 return self._provider_type(self, page, user_data)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	246
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247 def getTaxonomyPageRef(self, tax_name):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	248 tax_pages = self.config.get('taxonomy_pages')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	249 if tax_pages is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	250 return None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	251 return tax_pages.get(tax_name)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	252
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	253
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	254 class IPreparingSource:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	255 def setupPrepareParser(self, parser, app):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	256 raise NotImplementedError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	257
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	258 def buildMetadata(self, args):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	259 raise NotImplementedError()
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	260
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	261
171 d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	262 class IListableSource:
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	263 def listPath(self, rel_path):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	264 raise NotImplementedError()
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	265
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	266 def getDirpath(self, rel_path):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	267 raise NotImplementedError()
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	268
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	269 def getBasename(self, rel_path):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	270 raise NotImplementedError()
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	271
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	272
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	273 class SimplePaginationSourceMixin(IPaginationSource):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	274 def getItemsPerPage(self):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	275 return self.config['items_per_page']
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	276
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	277 def getSourceIterator(self):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	278 return SourceFactoryIterator(self)
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	279
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	280 def getSorterIterator(self, it):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	281 return DateSortIterator(it)
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	282
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	283 def getTailIterator(self, it):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	284 return PaginationDataBuilderIterator(it)
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	285
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	286 def getPaginationFilter(self, page):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	287 conf = (page.config.get('items_filters') or
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	288 page.app.config.get('site/items_filters'))
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	289 if conf == 'none' or conf == 'nil' or conf == '':
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	290 conf = None
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	291 if conf is not None:
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	292 f = PaginationFilter()
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	293 f.addClausesFromConfig(conf)
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	294 return f
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	295 return None
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	296
226 e9dc18a275ff data: Add ability for `IPaginationSource`s to specify how to get settings. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	297 def getSettingAccessor(self):
e9dc18a275ff data: Add ability for `IPaginationSource`s to specify how to get settings. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	298 return lambda i, n: i.config.get(n)
e9dc18a275ff data: Add ability for `IPaginationSource`s to specify how to get settings. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	299
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	300
7 343d08ef5668 More PieCrust 3 fixes, and a couple of miscellaneous bug fixes. Ludovic Chabant <ludovic@chabant.com> parents: 6 diff changeset	301 class ArraySource(PageSource, SimplePaginationSourceMixin):
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	302 def __init__(self, app, inner_source, name='array', config=None):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	303 super(ArraySource, self).__init__(app, name, config or {})
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	304 self.inner_source = inner_source
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	305
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307 def page_count(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	308 return len(self.inner_source)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	309
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	310 def getPageFactories(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	311 for p in self.inner_source:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	312 yield CachedPageFactory(p)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	313
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	314
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	315 class SimplePageSource(PageSource, IListableSource, IPreparingSource,
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	316 SimplePaginationSourceMixin):
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 def __init__(self, app, name, config):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	318 super(SimplePageSource, self).__init__(app, name, config)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	319 self.fs_endpoint = config.get('fs_endpoint', name)
36 485682a6de50 New site layout support. Ludovic Chabant <ludovic@chabant.com> parents: 30 diff changeset	320 self.fs_endpoint_path = os.path.join(self.root_dir, self.fs_endpoint)
5 474c9882decf Upgrade to Python 3. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	321 self.supported_extensions = list(app.config.get('site/auto_formats').keys())
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	322 self.default_auto_format = app.config.get('site/default_auto_format')
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	323
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	324 def buildPageFactories(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	325 logger.debug("Scanning for pages in: %s" % self.fs_endpoint_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	326 if not os.path.isdir(self.fs_endpoint_path):
84 b3ce11b2cf36 Don't complain about missing `pages` or `posts` directories by default. Ludovic Chabant <ludovic@chabant.com> parents: 50 diff changeset	327 if self.ignore_missing_dir:
b3ce11b2cf36 Don't complain about missing `pages` or `posts` directories by default. Ludovic Chabant <ludovic@chabant.com> parents: 50 diff changeset	328 return
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	329 raise InvalidFileSystemEndpointError(self.name, self.fs_endpoint_path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	330
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331 for dirpath, dirnames, filenames in os.walk(self.fs_endpoint_path):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	332 rel_dirpath = os.path.relpath(dirpath, self.fs_endpoint_path)
5 474c9882decf Upgrade to Python 3. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	333 dirnames[:] = list(filter(self._filterPageDirname, dirnames))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	334 for f in filter(self._filterPageFilename, filenames):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	335 fac_path = f
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 if rel_dirpath != '.':
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 fac_path = os.path.join(rel_dirpath, f)
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	338 slug = self._makeSlug(fac_path)
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	339 metadata = {'path': slug}
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	340 fac_path = fac_path.replace('\\', '/')
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	341 self._populateMetadata(fac_path, metadata)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	342 yield PageFactory(self, fac_path, metadata)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	343
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	344 def resolveRef(self, ref_path):
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	345 return os.path.normpath(
211 0b2d8f6df4ce internal: A bit of input validation for source APIs. Ludovic Chabant <ludovic@chabant.com> parents: 186 diff changeset	346 os.path.join(self.fs_endpoint_path, ref_path.lstrip("\\/")))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	347
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	348 def findPagePath(self, metadata, mode):
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	349 uri_path = metadata.setdefault('path', '')
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	350 if not uri_path:
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 uri_path = '_index'
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	352 path = os.path.normpath(os.path.join(self.fs_endpoint_path, uri_path))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 _, ext = os.path.splitext(path)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355 if mode == MODE_CREATING:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 if ext == '':
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	357 path = '%s.%s' % (path, self.default_auto_format)
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	358 rel_path = os.path.relpath(path, self.fs_endpoint_path)
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	359 rel_path = rel_path.replace('\\', '/')
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	360 self._populateMetadata(rel_path, metadata, mode)
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	361 return rel_path, metadata
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	362
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 if ext == '':
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	364 paths_to_check = [
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	365 '%s.%s' % (path, e)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	366 for e in self.supported_extensions]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367 else:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368 paths_to_check = [path]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	369 for path in paths_to_check:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	370 if os.path.isfile(path):
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	371 rel_path = os.path.relpath(path, self.fs_endpoint_path)
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	372 rel_path = rel_path.replace('\\', '/')
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	373 self._populateMetadata(rel_path, metadata, mode)
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	374 return rel_path, metadata
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	375
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	376 return None, None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	377
171 d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	378 def listPath(self, rel_path):
211 0b2d8f6df4ce internal: A bit of input validation for source APIs. Ludovic Chabant <ludovic@chabant.com> parents: 186 diff changeset	379 path = os.path.join(self.fs_endpoint_path, rel_path.lstrip("\\/"))
171 d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	380 names = sorted(os.listdir(path))
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	381 items = []
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	382 for name in names:
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	383 if os.path.isdir(os.path.join(path, name)):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	384 if self._filterPageDirname(name):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	385 rel_subdir = os.path.join(rel_path, name)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	386 items.append((True, name, rel_subdir))
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	387 else:
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	388 if self._filterPageFilename(name):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	389 slug = self._makeSlug(os.path.join(rel_path, name))
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	390 metadata = {'path': slug}
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	391
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	392 fac_path = name
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	393 if rel_path != '.':
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	394 fac_path = os.path.join(rel_path, name)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	395 fac_path = fac_path.replace('\\', '/')
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	396
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	397 self._populateMetadata(fac_path, metadata)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	398 fac = PageFactory(self, fac_path, metadata)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	399 items.append((False, name, fac))
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	400 return items
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	401
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	402 def getDirpath(self, rel_path):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	403 return os.path.dirname(rel_path)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	404
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	405 def getBasename(self, rel_path):
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	406 filename = os.path.basename(rel_path)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	407 name, _ = os.path.splitext(filename)
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	408 return name
d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	409
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	410 def setupPrepareParser(self, parser, app):
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	411 parser.add_argument('uri', help='The URI for the new page.')
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	412
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	413 def buildMetadata(self, args):
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	414 return {'path': args.uri}
e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	415
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	416 def _makeSlug(self, rel_path):
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	417 slug, ext = os.path.splitext(rel_path)
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	418 slug = slug.replace('\\', '/')
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	419 if ext.lstrip('.') not in self.supported_extensions:
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	420 slug += ext
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	421 if slug.startswith('./') or slug.startswith('.\\'):
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	422 slug = slug[2:]
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	423 if slug == '_index':
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	424 slug = ''
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	425 return slug
c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	426
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	427 def _filterPageDirname(self, d):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	428 return not d.endswith('-assets')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	429
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	430 def _filterPageFilename(self, f):
27 105f24f490cb Various fixes for the default page source: Ludovic Chabant <ludovic@chabant.com> parents: 11 diff changeset	431 return (f[0] != '.' and # .DS_store and other crap
105f24f490cb Various fixes for the default page source: Ludovic Chabant <ludovic@chabant.com> parents: 11 diff changeset	432 f[-1] != '~' and # Vim temp files and what-not
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	433 f not in ['Thumbs.db']) # Windows bullshit
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	434
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	435 def _populateMetadata(self, rel_path, metadata, mode=None):
170 c3831a762bc2 sources: Make the `SimplePageSource` more extensible, fix bugs in `prose` source. Ludovic Chabant <ludovic@chabant.com> parents: 144 diff changeset	436 pass
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	437
171 d5991525801d sources: Add an `IListableSource` interface for sources that can be listed. Ludovic Chabant <ludovic@chabant.com> parents: 170 diff changeset	438
186 e61fbae61402 sources: Pass any current mode to `_populateMetadata` when finding pages. Ludovic Chabant <ludovic@chabant.com> parents: 171 diff changeset	439 class DefaultPageSource(SimplePageSource):
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	440 SOURCE_NAME = 'default'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	441
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	442 def __init__(self, app, name, config):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	443 super(DefaultPageSource, self).__init__(app, name, config)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	444
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	445
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	446 class SourceFactoryIterator(object):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	447 def __init__(self, source):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	448 self.source = source
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	449 self.it = None # This is to permit recursive traversal of the
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	450 # iterator chain. It acts as the end.
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	451
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	452 def __iter__(self):
114 371a6c879ab9 When possible, try and batch-load pages so we only lock once. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	453 return self.source.getPages()
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	454
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	455
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	456 class DateSortIterator(object):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	457 def __init__(self, it, reverse=True):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	458 self.it = it
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	459 self.reverse = reverse
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	460
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	461 def __iter__(self):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	462 return iter(sorted(self.it,
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	463 key=lambda x: x.datetime, reverse=self.reverse))
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	464
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	465
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	466 class PaginationDataBuilderIterator(object):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	467 def __init__(self, it):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	468 self.it = it
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	469
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	470 def __iter__(self):
f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	471 for page in self.it:
11 617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	472 if page is None:
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	473 yield None
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	474 else:
617191dec18e Fixes for Windows, make `findPagePath` return a ref path. Ludovic Chabant <ludovic@chabant.com> parents: 7 diff changeset	475 yield PaginationData(page)
6 f5ca5c5bed85 More Python 3 fixes, modularization, and new unit tests. Ludovic Chabant <ludovic@chabant.com> parents: 5 diff changeset	476

Mercurial > piecrust2

annotate piecrust/sources/base.py @ 226:e9dc18a275ff