U
|
Þ=®d\6 ã @ s d Z ddlmZ ddlZddlmZ ddlmZ ddl m
|
Z
|
ddl m Z dd l mZ dd
|
lmZ ejrdd lmZ dd lmZ dd lmZ G dd deZG dd deZefdddddddZG dd dZG dd d Z G d d d Z G d d d Z G d!d" d"Z dS )#a
|
WSGI Protocol Linter
|
====================
|
|
This module provides a middleware that performs sanity checks on the
|
behavior of the WSGI server and application. It checks that the
|
:pep:`3333` WSGI spec is properly implemented. It also warns on some
|
common HTTP errors such as non-empty responses for 304 status codes.
|
|
.. autoclass:: LintMiddleware
|
|
:copyright: 2007 Pallets
|
:license: BSD-3-Clause
|
é )Ú annotationsN)Ú TracebackType)Úurlparse)Úwarné )ÚHeaders)Úis_entity_header)Ú FileWrapper)Ú StartResponse)ÚWSGIApplication)ÚWSGIEnvironmentc @ s e Zd ZdZdS )Ú WSGIWarningz Warning class for WSGI warnings.N©Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__© r r úOd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\werkzeug/middleware/lint.pyr s r c @ s e Zd ZdZdS )Ú HTTPWarningz Warning class for HTTP warnings.Nr r r r r r $ s r ÚstrÚobjectzt.TypeÚNone)ÚcontextÚobjÚneedÚreturnc C s8 t ||k r4t| d|jdt |jdtdd d S )Nz
|
requires z, got Ú.é ©Ú
|
stacklevel)Útyper r r )r r r r r r Ú
|
check_type( s ýr" c @ sX e Zd ZdddddZdddd d
|
Zdddd d Zd dddZddddZdS )Ú InputStreamz t.IO[bytes]r ©Ústreamr c C s
|
|| _ d S ©N©Ú_stream©Úselfr% r r r Ú__init__2 s zInputStream.__init__út.AnyÚbytes)Úargsr c G sB t |dkr tdtdd nt |dkr6tdtdd | jj| S )Nr zWSGI does not guarantee an EOF marker on the input stream, thus making calls to 'wsgi.input.read()' unsafe. Conforming servers may never return from this call.r r é z2Too many parameters passed to 'wsgi.input.read()'.)Úlenr r r( Úread©r* r. r r r r1 5 s û ýzInputStream.readc G sL t |dkr tdtdd n$t |dkr8tdtdd ntd| jj| S )Nr z_Calls to 'wsgi.input.readline()' without arguments are unsafe. Use 'wsgi.input.read()' instead.r r r/ z~'wsgi.input.readline()' was called with a size hint. WSGI does not support this, although it's available on all major servers.z5Too many arguments passed to 'wsgi.input.readline()'.)r0 r r Ú TypeErrorr( Úreadliner2 r r r r4 F s ü üzInputStream.readlinezt.Iterator[bytes]©r c C s< z t | jW S tk
|
r6 tdtdd t d Y S X d S )Nz 'wsgi.input' is not iterable.r r r )Úiterr( r3 r r ©r* r r r Ú__iter__Y s
|
zInputStream.__iter__c C s t dtdd | j ¡ d S )Nz(The application closed the input stream!r r ©r r r( Úcloser7 r r r r: ` s zInputStream.closeN)r r r r+ r1 r4 r8 r: r r r r r# 1 s
|
r# c @ sX e Zd ZdddddZddddd Zdd
|
d d Zd ddddZdd
|
ddZdS )Ú ErrorStreamz t.IO[str]r r$ c C s
|
|| _ d S r& r' r) r r r r+ f s zErrorStream.__init__r ©Úsr c C s t d|t | j |¡ d S )Nzwsgi.error.write())r" r r( Úwrite©r* r= r r r r> i s zErrorStream.writer5 c C s | j ¡ d S r& )r( Úflushr7 r r r r@ m s zErrorStream.flushzt.Iterable[str])Úseqr c C s |D ]}| |¡ qd S r& )r> )r* rA Úliner r r Ú
|
writelinesp s zErrorStream.writelinesc C s t dtdd | j ¡ d S )Nz(The application closed the error stream!r r r9 r7 r r r r: t s zErrorStream.closeN)r r r r+ r> r@ rC r: r r r r r; e s
|
r; c @ s. e Zd ZddddddZdddd d
|
Zd S ) Ú GuardedWritezt.Callable[[bytes], object]ú list[int]r )r> Úchunksr c C s || _ || _d S r& )Ú_writeÚ_chunks)r* r> rF r r r r+ z s zGuardedWrite.__init__r- r< c C s* t d|t | |¡ | j t|¡ d S )Nzwrite())r" r- rG rH Úappendr0 r? r r r Ú__call__~ s
|
zGuardedWrite.__call__N)r r r r+ rJ r r r r rD y s rD c @ sX e Zd ZdddddddZd dd d
|
Zd dd d ZddddZddddZdS )ÚGuardedIteratorút.Iterable[bytes]útuple[int, Headers]rE r )ÚiteratorÚ headers_setrF r c C s( || _ t|j| _d| _|| _|| _d S )NF)Ú _iteratorr6 Ú__next__Ú_nextÚclosedrO rF )r* rN rO rF r r r r+
s
|
zGuardedIterator.__init__r5 c C s | S r& r r7 r r r r8 s zGuardedIterator.__iter__r- c C sP | j rtdtdd | ¡ }| js0tdtdd td|t | j t |¡ |S )Nz Iterated over closed 'app_iter'.r r z8The application returned before it started the response.zapplication iterator items)
|
rS r r rR rO r" r- rF rI r0 )r* Úrvr r r rQ s ý zGuardedIterator.__next__c C sþ d| _ t| jdr | j ¡ | jrú| j\}}t| j}|jdtd}|dkr|D ]2\}}| ¡ }|dkrPt
|
|rPt d|dt qP|rút d t nfd
|
| kr¨d k s²n |d krà|d krÊt | dt |rút | dt n|d k rú||krút dt d S )NTr: zcontent-length)r! i0 )Úexpireszcontent-locationzEntity header z found in 304 response.z#304 responses must not have a body.éd éÈ éÌ r z- responses must have an empty content length.z responses must not have a body.zGContent-Length and the number of bytes sent to the client do not match.)rS ÚhasattrrP r: rO ÚsumrF ÚgetÚintÚlowerr r r r )r* Ú status_codeÚheadersZ
|
bytes_sentÚcontent_lengthÚkeyÚ_valuer r r r: ¥ s@
|
|
|
|
ÿ
|
ÿ þýzGuardedIterator.closec C s. | j s*ztdt W n tk
|
r( Y nX d S )Nz4Iterator was garbage collected before it was closed.)rS r r Ú Exceptionr7 r r r Ú__del__Ê s ÿzGuardedIterator.__del__N)r r r r+ r8 rQ r: rd r r r r rK s
|
%rK c @ sv e Zd ZdZdddddZdddd d
|
Zd d d ddddZdddddZdddddZddddd d Z d S ) ÚLintMiddlewarea Warns about common errors in the WSGI and HTTP behavior of the
|
server and wrapped application. Some of the issues it checks are:
|
|
- invalid status codes
|
- non-bytes sent to the WSGI server
|
- strings returned from the WSGI application
|
- non-empty conditional responses
|
- unquoted etags
|
- relative URLs in the Location header
|
- unsafe calls to wsgi.input
|
- unclosed iterators
|
|
Error information is emitted using the :mod:`warnings` module.
|
|
:param app: The WSGI application to wrap.
|
|
.. code-block:: python
|
|
from werkzeug.middleware.lint import LintMiddleware
|
app = LintMiddleware(app)
|
r r )Úappr c C s
|
|| _ d S r& )rf )r* rf r r r r+ ë s zLintMiddleware.__init__r )Úenvironr c C sÀ t |tk rtdtdd dD ]"}||kr td|dtdd q |d d kr\td
|
tdd | d d ¡}| d d ¡}|r|d dkrtd|tdd |r¼|d dkr¼td|tdd d S )Nz/WSGI environment is not a standard Python dict.é r ) ÚREQUEST_METHODZ SERVER_NAMEZ SERVER_PORTú wsgi.versionú
|
wsgi.inputú wsgi.errorszwsgi.multithreadzwsgi.multiprocessz wsgi.run_oncezRequired environment key z
|
not foundr rj )r/ r z"Environ is not a WSGI 1.0 environ.Z SCRIPT_NAMEÚ Z PATH_INFOr ú/z+'SCRIPT_NAME' does not start with a slash: z)'PATH_INFO' does not start with a slash: )r! Údictr r r[ )r* rg ra Ú script_nameZ path_infor r r Ú check_environî s: ý
|
ý ýýz LintMiddleware.check_environr zlist[tuple[str, str]]z?None | tuple[type[BaseException], BaseException, TracebackType]rM )Ústatusr_ Úexc_infor c C s\ t d|t | d d¡d }t|dks0| ¡ s>tdtdd t|dk sV|d dkrltd |d
|
tdd t|}|d k rtd tdd t|t k r¤td tdd |D ]t}t|t
|
k sÄt|dkrÒtdtdd |\}}t|tk sôt|tk rtdtdd | ¡ dkr¨tdtdd q¨|d k rBt |t
|
sBtdtdd t |}| |¡ ||fS )Nrr r/ r r z!Status code must be three digits.r rh ú zInvalid value for status zJ. Valid status strings are three digits, a space and a status explanation.rV zStatus code < 100 detected.zHeader list is not a list.r z#Header items must be 2-item tuples.z'Header keys and values must be strings.zFThe status header is not supported due to conflicts with the CGI spec.zInvalid value for exc_info.)r" r Úsplitr0 Ú isdecimalr r r\ r! ÚlistÚtupler] Ú
|
isinstancer Ú check_headers) r* rr r_ rs Zstatus_code_strr^ ÚitemÚnameÚvaluer r r Úcheck_start_response sH
|
ü ÿ ü
|
z#LintMiddleware.check_start_responser )r_ r c C s¢ | d¡}|d k rt| d¡r@| d¡r4tdtdd |dd
}|d d
|d d
krdd
|
kstn td tdd | d ¡}|d k rt|jstd tdd d S )NÚetag)zW/úw/r z)Weak etag indicator should be upper case.rh r r r/ éÿÿÿÿú"zUnquoted etag emitted.Úlocationz+Absolute URLs required for location header.)r[ Ú
|
startswithr r r Únetloc)r* r_ r r r r r rz N s(
|
|
|
ý &
|
|
ýz LintMiddleware.check_headersrL )Úapp_iterr c C s t |trtdtdd d S )Nz The application returned a string. The response will send one character at a time to the client, which will kill performance. Return a list or iterable instead.r r )ry r r r )r* r r r r Úcheck_iteratori s
|
ûz LintMiddleware.check_iteratorr, ©r. Úkwargsr c sÎ t |dkrtdtdd |r,tdtdd |d }|d |¡ t|d |d< t|d |d< t|d < g g d
|
d
|
d d fd d } |t d|¡¡}
|
|¡ t |t tj t tf ¡ S )Nr z A WSGI app takes two arguments.r z+A WSGI app does not take keyword arguments.r r/ rk rl zwsgi.file_wrapperr, zt.Callable[[bytes], None]r c s t | dkr&tdt | dtdd |r4tdt | d }| d }t | d krX| d nd } |||¡d d
< t||| S )
|
N> r r z Invalid number of arguments: z, expected 2 or 3.r r z1'start_response' does not take keyword arguments.r r/ r )r0 r r r~ rD )r. r rr r_ rs ©rF rO r* Zstart_responser r Úchecking_start_response s ý
|
þz8LintMiddleware.__call__.<locals>.checking_start_responser
|
)r0 r r rq r# r; r rf ÚtÚcastr rK ÚTupler\ r )r* r. r rg r r r r r rJ s s0 ÿ
|
|
ÿzLintMiddleware.__call__N)
|
r r r r r+ rq r~ rz r rJ r r r r re Ô s ,4
|
re ) r Ú
|
__future__r Útypingr Útypesr Ú urllib.parser Úwarningsr Zdatastructuresr Úhttpr Zwsgir Ú TYPE_CHECKINGZ_typeshed.wsgir
|
r r ÚWarningr r r r" r# r; rD rK re r r r r Ú<module> s( 4 P
|
