def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={"KEY": "VAL", "QUAY": "VALYOU"})
res = ep.fdel(req)
assert res is None
assert "KEY" not in req.environ
assert req.environ["QUAY"] == "VALYOU"
def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={"KEY": "VAL", "QUAY": "VALYOU"})
res = ep.fdel(req)
assert res is None
assert "KEY" not in req.environ
assert req.environ["QUAY"] == "VALYOU"
def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': 'VAL', 'QUAY': 'VALYOU'})
res = ep.fdel(req)
self.assertEqual(res, None)
self.assertFalse('KEY' in req.environ)
self.assertEqual(req.environ['QUAY'], 'VALYOU')
def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': 'VAL', 'QUAY': 'VALYOU'})
res = ep.fdel(req)
assert res is None
assert 'KEY' not in req.environ
assert req.environ['QUAY'] == 'VALYOU'
def test_fget_star_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': '*'})
res = ep.fget(req)
import webob.etag
assert type(res) == webob.etag._AnyETag
assert res.__dict__ == {}
def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': 'VAL', 'QUAY': 'VALYOU'})
res = ep.fdel(req)
assert res is None
assert 'KEY' not in req.environ
assert req.environ['QUAY'] == 'VALYOU'
def test_fget_star_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': '*'})
res = ep.fget(req)
import webob.etag
assert type(res) == webob.etag._AnyETag
assert res.__dict__ == {}
def test_fedl(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY':'VAL', 'QUAY':'VALYOU'})
res = ep.fdel(req)
self.assertEqual(res, None)
self.assertFalse('KEY' in req.environ)
self.assertEqual(req.environ['QUAY'], 'VALYOU')
def test_fset_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={"KEY": "*"})
res = ep.fset(req, None)
assert res is None
def test_fget_found_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={"KEY": '"VALUE"'})
res = ep.fget(req)
assert res.etags == ["VALUE"]
def test_fget_missing_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={})
assert ep.fget(req) == "DEFAULT"
class MyRequest(Request):
"""I override webob.Request by allowing weak etags.
"""
if_match = etag_property('HTTP_IF_MATCH', AnyETag, '14.24', strong=False)
class BaseRequest(object):
## Options:
unicode_errors = 'strict'
## The limit after which request bodies should be stored on disk
## if they are read in (under this, and the request body is stored
## in memory):
request_body_tempfile_limit = 10 * 1024
def __init__(self,
environ,
charset=NoDefault,
unicode_errors=NoDefault,
**kw):
if type(environ) is not dict:
raise TypeError("WSGI environ must be a dict")
d = self.__dict__
d['environ'] = environ
if charset is not NoDefault:
self.charset = charset
if unicode_errors is not NoDefault:
d['unicode_errors'] = unicode_errors
if 'decode_param_names' in kw or hasattr(self.__class__,
'decode_param_names'):
raise DeprecationWarning("decode_param_names is deprecated")
if kw:
cls = self.__class__
if 'method' in kw:
# set method first, because .body setters
# depend on it for checks
self.method = kw.pop('method')
for name, value in kw.iteritems():
if not hasattr(cls, name):
raise TypeError("Unexpected keyword: %s=%r" %
(name, value))
setattr(self, name, value)
# this is necessary for correct warnings depth for both
# BaseRequest and Request (due to AdhocAttrMixin.__setattr__)
_setattr_stacklevel = 2
def _body_file__get(self):
"""
Input stream of the request (wsgi.input).
Setting this property resets the content_length and seekable flag
(unlike setting req.body_file_raw).
"""
if not self.is_body_readable:
return BytesIO('')
r = self.body_file_raw
clen = self.content_length
if not self.is_body_seekable and clen is not None:
# we need to wrap input in LimitedLengthFile
# but we have to cache the instance as well
# otherwise this would stop working
# (.remaining counter would reset between calls):
# req.body_file.read(100)
# req.body_file.read(100)
env = self.environ
wrapped, raw = env.get('webob._body_file', (0, 0))
if raw is not r:
wrapped = LimitedLengthFile(r, clen)
wrapped = io.BufferedReader(wrapped)
env['webob._body_file'] = wrapped, r
r = wrapped
return r
def _body_file__set(self, value):
if isinstance(value, str):
warn_deprecation(
"Please use req.body = 'str' or req.body_file = fileobj",
'1.2', self._setattr_stacklevel)
self.body = value
return
self.content_length = None
self.body_file_raw = value
self.is_body_seekable = False
self.is_body_readable = True
def _body_file__del(self):
self.body = ''
body_file = property(_body_file__get,
_body_file__set,
_body_file__del,
doc=_body_file__get.__doc__)
body_file_raw = environ_getter('wsgi.input')
@property
def body_file_seekable(self):
"""
Get the body of the request (wsgi.input) as a seekable file-like
object. Middleware and routing applications should use this
attribute over .body_file.
If you access this value, CONTENT_LENGTH will also be updated.
"""
if not self.is_body_seekable:
self.make_body_seekable()
return self.body_file_raw
scheme = environ_getter('wsgi.url_scheme')
method = environ_getter('REQUEST_METHOD', 'GET')
http_version = environ_getter('SERVER_PROTOCOL')
script_name = environ_getter('SCRIPT_NAME', '')
path_info = environ_getter('PATH_INFO')
content_length = converter(environ_getter('CONTENT_LENGTH', None, '14.13'),
parse_int_safe, serialize_int, 'int')
remote_user = environ_getter('REMOTE_USER', None)
remote_addr = environ_getter('REMOTE_ADDR', None)
query_string = environ_getter('QUERY_STRING', '')
server_name = environ_getter('SERVER_NAME')
server_port = converter(environ_getter('SERVER_PORT'), parse_int,
serialize_int, 'int')
uscript_name = upath_property('SCRIPT_NAME')
upath_info = upath_property('PATH_INFO')
def _content_type__get(self):
"""Return the content type, but leaving off any parameters (like
charset, but also things like the type in ``application/atom+xml;
type=entry``)
If you set this property, you can include parameters, or if
you don't include any parameters in the value then existing
parameters will be preserved.
"""
return self.environ.get('CONTENT_TYPE', '').split(';', 1)[0]
def _content_type__set(self, value):
if value is None:
del self.content_type
return
value = str(value)
if ';' not in value:
content_type = self.environ.get('CONTENT_TYPE', '')
if ';' in content_type:
value += ';' + content_type.split(';', 1)[1]
self.environ['CONTENT_TYPE'] = value
def _content_type__del(self):
if 'CONTENT_TYPE' in self.environ:
del self.environ['CONTENT_TYPE']
content_type = property(_content_type__get, _content_type__set,
_content_type__del, _content_type__get.__doc__)
_charset_cache = (None, None)
def _charset__get(self):
"""Get the charset of the request.
If the request was sent with a charset parameter on the
Content-Type, that will be used. Otherwise if there is a
default charset (set during construction, or as a class
attribute) that will be returned. Otherwise None.
Setting this property after request instantiation will always
update Content-Type. Deleting the property updates the
Content-Type to remove any charset parameter (if none exists,
then deleting the property will do nothing, and there will be
no error).
"""
content_type = self.environ.get('CONTENT_TYPE', '')
cached_ctype, cached_charset = self._charset_cache
if cached_ctype == content_type:
return cached_charset
charset_match = CHARSET_RE.search(content_type)
if charset_match:
result = charset_match.group(1).strip('"').strip()
else:
result = 'UTF-8'
self._charset_cache = (content_type, result)
return result
def _charset__set(self, charset):
if charset is None or charset == '':
del self.charset
return
charset = str(charset)
content_type = self.environ.get('CONTENT_TYPE', '')
charset_match = CHARSET_RE.search(self.environ.get('CONTENT_TYPE', ''))
if charset_match:
content_type = (content_type[:charset_match.start(1)] + charset +
content_type[charset_match.end(1):])
# comma to separate params? there's nothing like that in RFCs AFAICT
#elif ';' in content_type:
# content_type += ', charset="%s"' % charset
else:
content_type += '; charset="%s"' % charset
self.environ['CONTENT_TYPE'] = content_type
def _charset__del(self):
new_content_type = CHARSET_RE.sub('',
self.environ.get('CONTENT_TYPE', ''))
new_content_type = new_content_type.rstrip().rstrip(';').rstrip(',')
self.environ['CONTENT_TYPE'] = new_content_type
charset = property(_charset__get, _charset__set, _charset__del,
_charset__get.__doc__)
_headers = None
def _headers__get(self):
"""
All the request headers as a case-insensitive dictionary-like
object.
"""
if self._headers is None:
self._headers = EnvironHeaders(self.environ)
return self._headers
def _headers__set(self, value):
self.headers.clear()
self.headers.update(value)
headers = property(_headers__get, _headers__set, doc=_headers__get.__doc__)
@property
def host_url(self):
"""
The URL through the host (no path)
"""
e = self.environ
url = e['wsgi.url_scheme'] + '://'
if e.get('HTTP_HOST'):
host = e['HTTP_HOST']
if ':' in host:
host, port = host.split(':', 1)
else:
port = None
else:
host = e['SERVER_NAME']
port = e['SERVER_PORT']
if self.environ['wsgi.url_scheme'] == 'https':
if port == '443':
port = None
elif self.environ['wsgi.url_scheme'] == 'http':
if port == '80':
port = None
url += host
if port:
url += ':%s' % port
return url
@property
def application_url(self):
"""
The URL including SCRIPT_NAME (no PATH_INFO or query string)
"""
return self.host_url + urllib.quote(
self.environ.get('SCRIPT_NAME', ''), PATH_SAFE)
@property
def path_url(self):
"""
The URL including SCRIPT_NAME and PATH_INFO, but not QUERY_STRING
"""
return self.application_url + urllib.quote(
self.environ.get('PATH_INFO', ''), PATH_SAFE)
@property
def path(self):
"""
The path of the request, without host or query string
"""
return (urllib.quote(self.script_name, PATH_SAFE) +
urllib.quote(self.path_info, PATH_SAFE))
@property
def path_qs(self):
"""
The path of the request, without host but with query string
"""
path = self.path
qs = self.environ.get('QUERY_STRING')
if qs:
path += '?' + qs
return path
@property
def url(self):
"""
The full request URL, including QUERY_STRING
"""
url = self.path_url
if self.environ.get('QUERY_STRING'):
url += '?' + self.environ['QUERY_STRING']
return url
def relative_url(self, other_url, to_application=False):
"""
Resolve other_url relative to the request URL.
If ``to_application`` is True, then resolve it relative to the
URL with only SCRIPT_NAME
"""
if to_application:
url = self.application_url
if not url.endswith('/'):
url += '/'
else:
url = self.path_url
return urlparse.urljoin(url, other_url)
def path_info_pop(self, pattern=None):
"""
'Pops' off the next segment of PATH_INFO, pushing it onto
SCRIPT_NAME, and returning the popped segment. Returns None if
there is nothing left on PATH_INFO.
Does not return ``''`` when there's an empty segment (like
``/path//path``); these segments are just ignored.
Optional ``pattern`` argument is a regexp to match the return value
before returning. If there is no match, no changes are made to the
request and None is returned.
"""
path = self.path_info
if not path:
return None
slashes = ''
while path.startswith('/'):
slashes += '/'
path = path[1:]
idx = path.find('/')
if idx == -1:
idx = len(path)
r = path[:idx]
if pattern is None or re.match(pattern, r):
self.script_name += slashes + r
self.path_info = path[idx:]
return r
def path_info_peek(self):
"""
Returns the next segment on PATH_INFO, or None if there is no
next segment. Doesn't modify the environment.
"""
path = self.path_info
if not path:
return None
path = path.lstrip('/')
return path.split('/', 1)[0]
def _urlvars__get(self):
"""
Return any *named* variables matched in the URL.
Takes values from ``environ['wsgiorg.routing_args']``.
Systems like ``routes`` set this value.
"""
if 'paste.urlvars' in self.environ:
return self.environ['paste.urlvars']
elif 'wsgiorg.routing_args' in self.environ:
return self.environ['wsgiorg.routing_args'][1]
else:
result = {}
self.environ['wsgiorg.routing_args'] = ((), result)
return result
def _urlvars__set(self, value):
environ = self.environ
if 'wsgiorg.routing_args' in environ:
environ['wsgiorg.routing_args'] = (
environ['wsgiorg.routing_args'][0], value)
if 'paste.urlvars' in environ:
del environ['paste.urlvars']
elif 'paste.urlvars' in environ:
environ['paste.urlvars'] = value
else:
environ['wsgiorg.routing_args'] = ((), value)
def _urlvars__del(self):
if 'paste.urlvars' in self.environ:
del self.environ['paste.urlvars']
if 'wsgiorg.routing_args' in self.environ:
if not self.environ['wsgiorg.routing_args'][0]:
del self.environ['wsgiorg.routing_args']
else:
self.environ['wsgiorg.routing_args'] = (
self.environ['wsgiorg.routing_args'][0], {})
urlvars = property(_urlvars__get,
_urlvars__set,
_urlvars__del,
doc=_urlvars__get.__doc__)
def _urlargs__get(self):
"""
Return any *positional* variables matched in the URL.
Takes values from ``environ['wsgiorg.routing_args']``.
Systems like ``routes`` set this value.
"""
if 'wsgiorg.routing_args' in self.environ:
return self.environ['wsgiorg.routing_args'][0]
else:
# Since you can't update this value in-place, we don't need
# to set the key in the environment
return ()
def _urlargs__set(self, value):
environ = self.environ
if 'paste.urlvars' in environ:
# Some overlap between this and wsgiorg.routing_args; we need
# wsgiorg.routing_args to make this work
routing_args = (value, environ.pop('paste.urlvars'))
elif 'wsgiorg.routing_args' in environ:
routing_args = (value, environ['wsgiorg.routing_args'][1])
else:
routing_args = (value, {})
environ['wsgiorg.routing_args'] = routing_args
def _urlargs__del(self):
if 'wsgiorg.routing_args' in self.environ:
if not self.environ['wsgiorg.routing_args'][1]:
del self.environ['wsgiorg.routing_args']
else:
self.environ['wsgiorg.routing_args'] = (
(), self.environ['wsgiorg.routing_args'][1])
urlargs = property(_urlargs__get, _urlargs__set, _urlargs__del,
_urlargs__get.__doc__)
@property
def is_xhr(self):
"""Is X-Requested-With header present and equal to ``XMLHttpRequest``?
Note: this isn't set by every XMLHttpRequest request, it is
only set if you are using a Javascript library that sets it
(or you set the header yourself manually). Currently
Prototype and jQuery are known to set this header."""
return self.environ.get('HTTP_X_REQUESTED_WITH',
'') == 'XMLHttpRequest'
def _host__get(self):
"""Host name provided in HTTP_HOST, with fall-back to SERVER_NAME"""
if 'HTTP_HOST' in self.environ:
return self.environ['HTTP_HOST']
else:
return '%(SERVER_NAME)s:%(SERVER_PORT)s' % self.environ
def _host__set(self, value):
self.environ['HTTP_HOST'] = value
def _host__del(self):
if 'HTTP_HOST' in self.environ:
del self.environ['HTTP_HOST']
host = property(_host__get, _host__set, _host__del, doc=_host__get.__doc__)
def _body__get(self):
"""
Return the content of the request body.
"""
if not self.is_body_readable:
return ''
self.make_body_seekable() # we need this to have content_length
r = self.body_file.read(self.content_length)
self.body_file_raw.seek(0)
return r
def _body__set(self, value):
if value is None:
value = ''
if not isinstance(value, str):
raise TypeError("You can only set Request.body to a str (not %r)" %
type(value))
if not http_method_probably_has_body.get(self.method, True):
if not value:
self.content_length = None
self.body_file_raw = BytesIO('')
return
self.content_length = len(value)
self.body_file_raw = BytesIO(value)
self.is_body_seekable = True
def _body__del(self):
self.body = ''
body = property(_body__get, _body__set, _body__del, doc=_body__get.__doc__)
@property
def POST(self):
"""
A MultiDict containing all the variables from a form
request. An empty dict-like object for non-form
requests.
Form requests are typically POST requests, however PUT requests
with an appropriate Content-Type are also supported.
All keys and values are unicode.
"""
env = self.environ
if self.method not in ('POST', 'PUT'):
return NoVars('Not a form request')
if 'webob._parsed_post_vars' in env:
vars, body_file = env['webob._parsed_post_vars']
if body_file is self.body_file_raw:
return vars
content_type = self.content_type
if ((self.method == 'PUT' and not content_type) or content_type
not in ('', 'application/x-www-form-urlencoded',
'multipart/form-data')):
# Not an HTML form submission
return NoVars('Not an HTML form submission (Content-Type: %s)' %
content_type)
if self.is_body_seekable:
self.body_file_raw.seek(0)
fs_environ = env.copy()
# FieldStorage assumes a missing CONTENT_LENGTH, but a
# default of 0 is better:
fs_environ.setdefault('CONTENT_LENGTH', '0')
fs_environ['QUERY_STRING'] = ''
fs = cgi.FieldStorage(fp=self.body_file,
environ=fs_environ,
keep_blank_values=True)
vars = MultiDict.from_fieldstorage(fs)
#ctype = self.content_type or 'application/x-www-form-urlencoded'
ctype = env.get('CONTENT_TYPE', 'application/x-www-form-urlencoded')
self.body_file = io.BufferedReader(FakeCGIBody(vars, ctype))
vars = UnicodeMultiDict(vars,
encoding=self.charset,
errors=self.unicode_errors)
env['webob._parsed_post_vars'] = (vars, self.body_file_raw)
return vars
@property
def GET(self):
"""
A MultiDict containing all the variables from the QUERY_STRING.
"""
env = self.environ
source = env.get('QUERY_STRING', '')
if 'webob._parsed_query_vars' in env:
vars, qs = env['webob._parsed_query_vars']
if qs == source:
return vars
def _update_get(_vars, key=None, value=None):
assert _vars is vars.multi
qs = urllib.urlencode(_vars.items())
env['QUERY_STRING'] = qs
env['webob._parsed_query_vars'] = (vars, qs)
if not source:
#@@xxxxx
vars = TrackableMultiDict(__tracker=_update_get, __name='GET')
else:
vars = TrackableMultiDict(parse_qsl(source,
keep_blank_values=True,
strict_parsing=False),
__tracker=_update_get,
__name='GET')
vars = UnicodeMultiDict(vars,
encoding=self.charset,
errors=self.unicode_errors)
env['webob._parsed_query_vars'] = (vars, source)
return vars
@property
def params(self):
"""
A dictionary-like object containing both the parameters from
the query string and request body.
"""
return NestedMultiDict(self.GET, self.POST)
@property
def cookies(self):
"""
A dictionary of cookies as found in the request.
"""
env = self.environ
source = env.get('HTTP_COOKIE', '')
if 'webob._parsed_cookies' in env:
vars, var_source = env['webob._parsed_cookies']
if var_source == source:
return vars
vars = {}
if source:
cookies = Cookie(source)
for name in cookies:
vars[name] = cookies[name].value
#@@ decode directly
vars = UnicodeMultiDict(vars,
encoding=self.charset,
errors=self.unicode_errors)
env['webob._parsed_cookies'] = (vars, source)
return vars
def copy(self):
"""
Copy the request and environment object.
This only does a shallow copy, except for wsgi.input
"""
self.make_body_seekable()
env = self.environ.copy()
new_req = self.__class__(env)
new_req.copy_body()
return new_req
def copy_get(self):
"""
Copies the request and environment object, but turning this request
into a GET along the way. If this was a POST request (or any other
verb) then it becomes GET, and the request body is thrown away.
"""
env = self.environ.copy()
return self.__class__(env, method='GET', content_type=None, body='')
# webob.is_body_seekable marks input streams that are seekable
# this way we can have seekable input without testing the .seek() method
is_body_seekable = environ_getter('webob.is_body_seekable', False)
#is_body_readable = environ_getter('webob.is_body_readable', False)
def _is_body_readable__get(self):
"""
webob.is_body_readable is a flag that tells us
that we can read the input stream even though
CONTENT_LENGTH is missing. This allows FakeCGIBody
to work and can be used by servers to support
chunked encoding in requests.
For background see https://bitbucket.org/ianb/webob/issue/6
"""
if http_method_probably_has_body.get(self.method):
# known HTTP method with body
return True
elif self.content_length is not None:
# unknown HTTP method, but the Content-Length
# header is present
return True
else:
# last resort -- rely on the special flag
return self.environ.get('webob.is_body_readable', False)
def _is_body_readable__set(self, flag):
self.environ['webob.is_body_readable'] = bool(flag)
is_body_readable = property(_is_body_readable__get,
_is_body_readable__set,
doc=_is_body_readable__get.__doc__)
def make_body_seekable(self):
"""
This forces ``environ['wsgi.input']`` to be seekable.
That means that, the content is copied into a BytesIO or temporary
file and flagged as seekable, so that it will not be unnecessarily
copied again.
After calling this method the .body_file is always seeked to the
start of file and .content_length is not None.
The choice to copy to BytesIO is made from
``self.request_body_tempfile_limit``
"""
if self.is_body_seekable:
self.body_file_raw.seek(0)
else:
self.copy_body()
def copy_body(self):
"""
Copies the body, in cases where it might be shared with
another request object and that is not desired.
This copies the body in-place, either into a BytesIO object
or a temporary file.
"""
if not self.is_body_readable:
# there's no body to copy
self.body = ''
elif self.content_length is None:
# chunked body or FakeCGIBody
self.body = self.body_file_raw.read()
self._copy_body_tempfile()
else:
# try to read body into tempfile
did_copy = self._copy_body_tempfile()
if not did_copy:
# it wasn't necessary, so just read it into memory
self.body = self.body_file.read(self.content_length)
def _copy_body_tempfile(self):
"""
Copy wsgi.input to tempfile if necessary. Returns True if it did.
"""
tempfile_limit = self.request_body_tempfile_limit
todo = self.content_length
assert isinstance(todo, (int, long)), ` todo `
if not tempfile_limit or todo <= tempfile_limit:
return False
fileobj = self.make_tempfile()
input = self.body_file
while todo > 0:
data = input.read(min(todo, 65536))
if not data:
# Normally this should not happen, because LimitedLengthFile should
# have raised an exception by now.
# It can happen if the is_body_seekable flag is incorrect.
raise DisconnectionError(
"Client disconnected (%s more bytes were expected)" % todo)
fileobj.write(data)
todo -= len(data)
fileobj.seek(0)
self.body_file_raw = fileobj
self.is_body_seekable = True
return True
def make_tempfile(self):
"""
Create a tempfile to store big request body.
This API is not stable yet. A 'size' argument might be added.
"""
return tempfile.TemporaryFile()
def remove_conditional_headers(self,
remove_encoding=True,
remove_range=True,
remove_match=True,
remove_modified=True):
"""
Remove headers that make the request conditional.
These headers can cause the response to be 304 Not Modified,
which in some cases you may not want to be possible.
This does not remove headers like If-Match, which are used for
conflict detection.
"""
check_keys = []
if remove_range:
check_keys += ['HTTP_IF_RANGE', 'HTTP_RANGE']
if remove_match:
check_keys.append('HTTP_IF_NONE_MATCH')
if remove_modified:
check_keys.append('HTTP_IF_MODIFIED_SINCE')
if remove_encoding:
check_keys.append('HTTP_ACCEPT_ENCODING')
for key in check_keys:
if key in self.environ:
del self.environ[key]
accept = accept_property('Accept', '14.1', MIMEAccept, MIMENilAccept)
accept_charset = accept_property('Accept-Charset', '14.2', AcceptCharset)
accept_encoding = accept_property('Accept-Encoding',
'14.3',
NilClass=NoAccept)
accept_language = accept_property('Accept-Language', '14.4',
AcceptLanguage)
authorization = converter(
environ_getter('HTTP_AUTHORIZATION', None, '14.8'),
parse_auth,
serialize_auth,
)
def _cache_control__get(self):
"""
Get/set/modify the Cache-Control header (`HTTP spec section 14.9
<http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9>`_)
"""
env = self.environ
value = env.get('HTTP_CACHE_CONTROL', '')
cache_header, cache_obj = env.get('webob._cache_control', (None, None))
if cache_obj is not None and cache_header == value:
return cache_obj
cache_obj = CacheControl.parse(value,
updates_to=self._update_cache_control,
type='request')
env['webob._cache_control'] = (value, cache_obj)
return cache_obj
def _cache_control__set(self, value):
env = self.environ
value = value or ''
if isinstance(value, dict):
value = CacheControl(value, type='request')
if isinstance(value, CacheControl):
str_value = str(value)
env['HTTP_CACHE_CONTROL'] = str_value
env['webob._cache_control'] = (str_value, value)
else:
env['HTTP_CACHE_CONTROL'] = str(value)
env['webob._cache_control'] = (None, None)
def _cache_control__del(self):
env = self.environ
if 'HTTP_CACHE_CONTROL' in env:
del env['HTTP_CACHE_CONTROL']
if 'webob._cache_control' in env:
del env['webob._cache_control']
def _update_cache_control(self, prop_dict):
self.environ['HTTP_CACHE_CONTROL'] = serialize_cache_control(prop_dict)
cache_control = property(_cache_control__get,
_cache_control__set,
_cache_control__del,
doc=_cache_control__get.__doc__)
if_match = etag_property('HTTP_IF_MATCH', AnyETag, '14.24')
if_none_match = etag_property('HTTP_IF_NONE_MATCH', NoETag, '14.26')
date = converter_date(environ_getter('HTTP_DATE', None, '14.8'))
if_modified_since = converter_date(
environ_getter('HTTP_IF_MODIFIED_SINCE', None, '14.25'))
if_unmodified_since = converter_date(
environ_getter('HTTP_IF_UNMODIFIED_SINCE', None, '14.28'))
if_range = converter(environ_getter('HTTP_IF_RANGE', None, '14.27'),
parse_if_range, serialize_if_range, 'IfRange object')
max_forwards = converter(
environ_getter('HTTP_MAX_FORWARDS', None, '14.31'), parse_int,
serialize_int, 'int')
pragma = environ_getter('HTTP_PRAGMA', None, '14.32')
range = converter(environ_getter('HTTP_RANGE', None, '14.35'), parse_range,
serialize_range, 'Range object')
referer = environ_getter('HTTP_REFERER', None, '14.36')
referrer = referer
user_agent = environ_getter('HTTP_USER_AGENT', None, '14.43')
def __repr__(self):
try:
name = '%s %s' % (self.method, self.url)
except KeyError:
name = '(invalid WSGI environ)'
msg = '<%s at 0x%x %s>' % (self.__class__.__name__, abs(
id(self)), name)
return msg
def as_string(self, skip_body=False):
"""
Return HTTP string representing this request.
If skip_body is True, exclude the body.
If skip_body is an integer larger than one, skip body
only if its length is bigger than that number.
"""
url = self.url
host = self.host_url
assert url.startswith(host)
url = url[len(host):]
parts = ['%s %s %s' % (self.method, url, self.http_version)]
#self.headers.setdefault('Host', self.host)
# acquire body before we handle headers so that
# content-length will be set
body = None
if self.method in ('PUT', 'POST'):
if skip_body > 1:
if len(self.body) > skip_body:
body = '<body skipped (len=%s)>' % len(self.body)
else:
skip_body = False
if not skip_body:
body = self.body
parts += map('%s: %s'.__mod__, sorted(self.headers.items()))
if body:
parts.extend(['', body])
# HTTP clearly specifies CRLF
return '\r\n'.join(parts)
__str__ = as_string
@classmethod
def from_string(cls, s):
"""
Create a request from HTTP string. If the string contains
extra data after the request, raise a ValueError.
"""
f = BytesIO(s)
r = cls.from_file(f)
if f.tell() != len(s):
raise ValueError("The string contains more data than expected")
return r
@classmethod
def from_file(cls, fp):
"""Read a request from a file-like object (it must implement
``.read(size)`` and ``.readline()``).
It will read up to the end of the request, not the end of the
file (unless the request is a POST or PUT and has no
Content-Length, in that case, the entire file is read).
This reads the request as represented by ``str(req)``; it may
not read every valid HTTP request properly."""
start_line = fp.readline()
try:
method, resource, http_version = start_line.rstrip('\r\n').split(
None, 2)
except ValueError:
raise ValueError('Bad HTTP request line: %r' % start_line)
r = cls(environ_from_url(resource),
http_version=http_version,
method=method.upper())
del r.environ['HTTP_HOST']
while 1:
line = fp.readline()
if not line.strip():
# end of headers
break
hname, hval = line.split(':', 1)
hval = hval.strip()
if hname in r.headers:
hval = r.headers[hname] + ', ' + hval
r.headers[hname] = hval
if r.method in ('PUT', 'POST'):
clen = r.content_length
if clen is None:
r.body = fp.read()
else:
r.body = fp.read(clen)
return r
def call_application(self, application, catch_exc_info=False):
"""
Call the given WSGI application, returning ``(status_string,
headerlist, app_iter)``
Be sure to call ``app_iter.close()`` if it's there.
If catch_exc_info is true, then returns ``(status_string,
headerlist, app_iter, exc_info)``, where the fourth item may
be None, but won't be if there was an exception. If you don't
do this and there was an exception, the exception will be
raised directly.
"""
if self.is_body_seekable:
self.body_file_raw.seek(0)
captured = []
output = []
def start_response(status, headers, exc_info=None):
if exc_info is not None and not catch_exc_info:
raise exc_info[0], exc_info[1], exc_info[2]
captured[:] = [status, headers, exc_info]
return output.append
app_iter = application(self.environ, start_response)
if output or not captured:
try:
output.extend(app_iter)
finally:
if hasattr(app_iter, 'close'):
app_iter.close()
app_iter = output
if catch_exc_info:
return (captured[0], captured[1], app_iter, captured[2])
else:
return (captured[0], captured[1], app_iter)
# Will be filled in later:
ResponseClass = None
def get_response(self, application, catch_exc_info=False):
"""
Like ``.call_application(application)``, except returns a
response object with ``.status``, ``.headers``, and ``.body``
attributes.
This will use ``self.ResponseClass`` to figure out the class
of the response object to return.
"""
if catch_exc_info:
status, headers, app_iter, exc_info = self.call_application(
application, catch_exc_info=True)
del exc_info
else:
status, headers, app_iter = self.call_application(
application, catch_exc_info=False)
return self.ResponseClass(status=status,
headerlist=list(headers),
app_iter=app_iter)
@classmethod
def blank(cls,
path,
environ=None,
base_url=None,
headers=None,
POST=None,
**kw):
"""
Create a blank request environ (and Request wrapper) with the
given path (path should be urlencoded), and any keys from
environ.
The path will become path_info, with any query string split
off and used.
All necessary keys will be added to the environ, but the
values you pass in will take precedence. If you pass in
base_url then wsgi.url_scheme, HTTP_HOST, and SCRIPT_NAME will
be filled in from that value.
Any extra keyword will be passed to ``__init__`` (e.g.,
``decode_param_names``).
"""
env = environ_from_url(path)
if base_url:
scheme, netloc, path, query, fragment = urlparse.urlsplit(base_url)
if query or fragment:
raise ValueError(
"base_url (%r) cannot have a query or fragment" % base_url)
if scheme:
env['wsgi.url_scheme'] = scheme
if netloc:
if ':' not in netloc:
if scheme == 'http':
netloc += ':80'
elif scheme == 'https':
netloc += ':443'
else:
raise ValueError("Unknown scheme: %r" % scheme)
host, port = netloc.split(':', 1)
env['SERVER_PORT'] = port
env['SERVER_NAME'] = host
env['HTTP_HOST'] = netloc
if path:
env['SCRIPT_NAME'] = urllib.unquote(path)
if environ:
env.update(environ)
content_type = kw.get('content_type', env.get('CONTENT_TYPE'))
if headers and 'Content-Type' in headers:
content_type = headers['Content-Type']
if content_type is not None:
kw['content_type'] = content_type
environ_add_POST(env, POST, content_type)
obj = cls(env, **kw)
if headers is not None:
obj.headers.update(headers)
return obj
def test_fset_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY':'*'})
res = ep.fset(req, None)
self.assertEqual(res, None)
def test_fset_not_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={"KEY": "OLDVAL"})
res = ep.fset(req, "NEWVAL")
assert res is None
assert req.environ["KEY"] == "NEWVAL"
def test_fset_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': '*'})
res = ep.fset(req, None)
assert res is None
def test_fget_found_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': '"VALUE"'})
res = ep.fget(req)
assert res.etags == ['VALUE']
def test_fget_missing_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={})
assert ep.fget(req) == "DEFAULT"
def test_fset_not_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY':'OLDVAL'})
res = ep.fset(req, "NEWVAL")
self.assertEqual(res, None)
self.assertEqual(req.environ['KEY'], 'NEWVAL')
def test_fset_not_None(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY': 'OLDVAL'})
res = ep.fset(req, "NEWVAL")
assert res is None
assert req.environ['KEY'] == 'NEWVAL'
def test_fget_found_key(self):
ep = etag_property("KEY", "DEFAULT", "RFC_SECTION")
req = self._makeDummyRequest(environ={'KEY':'"VALUE"'})
res = ep.fget(req)
self.assertEqual(res.etags, ['VALUE'])