Issue 2119 - Add get_page_content template function.

cms/converters.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
@@ skipping 326 matching lines @@
     # generating the master translation.
     localedata = self._params["localedata"]
     return jinja2.Markup(self.localize_string(name, default, localedata, html_escapes))
 
   def get_string(self, name, page):
     localedata = self._params["source"].read_locale(self._params["locale"], page)
     default = localedata[name]
     return jinja2.Markup(self.localize_string(name, default, localedata, html_escapes))
 
   def get_page_content(self, page, locale=None):
-    from utils import get_page_params

[kzar, 2015/04/05 12:10:12]

(I import this here as we have a circular dependency between utils.py and
converters.py.)

[Sebastian Noack, 2015/04/05 12:50:17]

This is usually an indicator, that something is wrong wit the structure of your
code. How about moving get_page_params into this (or a new) module?

[kzar, 2015/04/05 13:25:08]

I thought about that, and maybe I'm wrong, but I thought in this situation the
structure is OK. It's more a reflection of the recursive functionality.
(Processing one page requires the processing of another page.)

[Sebastian Noack, 2015/04/05 13:30:33]

Cyclic dependencies aren't great. However, the logic here doesn't require cyclic
dependencies it merely comes from how the code is structured. But it's not
important.

-
-    page, format = page.rsplit(".")

[Sebastian Noack, 2015/04/05 12:50:17]

I suppose you forgot the second argument to .rsplit()? However, I would use
os.path.splitext() instead anyway.

[kzar, 2015/04/05 13:25:08]

Done.

-    params = get_page_params(self._params["source"], locale, page, format)

[kzar, 2015/04/05 12:10:12]

(I'm unsure if I should pass self._params["site_url"] through here as the
site_url_override keyword argument to get_page_params or not. I couldn't find
where the site_url was even being used.)

[Sebastian Noack, 2015/04/05 12:50:17]

Shouldn't you fallback to self._params["locale"] if locale is not given?

[kzar, 2015/04/05 13:25:08]

Done.

-    return params["head"], params["body"]

[Sebastian Noack, 2015/04/05 12:50:17]

I would rather return a dict here, to make the calling code more obvious:

return {k: params[k] for k in ("head", "body")}

[kzar, 2015/04/05 13:25:08]

Done.

+    from cms.utils import get_page_params
+
+    if locale is None:
+      locale = self._params["locale"]
+    return get_page_params(self._params["source"], locale, page)
 
   def linkify(self, page, locale=None, **attrs):
     if locale is None:
       locale = self._params["locale"]
 
     locale, url = self._params["source"].resolve_link(page, locale)
     return jinja2.Markup('<a%s>' % ''.join(
       ' %s="%s"' % (name, jinja2.escape(value)) for name, value in [
         ('href', url),
         ('hreflang', locale)
@@ skipping 17 matching lines @@
         stack.pop()
       stack[-1]["subitems"].append(item)
       stack.append(item)
     return structured
 
 converters = {
   "html": RawConverter,
   "md": MarkdownConverter,
   "tmpl": TemplateConverter,
 }