_l@s6ddlZddlmZddlmZddlmZddlmZddlmZddlmZdd l m Z dd l m Z dd l m Z dd l mZdd l mZddlmZddlmZddlmZddaddZddZddZGdddeZdS)N) integer_types) string_types) text_type)to_bytes) to_native)Headers) dump_cookie)HTTP_STATUS_CODES)remove_entity_headers) iri_to_uri)url_join)get_content_type)ClosingIterator)get_current_urlcGsddlmat|S)zsThis function replaces itself to ensure that the test module is not imported unless required. DO NOT USE! r) run_wsgi_app)testr _run_wsgi_app)argsrC/tmp/pip-build-5gj8f0j9/Werkzeug/werkzeug/wrappers/base_response.pyrsrcCs&t|tr"tjddddS)znHelper for the response objects to check if the iterable returned to the WSGI server is not a string. zResponse iterable was set to a string. This will appear to work but means that the server will send the data to the client one character at a time. This is almost never intended behavior, use 'response.data' to assign strings to the response object. stacklevelrN) isinstancerwarningswarn)iterablerrr_warn_if_stringsrccs:x3|D]+}t|tr-|j|Vq|VqWdS)N)rrencode)rcharsetitemrrr _iter_encoded,s r cCsI|dkrdS|dkr dSt|tr9t|StddS)NTbytesFnonezInvalid accept_ranges value)rrr ValueError)Z accept_rangesrrr_clean_accept_ranges4s   r$c @s eZdZdZdZdZdZdZdZdZ dZ ddddddd d Z d d Z d dZ edddZedddZeddZejddZeddZejddZdddZddZeeeddZdd Zdd!d"Zd#d$Zd%d&Zd'ddd(ddddd)d*Zd(dd+d,Zed-d.Zed/d0Zd1d2Z d3d4Z!d5d6Z"d7d8Z#d9d:Z$d;d<Z%d=d>Z&d?d@Z'dS)A BaseResponsea Base response class. The most important fact about a response object is that it's a regular WSGI application. It's initialized with a couple of response parameters (headers, body, status code etc.) and will start a valid WSGI response when called with the environ and start response callable. Because it's a WSGI application itself processing usually ends before the actual response is sent to the server. This helps debugging systems because they can catch all the exceptions before responses are started. Here a small example WSGI application that takes advantage of the response objects:: from werkzeug.wrappers import BaseResponse as Response def index(): return Response('Index page') def application(environ, start_response): path = environ.get('PATH_INFO') or '/' if path == '/': response = index() else: response = Response('Not Found', status=404) return response(environ, start_response) Like :class:`BaseRequest` which object is lacking a lot of functionality implemented in mixins. This gives you a better control about the actual API of your response objects, so you can create subclasses and add custom functionality. A full featured response object is available as :class:`Response` which implements a couple of useful mixins. To enforce a new type of already existing responses you can use the :meth:`force_type` method. This is useful if you're working with different subclasses of response objects and you want to post process them with a known interface. Per default the response object will assume all the text data is `utf-8` encoded. Please refer to :doc:`the unicode chapter ` for more details about customizing the behavior. Response can be any kind of iterable or string. If it's a string it's considered being an iterable with one item which is the string passed. Headers can be a list of tuples or a :class:`~werkzeug.datastructures.Headers` object. Special note for `mimetype` and `content_type`: For most mime types `mimetype` and `content_type` work the same, the difference affects only 'text' mimetypes. If the mimetype passed with `mimetype` is a mimetype starting with `text/`, the charset parameter of the response object is appended to it. In contrast the `content_type` parameter is always added as header unmodified. .. versionchanged:: 0.5 the `direct_passthrough` parameter was added. :param response: a string or response iterable. :param status: a string with a status or an integer with the status code. :param headers: a list of headers or a :class:`~werkzeug.datastructures.Headers` object. :param mimetype: the mimetype for the response. See notice above. :param content_type: the content type for the response. See notice above. :param direct_passthrough: if set to `True` :meth:`iter_encoded` is not called before iteration which makes it possible to pass special iterators through unchanged (see :func:`wrap_file` for more details.) zutf-8z text/plainTiNFcCsDt|tr||_n$|s0t|_nt||_|dkr|dkrod|jkro|j}|dk rt||j}|}|dk r||jd<|dkr|j}t|tr||_n ||_ ||_ g|_ |dkrg|_ n1t|t ttfr7|j|n ||_ dS)Nz content-typez Content-Type)rrheadersdefault_mimetyperrdefault_statusr status_codestatusdirect_passthrough _on_closeresponserr! bytearrayset_data)selfr.r+r'mimetype content_typer,rrr__init__s2               zBaseResponse.__init__cCs|jj||S)aAdds a function to the internal list of functions that should be called as part of closing down the response. Since 0.7 this function also returns the function that was passed so that this can be used as a decorator. .. versionadded:: 0.6 )r-append)r1funcrrr call_on_closeszBaseResponse.call_on_closecCsZ|jr+dttt|j}n|jr:dnd}d|jj||jfS)Nz%d bytesZstreamedzlikely-streamedz <%s %s [%s]>) is_sequencesummaplen iter_encoded is_streamed __class____name__r+)r1Z body_inforrr__repr__s "zBaseResponse.__repr__cCsIt|ts<|dkr'tdtt||}||_|S)aEnforce that the WSGI response is a response object of the current type. Werkzeug will use the :class:`BaseResponse` internally in many situations like the exceptions. If you call :meth:`get_response` on an exception you will get back a regular :class:`BaseResponse` object, even if you are using a custom subclass. This method can enforce a given response type, and it will also convert arbitrary WSGI callables into response objects if an environ is provided:: # convert a Werkzeug response object into an instance of the # MyResponseClass subclass. response = MyResponseClass.force_type(response) # convert any WSGI application into a response object response = MyResponseClass.force_type(response, environ) This is especially useful if you want to post-process responses in the main dispatcher and use functionality provided by your subclass. Keep in mind that this will modify response objects in place if possible! :param response: a response object or wsgi application. :param environ: a WSGI environment object. :return: a response object. NzHcannot convert WSGI application into response objects without an environ)rr% TypeErrorrr>)clsr.environrrr force_types   zBaseResponse.force_typecCs|t|||S)aCreate a new response object from an application output. This works best if you pass it an application that returns a generator all the time. Sometimes applications may use the `write()` callable returned by the `start_response` function. This tries to resolve such edge cases automatically. But if you don't get the expected output you should set `buffered` to `True` which enforces buffering. :param app: the WSGI application to execute. :param environ: the WSGI environment to execute against. :param buffered: set to `True` to enforce buffering. :return: a response object. )r)rBZapprCZbufferedrrrfrom_appszBaseResponse.from_appcCs|jS)z!The HTTP status code as a number.) _status_code)r1rrrr*!szBaseResponse.status_codec CsP||_y!d|t|jf|_Wntk rKd||_YnXdS)Nz%d %sz %d UNKNOWN)rFr upper_statusKeyError)r1coderrrr*&s  ! cCs|jS)z!The HTTP status code as a string.)rH)r1rrrr+.szBaseResponse.statuscCsyt||_Wntk r3tdYnXy&t|jjddd|_WnHtk rd|_d|j|_Yntk rtdYnXdS)NzInvalid status argumentrz0 %szEmpty status argument) rrHAttributeErrorrAintsplitrFr# IndexError)r1valuerrrr+3s &   cCs;|jdj|j}|r7|j|j}|S)aThe string representation of the request body. Whenever you call this property the request iterable is encoded and flattened. This can lead to unwanted behavior if you stream big data. This behavior can be disabled by setting :attr:`implicit_sequence_conversion` to `False`. If `as_text` is set to `True` the return value will be a decoded unicode string. .. versionadded:: 0.9 )_ensure_sequencejoinr<decoder)r1Zas_textrvrrrget_dataBs zBaseResponse.get_datacCsbt|tr$|j|j}n t|}|g|_|jr^tt||j dA descriptor that calls :meth:`get_data` and :meth:`set_data`.c CsDy|jWntk r&dSYnXtdd|jDS)zrsz8BaseResponse.calculate_content_length..)rR RuntimeErrorr9r<)r1rrrcalculate_content_lengthls   z%BaseResponse.calculate_content_lengthcCsp|jr8|r4t|jt r4t|j|_dS|jrMtd|jsbtd|jdS)zThis method can be called by methods that need a sequence. If `mutable` is true, it will also ensure that the response sequence is a standard Python list. .. versionadded:: 0.6 Nz]Attempted implicit sequence conversion but the response object is in direct passthrough mode.zThe response object required the iterable to be a sequence, but the implicit conversion was disabled. Call make_sequence() yourself.)r8rr.listr,r]implicit_sequence_conversion make_sequence)r1ZmutablerrrrRts     zBaseResponse._ensure_sequencecCsP|jsLt|jdd}t|j|_|dk rL|j|dS)aCConverts the response iterator in a list. By default this happens automatically if required. If `implicit_sequence_conversion` is disabled, this method is not automatically called and some properties might raise exceptions. This also encodes all the items. .. versionadded:: 0.6 closeN)r8getattrr.r_r<r7)r1rbrrrras   zBaseResponse.make_sequencecCs t|jt|j|jS)aIter the response encoded with the encoding of the response. If the response object is invoked as WSGI application the return value of this method is used as application iterator unless :attr:`direct_passthrough` was activated. )rr.r r)r1rrrr<s zBaseResponse.iter_encoded/c Cs_|jjdt|d|d|d|d|d|d|d|d |jd |jd |  d S) aXSets a cookie. The parameters are the same as in the cookie `Morsel` object in the Python standard library but it accepts unicode data, too. A warning is raised if the size of the cookie header exceeds :attr:`max_cookie_size`, but the header will still be set. :param key: the key (name) of the cookie to be set. :param value: the value of the cookie. :param max_age: should be a number of seconds, or `None` (default) if the cookie should last only as long as the client's browser session. :param expires: should be a `datetime` object or UNIX timestamp. :param path: limits the cookie to a given path, per default it will span the whole domain. :param domain: if you want to set a cross-domain cookie. For example, ``domain=".example.com"`` will set a cookie that is readable by the domain ``www.example.com``, ``foo.example.com`` etc. Otherwise, a cookie will only be readable by the domain that set it. :param secure: If `True`, the cookie will only be available via HTTPS :param httponly: disallow JavaScript to access the cookie. This is an extension to the cookie standard and probably not supported by all browsers. :param samesite: Limits the scope of the cookie such that it will only be attached to requests if those requests are "same-site". z Set-CookierPmax_ageexpirespathdomainsecurehttponlyrmax_sizesamesiteN)r'addr rmax_cookie_size) r1keyrPrfrgrhrirjrkrmrrr set_cookies'   zBaseResponse.set_cookiec Cs)|j|ddddd|d|dS)aDelete a cookie. Fails silently if key doesn't exist. :param key: the key (name) of the cookie to be deleted. :param path: if the cookie that should be deleted was limited to a path, the path has to be defined here. :param domain: if the cookie that should be deleted was limited to a domain, that domain has to be defined here. rgrrfrhriN)rq)r1rprhrirrr delete_cookies zBaseResponse.delete_cookiec Cs4yt|jWnttfk r/dSYnXdS)aIf the response is streamed (the response is not an iterable with a length information) this property is `True`. In this case streamed means that there is no information about the number of iterations. This is usually `True` if a generator is passed to the response object. This is useful for checking before applying some sort of post filtering that should not take place for streamed responses. TF)r;r.rArL)r1rrrr=s  zBaseResponse.is_streamedcCst|jttfS)zIf the iterator is buffered, this property will be `True`. A response object will consider an iterator to be buffered if the response attribute is a list or tuple. .. versionadded:: 0.6 )rr.tupler_)r1rrrr8szBaseResponse.is_sequencecCs>t|jdr|jjx|jD] }|q)WdS)zClose the wrapped response if possible. You can also use the object in a with statement which will automatically close it. .. versionadded:: 0.9 Can now be used in a with statement. rbN)hasattrr.rbr-)r1r6rrrrbs zBaseResponse.closecCs|S)Nr)r1rrr __enter__szBaseResponse.__enter__cCs|jdS)N)rb)r1exc_type exc_valuetbrrr__exit__szBaseResponse.__exit__cCs>t|j|_tttt|j|jd.)r~r)rr'r*lowerrrr autocorrect_location_headerrr remover rWr8r9r. UnicodeErrorrX) r1rCr'r{content_locationZcontent_lengthr+rprPikey old_locationZ current_urlrrrget_wsgi_headers'sR             (        zBaseResponse.get_wsgi_headerscCs|j}|ddksAd|ko0dknsA|dkrJf}n)|jrgt|j|jS|j}t||jS)aReturns the application iterator for the given environ. Depending on the request method and the current status code the return value might be an empty response rather than the one from the response. If the request method is `HEAD` or the status code is in a range where the HTTP specification requires an empty response, an empty iterable is returned. .. versionadded:: 0.6 :param environ: the WSGI environment of the request. :return: a response iterable. REQUEST_METHODHEADr}r&r~0)r~r)r*r,rr.r<rrb)r1rCr+rrrr get_app_iters      zBaseResponse.get_app_itercCs4|j|}|j|}||j|jfS)aFReturns the final WSGI response as tuple. The first item in the tuple is the application iterator, the second the status and the third the list of headers. The response returned is created specially for the given environment. For example if the request method in the WSGI environment is ``'HEAD'`` the response will be empty and only the headers and status code will be present. .. versionadded:: 0.6 :param environ: the WSGI environment of the request. :return: an ``(app_iter, status, headers)`` tuple. )rrr+Z to_wsgi_list)r1rCr'app_iterrrrget_wsgi_responses zBaseResponse.get_wsgi_responsecCs)|j|\}}}||||S)zProcess this response as WSGI application. :param environ: the WSGI environment. :param start_response: the response callable provided by the WSGI server. :return: an application iterator )r)r1rCZstart_responserr+r'rrr__call__s zBaseResponse.__call__)(r? __module__ __qualname____doc__rr)r(r`rrWror4r7r@ classmethodrDrEpropertyr*setterr+rVr0datar^rRrar<rqrrr=r8rbruryrzrrrrrrrrr%>sj D  $ &     .    ]  r%)r_compatrrrrrZdatastructuresrhttpr r r urlsr r utilsrZwsgirrrrr r$objectr%rrrrs&