Multiple CMS improvements

sitescripts/cms/converters.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2013 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 165 matching lines @@
     Converter.__init__(self, *args, **kwargs)
 
     filters = {
       "translate": self.translate,
       "linkify": self.linkify,
       "toclist": self.toclist,
     }
 
     for filename in self._params["source"].list_files("filters"):
       root, ext = os.path.splitext(filename)
-      if ext != ".py":

[Sebastian Noack, 2013/12/11 11:38:29]

You might want to compare the file extension case-insensitive.

[Wladimir Palant, 2013/12/11 12:05:19]

Then we should do the same everywhere else where we look at file extensions.

+      if ext.lower() != ".py":
         continue
 
       path = "%s/%s" % ("filters", filename)
       code = self._params["source"].read_file(path)
       module = imp.new_module(root.replace("/", "."))
       exec code in module.__dict__
 
       func = os.path.basename(root)
-      if func not in module.__dict__:

[Sebastian Noack, 2013/12/11 11:38:29]

You should use the getattr/setattr/hasattr/delattr family of built-in functions
instead of accessing __dict__ directly, when possible, so in this case:

hasattr(module, func)

+      if not hasattr(module, func):
         raise Exception("Expected function %s not found in filter file %s" % (func, filename))
-      filters[func] = module.__dict__[func]

[Sebastian Noack, 2013/12/11 11:38:29]

See above:

getattr(module, func)

-      filters[func].__module__ = module  # Prevent garbage collection

[Sebastian Noack, 2013/12/11 11:38:29]

The __module__ attribute of objects is supposed to be the name (not the
instance) of the module, which is already set correctly here.

Instead you should put the module into sys.modules, where all imported modules
store their references.

[Wladimir Palant, 2013/12/11 12:05:19]

Ok, clashing with a predefined property was unintended, I changed that into
property name into module_ref.
I explicitly didn't want to put this into sys.modules - that isn't a real
module, rather a temporary execution context for a filter. We reload filters on
each use, messing with somebody's import statements wasn't the idea.

+      filters[func] = getattr(module, func)
+      filters[func].module_ref = module  # Prevent garbage collection
 
     self._env = get_custom_template_environment(filters)
 
   def get_html(self, source):
     template = self._env.from_string(source)
     return template.render(self._params)
 
   def translate(self, name, page=None, links=[]):
     if page == None:
       localedata = self._params["localedata"]
@@ skipping 28 matching lines @@
         stack.pop()
       stack[-1]["subitems"].append(item)
       stack.append(item)
     return structured
 
 converters = {
   "raw": RawConverter,
   "md": MarkdownConverter,
   "tmpl": TemplateConverter,
 }