o
b5 @ s d Z g dZddlZddlmZmZmZ ddlmZ ddl m
Z
ddl m Z ddl
mZmZ dd lmZ G d
d d eZd d
ZeeG dd dZdd ZG dd deZG dd deZG dd deZG dd deZeeG dd de
eZdS ) z4
Implementation of the lowest-level Resource class.
) IResourcegetChildForRequestResource ErrorPage
NoResourceForbiddenResourceEncodingResourceWrapper N) Attribute Interface implementer) nativeString)proxyForInterface)prefixedMethodNames) FORBIDDEN NOT_FOUND)UnsupportedMethodc @ s0 e Zd ZdZedZdd Zdd Zdd Zd S )
r z
A web resource.
z
Signal if this IResource implementor is a "leaf node" or not. If True,
getChildWithDefault will not be called on this Resource.
c C dS )a
Return a child with the given name for the given request.
This is the external interface used by the Resource publishing
machinery. If implementing IResource without subclassing
Resource, it must be provided. However, if subclassing Resource,
getChild overridden instead.
@param name: A single path component from a requested URL. For example,
a request for I{http://example.com/foo/bar} will result in calls to
this method with C{b"foo"} and C{b"bar"} as values for this
argument.
@type name: C{bytes}
@param request: A representation of all of the information about the
request that is being made for this child.
@type request: L{twisted.web.server.Request}
N )namerequestr r 6/usr/lib/python3/dist-packages/twisted/web/resource.pygetChildWithDefault+ z IResource.getChildWithDefaultc C r )a
Put a child IResource implementor at the given path.
@param path: A single path component, to be interpreted relative to the
path this resource is found at, at which to put the given child.
For example, if resource A can be found at I{http://example.com/foo}
then a call like C{A.putChild(b"bar", B)} will make resource B
available at I{http://example.com/foo/bar}.
@type path: C{bytes}
Nr )pathchildr r r putChild> r zIResource.putChildc C r )ap
Render a request. This is called on the leaf resource for a request.
@return: Either C{server.NOT_DONE_YET} to indicate an asynchronous or a
C{bytes} instance to write as the response to the request. If
C{NOT_DONE_YET} is returned, at some point later (for example, in a
Deferred callback) call C{request.write(b"")} to write data to
the request, and C{request.finish()} to send the data to the
browser.
@raise twisted.web.error.UnsupportedMethod: If the HTTP verb
requested is not supported by this resource.
Nr r r r r renderJ r zIResource.renderN) __name__
__module__ __qualname____doc__r isLeafr r r r r r r r s r c C s@ |j r | js |j d}|j| | ||} |j r | jr| S )zE
Traverse resource tree to find who will handle the request.
r )postpathr" popprepathappendr )resourcer pathElementr r r r Z s r c @ s e Zd ZdZeZdZdd ZdZdd Z dd Z
d
d Z d d
Z dd Z
d&ddZdd Zdd Zdd Zdd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% ZdS )'r z
Define a web-accessible resource.
This serves 2 main purposes; one is to provide a standard representation
for what HTTP specification calls an 'entity', and the other is to provide
an abstract directory structure for URL retrieval.
Nc C s
i | _ dS )z
Initialize.
Nchildrenselfr r r __init__s s
zResource.__init__r c C t | j S N)listr* keysr+ r r r listStaticNames} zResource.listStaticNamesc C r. r/ )r0 r* itemsr+ r r r listStaticEntities r3 zResource.listStaticEntitiesc C t | | S r/ )r0 r2 listDynamicNamesr+ r r r listNames zResource.listNamesc C r6 r/ )r0 r5 listDynamicEntitiesr+ r r r listEntities r9 zResource.listEntitiesc C g S r/ r r+ r r r r7 zResource.listDynamicNamesc C r< r/ r r, r r r r r: r= z Resource.listDynamicEntitiesc C s | j |S r/ )r* getr, r r r r getStaticEntity zResource.getStaticEntityc C s || j vr | ||S d S r/ r* getChild)r, r r r r r getDynamicEntity s
zResource.getDynamicEntityc C s | j |= d S r/ r) r@ r r r delEntity rB zResource.delEntityc C s || j |< d S r/ r) )r, r entityr r r reallyPutEntity r3 zResource.reallyPutEntityc C s t dS )a<
Retrieve a 'child' resource from me.
Implement this to create dynamic resource generation -- resources which
are always available may be registered with self.putChild().
This will not be called if the class-level variable 'isLeaf' is set in
your subclass; instead, the 'postpath' attribute of the request will be
left as a list of the remaining path elements.
For example, the URL /foo/bar/baz will normally be::
| site.resource.getChild('foo').getChild('bar').getChild('baz').
However, if the resource returned by 'bar' has isLeaf set to true, then
the getChild call will never be made on it.
Parameters and return value have the same meaning and requirements as
those defined by L{IResource.getChildWithDefault}.
zNo such child resource.)r r, r r r r r rD s zResource.getChildc C s || j v r
| j | S | ||S )a
Retrieve a static or dynamically generated child resource from me.
First checks if a resource was added manually by putChild, and then
call getChild to check for dynamic resources. Only override if you want
to affect behaviour of all child lookups, rather than just dynamic
ones.
This will check to see if I have a pre-registered child resource of the
given name, and call getChild if I do not.
@see: L{IResource.getChildWithDefault}
rC rI r r r r s
z Resource.getChildWithDefaultc C s t dtd t| |S )Nz+Please use module level getChildForRequest. )warningswarnDeprecationWarningr r> r r r r s
zResource.getChildForRequestc C s: t |tstjdt|tdd || j|< | j|_dS )a
Register a static child.
You almost certainly don't want '/' in your path. If you
intended to have the root of a folder, e.g. /foo/, you want
path to be ''.
@param path: A single path component.
@type path: L{bytes}
@param child: The child resource to register.
@type child: L{IResource}
@see: L{IResource.putChild}
zcPath segment must be bytes; passing {} has never worked, and will raise an exception in the future.rJ )category
stacklevelN)
isinstancebytesrK rL formattyperM r* server)r, r r r r r r s
zResource.putChildc C sT t | dt|j d}|s&z| j}W t| ty% t| }Y t|w ||S )aF
Render a given resource. See L{IResource}'s render method.
I delegate to methods of self with the form 'render_METHOD'
where METHOD is the HTTP that was used to make the
request. Examples: render_GET, render_HEAD, render_POST, and
so on. Generally you should implement those methods instead of
overriding this one.
render_METHOD methods are expected to return a byte string which will be
the rendered page, unless the return value is C{server.NOT_DONE_YET}, in
which case it is this class's responsibility to write the results using
C{request.write(data)} and then call C{request.finish()}.
Old code that overrides render() directly is likewise expected
to return a byte string or NOT_DONE_YET.
@see: L{IResource.render}
render_N)getattrr methodallowedMethodsAttributeError_computeAllowedMethodsr )r, r mrX r r r r s
zResource.renderc C s
| |S )z
Default handling of HEAD method.
I just return self.render_GET(request). When method is HEAD,
the framework will handle this correctly.
)
render_GETr> r r r render_HEAD s
zResource.render_HEADr/ )r r r r! r
entityTyperT r- r" r2 r5 r8 r; r7 r: rA rE rF rH rD r r r r r] r r r r r e s,
r c C s* g }t | jdD ]
}||d q|S )z
Compute the allowed methods on a C{Resource} based on defined render_FOO
methods. Used when raising C{UnsupportedMethod} but C{Resource} does
not define C{allowedMethods} attribute.
rU ascii)r __class__r& encode)r' rX r r r r rZ s rZ c @ s, e Zd ZdZdZdd Zdd Zdd Zd S )
r a
L{ErrorPage} is a resource which responds with a particular
(parameterized) status and a body consisting of HTML containing some
descriptive text. This is useful for rendering simple error pages.
@ivar template: A native string which will have a dictionary interpolated
into it to generate the response body. The dictionary has the following
keys:
- C{"code"}: The status code passed to L{ErrorPage.__init__}.
- C{"brief"}: The brief description passed to L{ErrorPage.__init__}.
- C{"detail"}: The detailed description passed to
L{ErrorPage.__init__}.
@ivar code: An integer status code which will be used for the response.
@type code: C{int}
@ivar brief: A short string which will be included in the response body as
the page title.
@type brief: C{str}
@ivar detail: A longer string which will be included in the response body.
@type detail: C{str}
z
%(code)s - %(brief)s
%(brief)s
%(detail)s
c C s t | || _|| _|| _d S r/ )r r- codebriefdetail)r, statusrc rd r r r r- E s
zErrorPage.__init__c C sJ | | j |dd | jt| j| j| jd }t|tr#| dS |S )Ns content-types text/html; charset=utf-8)rb rc rd zutf-8)
setResponseCoderb setHeadertemplatedictrc rd rP strra )r, r interpolatedr r r r K s
zErrorPage.renderc C s | S r/ r )r, chnamr r r r rD U r= zErrorPage.getChildN)r r r r! rh r- r rD r r r r r ! s
r c @ e Zd ZdZdddZdS )r zr
L{NoResource} is a specialization of L{ErrorPage} which returns the HTTP
response code I{NOT FOUND}.
%Sorry. No luck finding that resource.c C t | td| d S )NzNo Such Resource)r r- r r, messager r r r- _ r9 zNoResource.__init__N)rn r r r r! r- r r r r r Y r c @ rm )r zy
L{ForbiddenResource} is a specialization of L{ErrorPage} which returns the
I{FORBIDDEN} HTTP response code.
Sorry, resource is forbidden.c C ro )NzForbidden Resource)r r- r rp r r r r- i r9 zForbiddenResource.__init__N)rt rr r r r r r c rs r c @ s e Zd ZdZdd ZdS )_IEncodingResourcezT
A resource which knows about L{_IRequestEncoderFactory}.
@since: 12.3
c C r )z
Parse the request and return an encoder if applicable, using
L{_IRequestEncoderFactory.encoderForRequest}.
@return: A L{_IRequestEncoder}, or L{None}.
Nr r r r r
getEncodert r z _IEncodingResource.getEncoderN)r r r r! rv r r r r ru m s ru c s( e Zd ZdZ fddZdd Z ZS )r a
Wrap a L{IResource}, potentially applying an encoding to the response body
generated.
Note that the returned children resources won't be wrapped, so you have to
explicitly wrap them if you want the encoding to be applied.
@ivar encoders: A list of
L{_IRequestEncoderFactory}
returning L{_IRequestEncoder} that
may transform the data passed to C{Request.write}. The list must be
sorted in order of priority: the first encoder factory handling the
request will prevent the others from doing the same.
@type encoders: C{list}.
@since: 12.3
c s t | || _d S r/ )superr- _encoders)r, originalencodersr` r r r- s
z EncodingResourceWrapper.__init__c C s* | j D ]}||}|dur| S qdS )zR
Browser the list of encoders looking for one applicable encoder.
N)rx encoderForRequest)r, r encoderFactoryencoderr r r rv s
z"EncodingResourceWrapper.getEncoder)r r r r! r- rv
__classcell__r r r{ r r } s r )r! __all__rK zope.interfacer r
r twisted.python.compatr twisted.python.componentsr
twisted.python.reflectr twisted.web._responsesr r twisted.web.errorr r r r rZ r r r ru r r r r r s*
; -8