openstack/deb-python-falcon
Code Issues Proposed changes

Fix inaccurate docstring for API._get_responder

Browse Source 
The docstring for falcon.api.API._get_responder incorrectly stated
that the return from the function was a 3-tuple. This patch corrects
that to state that the return is a 2-tuple containing the responder
and the param dict, and adds some notes about the responder returned
for bad requests and no matching route.
This commit is contained in:
Jay Pipes
2014-02-09 18:12:13 -05:00
parent 8982f97a14
commit 4e42588a7e
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
falcon/api.py
View File

@@ -298,11 +298,19 @@ class API(object):
method: HTTP method (uppercase) requested
Returns:
A 3-member tuple, containing a responder callable, a dict
containing parsed path fields (if any were specified in
the matching route's URI template), and a reference to
the "method not allowed" responder for the resource.
A 2-member tuple consisting of a responder callable and
a dict containing parsed path fields (if any were specified in
the matching route's URI template).
Note:
If a responder was matched to the given URI, but the HTTP
method was not found in the method_map for the responder,
the responder callable element of the returned tuple will be
`falcon.responder.bad_request`.
Likewise, if no responder was matched for the given URI, then
the responder callable element of the returned tuple will be
`falcon.responder.path_not_found`
"""
for route in self._routes: