Automatically dedent map/reduce code in ViewDefinition.

cmlenz · cmlenz · commit 360d7cfee807 · 2008-11-07T16:38:35.000Z
--HG--
extra : convert_revision : svn%3A7a298fb0-333a-0410-83e7-658617cd9cf3/trunk%40120
diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -24,8 +24,8 @@ http://couchdb-python.googlecode.com/svn/tags/0.4.1
    triggering an internal server error (issue 31).
  * Added a new `couchdb.design` module that provides functionality for
    managing views in design documents, so that they can be defined in the
-   Python application code, and kept in sync with the design documents
-   actually stored in the database.
+   Python application code, and the design documents actually stored in the
+   database can be kept in sync with the definitions in the code.
 
 
 Version 0.4
diff --git a/couchdb/design.py b/couchdb/design.py
@@ -11,10 +11,11 @@
 from copy import deepcopy
 from itertools import groupby
 from operator import attrgetter
+from textwrap import dedent
 
 
 class ViewDefinition(object):
-    """Definition of a view stored in a specific design document.
+    r"""Definition of a view stored in a specific design document.
     
     An instance of this class can be used to access the results of the view,
     as well as to keep the view definition in the design document up to date
@@ -53,6 +54,10 @@ def __init__(self, design, name, map_fun, reduce_fun=None,
                  language='javascript', wrapper=None):
         """Initialize the view definition.
         
+        Note that the code in `map_fun` and `reduce_fun` is automatically
+        dedented, that is, any common leading whitespace is removed from each
+        line.
+        
         :param design: the name of the design document
         :param name: the name of the view
         :param map_fun: the map function code
@@ -65,7 +70,9 @@ def __init__(self, design, name, map_fun, reduce_fun=None,
             design = design[8:]
         self.design = design
         self.name = name
-        self.map_fun = map_fun
+        self.map_fun = dedent(map_fun.lstrip('\n\r'))
+        if reduce_fun:
+            reduce_fun = dedent(reduce_fun.lstrip('\n\r'))
         self.reduce_fun = reduce_fun
         self.language = language
         self.wrapper = wrapper
@@ -121,7 +128,8 @@ def sync_many(db, views, remove_missing=False, callback=None):
                                instances should be removed
         :param callback: a callback function that is invoked when a design
                          document gets updated; the callback gets passed the
-                         design document as only parameter
+                         design document as only parameter, before that doc
+                         has actually been saved back to the database
         """
         docs = []
 
diff --git a/couchdb/schema.py b/couchdb/schema.py
@@ -174,18 +174,24 @@ def _to_json(self, value):
 
 
 class View(object):
-    """Descriptor that can be used to bind a view definition to a property of
+    r"""Descriptor that can be used to bind a view definition to a property of
     a `Document` class.
     
     >>> class Person(Document):
     ...     name = TextField()
     ...     age = IntegerField()
-    ...     by_name = View('people', '''function(doc) {
-    ...         emit(doc.name, doc.age);
-    ...     }''')
+    ...     by_name = View('people', '''\
+    ...         function(doc) {
+    ...             emit(doc.name, doc.age);
+    ...         }''')
     >>> Person.by_name
     <ViewDefinition '_view/people/by_name'>
     
+    >>> print Person.by_name.map_fun
+    function(doc) {
+        emit(doc.name, doc.age);
+    }
+    
     That property can be used as a function, which will execute the view.
     
     >>> from couchdb import Database
