piecrust2: piecrust/data/linker.py annotate

annotate piecrust/data/linker.py @ 455:cb3446be44b7

bake: Abort "render first" jobs if we start using other pages. This prevents the baker from having one worker stuck on a very long job, like rendering the index page of a blog with lots and lots of posts.

author	Ludovic Chabant <ludovic@chabant.com>
date	Wed, 08 Jul 2015 22:51:29 -0700
parents	32c7c2d219d2
children	48fcdd967212

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

Mercurial > piecrust2

annotate piecrust/data/linker.py @ 455:cb3446be44b7