Improved comments, removed debug code

src/djanalytics/core/auth.py

@@ -22,6 +22,14 @@ from django.conf import settings
 import re
 
 def auth(f):
+    ''' Authentication decorator. It will allow all access, unless
+    django settings defines a DJA_AUTH parameter. Such a parameter can
+    specify a decorator which will handle authentication/authorization. 
+
+    DJA_AUTH is a dictionary mapping regexps to appropriate decorators
+    (so it is possible to e.g. use one for views, and a different one
+    for queries)
+    '''
     try:
         dja = settings.DJA_AUTH
     except AttributeError:

src/djanalytics/core/decorators.py

@@ -170,6 +170,11 @@ def cron(period, params=None):
     return factory
 
 def event_property(name=None, description=None):
+    ''' This is used to add properties to events. 
+
+    E.g. a module could add the tincan properties such that other
+    analytics modules could access event properties generically. 
+    '''
     def register(f):
         registry.register_event_property(f, name, description)
         return f

src/djanalytics/core/djobject.py

@@ -57,7 +57,7 @@ class multi_embed():
     def __init__(self, embeds):
         self._embeds = embeds
     def __getattr__(self, attr):
-        print ">>>>>>>>>>>>> Getting", attr
+#        print ">>>>>>>>>>>>> Getting", attr
         for x in self._embeds:
             f = None
             try:
@@ -65,11 +65,11 @@ class multi_embed():
             except AttributeError:
                 pass
             if f:
-                print
-                print ">>>>>>>>>>>>>>>>>>>", f
-                print
+#                print
+#                print ">>>>>>>>>>>>>>>>>>>", f
+#                print
                 return f
-        print "Not found"
+        print "Not found", attr
         raise AttributeError(attr)
 
     def _refresh_schema(self):
@@ -77,7 +77,7 @@ class multi_embed():
             x._refresh_schema
     def __dir__(self):
         child_dirs = [x.__dir__() for x in self._embeds]
-        print child_dirs
+#        print child_dirs
         return sorted(list(set(sum(child_dirs, []))))
     def __repr__(self):
         return "/".join(map(lambda x:repr(x), self._embeds))
@@ -252,7 +252,7 @@ def get_embed(t, config = None):
     if config: 
         embeds = []
         for embed_spec in config:
-            print embed_spec
+#            print embed_spec
             embeds.append(single_embed(t, **embed_spec))
         return multi_embed(embeds)
     return single_embed(t)
@@ -267,7 +267,7 @@ if __name__ == "__main__":
     if True: # Internal test -- from djanalytics
         print djo.query.djt_event_count()
         print djo.query.djt_user_event_count(user = "bob")
-        print djo.query.__dir__()
+        print dir(djo.query)
 
     if False: # External test -- from edxanalytics
         transform_policy = {'name': 'test',
@@ -282,6 +282,6 @@ if __name__ == "__main__":
                     'course' : '6.002x' }
         
         secure_view = transform_embed(transform_policy, context, djo.view)
-        print secure_view.__dir__()
+        print dir(secure_view)
         print secure_view.page_count(course = '6.002x')
         print inspect.getargspec(secure_view.page_count)

src/djanalytics/core/registry.py

@@ -91,6 +91,8 @@ def register_event_property(f, name, description):
     event_property_registry[name] = {'function': f, 'name': name, 'doc': description}
 
 def schema_helper():
+    ''' Return all endpoints (returned in a format identical to schema view)
+    '''
     endpoints = []
     for cls in request_handlers:
         for name in request_handlers[cls]:

src/djanalytics/core/render.py

@@ -58,6 +58,10 @@ lookups = {}
 
 
 def lookup(directory):
+    ''' Return the mako TemplateLookup for a directory. 
+
+    Will cache lookups if we created one before. 
+    '''
     if directory in lookups:
         return lookups[directory]
     else:

src/djanalytics/modules/testmodule/__init__.py

@@ -8,6 +8,7 @@ from djanalytics.core.decorators import query, event_handler, view, event_proper
 
 @view()
 def djt_hello_template():
+    ''' Example of how to use mako templates in a view '''
     from djanalytics.core.render import render
     return render("hello.html", {})
 
@@ -123,11 +124,13 @@ def djt_readfile(fs, filename):
 
 @query()
 def djt_cache_get(cache, key):
+    ''' Used in test case for cache '''
     result = cache.get(key)
     return result
 
 @event_handler()
 def djt_cache_set(cache, events):
+    ''' Used in test case for cache '''
     for evt in events:
         if 'event' in evt and evt['event'] == 'cachetest':
             cache.set(evt['key'], evt['value'], evt['timeout'])
@@ -145,12 +148,14 @@ def djt_agent(event):
 
 @event_handler()
 def djt_event_property_check(cache, events):
+    ''' Used in test case for event handler '''
     for evt in events:
         if "event_property_check" in evt:
             cache.set("last_seen_user", evt.djt_agent, 30)
 
 @query()
 def djt_fake_user_count():
+    ''' Used as test case for query objects '''
     return 2
 
 @view()