github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Pass write function to reduce duplication. Simplify logic.

Browse source
This commit is contained in:
Stuart Colville 2012-05-02 09:26:33 +01:00
commit 06ba9acdb8
2 changed files with 31 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

57
pelican/generators.py
View file

@ -162,45 +162,32 @@ class ArticlesGenerator(Generator):
writer.write_feed(items, self.context, writer.write_feed(items, self.context,
self.settings['TRANSLATION_FEED'] % lang) self.settings['TRANSLATION_FEED'] % lang)
def generate_articles(self, writer): def generate_articles(self, write):
"""Generate the articles.""" """Generate the articles."""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
article_template = self.get_template('article') article_template = self.get_template('article')
for article in chain(self.translations, self.articles): for article in chain(self.translations, self.articles):
write(article.save_as, write(article.save_as,
article_template, self.context, article=article, article_template, self.context, article=article,
category=article.category) category=article.category)
def generate_direct_templates(self, writer): def generate_direct_templates(self, write):
"""Generate direct templates pages""" """Generate direct templates pages"""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
PAGINATED_TEMPLATES = self.settings.get('PAGINATED_DIRECT_TEMPLATES') PAGINATED_TEMPLATES = self.settings.get('PAGINATED_DIRECT_TEMPLATES')
for template in self.settings.get('DIRECT_TEMPLATES'): for template in self.settings.get('DIRECT_TEMPLATES'):
paginated = {} paginated = {}
if template in PAGINATED_TEMPLATES: if template in PAGINATED_TEMPLATES:
paginated = {'articles': self.articles, 'dates': self.dates} paginated = {'articles': self.articles, 'dates': self.dates}
save_as = self.settings.get("%s_SAVE_AS" % template.upper(),
save_as = self.settings.get("%s_SAVE_AS" % template.upper(), None) '%s.html' % template)
if save_as is None: if not save_as:
file_name = '%s.html' % template
elif save_as:
file_name = save_as
else:
continue continue
write(file_name, self.get_template(template), write(save_as, self.get_template(template),
self.context, blog=True, paginated=paginated, self.context, blog=True, paginated=paginated,
page_name=template) page_name=template)
def generate_tags(self, writer): def generate_tags(self, write):
"""Generate Tags pages.""" """Generate Tags pages."""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
tag_template = self.get_template('tag') tag_template = self.get_template('tag')
for tag, articles in self.tags.items(): for tag, articles in self.tags.items():
articles.sort(key=attrgetter('date'), reverse=True) articles.sort(key=attrgetter('date'), reverse=True)
@ -210,11 +197,8 @@ class ArticlesGenerator(Generator):
paginated={'articles': articles, 'dates': dates}, paginated={'articles': articles, 'dates': dates},
page_name=u'tag/%s' % tag) page_name=u'tag/%s' % tag)
def generate_categories(self, writer): def generate_categories(self, write):
"""Generate category pages.""" """Generate category pages."""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
category_template = self.get_template('category') category_template = self.get_template('category')
for cat, articles in self.categories: for cat, articles in self.categories:
dates = [article for article in self.dates if article in articles] dates = [article for article in self.dates if article in articles]
@ -223,11 +207,8 @@ class ArticlesGenerator(Generator):
paginated={'articles': articles, 'dates': dates}, paginated={'articles': articles, 'dates': dates},
page_name=u'category/%s' % cat) page_name=u'category/%s' % cat)
def generate_authors(self, writer): def generate_authors(self, write):
"""Generate Author pages.""" """Generate Author pages."""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
author_template = self.get_template('author') author_template = self.get_template('author')
for aut, articles in self.authors: for aut, articles in self.authors:
dates = [article for article in self.dates if article in articles] dates = [article for article in self.dates if article in articles]
@ -236,11 +217,8 @@ class ArticlesGenerator(Generator):
paginated={'articles': articles, 'dates': dates}, paginated={'articles': articles, 'dates': dates},
page_name=u'author/%s' % aut) page_name=u'author/%s' % aut)
def generate_drafts(self, writer): def generate_drafts(self, write):
"""Generate drafts pages.""" """Generate drafts pages."""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
article_template = self.get_template('article') article_template = self.get_template('article')
for article in self.drafts: for article in self.drafts:
write('drafts/%s.html' % article.slug, article_template, write('drafts/%s.html' % article.slug, article_template,
@ -248,17 +226,20 @@ class ArticlesGenerator(Generator):
def generate_pages(self, writer): def generate_pages(self, writer):
"""Generate the pages on the disk""" """Generate the pages on the disk"""
write = partial(writer.write_file,
relative_urls=self.settings.get('RELATIVE_URLS'))
# to minimize the number of relative path stuff modification # to minimize the number of relative path stuff modification
# in writer, articles pass first # in writer, articles pass first
self.generate_articles(writer) self.generate_articles(write)
self.generate_direct_templates(writer) self.generate_direct_templates(write)
# and subfolders after that # and subfolders after that
self.generate_tags(writer) self.generate_tags(write)
self.generate_categories(writer) self.generate_categories(write)
self.generate_authors(writer) self.generate_authors(write)
self.generate_drafts(writer) self.generate_drafts(write)
def generate_context(self): def generate_context(self):
"""change the context""" """change the context"""

23
tests/test_generators.py
View file

@ -54,11 +54,10 @@ class TestArticlesGenerator(unittest.TestCase):
generator = ArticlesGenerator(settings.copy(), settings, None, generator = ArticlesGenerator(settings.copy(), settings, None,
_DEFAULT_CONFIG['THEME'], None, _DEFAULT_CONFIG['THEME'], None,
_DEFAULT_CONFIG['MARKUP']) _DEFAULT_CONFIG['MARKUP'])
write = MagicMock()
writer = MagicMock() generator.generate_direct_templates(write)
generator.generate_direct_templates(writer) write.assert_called_with("archives.html",
writer.write_file.assert_called_with("archives.html", generator.get_template("archives"), settings,
generator.get_template("archives"), settings, relative_urls=True,
blog=True, paginated={}, page_name='archives') blog=True, paginated={}, page_name='archives')
def test_direct_templates_save_as_modified(self): def test_direct_templates_save_as_modified(self):
@ -69,10 +68,10 @@ class TestArticlesGenerator(unittest.TestCase):
generator = ArticlesGenerator(settings, settings, None, generator = ArticlesGenerator(settings, settings, None,
_DEFAULT_CONFIG['THEME'], None, _DEFAULT_CONFIG['THEME'], None,
_DEFAULT_CONFIG['MARKUP']) _DEFAULT_CONFIG['MARKUP'])
writer = MagicMock() write = MagicMock()
generator.generate_direct_templates(writer) generator.generate_direct_templates(write)
writer.write_file.assert_called_with("archives/index.html", write.assert_called_with("archives/index.html",
generator.get_template("archives"), settings, relative_urls=True, generator.get_template("archives"), settings,
blog=True, paginated={}, page_name='archives') blog=True, paginated={}, page_name='archives')
def test_direct_templates_save_as_false(self): def test_direct_templates_save_as_false(self):
@ -83,6 +82,6 @@ class TestArticlesGenerator(unittest.TestCase):
generator = ArticlesGenerator(settings, settings, None, generator = ArticlesGenerator(settings, settings, None,
_DEFAULT_CONFIG['THEME'], None, _DEFAULT_CONFIG['THEME'], None,
_DEFAULT_CONFIG['MARKUP']) _DEFAULT_CONFIG['MARKUP'])
writer = MagicMock() write = MagicMock()
generator.generate_direct_templates(writer) generator.generate_direct_templates(write)
writer.write_file.assert_called_count == 0 write.assert_called_count == 0