B `U@sddlmZddlmZddlmZddlmZddlm Z m Z m Z ddl m Z mZmZGdddZeeGd d d Zd S) ) implementer) action_method)ConfigurationError)ITweens)EXCVIEWINGRESSMAIN)TopologicalSorteris_nonstr_iteris_string_or_iterablec@s,eZdZd ddZddZed ddZdS) TweensConfiguratorMixinNcCs|j|||ddS)a .. versionadded:: 1.2 Add a 'tween factory'. A :term:`tween` (a contraction of 'between') is a bit of code that sits between the Pyramid router's main request handling function and the upstream WSGI component that uses :app:`Pyramid` as its 'app'. Tweens are a feature that may be used by Pyramid framework extensions, to provide, for example, Pyramid-specific view timing support, bookkeeping code that examines exceptions before they are returned to the upstream WSGI application, or a variety of other features. Tweens behave a bit like :term:`WSGI` 'middleware' but they have the benefit of running in a context in which they have access to the Pyramid :term:`application registry` as well as the Pyramid rendering machinery. .. note:: You can view the tween ordering configured into a given Pyramid application by using the ``ptweens`` command. See :ref:`displaying_tweens`. The ``tween_factory`` argument must be a :term:`dotted Python name` to a global object representing the tween factory. The ``under`` and ``over`` arguments allow the caller of ``add_tween`` to provide a hint about where in the tween chain this tween factory should be placed when an implicit tween chain is used. These hints are only used when an explicit tween chain is not used (when the ``pyramid.tweens`` configuration value is not set). Allowable values for ``under`` or ``over`` (or both) are: - ``None`` (the default). - A :term:`dotted Python name` to a tween factory: a string representing the dotted name of a tween factory added in a call to ``add_tween`` in the same configuration session. - One of the constants :attr:`pyramid.tweens.MAIN`, :attr:`pyramid.tweens.INGRESS`, or :attr:`pyramid.tweens.EXCVIEW`. - An iterable of any combination of the above. This allows the user to specify fallbacks if the desired tween is not included, as well as compatibility with multiple other tweens. ``under`` means 'closer to the main Pyramid application than', ``over`` means 'closer to the request ingress than'. For example, calling ``add_tween('myapp.tfactory', over=pyramid.tweens.MAIN)`` will attempt to place the tween factory represented by the dotted name ``myapp.tfactory`` directly 'above' (in ``ptweens`` order) the main Pyramid request handler. Likewise, calling ``add_tween('myapp.tfactory', over=pyramid.tweens.MAIN, under='mypkg.someothertween')`` will attempt to place this tween factory 'above' the main handler but 'below' (a fictional) 'mypkg.someothertween' tween factory. If all options for ``under`` (or ``over``) cannot be found in the current configuration, it is an error. If some options are specified purely for compatibility with other tweens, just add a fallback of MAIN or INGRESS. For example, ``under=('mypkg.someothertween', 'mypkg.someothertween2', INGRESS)``. This constraint will require the tween to be located under both the 'mypkg.someothertween' tween, the 'mypkg.someothertween2' tween, and INGRESS. If any of these is not in the current configuration, this constraint will only organize itself based on the tweens that are present. Specifying neither ``over`` nor ``under`` is equivalent to specifying ``under=INGRESS``. Implicit tween ordering is obviously only best-effort. Pyramid will attempt to present an implicit order of tweens as best it can, but the only surefire way to get any particular ordering is to use an explicit tween order. A user may always override the implicit tween ordering by using an explicit ``pyramid.tweens`` configuration value setting. ``under``, and ``over`` arguments are ignored when an explicit tween chain is specified using the ``pyramid.tweens`` configuration value. For more information, see :ref:`registering_tweens`. F)underoverexplicit) _add_tween)self tween_factoryr rr]/home/kop/projects/devel/pgwui/test_venv/lib/python3.7/site-packages/pyramid/config/tweens.py add_tweensQz!TweensConfiguratorMixin.add_tweencCs|tdS)N)rr)rrrradd_default_tweensdsz*TweensConfiguratorMixin.add_default_tweensFc szttstdttfkr2td|x.registerZtweenrimplicitrz%s tweenrfactorytype)introspectables) isinstancestrrrrZ maybe_dottedr r registryZ queryUtilityrTweensZregisterUtilityZintrospectableappendaction) rrr rrtpr"rrZ discriminatorZ tween_typeZintrr)rrrrrr rrgsF          z"TweensConfiguratorMixin._add_tween)NN)NNF)__name__ __module__ __qualname__rrrrrrrrr s Ur c@s6eZdZddZddZd ddZdd Zd d ZdS) r#cCstdtttd|_g|_dS)N)Zdefault_beforeZ default_afterfirstlast)r rrsorterr)rrrr__init__s  zTweens.__init__cCs|j||fdS)N)rr$)rrrrrrrszTweens.add_explicitNcCs|jj||||ddS)N)afterbefore)r-add)rrrr rrrrrszTweens.add_implicitcCs |jS)N)r-sorted)rrrrrszTweens.implicitcCs@|jr|j}n|}x$|dddD]\}}|||}q&W|S)N)rr)rhandlerr"Zuserrrrr__call__s zTweens.__call__)NN)r(r)r*r.rrrr5rrrrr#s   r#N)Zzope.interfacerZpyramid.config.actionsrZpyramid.exceptionsrZpyramid.interfacesrZpyramid.tweensrrrZ pyramid.utilr r r r r#rrrrs