U
|
Þ=®dÂI ã @ sÊ d dl mZ d dlZd dlZd dlZddlmZ ddlm Z ddl
|
m Z ddl m Z dd l mZ G d
|
d d Zd d dddZdd dddZe d¡Zdd dddZG dd de eZddlmZ dS ) é )Ú annotationsNé )Ú_missing)ÚBadRequestKeyErroré )ÚImmutableHeadersMixin)Úiter_multi_items)Ú MultiDictc @ s e Zd ZdZdCddZdDddZdd ZdZdEd
|
d ZdFd d Z dd Z
|
dGddZ dHddZ dd Z dd ZdIddZdd Zdefd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zd-d. Zd/d0 Zd1d2 Z d3d4 Z d5d6 Z d7d8 Z d9d: Z d;d< Z!d=d> Z"d?d@ Z#dAdB Z$dS )JÚHeadersaC An object that stores some headers. It has a dict-like interface,
|
but is ordered, can store the same key multiple times, and iterating
|
yields ``(key, value)`` pairs instead of only keys.
|
|
This data structure is useful if you want a nicer way to handle WSGI
|
headers which are stored as tuples in a list.
|
|
From Werkzeug 0.3 onwards, the :exc:`KeyError` raised by this class is
|
also a subclass of the :class:`~exceptions.BadRequest` HTTP exception
|
and will render a page for a ``400 BAD REQUEST`` if caught in a
|
catch-all for HTTP exceptions.
|
|
Headers is mostly compatible with the Python :class:`wsgiref.headers.Headers`
|
class, with the exception of `__getitem__`. :mod:`wsgiref` will return
|
`None` for ``headers['missing']``, whereas :class:`Headers` will raise
|
a :class:`KeyError`.
|
|
To create a new ``Headers`` object, pass it a list, dict, or
|
other ``Headers`` object with default values. These values are
|
validated the same way values added later are.
|
|
:param defaults: The list of default values for the :class:`Headers`.
|
|
.. versionchanged:: 2.1.0
|
Default values are validated the same as values added later.
|
|
.. versionchanged:: 0.9
|
This data structure now stores unicode values similar to how the
|
multi dicts do it. The main difference is that bytes can be set as
|
well which will automatically be latin1 decoded.
|
|
.. versionchanged:: 0.9
|
The :meth:`linked` function was removed without replacement as it
|
was an API that does not support the changes to the encoding model.
|
Nc C s g | _ |d k r| |¡ d S ©N)Ú_listÚextend)ÚselfÚdefaults© r úVd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\werkzeug/datastructures/headers.pyÚ__init__3 s zHeaders.__init__Fc C s |s2t |tr| j| S t |tr2| | j| ¡S t |tsDt|| ¡ }| jD ] \}}| ¡ |krR| S qR|rzt t|d S r ) Ú
|
isinstanceÚintr ÚsliceÚ __class__Ústrr ÚlowerÚKeyError)r ÚkeyÚ _get_modeÚikeyÚkÚvr r r Ú __getitem__8 s
|
|
|
|
|
zHeaders.__getitem__c C s4 dd }|j | j ko2tt||jtt|| jkS )Nc S s | d ¡ f| dd
S )Nr r ©r )Úitemr r r ÚloweredL s z Headers.__eq__.<locals>.lowered)r ÚsetÚmapr )r Úotherr" r r r Ú__eq__K s
|
ÿþzHeaders.__eq__c C s |dk rt jdtdd z| j|dd}W n tk
|
rB | Y S X |rR| d¡}|dkr^|S z
|
||W S tk
|
r | Y S X dS )a= Return the default value if the requested data doesn't exist.
|
If `type` is provided and is a callable it should convert the value,
|
return it or raise a :exc:`ValueError` if that is not possible. In
|
this case the function will return the default as if the value was not
|
found:
|
|
>>> d = Headers([('Content-Length', '42')])
|
>>> d.get('Content-Length', type=int)
|
42
|
|
:param key: The key to be looked up.
|
:param default: The default value to be returned if the key can't
|
be looked up. If not further specified `None` is
|
returned.
|
:param type: A callable that is used to cast the value in the
|
:class:`Headers`. If a :exc:`ValueError` is raised
|
by this callable the default value is returned.
|
|
.. versionchanged:: 2.3
|
The ``as_bytes`` parameter is deprecated and will be removed
|
in Werkzeug 3.0.
|
|
.. versionchanged:: 0.9
|
The ``as_bytes`` parameter was added.
|
NúKThe 'as_bytes' parameter is deprecated and will be removed in Werkzeug 3.0.r ©Ú
|
stacklevelT©r Úlatin1)ÚwarningsÚwarnÚDeprecationWarningr r ÚencodeÚ
|
ValueError)r r ÚdefaultÚtypeÚas_bytesÚrvr r r ÚgetU s$ ü
|
|
|
z Headers.getc C s |dk rt jdtdd | ¡ }g }| D ]Z\}}| ¡ |kr(|rJ| d¡}|dk rxz ||}W n tk
|
rv Y q(Y nX | |¡ q(|S )aF Return the list of items for a given key. If that key is not in the
|
:class:`Headers`, the return value will be an empty list. Just like
|
:meth:`get`, :meth:`getlist` accepts a `type` parameter. All items will
|
be converted with the callable defined there.
|
|
:param key: The key to be looked up.
|
:param type: A callable that is used to cast the value in the
|
:class:`Headers`. If a :exc:`ValueError` is raised
|
by this callable the value will be removed from the list.
|
:return: a :class:`list` of all the values for the key.
|
|
.. versionchanged:: 2.3
|
The ``as_bytes`` parameter is deprecated and will be removed
|
in Werkzeug 3.0.
|
|
.. versionchanged:: 0.9
|
The ``as_bytes`` parameter was added.
|
Nr' r r( r+ )r, r- r. r r/ r0 Úappend)r r r2 r3 r Úresultr r r r r Úgetlist s& ü
|
|
zHeaders.getlistc C s
|
| |¡S )z±Return a list of all the values for the named field.
|
|
This method is compatible with the :mod:`wsgiref`
|
:meth:`~wsgiref.headers.Headers.get_all` method.
|
)r8 )r Únamer r r Úget_all s zHeaders.get_allc c s( | D ] \}}|r| ¡ }||fV qd S r r )r r r Úvaluer r r Úitemsµ s z Headers.itemsc c s | |¡D ]\}}|V q
|
d S r ©r< )r r r Ú_r r r Úkeys» s z Headers.keysc c s | ¡ D ]\}}|V qd S r r= )r r> r; r r r Úvalues¿ s zHeaders.valuesc O sf t |dkr tdt | |rDt|d D ]\}}| ||¡ q.t|D ]\}}| ||¡ qLdS )aÞ Extend headers in this object with items from another object
|
containing header items as well as keyword arguments.
|
|
To replace existing keys instead of extending, use
|
:meth:`update` instead.
|
|
If provided, the first argument can be another :class:`Headers`
|
object, a :class:`MultiDict`, :class:`dict`, or iterable of
|
pairs.
|
|
.. versionchanged:: 1.0
|
Support :class:`MultiDict`. Allow passing ``kwargs``.
|
r ú)update expected at most 1 arguments, got r N)ÚlenÚ TypeErrorr Úadd)r ÚargsÚkwargsr r; r r r r à s zHeaders.extendTc C sf |r t |ttfr | j|= d S | ¡ }g }| jD ]"\}}| ¡ |kr0| ||f¡ q0|| jd d
< d S r )r r r r r r6 )r r Ú_index_operationÚnewr r r r r Ú __delitem__Û s zHeaders.__delitem__c C s | j |ddS )zBRemove a key.
|
|
:param key: The key to be removed.
|
F)rG )rI ©r r r r r Úremoveæ s zHeaders.removec C sj |dkr| j ¡ S t|tr(| j |¡S z| | }| |¡ W n& tk
|
rd |tk r^| Y S Y nX |S )aQ Removes and returns a key or index.
|
|
:param key: The key to be popped. If this is an integer the item at
|
that position is removed, if it's a string the value for
|
that key is. If the key is omitted or `None` the last
|
item is removed.
|
:return: an item.
|
N)r Úpopr r rK r r )r r r1 r4 r r r rL í s
|
|
z Headers.popc C s | ¡ S )z7Removes a key or index and returns a (key, value) item.)rL ©r r r r Úpopitem s zHeaders.popitemc C s. z| j |dd W n tk
|
r( Y dS X dS )zCheck if a key is present.Tr* F)r r rJ r r r Ú __contains__ s
|
zHeaders.__contains__c C s
|
t | jS )z Yield ``(key, value)`` tuples.)Úiterr rM r r r Ú__iter__ s zHeaders.__iter__c C s
|
t | jS r )rB r rM r r r Ú__len__ s zHeaders.__len__c K s2 |rt ||}t|}t|}| j ||f¡ dS )a Add a new header tuple to the list.
|
|
Keyword arguments can specify additional parameters for the header
|
value, with underscores converted to dashes::
|
|
>>> d = Headers()
|
>>> d.add('Content-Type', 'text/plain')
|
>>> d.add('Content-Disposition', 'attachment', filename='foo.png')
|
|
The keyword argument dumping uses :func:`dump_options_header`
|
behind the scenes.
|
|
.. versionadded:: 0.4.1
|
keyword arguments were added for :mod:`wsgiref` compatibility.
|
N)Ú_options_header_vkwÚ_str_header_keyÚ_str_header_valuer r6 )r Ú_keyÚ_valueÚkwr r r rD s
|
|
z Headers.addc K s | j ||f| dS )z´Add a new header tuple to the list.
|
|
An alias for :meth:`add` for compatibility with the :mod:`wsgiref`
|
:meth:`~wsgiref.headers.Headers.add_header` method.
|
N)rD )r rV rW Z_kwr r r Ú
|
add_header, s zHeaders.add_headerc C s | j dd
= dS )zClears all headers.N)r rM r r r Úclear4 s z Headers.clearc s¶ |rt ||}t|}t|}| js8| j ||f¡ dS t| j}| ¡ t|D ]*\}\}}| ¡ krR||f| j|< qqR| j ||f¡ dS fdd|D | j|d d
< dS )a0 Remove all header tuples for `key` and add a new one. The newly
|
added key either appears at the end of the list if there was no
|
entry or replaces the first one.
|
|
Keyword arguments can specify additional parameters for the header
|
value, with underscores converted to dashes. See :meth:`add` for
|
more information.
|
|
.. versionchanged:: 0.6.1
|
:meth:`set` now accepts the same arguments as :meth:`add`.
|
|
:param key: The key to be inserted.
|
:param value: The value to be inserted.
|
Nc s g | ]}|d ¡ kr|qS )r r )Ú.0Út©r r r Ú
|
<listcomp>X s z Headers.set.<locals>.<listcomp>r )rS rT rU r r6 rP r Ú enumerate)r rV rW rX ÚlistiterÚidxZold_keyZ
|
_old_valuer r] r r# 8 s
|
|
z Headers.setc C sB |r4t |}| |t|¡ |D ]}| ||¡ q n
|
| |¡ dS )zÎRemove any existing values for a header and add new ones.
|
|
:param key: The header key to set.
|
:param values: An iterable of values to set for the key.
|
|
.. versionadded:: 1.0
|
N)rP r# ÚnextrD rK )r r r@ Z values_iterr; r r r ÚsetlistZ s zHeaders.setlistc C s || kr| | S | ||¡ |S )a* Return the first value for the key if it is in the headers,
|
otherwise set the header to the value given by ``default`` and
|
return that.
|
|
:param key: The header key to get.
|
:param default: The value to set for the key if it is not in the
|
headers.
|
)r# ©r r r1 r r r Ú
|
setdefaultk s zHeaders.setdefaultc C s || kr| ||¡ | |¡S )aÔ Return the list of values for the key if it is in the
|
headers, otherwise set the header to the list of values given
|
by ``default`` and return that.
|
|
Unlike :meth:`MultiDict.setlistdefault`, modifying the returned
|
list will not affect the headers.
|
|
:param key: The header key to get.
|
:param default: An iterable of values to set for the key if it
|
is not in the headers.
|
|
.. versionadded:: 1.0
|
)rc r8 rd r r r Úsetlistdefaultz s zHeaders.setlistdefaultc C sb t |ttfrRt |tr |g}dd |D }t |trF|d | j|< q^|| j|< n | ||¡ dS )z=Like :meth:`set` but also supports index/slice based setting.c S s g | ]\}}t |t|fqS r )rT rU ©r[ r r r r r r^ s z'Headers.__setitem__.<locals>.<listcomp>r N)r r r r r# ©r r r; r r r Ú __setitem__ s
|
|
zHeaders.__setitem__c O sø t |dkr tdt | |rº|d }t|ttfrZ| ¡ D ]}| || |¡¡ q@n`t|tr | ¡ D ]0\}}t|t
|
t fr| ||¡ ql| ||¡ qln|D ]\}}| ||¡ q¤| ¡ D ]0\}}t|t
|
t fræ| ||¡ qÂ| ||¡ qÂdS )a Replace headers in this object with items from another
|
headers object and keyword arguments.
|
|
To extend existing keys instead of replacing, use :meth:`extend`
|
instead.
|
|
If provided, the first argument can be another :class:`Headers`
|
object, a :class:`MultiDict`, :class:`dict`, or iterable of
|
pairs.
|
|
.. versionadded:: 1.0
|
r rA r N) rB rC r r
|
r r? rc r8 Údictr< ÚlistÚtupler# )r rE rF Úmappingr r; r r r Úupdate s$
|
zHeaders.updatec C s t | S )zRConvert the headers into a list suitable for WSGI.
|
|
:return: list
|
)rk rM r r r Ú to_wsgi_listÀ s zHeaders.to_wsgi_listc C s | | j¡S r )r r rM r r r ÚcopyÇ s z Headers.copyc C s | ¡ S r )rp rM r r r Ú__copy__Ê s zHeaders.__copy__c C s> g }| ¡ D ] \}}| | d| ¡ q | d¡ d |¡S )z9Returns formatted headers suitable for HTTP transmission.z: z
|
)ro r6 Újoin)r Ústrsr r; r r r Ú__str__Í s
|
|
zHeaders.__str__c C s t | j dt| dS )Nú(ú))r2 Ú__name__rk rM r r r Ú__repr__Õ s zHeaders.__repr__)N)F)NNN)NN)F)F)T)%rw Ú
|
__module__Ú __qualname__Ú__doc__r r r& Ú__hash__r5 r8 r: r< r? r@ r rI rK r rL rN rO rQ rR rD rY rZ r# rc re rf ri rn ro rp rq rt rx r r r r r
|
sB $
|
|
|
/
|
)
|
|
|
" &r
|
r zdict[str, t.Any]©r; rX c C s t | dd | ¡ D ¡S )Nc S s i | ]\}}| d d¡|qS )r> ú-)Úreplacerg r r r Ú
|
<dictcomp>Û s
|
z'_options_header_vkw.<locals>.<dictcomp>)ÚhttpZdump_options_headerr< r} r r r rS Ù s ÿrS zt.Any)r Úreturnc C s< t | ts8tjdtdd t | tr0| d¡} nt| } | S )NziHeader keys must be strings. Passing other types is deprecated and will not be supported in Werkzeug 3.0.r r( úlatin-1)r r r, r- r. ÚbytesÚdecode)r r r r rT ß s
|
ü
|
rT z[\r\n])r; r c C sP t | tr$tjdtdd | d¡} t | ts6t| } t | ¡d k rLt d| S )NzXPassing bytes as a header value is deprecated and will not be supported in Werkzeug 3.0.r r( r z2Header values must not contain newline characters.)
|
r r r, r- r. r
r Ú _newline_reÚsearchr0 )r; r r r rU ó s
|
ü
|
|
rU c @ sF e Zd ZdZdd Zdd ZdZddd Zd
|
d Zd d Z dd Z
|
dS )ÚEnvironHeadersa Read only version of the headers from a WSGI environment. This
|
provides the same interface as `Headers` and is constructed from
|
a WSGI environment.
|
From Werkzeug 0.3 onwards, the `KeyError` raised by this class is also a
|
subclass of the :exc:`~exceptions.BadRequest` HTTP exception and will
|
render a page for a ``400 BAD REQUEST`` if caught in a catch-all for
|
HTTP exceptions.
|
c C s
|
|| _ d S r ©Úenviron)r r r r r r s zEnvironHeaders.__init__c C s | j |j kS r r )r r% r r r r& s zEnvironHeaders.__eq__NFc C sD t |tst|| ¡ dd¡}|dkr4| j| S | jd| S )Nr~ r> > Ú CONTENT_TYPEÚCONTENT_LENGTHÚHTTP_)r r r Úupperr r )r r r r r r r s
|
|
zEnvironHeaders.__getitem__c C s t tt| S r )rB rk rP rM r r r rR " s zEnvironHeaders.__len__c c sl | j ¡ D ]\\}}| d¡rD|dkrD|dd
dd¡ ¡ |fV q
|
|dkr
|
|r
|
| dd¡ ¡ |fV q
|
d S )Nr > ÚHTTP_CONTENT_TYPEÚHTTP_CONTENT_LENGTHé r> r~ > r r )r r< Ú
|
startswithr Útitlerh r r r rQ ' s
|
zEnvironHeaders.__iter__c C s t dt| jdd S )Nzcannot create z copies)rC r2 rw rM r r r rp 1 s zEnvironHeaders.copy)F) rw ry rz r{ r r& r| r rR rQ rp r r r r r s
|
|
|
r )r )Ú
|
__future__r ÚreÚtypingr\ r, Ú _internalr Ú
|
exceptionsr Zmixinsr Ú
|
structuresr r r
|
rS rT Úcompiler rU r Ú r r r r r Ú<module> s$ N
|
0
|
