B `> @s<ddlmZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZmZmZdd lmZmZdd lmZmZdd lmZdd lmZmZmZmZm Z dd l!m"Z"GdddZ#GdddZ$eeGdddeee$ee eee" Z%dddZ&ddZ'ddZ(d ddZ)GdddZ*dS)!)dequeN) BaseRequest) implementer)InterfaceClass)reify)LocalizerRequestMixin)IRequestIRequestExtensions IResponseISessionFactory)Response_get_response_factory)AuthenticationAPIMixinSecurityAPIMixin)URLMethodsMixin)InstancePropertyHelperInstancePropertyMixinSentinelbytes_text_)ViewMethodsMixinc@s eZdZdS)TemplateContextN)__name__ __module__ __qualname__rrW/home/kop/projects/devel/pgwui/test_venv/lib/python3.7/site-packages/pyramid/request.pyrsrc@sDeZdZeddZeddZddZddZd d Zd d Z d S)CallbackMethodsMixincCstS)N)r)selfrrrfinished_callbacks"sz'CallbackMethodsMixin.finished_callbackscCstS)N)r)rrrrresponse_callbacks&sz'CallbackMethodsMixin.response_callbackscCs|j|dS)a Add a callback to the set of callbacks to be called by the :term:`router` at a point after a :term:`response` object is successfully created. :app:`Pyramid` does not have a global response object: this functionality allows an application to register an action to be performed against the response once one is created. A 'callback' is a callable which accepts two positional parameters: ``request`` and ``response``. For example: .. code-block:: python :linenos: def cache_callback(request, response): 'Set the cache_control max_age for the response' response.cache_control.max_age = 360 request.add_response_callback(cache_callback) Response callbacks are called in the order they're added (first-to-most-recently-added). No response callback is called if an exception happens in application code, or if the response object returned by :term:`view` code is invalid. All response callbacks are called *after* the tweens and *before* the :class:`pyramid.events.NewResponse` event is sent. Errors raised by callbacks are not handled specially. They will be propagated to the caller of the :app:`Pyramid` router application. .. seealso:: See also :ref:`using_response_callbacks`. N)r append)rcallbackrrradd_response_callback*s%z*CallbackMethodsMixin.add_response_callbackcCs&|j}x|r |}|||qWdS)N)r popleft)rresponse callbacksr"rrr_process_response_callbacksQsz0CallbackMethodsMixin._process_response_callbackscCs|j|dS)av Add a callback to the set of callbacks to be called unconditionally by the :term:`router` at the very end of request processing. ``callback`` is a callable which accepts a single positional parameter: ``request``. For example: .. code-block:: python :linenos: import transaction def commit_callback(request): '''commit or abort the transaction associated with request''' if request.exception is not None: transaction.abort() else: transaction.commit() request.add_finished_callback(commit_callback) Finished callbacks are called in the order they're added ( first- to most-recently- added). Finished callbacks (unlike response callbacks) are *always* called, even if an exception happens in application code that prevents a response from being generated. The set of finished callbacks associated with a request are called *very late* in the processing of that request; they are essentially the last thing called by the :term:`router`. They are called after response processing has already occurred in a top-level ``finally:`` block within the router request processing code. As a result, mutations performed to the ``request`` provided to a finished callback will have no meaningful effect, because response processing will have already occurred, and the request's scope will expire almost immediately after all finished callbacks have been processed. Errors raised by finished callbacks are not handled specially. They will be propagated to the caller of the :app:`Pyramid` router application. .. seealso:: See also :ref:`using_finished_callbacks`. N)rr!)rr"rrradd_finished_callbackWs/z*CallbackMethodsMixin.add_finished_callbackcCs$|j}x|r|}||qWdS)N)rr$)rr&r"rrr_process_finished_callbackssz0CallbackMethodsMixin._process_finished_callbacksN) rrrrrr r#r'r(r)rrrrr!s   '1rc@sTeZdZdZdZdZdZdZeZ e Z e ddZ e ddZe ddZd d ZdS) Requesta A subclass of the :term:`WebOb` Request class. An instance of this class is created by the :term:`router` and is provided to a view callable (and to other subsystems) as the ``request`` argument. The documentation below (save for the ``add_response_callback`` and ``add_finished_callback`` methods, which are defined in this subclass itself, and the attributes ``context``, ``registry``, ``root``, ``subpath``, ``traversed``, ``view_name``, ``virtual_root`` , and ``virtual_root_path``, each of which is added to the request by the :term:`router` at request ingress time) are autogenerated from the WebOb source code used when this documentation was generated. Due to technical constraints, we can't yet display the WebOb version number from which this documentation is autogenerated, but it will be the 'prevailing WebOb version' at the time of the release of this :app:`Pyramid` version. See https://webob.org/ for further information. NcCstS)N)r)rrrr tmpl_contextszRequest.tmpl_contextcCs$|jt}|dkrtd||S)zObtain the :term:`session` object associated with this request. If a :term:`session factory` has not been registered during application configuration, a :class:`pyramid.exceptions.ConfigurationError` will be raisedNzUNo session factory registered (see the Sessions chapter of the Pyramid documentation))registry queryUtilityr AttributeError)rfactoryrrrsessions  zRequest.sessioncCst|j}||S)a,This attribute is actually a "reified" property which returns an instance of the :class:`pyramid.response.Response`. class. The response object returned does not exist until this attribute is accessed. Subsequent accesses will return the same Response object. The ``request.response`` API is used by renderers. A render obtains the response object it will return from a view that uses that renderer by accessing ``request.response``. Therefore, it's possible to use the ``request.response`` API to set up a response object with "the right" attributes (e.g. by calling ``request.response.set_cookie()``) within a view that uses a renderer. Mutations to this response object will be preserved in the response sent to the client.)r r,)rZresponse_factoryrrrr%s zRequest.responsecCs4|jtkrdS|j}||t}|dkr,dS||kS)zgReturn ``True`` if the object passed as ``ob`` is a valid response object, ``False`` otherwise.TNF) __class__r r,ZqueryAdapterOrSelfr )robr,Zadaptedrrr is_responses  zRequest.is_response)rrr__doc__ exceptionexc_infoZ matchdictZ matched_routerZ request_ifacer Z ResponseClassrr+r0r%r3rrrrr*s   r*rcCs.td||dd}td||tfdd|_|S)Nz %s_IRequestz'route_request_iface-generated interface)basesr4z%s_combined_IRequestz0route_request_iface-generated combined interface)rrZcombined)namer7Zifacerrrroute_request_ifaces r9csfdd}||dS)Ncs&x D]\}}|j||fqWdS)N) headerlistr!)requestr%kv)r:rr add_headerssz0add_global_response_headers..add_headers)r#)r;r:r>r)r:radd_global_response_headerss r?c Cs|j}|dd}|dd}tt|dd}d}dddd|D}|dkrl|dkrl|drl|d7}||d}g} x6|r| |krP|} | r| d t t | d d qWx |r|d dkr|dd }qWd|}| } || jd<|| jd<| |S) NZ SCRIPT_NAMEZ PATH_INFO/subpathrcSsg|]}t|ddqS)zutf-8zlatin-1)rencode).0xrrr sz6call_app_with_subpath_as_path_info..rzlatin-1zutf-8) environgetlistgetattrjoinendswithsplitpopinsertrrcopyZ get_response) r;ZapprH script_nameZ path_inforBZnew_script_nameZ new_path_infoZworkbacktmpelZ new_requestrrr"call_app_with_subpath_as_path_infos4       rUcCs`|dkr|jt}|dk r\x0|jD]"\}}|||j}t|||q(Wt ||j dS)a~Apply request extensions (methods and properties) to an instance of :class:`pyramid.interfaces.IRequest`. This method is dependent on the ``request`` containing a properly initialized registry. After invoking this method, the ``request`` should have the methods and properties that were defined using :meth:`pyramid.config.Configurator.add_request_method`. N) r,r-r methodsitems__get__r1setattrrZapply_propertiesZ descriptors)r; extensionsr8fnmethodrrrapply_request_extensions=s  r]c@sPeZdZdZedZdddZddZddd Zefd d Z d d Z ddZ dS)RequestLocalCachea A store that caches values during for the lifecycle of a request. Wrapping Functions Instantiate and use it to decorate functions that accept a request parameter. The result is cached and returned in subsequent invocations of the function. .. code-block:: python @RequestLocalCache() def get_user(request): result = ... # do some expensive computations return result value = get_user(request) # manipulate the cache directly get_user.cache.clear(request) The cache instance is attached to the resulting function as the ``cache`` attribute such that the function may be used to manipulate the cache. Wrapping Methods A method can be used as the creator function but it needs to be bound to an instance such that it only accepts one argument - the request. An easy way to do this is to bind the creator in the constructor and then use :meth:`.get_or_create`: .. code-block:: python class SecurityPolicy: def __init__(self): self.identity_cache = RequestLocalCache(self.load_identity) def load_identity(self, request): result = ... # do some expensive computations return result def identity(self, request): return self.identity_cache.get_or_create(request) The cache maintains a weakref to each request and will release the cached values when the request is garbage-collected. However, in most scenarios, it will release resources earlier via :meth:`pyramid.request.Request.add_finished_callback`. .. versionadded:: 2.0 NO_VALUENcCst|_||_dS)N)weakrefWeakKeyDictionary_store_creator)rcreatorrrr__init__s zRequestLocalCache.__init__cs(tfdd|_|_S)Ncsj|S)N)cache get_or_create)r;)r[wrapperrrrhsz+RequestLocalCache.__call__..wrapper) functoolswrapsrfrc)rr[r)r[rhr__call__szRequestLocalCache.__call__cCsP|j||j}||jkrL|dkr8|j}|dkr8td||}||||S)a> Return the value from the cache. Compute if necessary. If no value is cached then execute the creator, cache the result, and return it. The creator may be passed in as an argument or bound to the cache by decorating a function or supplied as a constructor argument. NzUno creator function has been registered with the cache or supplied to "get_or_create")rbrIr_rc ValueErrorset)rr;rdresultrrrrgs   zRequestLocalCache.get_or_createcCs|j||S)zi Return the value from the cache. The cached value is returned or ``default``. )rbrI)rr;defaultrrrrIszRequestLocalCache.getcCs*||jk}||j|<|s&||jjdS)z5 Update the cache with a new value. N)rbr(rO)rr;valueZ already_setrrrrms  zRequestLocalCache.setcCs*|j}||jkr&|j|}|j|j|<|S)zo Delete the value from the cache. The cached value is returned or :attr:`.NO_VALUE`. )r_rb)rr; old_valuerrrclears    zRequestLocalCache.clear)N)N) rrrr4rr_rerkrgrIrmrrrrrrr^Rs4    r^)r)N)+ collectionsrrir`ZwebobrZzope.interfacerZzope.interface.interfacerZpyramid.decoratorrZ pyramid.i18nrZpyramid.interfacesrr r r Zpyramid.responser r Zpyramid.securityrrZ pyramid.urlrZ pyramid.utilrrrrrZ pyramid.viewrrrr*r9r?rUr]r^rrrrs:        nP 8