U
j @ s d dl Z d dlmZmZmZmZmZmZmZm Z d dl
m Z d dl m
Z
mZmZ d dlmZmZmZ erxd dlmZmZ edZeded ef d
ZG d d d Zed ef ed
ddZeddddZ e eG dd dZ dS ) N)
TYPE_CHECKINGAnyCallableListOptionalTypeVarUnionoverload) implementer)MissingRenderMethodMissingTemplateLoaderUnexposedMethodError) IRenderableIRequestITemplateLoader) FlattenableTagT_Tc.)boundc @ s e Zd ZdZeedef edddZe Ze ee
ede f dddZ e ee
e
eede f e
f d d
dZ efee
eed d dZ d S )
Exposea/
Helper for exposing methods for various uses using a simple decorator-style
callable.
Instances of this class can be called with one or more functions as
positional arguments. The names of these functions will be added to a list
on the class object of which they are methods.
.)ffuncObjsreturnc G s: t |g|D ]&}t|dg }|| t|d| q|S )a;
Add one or more functions to the set of exposed functions.
This is a way to declare something about a class definition, similar to
L{zope.interface.implementer}. Use it like this::
magic = Expose('perform extra magic')
class Foo(Bar):
def twiddle(self, x, y):
...
def frob(self, a, b):
...
magic(twiddle, frob)
Later you can query the object::
aFoo = Foo()
magic.get(aFoo, 'twiddle')(x=1, y=2)
The call to C{get} will fail if the name it is given has not been
exposed using C{magic}.
@param funcObjs: One or more function objects which will be exposed to
the client.
@return: The first of C{funcObjs}.
exposedThrough) itertoolschaingetattrappendsetattr)selfr r ZfObjr r! 8/tmp/pip-unpacked-wheel-59kc99xd/twisted/web/_element.py__call__, s
zExpose.__call__)instance
methodNamer c C s d S Nr! )r r$ r% r! r! r" getP s z
Expose.get)r$ r% defaultr c C s d S r& r! )r r$ r% r( r! r! r" r' T s c C s< t ||d}t |dg }| |kr8|| jkr4t| ||S |S )aB
Retrieve an exposed method with the given name from the given instance.
@raise UnexposedMethodError: Raised if C{default} is not specified and
there is no exposed method with the given name.
@return: A callable object for the named method assigned to the given
instance.
Nr )r
_nodefaultr
)r r$ r% r( methodr r! r! r" r' Z s
N)__name__
__module__ __qualname____doc__r r objectr# r) r strr r' r r r! r! r! r" r " s$ " r )thunkr c C s t }| j|_|S r& )r r. )r1 Zexposer! r! r" exposero s r2 )r c C s dS )a
Decorate with L{renderer} to use methods as template render directives.
For example::
class Foo(Element):
@renderer
def twiddle(self, request, tag):
return tag('Hello, world.')
Will result in this final output::
Hello, world.
Nr! r! r! r! r" rendereru s r3 c @ sj e Zd ZU dZdZee ed< dee dddZe e
ee dgdf d d
d Z ee dd d
dZ
dS )Elementa
Base for classes which can render part of a page.
An Element is a renderer that can be embedded in a stan document and can
hook its template (from the loader) up to render methods.
An Element might be used to encapsulate the rendering of a complex piece of
data which is to be displayed in multiple different contexts. The Element
allows the rendering logic to be easily re-used in different ways.
Element returns render methods which are registered using
L{twisted.web._element.renderer}. For example::
class Menu(Element):
@renderer
def items(self, request, tag):
....
Render methods are invoked with two arguments: first, the
L{twisted.web.http.Request} being served and second, the tag object which
"invoked" the render method.
@ivar loader: The factory which will be used to load documents to
return from C{render}.
Nloaderr5 c C s |d k r|| _ d S r& r6 )r r5 r! r! r" __init__ s zElement.__init__r r )namer c C s$ t | |d}|dkr t| ||S )z=
Look up and return the named render method.
N)r3 r' r )r r8 r* r! r! r" lookupRenderMethod s
zElement.lookupRenderMethod)requestr c C s | j }|dkrt| | S )a
Implement L{IRenderable} to allow one L{Element} to be embedded in
another's template or rendering output.
(This will simply load the template from the C{loader}; when used in a
template, the flattening engine will keep track of this object
separately as the object to lookup renderers on and call
L{Element.renderer} to look them up. The resulting object from this
method is not directly associated with this L{Element}.)
N)r5 r load)r r: r5 r! r! r" render s zElement.render)N)r+ r, r- r. r5 r r __annotations__r7 r0 r r r9 r< r! r! r! r" r4 s
r4 ) r typingr r r r r r r r Zzope.interfacer
Ztwisted.web.errorr r r
Ztwisted.web.iwebr r r Ztwisted.web.templater r r r/ r r r2 r3 r4 r! r! r! r" s ( M