piecrust2: piecrust/data/linker.py annotate

annotate piecrust/data/linker.py @ 381:4c9eab0e283b

data: Fix problems with using non-existing metadata on a linked page. The page data wrapper now has supports for loader to raise a custom exception to declare that they can't return a value after all (this is especially useful for the wildcard loader). The returned value, if any, is also now cached properly.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sun, 10 May 2015 00:37:28 -0700
parents	2408eb6f4da8
children	8e1e55ad35fb

rev	line source
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	1 import logging
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	2 import collections
381 4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	3 from piecrust.data.base import PaginationData, LazyPageConfigLoaderHasNoValue
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	4 from piecrust.data.iterators import PageIterator
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 237 diff changeset	5 from piecrust.sources.interfaces import IPaginationSource, IListableSource
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	6
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	7
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	8 logger = logging.getLogger(__name__)
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	9
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	10
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	11 class PageLinkerData(object):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	12 """ Entry template data to get access to related pages from a given
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	13 root page.
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	14 """
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	15 def __init__(self, source, page_path):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	16 self._linker = Linker(source, page_path)
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	17
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	18 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	19 def siblings(self):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	20 return self._linker
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	21
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	22 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	23 def children(self):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	24 self._linker._load()
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	25 if self._linker._self_item is None:
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	26 return None
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	27 return self._linker._self_item._linker_info.child_linker
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	28
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	29 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	30 def root(self):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	31 return self._linker.root
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	32
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	33 def forpath(self, rel_path):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	34 return self._linker.forpath(rel_path)
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	35
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	36
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	37 class LinkedPageData(PaginationData):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	38 """ Class whose instances get returned when iterating on a `Linker`
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	39 or `RecursiveLinker`. It's just like what gets usually returned by
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	40 `Paginator` and other page iterators, but with a few additional data
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	41 like hierarchical data.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	42 """
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	43 debug_render = ['is_dir', 'is_self'] + PaginationData.debug_render
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	44
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	45 def __init__(self, page):
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	46 super(LinkedPageData, self).__init__(page)
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	47 self.name = page._linker_info.name
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	48 self.is_self = page._linker_info.is_self
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	49 self.children = page._linker_info.child_linker
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	50 self.is_dir = (self.children is not None)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	51 self.is_page = True
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	52
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	53 self.mapLoader('*', self._linkerChildLoader)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	54
381 4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	55 def _linkerChildLoader(self, data, name):
4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	56 if self.children and hasattr(self.children, name):
4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	57 return getattr(self.children, name)
4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	58 raise LazyPageConfigLoaderHasNoValue
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	59
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	60
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	61 class LinkedPageDataBuilderIterator(object):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	62 """ Iterator that builds `LinkedPageData` out of pages.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	63 """
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	64 def __init__(self, it):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	65 self.it = it
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	66
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	67 def __iter__(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	68 for item in self.it:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	69 yield LinkedPageData(item)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	70
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	71
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	72 class LinkerSource(IPaginationSource):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	73 """ Source iterator that returns pages given by `Linker`.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	74 """
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	75 def __init__(self, pages, orig_source):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	76 self._pages = list(pages)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	77 self._orig_source = None
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	78 if isinstance(orig_source, IPaginationSource):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	79 self._orig_source = orig_source
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	80
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	81 def getItemsPerPage(self):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	82 raise NotImplementedError()
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	83
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	84 def getSourceIterator(self):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	85 return self._pages
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	86
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	87 def getSorterIterator(self, it):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	88 # We don't want to sort the pages -- we expect the original source
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	89 # to return hierarchical items in the order it wants already.
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	90 return None
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	91
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	92 def getTailIterator(self, it):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	93 return LinkedPageDataBuilderIterator(it)
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	94
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	95 def getPaginationFilter(self, page):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	96 return None
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	97
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	98 def getSettingAccessor(self):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	99 if self._orig_source:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	100 return self._orig_source.getSettingAccessor()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	101 return None
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	102
701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	103
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	104 class _LinkerInfo(object):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	105 def __init__(self):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	106 self.name = None
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	107 self.is_self = False
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	108 self.child_linker = None
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	109
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	110
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	111 class _LinkedPage(object):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	112 def __init__(self, page):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	113 self._page = page
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	114 self._linker_info = _LinkerInfo()
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	115
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	116 def __getattr__(self, name):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	117 return getattr(self._page, name)
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	118
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	119
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120 class Linker(object):
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	121 debug_render_doc = """Provides access to sibling and children pages."""
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	122
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	123 def __init__(self, source, root_page_path, *, name=None, dir_path=None):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	124 self._source = source
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	125 self._root_page_path = root_page_path
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	126 self._name = name
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	127 self._dir_path = dir_path
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	128 self._items = None
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	129 self._self_item = None
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	130
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	131 self.is_dir = True
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	132 self.is_page = False
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	133 self.is_self = False
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	134
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	135 def __iter__(self):
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	136 return iter(self.pages)
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	137
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	138 def __getattr__(self, name):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	139 self._load()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	140 try:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	141 item = self._items[name]
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	142 except KeyError:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	143 raise AttributeError()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	144
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	145 if isinstance(item, Linker):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	146 return item
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	147
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	148 return LinkedPageData(item)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	149
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	150 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	151 def name(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	152 if self._name is None:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	153 self._load()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	154 return self._name
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	155
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	156 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	157 def children(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	158 return self._iterItems(0)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	159
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	160 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	161 def pages(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	162 return self._iterItems(0, filter_page_items)
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	163
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	164 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	165 def directories(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	166 return self._iterItems(0, filter_directory_items)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	167
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	168 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	169 def all(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	170 return self._iterItems()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	171
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	172 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	173 def allpages(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	174 return self._iterItems(-1, filter_page_items)
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	175
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	176 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	177 def alldirectories(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	178 return self._iterItems(-1, filter_directory_items)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	179
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	180 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	181 def root(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	182 return self.forpath('/')
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	183
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	184 def forpath(self, rel_path):
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	185 return Linker(self._source, self._root_page_path,
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	186 name='.', dir_path=rel_path)
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	187
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	188 def _iterItems(self, max_depth=-1, filter_func=None):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	189 items = walk_linkers(self, max_depth=max_depth,
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	190 filter_func=filter_func)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	191 src = LinkerSource(items, self._source)
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	192 return PageIterator(src)
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	193
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	194 def _load(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	195 if self._items is not None:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	196 return
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	197
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	198 is_listable = isinstance(self._source, IListableSource)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	199 if not is_listable:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	200 raise Exception("Source '%s' can't be listed." % self._source.name)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	201
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	202 if self._name is None:
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	203 self._name = self._source.getBasename(self._root_page_path)
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	204 if self._dir_path is None:
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	205 self._dir_path = self._source.getDirpath(self._root_page_path)
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	206
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	207 if self._dir_path is None:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	208 raise Exception("This linker has no directory to start from.")
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	209
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	210 items = list(self._source.listPath(self._dir_path))
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	211 self._items = collections.OrderedDict()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	212 with self._source.app.env.page_repository.startBatchGet():
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	213 for is_dir, name, data in items:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	214 # If `is_dir` is true, `data` will be the directory's source
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	215 # path. If not, it will be a page factory.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	216 if is_dir:
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	217 item = Linker(self._source, self._root_page_path,
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	218 name=name, dir_path=data)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	219 else:
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	220 page = data.buildPage()
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	221 is_self = (page.rel_path == self._root_page_path)
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	222 item = _LinkedPage(page)
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	223 item._linker_info.name = name
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	224 item._linker_info.is_self = is_self
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	225 if is_self:
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	226 self._self_item = item
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	227
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	228 existing = self._items.get(name)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	229 if existing is None:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	230 self._items[name] = item
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	231 elif is_dir:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	232 # The current item is a directory. The existing item
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	233 # should be a page.
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	234 existing._linker_info.child_linker = item
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	235 else:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	236 # The current item is a page. The existing item should
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	237 # be a directory.
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	238 item._linker_info.child_linker = existing
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	239 self._items[name] = item
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	240
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	241
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	242 def filter_page_items(item):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	243 return not isinstance(item, Linker)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	244
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	245
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	246 def filter_directory_items(item):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	247 return isinstance(item, linker)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	248
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	249
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	250 def walk_linkers(linker, depth=0, max_depth=-1, filter_func=None):
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	251 linker._load()
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	252 for item in linker._items.values():
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	253 if not filter_func or filter_func(item):
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	254 yield item
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	255
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	256 if (isinstance(item, Linker) and
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	257 (max_depth < 0 or depth + 1 <= max_depth)):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	258 yield from walk_linkers(item, depth + 1, max_depth)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	259

Mercurial > piecrust2

annotate piecrust/data/linker.py @ 381:4c9eab0e283b