replace get_summary with _get_summary

When memoizing summary a dummy get_summary function was introduced to
properly work. This has multiple problems:
* The siteurl argument is actually not used in the function, it is only
  used so it properly memoizes.
* It differs from how content is accessed and memoized.

This commit brings summary inline with how content is accessed and
processed. It also removes the old get_summary function with the unused
siteurl argument.

Additionally _get_summary is marked as deprecated and calls .summary
instead while also issueing a warning.
This commit is contained in:
derwinlu 2015-10-19 16:38:07 +02:00
commit 2cb2bf05df
2 changed files with 36 additions and 12 deletions

View file

@ -273,6 +273,9 @@ class Content(object):
return hrefs.sub(replacer, content)
def get_siteurl(self):
return self._context.get('localsiteurl', '')
@memoized
def get_content(self, siteurl):
if hasattr(self, '_get_content'):
@ -281,22 +284,19 @@ class Content(object):
content = self._content
return self._update_content(content, siteurl)
def get_siteurl(self):
return self._context.get('localsiteurl', '')
@property
def content(self):
return self.get_content(self.get_siteurl())
def _get_summary(self):
@memoized
def get_summary(self, siteurl):
"""Returns the summary of an article.
This is based on the summary metadata if set, otherwise truncate the
content.
"""
if hasattr(self, '_summary'):
return self._update_content(self._summary,
self.get_siteurl())
return self._update_content(self._summary, siteurl)
if self.settings['SUMMARY_MAX_LENGTH'] is None:
return self.content
@ -304,15 +304,17 @@ class Content(object):
return truncate_html_words(self.content,
self.settings['SUMMARY_MAX_LENGTH'])
@memoized
def get_summary(self, siteurl):
"""uses siteurl to be memoizable"""
return self._get_summary()
@property
def summary(self):
return self.get_summary(self.get_siteurl())
def _get_summary(self):
"""deprecated function to access summary"""
logger.warn('_get_summary() has been deprecated since 3.6.4. '
'Use the summary decorator instead')
return self.summary
@summary.setter
def summary(self, value):
"""Dummy function"""