o 'h`@s.ddlmZddlmZddlZddlZddlZddl m Z ddl m Z ddl mZddl mZddl mZdd l mZdd l mZdd l mZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddl m!Z!ddl m"Z"ej#rddl$m%Z%ddl$m&Z&GdddeZdS)) annotationsN)BytesIO)_wsgi_decoding_dance)CombinedMultiDict)EnvironHeaders) FileStorage)ImmutableMultiDict)iter_multi_items) MultiDict) BadRequest)UnsupportedMediaTypedefault_stream_factory)FormDataParser)Request)cached_property)environ_property) _get_server)get_input_stream)WSGIApplication)WSGIEnvironmentcs0eZdZUdZdZded<dZded<dZeZ ded <d ed <d ed <  dndofdd Z e dpddZ e dqddZ  drdsd%d&Zedtd'd(Zdud*d+Zdvd,d-Zdwd.d/Zdvd0d1Zdxd2d3Zdvd4d5Zedwd6d7Zeejed8d9d:Zedydr?builderr:r:r; from_valuess  zRequest.from_valuesf&t.Callable[[Request], WSGIApplication]rcs4ddlmtd fdd }td |S) amDecorate a function as responder that accepts the request as the last argument. This works like the :func:`responder` decorator but the function is passed the request object as the last argument and the request object will be closed automatically:: @Request.application def my_wsgi_app(request): return Response('Hello World!') As of Werkzeug 0.14 HTTP exceptions are automatically caught and converted to responses instead of failing. :param f: the WSGI callable to decorate :return: a new WSGI callable r) HTTPExceptionr<r=r cabc.Iterable[bytes]c s|d}|;z |dd|f}Wny3}ztd||d}WYd}~nd}~ww||ddWdS1sFwYdS)Nr)tcast get_response)r<requestresperHrCrFr:r; applications "$z(Request.application..applicationrN)r<r=r rI) exceptionsrH functoolswrapsrKrL)rCrFrRr:rQr;rRs  zRequest.applicationtotal_content_length content_type str | Nonefilenamecontent_length t.IO[bytes]cCst||||dS)aCalled to get a stream for the file upload. This must provide a file-like class with `read()`, `readline()` and `seek()` methods that is both writeable and readable. The default implementation returns a temporary file if the total content length is higher than 500KB. Because many browsers do not provide a content length for the files only the total content length matters. :param total_content_length: the total content length of all the data in the request combined. This value is guaranteed to be there. :param content_type: the mimetype of the uploaded file. :param filename: the filename of the uploaded file. May be `None`. :param content_length: the length of this file. This value is usually not provided because webbrowsers do not provide this value. )rVrYrWrZr)r7rVrWrYrZr:r:r;_get_file_streams zRequest._get_file_streamcCst|jdS)z``True`` if the request method carries content. By default this is true if a ``Content-Type`` is sent. .. versionadded:: 0.8 CONTENT_TYPE)rrr5r7r:r:r;want_form_data_parsedszRequest.want_form_data_parsedrcCs|j|j|j|j|j|jdS)zCreates the form data parser. Instantiates the :attr:`form_data_parser_class` with some parameters. .. versionadded:: 0.8 )stream_factoryrrmax_form_partsrC)rr\rrraparameter_storage_classr^r:r:r;make_form_data_parserszRequest.make_form_data_parsercCsld|jvrdS|jr|}|||j|j|j}n |j| | f}|j}|\|d<|d<|d<dS)auMethod used internally to retrieve submitted data. After calling this sets `form` and `files` on the request object to multi dicts filled with the incoming form data. As a matter of fact the input stream will be empty afterwards. You can also call this method to force the parsing of the form data. .. versionadded:: 0.8 formNstreamfiles) __dict__r_rcparse_get_stream_for_parsingmimetyperZmimetype_paramsrerb)r7parserdatadr:r:r;_load_form_datas zRequest._load_form_datacCs"t|dd}|durt|S|jS)zThis is the same as accessing :attr:`stream` with the difference that if it finds cached data from calling :meth:`get_data` first it will create a new stream out of the cached data. .. versionadded:: 0.9.3 _cached_dataN)getattrrre)r7 cached_datar:r:r;ri!s zRequest._get_stream_for_parsingcCs.|jd}t|p dD]\}}|q dS)zCloses associated resources of this request object. This closes all file handles explicitly. You can also use the request object in a with statement which will automatically close it. .. versionadded:: 0.9 rfr:N)rgr5r rB)r7rf_keyvaluer:r:r;rB-s  z Request.closecCs|SNr:r^r:r:r; __enter__8szRequest.__enter__cCs |dSru)rB)r7exc_type exc_valuetbr:r:r;__exit__;s zRequest.__exit__cCs|jrtdt|j|jdS)aThe WSGI input stream, with safety checks. This stream can only be consumed once. Use :meth:`get_data` to get the full data as bytes or text. The :attr:`data` attribute will contain the full bytes only if they do not represent form data. The :attr:`form` attribute will contain the parsed form data in that case. Unlike :attr:`input_stream`, this stream guards against infinite streams or reading past :attr:`content_length` or :attr:`max_content_length`. If ``max_content_length`` is set, it can be enforced on streams if ``wsgi.input_terminated`` is set. Otherwise, an empty stream is returned. If the limit is reached before the underlying stream is exhausted (such as a file that is too large, or an infinite stream), the remaining contents of the stream cannot be read safely. Depending on how the server handles this, clients may show a "connection reset" failure instead of seeing the 413 response. .. versionchanged:: 2.3 Check ``max_content_length`` preemptively and while reading. .. versionchanged:: 0.9 The stream is always set (but may be consumed) even if form parsing was accessed first. zXThis request was created with 'shallow=True', reading from the input stream is disabled.)r)r RuntimeErrorrrrr^r:r:r;re>szRequest.streamz wsgi.inputzThe raw WSGI input stream, without any safety checks. This is dangerous to use. It does not guard against infinite streams or reading past :attr:`content_length` or :attr:`max_content_length`. Use :attr:`stream` instead. )docbytescCs |jddS)zThe raw data read from :attr:`stream`. Will be empty if the request represents form data. To get the raw data even if it represents form data, use :meth:`get_data`. T)parse_form_data)get_datar^r:r:r;rmns z Request.datacacheas_textt.Literal[False]r~cCdSrur:r7rrr~r:r:r;rwzRequest.get_data.t.Literal[True]strcCrrur:rr:r:r;rr bytes | strcCsHt|dd}|dur|r||j}|r||_|r"|jdd}|S)aThis reads the buffered incoming data from the client into one bytes object. By default this is cached but that behavior can be changed by setting `cache` to `False`. Usually it's a bad idea to call this method without checking the content length first as a client could send dozens of megabytes or more to cause memory problems on the server. Note that if the form data was already parsed this method will not return anything as form data parsing does not cache the data like this method does. To implicitly invoke form data parsing function set `parse_form_data` to `True`. When this is done the return value of this method will be an empty string if the form parser handles the data. This generally is not necessary as if the whole data is cached (which is the default) the form parser will used the cached data to parse the form data. Please be generally aware of checking the content length first in any case before calling this method to avoid exhausting server memory. If `as_text` is set to `True` the return value will be a decoded string. .. versionadded:: 0.9 rpNreplace)errors)rqrorereadrpdecode)r7rrr~rvr:r:r;rs   ImmutableMultiDict[str, str]cC||jS)aDThe form parameters. By default an :class:`~werkzeug.datastructures.ImmutableMultiDict` is returned from this function. This can be changed by setting :attr:`parameter_storage_class` to a different type. This might be necessary if the order of the form data is important. Please keep in mind that file uploads will not end up here, but instead in the :attr:`files` attribute. .. versionchanged:: 0.9 Previous to Werkzeug 0.9 this would only contain form data for POST and PUT requests. )rordr^r:r:r;rdsz Request.formCombinedMultiDict[str, str]cCsP|jg}|jdkr||jg}|D]}t|tst|}||qt|S)aA :class:`werkzeug.datastructures.CombinedMultiDict` that combines :attr:`args` and :attr:`form`. For GET requests, only ``args`` are present, not ``form``. .. versionchanged:: 2.0 For GET requests, only ``args`` are present, not ``form``. r#)r<r+appendrd isinstancer r)r7sourcesr<rnr:r:r;valuess    zRequest.values$ImmutableMultiDict[str, FileStorage]cCr)a:class:`~werkzeug.datastructures.MultiDict` object containing all uploaded files. Each key in :attr:`files` is the name from the ````. Each value in :attr:`files` is a Werkzeug :class:`~werkzeug.datastructures.FileStorage` object. It basically behaves like a standard file object you know from Python, with the difference that it also has a :meth:`~werkzeug.datastructures.FileStorage.save` function that can store the file on the filesystem. Note that :attr:`files` will only contain data if the request method was POST, PUT or PATCH and the ``
`` that posted to the request had ``enctype="multipart/form-data"``. It will be empty otherwise. See the :class:`~werkzeug.datastructures.MultiDict` / :class:`~werkzeug.datastructures.FileStorage` documentation for more details about the used data structure. )rorfr^r:r:r;rfsz Request.filescC|jS)zgAlias for :attr:`self.root_path`. ``environ["SCRIPT_ROOT"]`` without a trailing slash. )r.r^r:r:r; script_rootzRequest.script_rootcCr)zAlias for :attr:`root_url`. The URL with scheme, host, and root path. For example, ``https://example.com/app/``. )root_urlr^r:r:r;url_rootrzRequest.url_root REMOTE_USERzIf the server supports user authentication, and the script is protected, this attribute contains the username the user has authenticated as.zwsgi.multithreadz[boolean that is `True` if the application is served by a multithreaded WSGI server.zwsgi.multiprocesszlboolean that is `True` if the application is served by a WSGI server that spawns multiple processes.z wsgi.run_oncezboolean that is `True` if the application will be executed only once in a process lifetime. This is the case for CGI for example, but it's not guaranteed that the execution only happens one time. t.Any | NonecCs|S)aThe parsed JSON data if :attr:`mimetype` indicates JSON (:mimetype:`application/json`, see :attr:`is_json`). Calls :meth:`get_json` with default arguments. If the request content type is not ``application/json``, this will raise a 415 Unsupported Media Type error. .. versionchanged:: 2.3 Raise a 415 error instead of 400. .. versionchanged:: 2.1 Raise a 400 error if the content type is incorrect. )get_jsonr^r:r:r;json sz Request.jsonztuple[t.Any, t.Any] _cached_jsonforcesilentcCrrur:r7rrrr:r:r;r6zRequest.get_jsoncCrrur:rr:r:r;r;rc Cs|r|j|tur|j|S|s|js|s|dSdS|j|d}z|j|}WnCtym}z7|rCd}|rB|j\}}||f|_n||}|r[|j\}} || f|_WYd}~|SWYd}~|SWYd}~|Sd}~ww|ru||f|_|S)aParse :attr:`data` as JSON. If the mimetype does not indicate JSON (:mimetype:`application/json`, see :attr:`is_json`), or parsing fails, :meth:`on_json_loading_failed` is called and its return value is used as the return value. By default this raises a 415 Unsupported Media Type resp. :param force: Ignore the mimetype and always try to parse JSON. :param silent: Silence mimetype and parsing errors, and return ``None`` instead. :param cache: Store the parsed JSON to return for subsequent calls. .. versionchanged:: 2.3 Raise a 415 error instead of 400. .. versionchanged:: 2.1 Raise a 400 error if the content type is incorrect. N)r)rEllipsisis_jsonon_json_loading_failedr json_moduleloads ValueError) r7rrrrmrrP normal_rv_ silent_rvr:r:r;r@s<           rPValueError | NonecCs|dur td|td)aCalled if :meth:`get_json` fails and isn't silenced. If this method returns a value, it is used as the return value for :meth:`get_json`. The default implementation raises :exc:`~werkzeug.exceptions.BadRequest`. :param e: If parsing failed, this is the exception. It will be ``None`` if the content type wasn't ``application/json``. .. versionchanged:: 2.3 Raise a 415 error instead of 400. NzFailed to decode JSON object: z^Did not attempt to load JSON data because the request Content-Type was not 'application/json'.)r r )r7rPr:r:r;rws  zRequest.on_json_loading_failed)TF)rrrrrrr r!)r<r=r>r=r r)rFrGr r)NN) rVrrWrXrYrXrZrr r[)r r)r r)r r!)r r[)r r)r r})TFF)rrrrr~rr r})T.F)rrrrr~rr r)rrrrr~rr r)r r)r r)r r)r r)r r)...)rrrrrrr r=)rrrrrrr r)FFT)rPrr r=)3__name__ __module__ __qualname____doc__r__annotations__rrarrr4 classmethodrErRr\propertyr_rcrorirBrvrzrrerrKIOr} input_streamrmoverloadrrdrrfrrr remote_userris_multithreadis_multiprocess is_run_oncerrrrrr __classcell__r:r:r8r;rs  /    ) !    !   $  &        7r)' __future__rcollections.abcabccabcrTrtypingrKior _internalrdatastructuresrrrr r r rSr r formparserrrsansio.requestr_SansIORequestutilsrrwsgirr TYPE_CHECKING_typeshed.wsgirrr:r:r:r;s4