U
|
ß=®dù9 ã @ s d dl mZ d dlZd dlZd dlZd dlmZ d dlm Z d dl
|
m Z ddl mZ ddlmZ dd lmZ dd
|
lmZ dd lmZ ejr®dd lmZ dd lmZ ddlmZ e Z G dd dZ dddddZ dddddZ ddddZ ddd d Z!G d d d Z"G d d! d!Z#dS )"é )Ú annotationsN)Úupdate_wrapper)Ú TracebackType)Ú HTTPExceptioné )Útyping)Ú_cv_app)Ú _cv_request)Úappcontext_popped)Úappcontext_pushed)ÚFlask)Ú SessionMixin)ÚRequestc @ s¬ e Zd ZdZdddddZddddd d
|
Zdddd d Zd ddddddZefddddddZ d!ddddddZ
|
dddddZ ddd d Z ddd d Z d S )"Ú_AppCtxGlobalsa¯ A plain object. Used as a namespace for storing data during an
|
application context.
|
|
Creating an app context automatically creates this object, which is
|
made available as the :data:`g` proxy.
|
|
.. describe:: 'key' in g
|
|
Check whether an attribute is present.
|
|
.. versionadded:: 0.10
|
|
.. describe:: iter(g)
|
|
Return an iterator over the attribute names.
|
|
.. versionadded:: 0.10
|
Ústrzt.Any)ÚnameÚreturnc C s0 z | j | W S tk
|
r* t|d Y nX d S ©N©Ú__dict__ÚKeyErrorÚAttributeError©Úselfr © r ú@d:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\flask/ctx.pyÚ __getattr__2 s z_AppCtxGlobals.__getattr__ÚNone)r Úvaluer c C s || j |< d S r ©r )r r r r r r Ú __setattr__8 s z_AppCtxGlobals.__setattr__c C s0 z | j |= W n tk
|
r* t|d Y nX d S r r r r r r Ú __delattr__; s z_AppCtxGlobals.__delattr__Nz t.Any | None)r Údefaultr c C s | j ||¡S )zîGet an attribute by name, or a default value. Like
|
:meth:`dict.get`.
|
|
:param name: Name of attribute to get.
|
:param default: Value to return if the attribute is not present.
|
|
.. versionadded:: 0.10
|
)r Úget©r r r" r r r r# A s z_AppCtxGlobals.getc C s& |t kr| j |¡S | j ||¡S dS )a Get and remove an attribute by name. Like :meth:`dict.pop`.
|
|
:param name: Name of attribute to pop.
|
:param default: Value to return if the attribute is not present,
|
instead of raising a ``KeyError``.
|
|
.. versionadded:: 0.11
|
N)Ú _sentinelr Úpopr$ r r r r& L s z_AppCtxGlobals.popc C s | j ||¡S )a5 Get the value of an attribute if it is present, otherwise
|
set and return a default value. Like :meth:`dict.setdefault`.
|
|
:param name: Name of attribute to get.
|
:param default: Value to set and return if the attribute is not
|
present.
|
|
.. versionadded:: 0.11
|
)r Ú
|
setdefaultr$ r r r r' Z s
|
z_AppCtxGlobals.setdefaultÚbool)Úitemr c C s
|
|| j kS r r )r r) r r r Ú __contains__f s z_AppCtxGlobals.__contains__zt.Iterator[str]©r c C s
|
t | jS r )Úiterr ©r r r r Ú__iter__i s z_AppCtxGlobals.__iter__c C s, t d ¡}|d k r"d|jj dS t | ¡S )Nz <flask.g of 'z'>)r r# Úappr ÚobjectÚ__repr__)r Úctxr r r r1 l s
|
z_AppCtxGlobals.__repr__)N)N)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r r r! r# r% r& r' r* r. r1 r r r r r s r zft.AfterRequestCallable)Úfr c C s* t d¡}|dkrtd|j | ¡ | S )a³ Executes a function after this request. This is useful to modify
|
response objects. The function is passed the response object and has
|
to return the same or a new one.
|
|
Example::
|
|
@app.route('/')
|
def index():
|
@after_this_request
|
def add_header(response):
|
response.headers['X-Foo'] = 'Parachute'
|
return response
|
return 'Hello World!'
|
|
This is more useful if a function other than the view function wants to
|
modify a response. For instance think of a decorator that wants to add
|
some headers without converting the return value into a response object.
|
|
.. versionadded:: 0.9
|
Nzc'after_this_request' can only be used when a request context is active, such as in a view function.)r r# Ú RuntimeErrorÚ_after_request_functionsÚappend)r7 r2 r r r Úafter_this_requests s
|
ÿ r; z
|
t.Callablec s: t d¡ dkrtd ¡ fdd}t|S )a: A helper function that decorates a function to retain the current
|
request context. This is useful when working with greenlets. The moment
|
the function is decorated a copy of the request context is created and
|
then pushed when the function is called. The current session is also
|
included in the copied request context.
|
|
Example::
|
|
import gevent
|
from flask import copy_current_request_context
|
|
@app.route('/')
|
def index():
|
@copy_current_request_context
|
def do_some_work():
|
# do some work here, it can access flask.request or
|
# flask.session like you would otherwise in the view function.
|
...
|
gevent.spawn(do_some_work)
|
return 'Regular response'
|
|
.. versionadded:: 0.10
|
Nzm'copy_current_request_context' can only be used when a request context is active, such as in a view function.c
|
s. j ¡| |W 5 Q R £ S Q R X d S r )r/ Ú ensure_sync)ÚargsÚkwargs©r2 r7 r r Úwrapper¶ s z-copy_current_request_context.<locals>.wrapper)r r# r8 Úcopyr )r7 r@ r r? r Ú copy_current_request_context s
|
ÿrB r( r+ c C s t d¡dk S )aú If you have code that wants to test if a request context is there or
|
not this function can be used. For instance, you may want to take advantage
|
of request information if the request object is available, but fail
|
silently if it is unavailable.
|
|
::
|
|
class User(db.Model):
|
|
def __init__(self, username, remote_addr=None):
|
self.username = username
|
if remote_addr is None and has_request_context():
|
remote_addr = request.remote_addr
|
self.remote_addr = remote_addr
|
|
Alternatively you can also just test any of the context bound objects
|
(such as :class:`request` or :class:`g`) for truthness::
|
|
class User(db.Model):
|
|
def __init__(self, username, remote_addr=None):
|
self.username = username
|
if remote_addr is None and request:
|
remote_addr = request.remote_addr
|
self.remote_addr = remote_addr
|
|
.. versionadded:: 0.7
|
N)r r# r r r r Úhas_request_context½ s rC c C s t d¡dk S )zÀWorks like :func:`has_request_context` but for the application
|
context. You can also just do a boolean check on the
|
:data:`current_app` object instead.
|
|
.. versionadded:: 0.9
|
N)r r# r r r r Úhas_app_contextÝ s rD c @ sd e Zd ZdZdddddZdddd Zefd
|
dd d d Zd dddZdd
|
dddddZ dS )Ú
|
AppContextzèThe app context contains application-specific information. An app
|
context is created and pushed at the beginning of each request if
|
one is not already active. An app context is also pushed when
|
running CLI commands.
|
r r )r/ r c C s& || _ | d ¡| _| ¡ | _g | _d S r )r/ Úcreate_url_adapterÚ url_adapterZapp_ctx_globals_classÚgÚ
|
_cv_tokens)r r/ r r r Ú__init__î s
|
zAppContext.__init__r+ c C s* | j t | ¡¡ tj| j| jjd dS )z-Binds the app context to the current context.©Z_async_wrapperN)rI r: r Úsetr Úsendr/ r< r- r r r Úpushô s zAppContext.pushúBaseException | None©Úexcr c
|
C s z2t| jdkr0|tkr$t ¡ d }| j
|
|¡ W 5 t ¡ }t | j ¡ ¡ X || k rlt d|d| dt j | j | j jd dS )zPops the app context.r zPopped wrong app context. (ú instead of ú)rK N)r r# ÚresetrI r& Úlenr% ÚsysÚexc_infor/ Zdo_teardown_appcontextÚAssertionErrorr
|
rM r< )r rQ r2 r r r r& ù s ÿzAppContext.popc C s | ¡ | S r ©rN r- r r r Ú __enter__ s zAppContext.__enter__ú type | NoneúTracebackType | None©Úexc_typeÚ exc_valueÚtbr c C s | |¡ d S r ©r& ©r r^ r_ r` r r r Ú__exit__ s zAppContext.__exit__N)
|
r3 r4 r5 r6 rJ rN r% r& rZ rc r r r r rE ç s rE c @ s e Zd ZdZd ddddddd d
|
Zd d d d Zdd ddZdd ddZefdddddZ d d ddZ
|
ddddddd Z d d d d Z dS )!ÚRequestContextaÛ The request context contains per-request information. The Flask
|
app creates and pushes it at the beginning of the request, then pops
|
it at the end of the request. It will create the URL adapter and
|
request object for the WSGI environment provided.
|
|
Do not attempt to use this class directly, instead use
|
:meth:`~flask.Flask.test_request_context` and
|
:meth:`~flask.Flask.request_context` to create this object.
|
|
When the request context is popped, it will evaluate all the
|
functions registered on the application for teardown execution
|
(:meth:`~flask.Flask.teardown_request`).
|
|
The request context is automatically popped at the end of the
|
request. When using the interactive debugger, the context will be
|
restored so ``request`` is still accessible. Similarly, the test
|
client can preserve the context after the request ends. However,
|
teardown functions may already have closed some resources such as
|
database connections.
|
Nr ÚdictzRequest | NonezSessionMixin | Noner )r/ ÚenvironÚrequestÚsessionr c
|
C s || _ |d kr | |¡}|j|_|| _d | _z| | j¡| _W n* tk
|
rh } z || j_W 5 d }~X Y nX d | _ || _
|
g | _ g | _ d S r ) r/ Z request_classÚjsonZ json_modulerg rG rF r Úrouting_exceptionZflashesrh r9 rI )r r/ rf rg rh Úer r r rJ . s
|
zRequestContext.__init__r+ c C s | j | j| jj| j| jdS )a5 Creates a copy of this request context with the same request object.
|
This can be used to move a request context to a different greenlet.
|
Because the actual request object is the same this cannot be used to
|
move a request context to a different thread unless access to the
|
request object is locked.
|
|
.. versionadded:: 0.10
|
|
.. versionchanged:: 1.1
|
The current session object is used instead of reloading the original
|
data. This prevents `flask.session` pointing to an out-of-date object.
|
)rf rg rh )Ú __class__r/ rg rf rh r- r r r rA H s üzRequestContext.copyc
|
C sR z"| j jdd}|\| j_| j_W n* tk
|
rL } z || j_W 5 d}~X Y nX dS )zZCan be overridden by a subclass to hook into the matching
|
of the request.
|
T)Z return_ruleN)rG Úmatchrg Zurl_ruleZ view_argsr rj )r Úresultrk r r r Ú match_request\ s
|
z RequestContext.match_requestc C s t d ¡}|d ks |j| jk r2| j ¡ }| ¡ nd }| j t | ¡|f¡ | j d kr| jj
|
}| | j| j ¡| _ | j d kr| | j¡| _ | jd k r| ¡ d S r )r r# r/ Z app_contextrN rI r: r rL rh Úsession_interfaceZ open_sessionrg Zmake_null_sessionrG ro )r Úapp_ctxrp r r r rN f s
|
|
|
|
|
|
zRequestContext.pushrO rP c C sº t | jdk}zD|rP|t kr(t
|
¡ d }| j |¡ t| jdd}|dk rP| W 5 t ¡ }| j ¡ \}}t |¡ |rd|jjd< |dk r| |¡ || k r´td|d| dX dS )a Pops the request context and unbinds it by doing that. This will
|
also trigger the execution of functions registered by the
|
:meth:`~flask.Flask.teardown_request` decorator.
|
|
.. versionchanged:: 0.9
|
Added the `exc` argument.
|
r Nzwerkzeug.requestz Popped wrong request context. (rR rS Úclose)rU rI r r# r& rT rg rf rX r% rV rW r/ Zdo_teardown_requestÚgetattr)r rQ Z clear_requestr2 Útokenrq Z request_closer r r r& s(
|
|
|
ÿzRequestContext.popc C s | ¡ | S r rY r- r r r rZ ¨ s zRequestContext.__enter__r[ r\ r] c C s | |¡ d S r ra rb r r r rc ¬ s zRequestContext.__exit__r c C s0 dt | j d| jjd| jj d| jj d S )Nú<ú z [z] of ú>)Útyper3 rg ÚurlÚmethodr/ r r- r r r r1 ´ s .ÿzRequestContext.__repr__)NN) r3 r4 r5 r6 rJ rA ro rN r% r& rZ rc r1 r r r r rd s û
|
%rd )$Ú
|
__future__r Z contextvarsrV r ÚtÚ functoolsr Útypesr Zwerkzeug.exceptionsr Ú ÚftÚglobalsr r Zsignalsr
|
r Ú TYPE_CHECKINGr/ r Úsessionsr Úwrappersr r0 r% r r; rB rC rD rE rd r r r r Ú<module> s. X!)
|
1
|
