581f23bc83
In RFC 2616 it says that "The only range unit defined by HTTP/1.1 is "bytes". HTTP/1.1 implementations MAY ignore ranges specified using other units.". Current falcon implementation only accepts 'bytes', which does not work with some client implementations using different range units. For example, dojo/store/JsonRest requires the server to support 'items' as range unit. Add a request property 'range_unit', which contains the range-unit parsed from Range header. It enhances format_range to accept a range unit as optional parameter in range tuple. This range unit default is set to 'bytes' to not break current API. Closes #570
85 lines
2.5 KiB
Python
85 lines
2.5 KiB
Python
# Copyright 2013 by Rackspace Hosting, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
|
|
def header_property(name, doc, transform=None):
|
|
"""Creates a header getter/setter.
|
|
|
|
Args:
|
|
name: Header name, e.g., "Content-Type"
|
|
doc: Docstring for the property
|
|
transform: Transformation function to use when setting the
|
|
property. The value will be passed to the function, and
|
|
the function should return the transformed value to use
|
|
as the value of the header (default ``None``).
|
|
|
|
"""
|
|
normalized_name = name.lower()
|
|
|
|
def fget(self):
|
|
try:
|
|
return self._headers[normalized_name]
|
|
except KeyError:
|
|
return None
|
|
|
|
if transform is None:
|
|
def fset(self, value):
|
|
self._headers[normalized_name] = value
|
|
else:
|
|
def fset(self, value):
|
|
self._headers[normalized_name] = transform(value)
|
|
|
|
def fdel(self):
|
|
del self._headers[normalized_name]
|
|
|
|
return property(fget, fset, fdel, doc)
|
|
|
|
|
|
def format_range(value):
|
|
"""Formats a range header tuple per the HTTP spec.
|
|
|
|
Args:
|
|
value: ``tuple`` passed to `req.range`
|
|
"""
|
|
|
|
# PERF: Concatenation is faster than % string formatting as well
|
|
# as ''.join() in this case.
|
|
if len(value) == 4:
|
|
unit = value[3] + ' '
|
|
else:
|
|
unit = 'bytes '
|
|
|
|
return (unit +
|
|
str(value[0]) + '-' +
|
|
str(value[1]) + '/' +
|
|
str(value[2]))
|
|
|
|
|
|
def is_ascii_encodable(s): # pragma: no cover
|
|
"""Check if argument encodes to ascii without error."""
|
|
try:
|
|
s.encode("ascii")
|
|
except UnicodeEncodeError:
|
|
# NOTE(tbug): Py2 and Py3 will raise this if string contained
|
|
# chars that could not be ascii encoded
|
|
return False
|
|
except UnicodeDecodeError:
|
|
# NOTE(tbug): py2 will raise this if type is str
|
|
# and contains non-ascii chars
|
|
return False
|
|
except AttributeError:
|
|
# NOTE(tbug): s is probably not a string type
|
|
return False
|
|
return True
|