piecrust2: piecrust/data/linker.py annotate

annotate piecrust/data/linker.py @ 661:2f780b191541

internal: Fix a bug with registering taxonomy terms that are not strings. Some objects, like the blog data provider's taxnonomy entries, can render as strings, but are objects themselves. When registering them as "used terms", we need to use their string representation.

author	Ludovic Chabant <ludovic@chabant.com>
date	Tue, 01 Mar 2016 22:26:09 -0800
parents	3cca1f6bd610
children	4850f8c21b6e

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
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	3 from piecrust.data.iterators import PageIterator
440 32c7c2d219d2 performance: Refactor how data is managed to reduce copying. Ludovic Chabant <ludovic@chabant.com> parents: 411 diff changeset	4 from piecrust.data.pagedata import LazyPageConfigLoaderHasNoValue
32c7c2d219d2 performance: Refactor how data is managed to reduce copying. Ludovic Chabant <ludovic@chabant.com> parents: 411 diff changeset	5 from piecrust.data.paginationdata import PaginationData
242 f130365568ff internal: Code reorganization to put less stuff in `sources.base`. Ludovic Chabant <ludovic@chabant.com> parents: 237 diff changeset	6 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	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
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	9 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	10
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	11
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	12 class PageLinkerData(object):
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	13 """ 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	14 root page.
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	15 """
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	16 debug_render = ['parent', 'ancestors', 'siblings', 'children', 'root',
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	17 'forpath']
590 3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	18 debug_render_invoke = ['parent', 'ancestors', 'siblings', 'children',
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	19 'root']
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	20 debug_render_redirect = {
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	21 'ancestors': '_debugRenderAncestors',
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	22 'siblings': '_debugRenderSiblings',
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	23 'children': '_debugRenderChildren',
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	24 'root': '_debugRenderRoot'}
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	25
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	26 def __init__(self, source, page_path):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	27 self._source = source
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	28 self._root_page_path = page_path
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	29 self._linker = None
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	30 self._is_loaded = False
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	31
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	32 @property
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	33 def parent(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	34 self._load()
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	35 if self._linker is not None:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	36 return self._linker.parent
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	37 return None
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	38
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	39 @property
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	40 def ancestors(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	41 cur = self.parent
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	42 while cur:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	43 yield cur
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	44 cur = cur.parent
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	45
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	46 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	47 def siblings(self):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	48 self._load()
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	49 if self._linker is None:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	50 return []
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	51 return self._linker
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	52
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	53 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	54 def children(self):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	55 self._load()
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	56 if self._linker is None:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	57 return []
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	58 self._linker._load()
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	59 if self._linker._self_item is None:
401 8e1e55ad35fb linker: Fix error when trying to list non-existing children. Ludovic Chabant <ludovic@chabant.com> parents: 381 diff changeset	60 return []
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	61 children = self._linker._self_item._linker_info.child_linker
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	62 if children is None:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	63 return []
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	64 return children
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	65
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	66 @property
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	67 def root(self):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	68 self._load()
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	69 if self._linker is None:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	70 return None
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	71 return self._linker.root
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	72
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	73 def forpath(self, rel_path):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	74 self._load()
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	75 if self._linker is None:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	76 return None
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	77 return self._linker.forpath(rel_path)
d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	78
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	79 def _load(self):
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	80 if self._is_loaded:
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	81 return
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	82
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	83 self._is_loaded = True
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	84
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	85 is_listable = isinstance(self._source, IListableSource)
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	86 if not is_listable:
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	87 return
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	88
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	89 dir_path = self._source.getDirpath(self._root_page_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	90 self._linker = Linker(self._source, dir_path,
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	91 root_page_path=self._root_page_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	92
590 3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	93 def _debugRenderAncestors(self):
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	94 return [i.name for i in self.ancestors]
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	95
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	96 def _debugRenderSiblings(self):
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	97 return [i.name for i in self.siblings]
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	98
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	99 def _debugRenderChildren(self):
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	100 return [i.name for i in self.children]
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	101
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	102 def _debugRenderRoot(self):
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	103 r = self.root
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	104 if r is not None:
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	105 return r.name
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	106 return None
3cca1f6bd610 debug: Fix how the linker shows children/siblings/etc. in the debug window. Ludovic Chabant <ludovic@chabant.com> parents: 518 diff changeset	107
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	108
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	109 class LinkedPageData(PaginationData):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	110 """ Class whose instances get returned when iterating on a `Linker`
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	111 or `RecursiveLinker`. It's just like what gets usually returned by
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	112 `Paginator` and other page iterators, but with a few additional data
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	113 like hierarchical data.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	114 """
408 fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	115 debug_render = (['is_dir', 'is_self', 'parent', 'children'] +
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	116 PaginationData.debug_render)
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	117 debug_render_invoke = (['is_dir', 'is_self', 'parent', 'children'] +
fd8e39254da0 debug: Better debug info output for iterators, providers, and linkers. Ludovic Chabant <ludovic@chabant.com> parents: 404 diff changeset	118 PaginationData.debug_render_invoke)
172 4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	119
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	120 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	121 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	122 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	123 self.is_self = page._linker_info.is_self
402 043b9d8304c7 linker: Fix linker returning the wrong value for `is_dir` in some situations. Ludovic Chabant <ludovic@chabant.com> parents: 401 diff changeset	124 self.is_dir = page._linker_info.is_dir
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	125 self.is_page = True
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	126 self._child_linker = page._linker_info.child_linker
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	127
440 32c7c2d219d2 performance: Refactor how data is managed to reduce copying. Ludovic Chabant <ludovic@chabant.com> parents: 411 diff changeset	128 self._mapLoader('*', self._linkerChildLoader)
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	129
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	130 @property
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	131 def parent(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	132 if self._child_linker is not None:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	133 return self._child_linker.parent
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	134 return None
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	135
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	136 @property
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	137 def children(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	138 if self._child_linker is not None:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	139 return self._child_linker
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	140 return []
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	141
381 4c9eab0e283b data: Fix problems with using non-existing metadata on a linked page. Ludovic Chabant <ludovic@chabant.com> parents: 368 diff changeset	142 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	143 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	144 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	145 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	146
237 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 class LinkedPageDataBuilderIterator(object):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	149 """ Iterator that builds `LinkedPageData` out of pages.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	150 """
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	151 def __init__(self, it):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	152 self.it = it
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	153
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	154 def __iter__(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	155 for item in self.it:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	156 yield LinkedPageData(item)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	157
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	159 class LinkerSource(IPaginationSource):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	160 """ Source iterator that returns pages given by `Linker`.
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	161 """
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	162 def __init__(self, pages, orig_source):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	163 self._pages = list(pages)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	164 self._orig_source = None
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	165 if isinstance(orig_source, IPaginationSource):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	166 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	167
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	168 def getItemsPerPage(self):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	169 raise NotImplementedError()
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	170
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	171 def getSourceIterator(self):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	172 return self._pages
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	173
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	174 def getSorterIterator(self, it):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	175 # 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	176 # 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	177 return None
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	178
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	179 def getTailIterator(self, it):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	180 return LinkedPageDataBuilderIterator(it)
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	181
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	182 def getPaginationFilter(self, page):
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	183 return None
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	184
d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	185 def getSettingAccessor(self):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	186 if self._orig_source:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	187 return self._orig_source.getSettingAccessor()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	188 return None
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	189
701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	190
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	191 class _LinkerInfo(object):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	192 def __init__(self):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	193 self.name = None
402 043b9d8304c7 linker: Fix linker returning the wrong value for `is_dir` in some situations. Ludovic Chabant <ludovic@chabant.com> parents: 401 diff changeset	194 self.is_dir = False
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	195 self.is_self = False
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	196 self.child_linker = None
368 2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	197
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	198
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	199 class _LinkedPage(object):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	200 def __init__(self, page):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	201 self._page = page
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	202 self._linker_info = _LinkerInfo()
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	203
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	204 def __getattr__(self, name):
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	205 return getattr(self._page, name)
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	206
2408eb6f4da8 linker: Don't put linker stuff in the config. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	207
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	208 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	209 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	210
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	211 def __init__(self, source, dir_path, *, root_page_path=None):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	212 self._source = source
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	213 self._dir_path = dir_path
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	214 self._root_page_path = root_page_path
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	215 self._items = None
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	216 self._parent = None
247 d9d5c5de02a8 data: Add a top level wrapper for `Linker`. Ludovic Chabant <ludovic@chabant.com> parents: 242 diff changeset	217 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	218
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	219 self.is_dir = True
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	220 self.is_page = False
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	221 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	222
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	223 def __iter__(self):
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	224 return iter(self.pages)
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	225
227 d6d0e4976beb data: Make the `Linekr` use the new `getSettingAccessor` API. Ludovic Chabant <ludovic@chabant.com> parents: 212 diff changeset	226 def __getattr__(self, name):
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	227 self._load()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	228 try:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	229 item = self._items[name]
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	230 except KeyError:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	231 raise AttributeError()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	232
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	233 if isinstance(item, Linker):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	234 return item
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	235
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	236 return LinkedPageData(item)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	237
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	238 def __str__(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	239 return self.name
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	240
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	241 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	242 def name(self):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	243 return self._source.getBasename(self._dir_path)
237 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 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	246 def children(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	247 return self._iterItems(0)
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 @property
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	250 def parent(self):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	251 if self._dir_path == '':
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	252 return None
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	253
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	254 if self._parent is None:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	255 parent_name = self._source.getBasename(self._dir_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	256 parent_dir_path = self._source.getDirpath(self._dir_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	257 for is_dir, name, data in self._source.listPath(parent_dir_path):
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	258 if not is_dir and name == parent_name:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	259 parent_page = data.buildPage()
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	260 item = _LinkedPage(parent_page)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	261 item._linker_info.name = parent_name
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	262 item._linker_info.child_linker = Linker(
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	263 self._source, parent_dir_path,
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	264 root_page_path=self._root_page_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	265 self._parent = LinkedPageData(item)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	266 break
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	267 else:
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	268 self._parent = Linker(self._source, parent_dir_path,
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	269 root_page_path=self._root_page_path)
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	270
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	271 return self._parent
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	272
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	273 @property
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	274 def pages(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	275 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	276
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	277 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	278 def directories(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	279 return self._iterItems(0, filter_directory_items)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	280
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	281 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	282 def all(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	283 return self._iterItems()
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	284
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	285 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	286 def allpages(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	287 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	288
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	289 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	290 def alldirectories(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	291 return self._iterItems(-1, filter_directory_items)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	292
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	293 @property
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	294 def root(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	295 return self.forpath('/')
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	296
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	297 def forpath(self, rel_path):
404 27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	298 return Linker(self._source, rel_path,
27b10024f8d8 linker: Add ability to return the parent and ancestors of a page. Ludovic Chabant <ludovic@chabant.com> parents: 402 diff changeset	299 root_page_path=self._root_page_path)
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	300
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	301 def _iterItems(self, max_depth=-1, filter_func=None):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	302 items = walk_linkers(self, max_depth=max_depth,
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	303 filter_func=filter_func)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	304 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	305 return PageIterator(src)
212 701591ebfcba data: Improve the Linker and RecursiveLinker features. Add tests. Ludovic Chabant <ludovic@chabant.com> parents: 172 diff changeset	306
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	307 def _load(self):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	308 if self._items is not None:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	309 return
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	310
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	311 is_listable = isinstance(self._source, IListableSource)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	312 if not is_listable:
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	313 raise Exception("Source '%s' can't be listed." % self._source.name)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	314
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	315 items = list(self._source.listPath(self._dir_path))
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	316 self._items = collections.OrderedDict()
411 e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	317 for is_dir, name, data in items:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	318 # If `is_dir` is true, `data` will be the directory's source
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	319 # path. If not, it will be a page factory.
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	320 if is_dir:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	321 item = Linker(self._source, data,
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	322 root_page_path=self._root_page_path)
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	323 else:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	324 page = data.buildPage()
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	325 is_self = (page.rel_path == self._root_page_path)
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	326 item = _LinkedPage(page)
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	327 item._linker_info.name = name
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	328 item._linker_info.is_self = is_self
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	329 if is_self:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	330 self._self_item = item
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	331
411 e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	332 existing = self._items.get(name)
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	333 if existing is None:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	334 self._items[name] = item
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	335 elif is_dir:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	336 # The current item is a directory. The existing item
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	337 # should be a page.
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	338 existing._linker_info.child_linker = item
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	339 existing._linker_info.is_dir = True
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	340 else:
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	341 # The current item is a page. The existing item should
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	342 # be a directory.
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	343 item._linker_info.child_linker = existing
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	344 item._linker_info.is_dir = True
e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 408 diff changeset	345 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	346
4fc1d306046b linker: Actually implement the `Linker` class, and use it in the page data. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	347
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	348 def filter_page_items(item):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	349 return not isinstance(item, Linker)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	350
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	351
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	352 def filter_directory_items(item):
401 8e1e55ad35fb linker: Fix error when trying to list non-existing children. Ludovic Chabant <ludovic@chabant.com> parents: 381 diff changeset	353 return isinstance(item, Linker)
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	354
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	355
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	356 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	357 linker._load()
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	358 for item in linker._items.values():
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	359 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	360 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	361
237 879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	362 if (isinstance(item, Linker) and
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	363 (max_depth < 0 or depth + 1 <= max_depth)):
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	364 yield from walk_linkers(item, depth + 1, max_depth)
879fe1457e48 data: `Linker` refactor. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	365

Mercurial > piecrust2

annotate piecrust/data/linker.py @ 661:2f780b191541