B ]\3@sdZddlZddlZddlmZddlmZddlmZddlm Z ddl m Z dd l m Zd d ZGd d d eZGdddeZGdddeZGdddeZGdddeZGdddeZdS)aF werkzeug.contrib.wrappers ~~~~~~~~~~~~~~~~~~~~~~~~~ Extra wrappers or mixins contributed by the community. These wrappers can be mixed in into request objects to add extra functionality. Example:: from werkzeug.wrappers import Request as RequestBase from werkzeug.contrib.wrappers import JSONRequestMixin class Request(RequestBase, JSONRequestMixin): pass Afterwards this request object provides the extra functionality of the :class:`JSONRequestMixin`. :copyright: 2007 Pallets :license: BSD-3-Clause N)wsgi_decoding_dance) BadRequest)dump_options_header)parse_options_header)cached_property) JSONMixincCs(yt|Wntk r"dSXdS)z/Checks if the given charset is known to Python.FT)codecslookup LookupError)charsetr s/private/var/folders/pf/vfcx6ndx4k5bb3vdnp68mdb40000gn/T/pip-install-6fjfx5ra/Werkzeug/werkzeug/contrib/wrappers.pyis_known_charset"s rcs$eZdZdZefddZZS)JSONRequestMixinz .. deprecated:: 0.15 Moved to :class:`werkzeug.wrappers.json.JSONMixin`. This old import will be removed in version 1.0. cstjdtddtt|jS)Nz'werkzeug.contrib.wrappers.JSONRequestMixin' has moved to 'werkzeug.wrappers.json.JSONMixin'. This old import will be removed in version 1.0.r) stacklevel)warningswarnDeprecationWarningsuperrjson)self) __class__r rr2s zJSONRequestMixin.json)__name__ __module__ __qualname____doc__propertyr __classcell__r r )rrr+src@seZdZdZdZddZdS)ProtobufRequestMixinaAdd protobuf parsing method to a request object. This will parse the input data through `protobuf`_ if possible. :exc:`~werkzeug.exceptions.BadRequest` will be raised if the content-type is not protobuf or if the data itself cannot be parsed property. .. _protobuf: https://github.com/protocolbuffers/protobuf .. deprecated:: 0.15 This mixin will be removed in version 1.0. TcCsxtjdtddd|jddkr*td|}y||jWntk r\tdYnX|j rt| sttd |S) z.Parse the data into an instance of proto_type.zu'werkzeug.contrib.wrappers.ProtobufRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rZprotobuf CONTENT_TYPEzNot a Protobuf requestz Unable to parse Protobuf requestzPartial Protobuf request) rrrenvirongetrZParseFromStringdata Exceptionprotobuf_check_initializationZ IsInitialized)rZ proto_typeobjr r rparse_protobufRsz#ProtobufRequestMixin.parse_protobufN)rrrrr&r(r r r rr>s rc@sTeZdZdZddZddZeeeddZ[[dd Zd d Z eee d dZ [[ d S)RoutingArgsRequestMixina This request mixin adds support for the wsgiorg routing args `specification`_. .. _specification: https://wsgi.readthedocs.io/en/latest/ specifications/routing_args.html .. deprecated:: 0.15 This mixin will be removed in version 1.0. cCs"tjdtdd|jdddS)Nzx'werkzeug.contrib.wrappers.RoutingArgsRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rzwsgiorg.routing_argsr r)rrrr"r#)rr r r_get_routing_argsws z)RoutingArgsRequestMixin._get_routing_argscCs2tjdtdd|jrtd||jf|jd<dS)Nzx'werkzeug.contrib.wrappers.RoutingArgsRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rzoA shallow request tried to modify the WSGI environment. If you really want to do that, set `shallow` to False.zwsgiorg.routing_args)rrrshallow RuntimeError routing_varsr")rvaluer r r_set_routing_argssz)RoutingArgsRequestMixin._set_routing_argsz1 The positional URL arguments as `tuple`.)doccCs@tjdtdd|jd}|dk r,|dSi}|js<||_|S)Nzx'werkzeug.contrib.wrappers.RoutingArgsRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rzwsgiorg.routing_args)rrrr"r#r+r-)rrvr r r_get_routing_varss z)RoutingArgsRequestMixin._get_routing_varscCs2tjdtdd|jrtd|j|f|jd<dS)Nzx'werkzeug.contrib.wrappers.RoutingArgsRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rzoA shallow request tried to modify the WSGI environment. If you really want to do that, set `shallow` to False.zwsgiorg.routing_args)rrrr+r, routing_argsr")rr.r r r_set_routing_varssz)RoutingArgsRequestMixin._set_routing_varsz- The keyword URL arguments as `dict`.N) rrrrr*r/rr4r3r5r-r r r rr)ks  r)c@s(eZdZdZeddZeddZdS) ReverseSlashBehaviorRequestMixina@This mixin reverses the trailing slash behavior of :attr:`script_root` and :attr:`path`. This makes it possible to use :func:`~urlparse.urljoin` directly on the paths. Because it changes the behavior or :class:`Request` this class has to be mixed in *before* the actual request class:: class MyRequest(ReverseSlashBehaviorRequestMixin, Request): pass This example shows the differences (for an application mounted on `/application` and the request going to `/application/foo/bar`): +---------------+-------------------+---------------------+ | | normal behavior | reverse behavior | +===============+===================+=====================+ | `script_root` | ``/application`` | ``/application/`` | +---------------+-------------------+---------------------+ | `path` | ``/foo/bar`` | ``foo/bar`` | +---------------+-------------------+---------------------+ .. deprecated:: 0.15 This mixin will be removed in version 1.0. cCs6tjdtddt|jdp d|j|j}|dS)zRequested path as unicode. This works a bit like the regular path info in the WSGI environment but will not include a leading slash. z'werkzeug.contrib.wrappers.ReverseSlashBehaviorRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rZ PATH_INFOr!/) rrrrr"r#r encoding_errorslstrip)rpathr r rr:sz%ReverseSlashBehaviorRequestMixin.pathcCs:tjdtddt|jdp d|j|j}|ddS)z8The root path of the script includling a trailing slash.z'werkzeug.contrib.wrappers.ReverseSlashBehaviorRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rZ SCRIPT_NAMEr!r7) rrrrr"r#r r8rstrip)rr:r r r script_rootsz,ReverseSlashBehaviorRequestMixin.script_rootN)rrrrrr:r<r r r rr6s r6c@s(eZdZdZdZddZeddZdS)DynamicCharsetRequestMixina"If this mixin is mixed into a request class it will provide a dynamic `charset` attribute. This means that if the charset is transmitted in the content type headers it's used from there. Because it changes the behavior or :class:`Request` this class has to be mixed in *before* the actual request class:: class MyRequest(DynamicCharsetRequestMixin, Request): pass By default the request object assumes that the URL charset is the same as the data charset. If the charset varies on each request based on the transmitted data it's not a good idea to let the URLs change based on that. Most browsers assume either utf-8 or latin1 for the URLs if they have troubles figuring out. It's strongly recommended to set the URL charset to utf-8:: class MyRequest(DynamicCharsetRequestMixin, Request): url_charset = 'utf-8' .. deprecated:: 0.15 This mixin will be removed in version 1.0. .. versionadded:: 0.6 latin1cCsdS)aKCalled if a charset was provided but is not supported by the Python codecs module. By default latin1 is assumed then to not lose any information, you may override this method to change the behavior. :param charset: the charset that was not found. :return: the replacement charset. r>r )rr r r runknown_charset!s z*DynamicCharsetRequestMixin.unknown_charsetcCsVtjdtdd|jd}|rPt|\}}|d}|rPt|rF|S||S|jS)z"The charset from the content type.z{'werkzeug.contrib.wrappers.DynamicCharsetRequestMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rr r ) rrrr"r#rrr?default_charset)rheaderctoptionsr r r rr ,s    z"DynamicCharsetRequestMixin.charsetN)rrrrr@r?rr r r r rr=s r=c@s6eZdZdZdZddZddZeeeddZ[[d S) DynamicCharsetResponseMixinaIf this mixin is mixed into a response class it will provide a dynamic `charset` attribute. This means that if the charset is looked up and stored in the `Content-Type` header and updates itself automatically. This also means a small performance hit but can be useful if you're working with different charsets on responses. Because the charset attribute is no a property at class-level, the default value is stored in `default_charset`. Because it changes the behavior or :class:`Response` this class has to be mixed in *before* the actual response class:: class MyResponse(DynamicCharsetResponseMixin, Response): pass .. deprecated:: 0.15 This mixin will be removed in version 1.0. .. versionadded:: 0.6 zutf-8cCs@tjdtdd|jd}|r:t|dd}|r:|S|jS)Nz|'werkzeug.contrib.wrappers.DynamicCharsetResponseMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rz content-typer1r )rrrheadersr#rr@)rrAr r r r _get_charset\s z(DynamicCharsetResponseMixin._get_charsetcCsPtjdtdd|jd}t|\}}|s4td||d<t|||jd<dS)Nz|'werkzeug.contrib.wrappers.DynamicCharsetResponseMixin' is deprecated as of version 0.15 and will be removed in version 1.0.r)rz content-typez5Cannot set charset if Content-Type header is missing.r z Content-Type)rrrrEr#r TypeErrorr)rr rArBrCr r r _set_charsetks  z(DynamicCharsetResponseMixin._set_charsetzj The charset for the response. It's stored inside the Content-Type header as a parameter.)r0N) rrrrr@rFrHrr r r r rrDAsrD)rr r_compatr exceptionsrhttprrutilsrZ wrappers.jsonrZ _JSONMixinrrobjectrr)r6r=rDr r r rs       -W<C