Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Basic update handler support. #268

Closed
mefyl wants to merge 6 commits into from
Closed

Basic update handler support. #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
acbfded
Fix view server binary versus text error on python 3.4.
mefyl Aug 10, 2015
9690aa3
Extract functions compilation routine.
mefyl Aug 12, 2015
6363387
Add basic updates handler support.
mefyl Aug 12, 2015
5ac4bfa
Remove erroneous map keys expected in update handlers.
mefyl Aug 12, 2015
651acd9
Expect POST when calling update handlers.
mefyl Aug 12, 2015
7ec2ecd
Accept PUT to call update handlers in query server.
mefyl Aug 19, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions couchdb/tests/view.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,90 @@ def test_reduce_empty(self):
self.assertEqual(output.getvalue(),
b'[true, [0]]\n')

def command_ddoc_add(self):
return [
'ddoc',
'new',
'_design/test_update',
{
'_id': '_design/test_update',
'_rev': '8-d7379de23a751dc2a19e5638a7bbc5cc',
'language': 'python',
'updates': {
'inc': '''\
def fun(obj, req):
if obj is not None:
obj['field'] += 1
return [obj, {"body": "."}]
''',
}
},
]

def test_update(self):
import json
request = {
'method': 'POST',
'query': {},
'body': '',
}
commands = [
self.command_ddoc_add(),
[
'ddoc',
'_design/test_update',
['updates', 'inc'],
[None, request]
],
[
'ddoc',
'_design/test_update',
['updates', 'inc'],
[{'field': 41, 'other_field': 'x'}, request]
],
]
input = StringIO(b'\n'.join(json.dumps(c).encode('utf-8')
for c in commands))
output = StringIO()
view.run(input=input, output=output)
results = [
json.loads(l.decode('utf-8'))
for l in output.getvalue().strip().split(b'\n')
]
self.assertEqual(len(results), 3)
self.assertEqual(results[0], True)
self.assertEqual(results[1], ['up', None, {'body': '.'}])
self.assertEqual(
results[2],
['up', {'field': 42, 'other_field': 'x'}, {'body': '.'}])

def test_update_wrong_method(self):
import json
request = {
'method': 'GET',
'query': {},
'body': '',
}
commands = [
self.command_ddoc_add(),
[
'ddoc',
'_design/test_update',
['updates', 'inc'],
[None, request]
],
]
input = StringIO(b'\n'.join(json.dumps(c).encode('utf-8')
for c in commands))
output = StringIO()
view.run(input=input, output=output)
results = [
json.loads(l.decode('utf-8'))
for l in output.getvalue().strip().split(b'\n')
]
self.assertEqual(len(results), 2)
self.assertEqual(results[1][2]['status'], 405)


def suite():
suite = unittest.TestSuite()
Expand Down
56 changes: 48 additions & 8 deletions couchdb/view.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

log = logging.getLogger('couchdb.view')

ddocs = {}

def run(input=sys.stdin, output=sys.stdout):
r"""CouchDB view function handler implementation for Python.
Expand All @@ -34,10 +35,14 @@ def run(input=sys.stdin, output=sys.stdout):

def _writejson(obj):
obj = json.encode(obj)
if isinstance(obj, util.utype):
obj = obj.encode('utf-8')
output.write(obj)
output.write(b'\n')
if hasattr(output, 'encoding'):
output.write(obj)
output.write('\n')
else:
if isinstance(obj, util.utype):
obj = obj.encode('utf-8')
output.write(obj)
output.write(b'\n')
output.flush()

def _log(message):
Expand All @@ -49,7 +54,7 @@ def reset(config=None):
del functions[:]
return True

def add_fun(string):
def compile_fun(string):
string = BOM_UTF8 + string.encode('utf-8')
globals_ = {}
try:
Expand All @@ -69,7 +74,10 @@ def add_fun(string):
function = list(globals_.values())[0]
if type(function) is not FunctionType:
return err
functions.append(function)
return function

def add_fun(string):
functions.append(compile_fun(string))
return True

def map_doc(doc):
Expand Down Expand Up @@ -128,8 +136,40 @@ def rereduce(*cmd):
# Note: weird kwargs is for Python 2.5 compat
return reduce(*cmd, **{'rereduce': True})

handlers = {'reset': reset, 'add_fun': add_fun, 'map_doc': map_doc,
'reduce': reduce, 'rereduce': rereduce}
def ddoc(*cmd):
if cmd[0] == 'new':
ddoc = cmd[2]
ddoc['updates'] = dict(
(name, compile_fun(value))
for name, value in ddoc['updates'].items())
ddocs[cmd[1]] = ddoc
return True
else:
ddoc = ddocs[cmd[0]]
action = cmd[1]
if action[0] == 'updates':
if cmd[2][1]['method'] not in ('POST', 'PUT'):
return [
'up',
None,
{'status': 405, 'body': 'Method not allowed'},
]
else:
fun = ddoc['updates'][action[1]]
doc, body = fun(*cmd[2])
res = ['up', doc, body]
sys.stderr.flush()
return res


handlers = {
'add_fun': add_fun,
'ddoc': ddoc,
'map_doc': map_doc,
'reduce': reduce,
'rereduce': rereduce,
'reset': reset,
}

try:
while True:
Expand Down
21 changes: 17 additions & 4 deletions doc/views.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Writing views in Python
=======================

The couchdb-python package comes with a view server to allow you to write
views in Python instead of JavaScript. When couchdb-python is installed, it
will install a script called couchpy that runs the view server. To enable
this for your CouchDB server, add the following section to local.ini::
The couchdb-python package comes with a query server to allow you to
write views or update handlers in Python instead of JavaScript. When
couchdb-python is installed, it will install a script called couchpy
that runs the view server. To enable this for your CouchDB server, add
the following section to local.ini::

[query_servers]
python=/usr/bin/couchpy
Expand All @@ -18,3 +19,15 @@ the language pull-down menu. Here's some sample view code to get you started::

Note that the ``map`` function uses the Python ``yield`` keyword to emit
values, where JavaScript views use an ``emit()`` function.

Here's an example update handler code that will increment the
``field`` member of an existing document. The name of the ``field`` to
increment is passed in the query string::

def fun(obj, req):
field = req.query['field']
if obj is not None and field in obj:
obj[field] += 1
return [obj, {"body": "incremented"}]
else:
return [None, {"body": "no such document or field"}]