advertisement
Falcon Documentation, Release 0.2.0rc1
falcon.util.to_query_str( params)
Converts a dictionary of params to a query string.
Parameters params ( dict ) – A dictionary of parameters, where each key is a parameter name, and each value is either a str or something that can be converted into a str. If params is a list , it will be converted to a comma-delimited string of values (e.g., ‘thing=1,2,3’)
Returns
A URI query string including the ‘?’ prefix, or an empty string if no params are given (the dict is empty).
Return type str
5.4 Changelogs
5.4.1 Changelog for Falcon 0.2.0
New
• Since 0.1 we’ve added proper RTD docs to make it easier for everyone to get started with the framework. Over time we will continue adding content, and we would love your help!
• Falcon now supports “wsgi.filewrapper”. You can assign any file-like object to resp.stream and Falcon will use
“wsgi.filewrapper” to more efficiently pipe the data to the WSGI server.
• Support was added for automatically parsing requests containing “application/x-www-form-urlencoded” content. Form fields are now folded into req.params.
• Custom Request and Response classes are now supported. You can specify custom types when instantiating falcon.API.
• A new middleware feature was added to the framework. Middleware deprecates global hooks, and we encourage everyone to migrate as soon as possible.
• A general-purpose dict attribute was added to Request. Middleware, hooks, and responders can now use req.context to share contextual information about the current request.
• A new method, append_header, was added to falcon.API to allow setting multiple values for the same header using comma separation. Note that this will not work for setting cookies, but we plan to address this in the next release (0.3).
• A new “resource” attribute was added to hooks. Old hooks that do not accept this new attribute are shimmed so that they will continue to function. While we have worked hard to minimize the performance impact, we recommend migrating to the new function signature to avoid any overhead.
• Error response bodies now support XML in addition to JSON. In addition, the HTTPError serialization code was refactored to make it easier to implement a custom error serializer.
• A new method, “set_error_serializer” was added to falcon.API. You can use this method to override Falcon’s default HTTPError serializer if you need to support custom media types.
• Falcon’s testing base class, testing.TestBase was improved to facilitate Py3k testing.
Notably, Test-
Base.simulate_request now takes an additional “decode” kwarg that can be used to automatically decode bytestring PEP-3333 response bodies.
• An “add_link” method was added to the Response class. Apps can use this method to add one or more Link header values to a response.
60 Chapter 5. Documentation
Falcon Documentation, Release 0.2.0rc1
• Added two new properties, req.host and req.subdomain, to make it easier to get at the hostname info in the request.
• Allow a wider variety of characters to be used in query string params.
• Internal APIs have been refactored to allow overriding the default routing mechanism. Further modularization is planned for the next release (0.3).
• Changed req.get_param so that it behaves the same whether a list was specified in the query string using the
HTML form style (in which each element is listed in a separate ‘key=val’ field) or in the more compact API style
(in which each element is comma-separated and assigned to a single param instance, as in ‘key=val1,val2,val3’)
• Added a convenience method, set_stream(...), to the Response class for setting the stream and its length at the same time, which should help people not forget to set both (and save a few keystrokes along the way).
• Added several new error classes, including HTTPRequestEntityTooLarge, HTTPInvalidParam, HTTPMissing-
Param, HTTPInvalidHeader and HTTPMissingHeader.
• Python 3.4 is now fully supported.
• Various minor performance improvements
Breaking Changes
• The deprecated util.misc.percent_escape and util.misc.percent_unescape functions were removed. Please use the functions in the util.uri module instead.
• The deprecated function, API.set_default_route, was removed. Please use sinks instead.
• HTTPRangeNotSatisfiable no longer accepts a media_type parameter.
• When using the comma-delimited list convention, req.get_param_as_list(...) will no longer insert placeholders, using the None type, for empty elements. For example, where previously the query string “foo=1„3” would result in [‘1’, None, ‘3’], it will now result in [‘1’, ‘3’].
Fixed
• Ensure 100% test coverage and fix any bugs identified in the process.
• Fix not recognizing the “bytes=” prefix in Range headers.
• Make HTTPNotFound and HTTPMethodNotAllowed fully compliant, according to RFC 7231.
• Fixed the default on_options responder causing a Cython type error.
• URI template strings can now be of type unicode under Python 2.
• When SCRIPT_NAME is not present in the WSGI environ, return an empty string for the req.app property.
• Global “after” hooks will now be executed even when a responder raises an error.
• Fixed several minor issues regarding testing.create_environ(...)
• Work around a wsgiref quirk, where if no content-length header is submitted by the client, wsgiref will set the value of that header to an empty string in the WSGI environ.
• Resolved an issue causing several source files to not be Cythonized.
• Docstrings have been edited for clarity and correctness.
5.4. Changelogs 61
Falcon Documentation, Release 0.2.0rc1
62 Chapter 5. Documentation
f falcon
,
falcon.routing
,
falcon.testing
,
falcon.util
,
falcon.util.uri
,
Python Module Index
63
Falcon Documentation, Release 0.2.0rc1
64 Python Module Index
Index
A accept (Request attribute),
add_error_handler() (falcon.API method),
add_link() (falcon.Response method),
add_route() (falcon.API method),
add_sink() (falcon.API method),
after() (in module falcon),
API (class in falcon),
api (falcon.util.uri.TestBase attribute),
app (Request attribute),
append_header() (falcon.Response method),
auth (Request attribute),
D data (Response attribute),
date (Request attribute),
decode() (in module falcon.util.uri),
deprecated() (in module falcon.util),
description (HTTPError attribute),
dt_to_http() (in module falcon.util),
E encode() (in module falcon.util.uri),
encode_value() (in module falcon.util.uri),
env (Request attribute),
etag (falcon.Response attribute),
expect (Request attribute),
B before() (in module falcon),
body (Response attribute),
body_encoded (Response attribute),
C cache_control (falcon.Response attribute),
call_count (falcon.util.uri.StartResponseMock attribute),
called (falcon.util.uri.TestResource attribute),
client_accepts() (falcon.Request method),
client_accepts_json (Request attribute),
client_accepts_msgpack (Request attribute),
client_accepts_xml (Request attribute),
client_prefers() (falcon.Request method),
code (HTTPError attribute),
compile_uri_template() (in module falcon.routing),
content_length (Request attribute),
content_location (falcon.Response attribute),
content_range (falcon.Response attribute),
content_type (falcon.Response attribute),
content_type (Request attribute),
context (Request attribute),
context_type (Request attribute),
create_environ() (in module falcon.testing),
create_http_method_map() (in module falcon.routing),
F falcon (module),
falcon.routing (module),
falcon.testing (module),
falcon.util (module),
falcon.util.uri (module),
G get_header() (falcon.Request method),
get_param() (falcon.Request method),
get_param_as_bool() (falcon.Request method),
get_param_as_int() (falcon.Request method),
get_param_as_list() (falcon.Request method),
H has_representation (HTTPError attribute),
headers (falcon.util.uri.StartResponseMock attribute),
headers (HTTPError attribute),
headers (Request attribute),
headers_dict (falcon.util.uri.StartResponseMock
attribute),
host (Request attribute),
http_date_to_dt() (in module falcon.util),
HTTPBadGateway,
HTTPBadRequest,
65
Falcon Documentation, Release 0.2.0rc1
HTTPConflict,
HTTPError (class in falcon),
HTTPForbidden,
HTTPInternalServerError,
HTTPInvalidHeader,
HTTPInvalidParam,
HTTPLengthRequired,
HTTPMethodNotAllowed,
HTTPMissingHeader,
HTTPMissingParam,
HTTPNotAcceptable,
HTTPNotFound,
httpnow() (in module falcon.testing),
HTTPPreconditionFailed,
HTTPRangeNotSatisfiable,
HTTPServiceUnavailable,
HTTPUnauthorized,
HTTPUnsupportedMediaType,
I if_match (Request attribute),
if_modified_since (Request attribute),
if_none_match (Request attribute),
if_range (Request attribute),
if_unmodified_since (Request attribute),
K keep_blank_qs_values (RequestOptions attribute),
kwargs (falcon.util.uri.TestResource attribute),
L last_modified (falcon.Response attribute),
link (HTTPError attribute),
location (falcon.Response attribute),
log_error() (falcon.Request method),
M method (Request attribute),
N
NoRepresentation (class in falcon.http_error),
O on_get() (falcon.testing.TestResource method),
options (Request attribute),
P params (Request attribute),
parse_host() (in module falcon.util.uri),
parse_query_string() (in module falcon.util.uri),
path (Request attribute),
protocol (Request attribute),
66
Q query_string (Request attribute),
R rand_string() (in module falcon.testing),
range (Request attribute),
relative_uri (Request attribute),
req (falcon.util.uri.TestResource attribute),
req_options (API attribute),
Request (class in falcon),
RequestOptions (class in falcon),
resp (falcon.util.uri.TestResource attribute),
resp_headers (falcon.util.uri.TestResource attribute),
Response (class in falcon),
retry_after (falcon.Response attribute),
S sample_body (falcon.util.uri.TestResource attribute),
sample_status (falcon.util.uri.TestResource attribute),
set_error_serializer() (falcon.API method),
set_header() (falcon.Response method),
set_headers() (falcon.Response method),
set_stream() (falcon.Response method),
setUp() (falcon.testing.TestBase method),
simulate_request() (falcon.testing.TestBase method),
srmock (falcon.util.uri.TestBase attribute),
StartResponseMock (class in falcon.testing),
status (falcon.util.uri.StartResponseMock attribute),
status (HTTPError attribute),
status (Response attribute),
stream (Request attribute),
stream (Response attribute),
stream_len (Response attribute),
subdomain (Request attribute),
T tearDown() (falcon.testing.TestBase method),
test_route (falcon.util.uri.TestBase attribute),
TestBase (class in falcon.testing),
TestResource (class in falcon.testing),
title (HTTPError attribute),
to_dict() (falcon.HTTPError method),
to_json() (falcon.HTTPError method),
to_query_str() (in module falcon.util),
to_xml() (falcon.HTTPError method),
U uri (Request attribute),
url (Request attribute),
user_agent (Request attribute),
V vary (falcon.Response attribute),
Index
advertisement
Related manuals
advertisement