Reports - user usefullness

sitescripts/utils.py

 # coding: utf-8
 
 # This Source Code is subject to the terms of the Mozilla Public License
 # version 2.0 (the "License"). You can obtain a copy of the License at
 # http://mozilla.org/MPL/2.0/.
 
 import os, sys, codecs, subprocess, sitescripts
 from time import time
 from tempfile import mkstemp
 from ConfigParser import SafeConfigParser
 
 siteScriptsPath = sitescripts.__path__[0]
 
 class cached(object):
   """
     Decorator that caches a function's return value for a given number of seconds.

[Wladimir Palant, 2012/10/25 15:12:55]

Still need a note here like:

Note that this only works if the string representation of the parameters is
always unique.

[Andrey Novikov, 2012/10/29 07:05:09]

Done.

-    Note that this can only be used with functions that take no arguments.
   """
-
   def __init__(self, timeout):
     self.timeout = timeout
-    self.func = None
-    self.lastUpdate = None
-    self.lastResult = None
+    self.lastResult = {}
+    self.lastUpdate = {}
 
-  def __call__(self, *args):
-    if len(args) == 1:
-      # We got called with the function to be decorated - remember the function
-      # and return the same object again
-      self.func = args[0]
-      return self
-    else:
+  def __call__(self, func):
+    def wrapped(*args, **kwargs):
+      key = str(kwargs)
       currentTime = time()
-      if self.lastUpdate == None or currentTime - self.lastUpdate > self.timeout:
-        self.lastResult = self.func()
-        self.lastUpdate = currentTime
-      return self.lastResult
+      if (args, key) not in self.lastUpdate or currentTime - self.lastUpdate[args, key] > self.timeout:
+        self.lastResult[args, key] = func(*args, **kwargs)
+        self.lastUpdate[args, key] = currentTime
+      return self.lastResult[args, key]
+    self.wrapped = wrapped
+    return wrapped
 
   def __repr__(self):
-    """Return the function's docstring"""
-    return self.func.__doc__
+    return repr(self.wrapped)

[Wladimir Palant, 2012/10/25 15:12:55]

I don't think that we should forward this to our wrapper - rather to the
original function. So I think that you should store the func parameter instead
of wrapped.

[Andrey Novikov, 2012/10/29 07:05:09]

Done.

 
 @cached(3600)
 def get_config():
   """
     Returns parsed configuration file (SafeConfigParser instance). File paths
     that will be checked: ~/.sitescripts, ~/sitescripts.ini, /etc/sitescripts,
     /etc/sitescripts.ini
   """
 
   paths = []
@@ skipping 69 matching lines @@
 def get_unescaped_template_environment():
   """
     Returns a Jinja2 template environment without autoescaping. Don't use this to
     generate HTML files!
   """
   from sitescripts.templateFilters import filters
   import jinja2
   env = jinja2.Environment(loader=jinja2.FileSystemLoader(siteScriptsPath))
   env.filters.update(filters)
   return env