/usr/lib/python3/dist-packages/twisted/web/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/web/__pycache__/xmlrpc.cpython-310.pyc (20015B)
o
bR @ s& d Z ddlZddlmZ ddlmZ ddlmZmZm Z m
Z
ddl m Z m
Z
mZ ddlmZ ddlmZmZ ddlmZ dd lmZmZmZ d
Zd Zd d
Z G dd de
Z G dd dZ G dd dej Z G dd de Z!dd Z"G dd dej#Z$dZ%G dd d ej&Z'G d d d Z(g d Z)dS ) z
A generic resource for publishing objects via XML-RPC.
Maintainer: Itamar Shtull-Trauring
@var Fault: See L{xmlrpclib.Fault}
@type Fault: L{xmlrpclib.Fault}
N)urlparse)BinaryBooleanDateTimeFault)defererrorprotocol)Logger)failurereflect) nativeString)httpresourceserverA B c C s
d| _ | S )a\
Decorator to cause the request to be passed as the first argument
to the method.
If an I{xmlrpc_} method is wrapped with C{withRequest}, the
request object is passed as the first argument to that method.
For example::
@withRequest
def xmlrpc_echo(self, request, s):
return s
@since: 10.2
T) withRequest)f r 4/usr/lib/python3/dist-packages/twisted/web/xmlrpc.pyr " s r c @ s e Zd ZdZdS )NoSuchFunctionz1
There is no function by the given name.
N)__name__
__module__ __qualname____doc__r r r r r 5 s r c @ s e Zd ZdZdd Zdd ZdS )HandleraP
Handle a XML-RPC request and store the state for a request in progress.
Override the run() method and return result using self.result,
a Deferred.
We require this class since we're not using threads, so we can't
encapsulate state in a running function if we're going to have
to wait for results.
For example, lets say we want to authenticate against twisted.cred,
run a LDAP query and then pass its result to a database query, all
as a result of a single XML-RPC command. We'd use a Handler instance
to store the state of the running command.
c G s || _ t | _| j| d S N)r r Deferredresultrun)selfr argsr r r __init__L s
zHandler.__init__c G s | j td d S )Nz Implement run() in subclasses)r errbackNotImplementedError)r! r" r r r r Q s z Handler.runN)r r r r r# r r r r r r ; s r c @ s~ e Zd ZdZdZdZdZdZdZe Z
d dd Z d
d Z d d
Z
dd Zdd Zdd Zd ddZdd Zdd Zdd ZdS ) XMLRPCa
A resource that implements XML-RPC.
You probably want to connect this to '/RPC2'.
Methods published can return XML-RPC serializable results, Faults,
Binary, Boolean, DateTime, Deferreds, or Handler instances.
By default methods beginning with 'xmlrpc_' are published.
Sub-handlers for prefixed methods (e.g., system.listMethods)
can be added with putSubHandler. By default, prefixes are
separated with a '.'. Override self.separator to change this.
@ivar allowNone: Permit XML translating of Python constant None.
@type allowNone: C{bool}
@ivar useDateTime: Present C{datetime} values as C{datetime.datetime}
objects?
@type useDateTime: C{bool}
r r .) POSTFc C s" t j| i | _|| _|| _d S r )r Resourcer# subHandlers allowNone useDateTime)r! r, r- r r r r# w s
zXMLRPC.__init__c C || j |< d S r )__dict__)r! namevaluer r r __setattr__} zXMLRPC.__setattr__c C r. r )r+ )r! prefixhandlerr r r
putSubHandler r3 zXMLRPC.putSubHandlerc C s | j |d S r )r+ get)r! r4 r r r
getSubHandler r3 zXMLRPC.getSubHandlerc C s t | j S r )listr+ keysr! r r r getSubHandlerPrefixes r3 z XMLRPC.getSubHandlerPrefixesc
C s. |j dd |dd ztj|j | jd\}}W n# ty? } zt| j d| }|
|| W Y d }~tjS d }~ww z| |}W n tya } z|
|| W Y d }~tjS d }~ww g }|
|j t|ddr}tj||g|R }n tj|g|R }|
| j || j
|| tjS )Nr s content-type text/xml; charset=utf-8 use_datetimezCan't deserialize input: r F)contentseek setHeader xmlrpclibloadsreadr- Exceptionr FAILURE _cbRenderlookupProcedure notifyFinish
addErrbackappendgetattrr
maybeDeferred _ebRender addCallbackr NOT_DONE_YET) r! requestr" functionPather functionresponseFaileddr r r render_POST s6
zXMLRPC.render_POSTNc
C s |rd S t |tr |j}t |ts|f}zLz tj|d| jd}W n$ tyD } zt| jd| }tj|d| jd}W Y d }~nd }~ww t |t rO|
d}| ddt |f |
| W n tyo | jd Y nw | d S )NT)methodresponse
allow_nonezCan't serialize output: utf8s content-length %d )
isinstancer r r rC dumpsr, rF rG strencoderB lenwrite_logr finish)r! r rR rV r@ rT r r r r rH s4
zXMLRPC._cbRenderc C s, t |jtr |jS | jd| t| jdS )Nr] r )r^ r1 r rd r rG )r! r r r r rO s zXMLRPC._ebRenderc C s | | jdkr'|| jd\}}| |}|du r"t| jd| ||S t| d| d}|s9t| jd| t|sEt| jd| |S )aN
Given a string naming a procedure, return a callable object for that
procedure or raise NoSuchFunction.
The returned object will be called, and should return the result of the
procedure, a Deferred, or a Fault instance.
Override in subclasses if you want your own policy. The base
implementation that given C{'foo'}, C{self.xmlrpc_foo} will be returned.
If C{procedurePath} contains C{self.separator}, the sub-handler for the
initial prefix is used to search for the remaining path.
If you override C{lookupProcedure}, you may also want to override
C{listProcedures} to accurately report the procedures supported by your
resource, so that clients using the I{system.listMethods} procedure
receive accurate results.
@since: 11.1
r' Nzno such subHandler %sz xmlrpc_%szprocedure %s not foundzprocedure %s not callable) find separatorsplitr8 r NOT_FOUNDrI rM callable)r!
procedurePathr4 r5 r r r r rI s
zXMLRPC.lookupProcedurec C s t | jdS )z\
Return a list of the names of all xmlrpc procedures.
@since: 11.1
xmlrpc_)r prefixedMethodNames __class__r; r r r listProcedures s zXMLRPC.listProcedures)FFr )r r r r rj rG isLeafrh allowedMethodsr
rd r# r2 r6 r8 r< rX rH rO rI rp r r r r r& V s$
'r& c @ sX e Zd ZdZdd Zdd Zdgge_dd Zd d gge_d
d Zdd gd d gge_d S )
XMLRPCIntrospectiona
Implement the XML-RPC Introspection API.
By default, the methodHelp method returns the 'help' method attribute,
if it exists, otherwise the __doc__ method attribute, if it exists,
otherwise the empty string.
To enable the methodSignature method, add a 'signature' method attribute
containing a list of lists. See methodSignature's documentation for the
format. Note the type strings should be XML-RPC types, not Python types.
c C s t | || _dS )z
Implement Introspection support for an XMLRPC server.
@param parent: the XMLRPC server to add Introspection support to.
@type parent: L{XMLRPC}
N)r& r# _xmlrpc_parent)r! parentr r r r# s
z XMLRPCIntrospection.__init__c sd g }| j dfg}|r0|d\ |fdd D | fdd D |s
|S )zO
Return a list of the method names implemented by this server.
r] r c s g | ]} | qS r r .0r0 )r4 r r
s z:XMLRPCIntrospection.xmlrpc_listMethods..c s$ g | ]} || j fqS r )r8 rh rv objr4 r r rx s )rt popextendrp r< )r! functionstodor ry r xmlrpc_listMethods s z&XMLRPCIntrospection.xmlrpc_listMethodsarrayc C s( | j |}t|ddpt|ddpdS )zW
Return a documentation string describing the use of the given method.
helpNr r] rt rI rM r! methodr r r xmlrpc_methodHelp! s z%XMLRPCIntrospection.xmlrpc_methodHelpstringc C s | j |}t|ddp
dS )a+
Return a list of type signatures.
Each type signature is a list of the form [rtype, type1, type2, ...]
where rtype is the return type and typeN is the type of the Nth
argument. If no signature information is available, the empty
string is returned.
signatureNr] r r r r r xmlrpc_methodSignature* s z*XMLRPCIntrospection.xmlrpc_methodSignatureN) r r r r r# r r r r r r r r rs s
rs c C s | dt| dS )z
Add Introspection support to an XMLRPC server.
@param xmlrpc: the XMLRPC server to add Introspection support to.
@type xmlrpc: L{XMLRPC}
systemN)r6 rs )xmlrpcr r r addIntrospection< s r c @ s, e Zd Zdd Zdd Zdd Zdd Zd S )
QueryProtocolc C s d | _ | d| jj | dd | d| jj | dd | jj}| ddt|f | jjrMd | jj| jj
g}d
d t |g}| d | |
| j| d S )
Nr) s
User-Agents Twisted/XMLRPClibs Hosts Content-typer= s Content-lengthr\ : s Basic s
Authorization) _response sendCommandfactorypath
sendHeaderhostpayloadrb userjoinpasswordbase64 b64encode
endHeaders transportrc )r! r auth
authHeaderr r r connectionMadeG s z QueryProtocol.connectionMadec C s |dkr
| j || d S d S )Ns 200)r badStatus)r! versionstatusmessager r r handleStatusW s zQueryProtocol.handleStatusc C s | j || _dS )z
Handle the XML-RPC response received from the server.
Specifically, disconnect from the server and store the XML-RPC
response so that it can be properly handled when the disconnect is
finished.
N)r loseConnectionr )r! contentsr r r handleResponse[ s
z QueryProtocol.handleResponsec C sX | tjtjs| jd| tj| | | j dur*| j d}| _ | j
| dS dS )z
The connection to the server has been lost.
If we have a full response from the server, then parse it and fired a
Deferred with the return value or C{Fault} that the server gave us.
N) checkr ConnectionDoneConnectionLostr clientConnectionLostr
HTTPClientconnectionLostr
parseResponse)r! reasonresponser r r r f s
z QueryProtocol.connectionLostN)r r r r r r r r r r r r F s
r zP
%s
%s
c @ sJ e Zd ZdZdZeZ d
ddZdd Zd d
Z e Z
d d Z dS ) QueryFactorya
XML-RPC Client Factory
@ivar path: The path portion of the URL to which to post method calls.
@type path: L{bytes}
@ivar host: The value to use for the Host HTTP header.
@type host: L{bytes}
@ivar user: The username with which to authenticate with the server
when making calls.
@type user: L{bytes} or L{None}
@ivar password: The password with which to authenticate with the server
when making calls.
@type password: L{bytes} or L{None}
@ivar useDateTime: Accept datetime values as datetime.datetime objects.
also passed to the underlying xmlrpclib implementation. Defaults to
C{False}.
@type useDateTime: C{bool}
NFr c
C sd ||| _ | _||| _| _t|tj||df | _t| jt r'| j
d| _t || _
| | _dS )a*
@param method: The name of the method to call.
@type method: C{str}
@param allowNone: allow the use of None values in parameters. It's
passed to the underlying xmlrpclib implementation. Defaults to
C{False}.
@type allowNone: C{bool} or L{None}
@param args: the arguments to pass to the method.
@type args: C{tuple}
@param canceller: A 1-argument callable passed to the deferred as the
canceller callback.
@type canceller: callable or L{None}
)rZ r[ N)r r r r payloadTemplaterC r_ r r^ r` ra r r deferredr- )
r! r r r r r r, r" cancellerr- r r r r# s
zQueryFactory.__init__c C st | j sd S ztj|| jdd d }W n ty+ | j d }| _ |t Y d S w | j d }| _ || d S )Nr> r ) r rC rD r-
BaseExceptionr$ r Failurecallback)r! r r r r r r r s zQueryFactory.parseResponsec C s* | j d ur| j d }| _ || d S d S r )r r$ )r! _r r r r r r s
z!QueryFactory.clientConnectionLostc C s" | j d }| _ |t|| d S r )r r$
ValueError)r! r r r r r r r s zQueryFactory.badStatus)NNFr NF) r r r r r r r r# r r clientConnectionFailedr r r r r r ~ s
' r c @ s2 e Zd ZdZeZ d ddZdd ZdS )
Proxya
A Proxy for making remote XML-RPC calls.
Pass the URL of the remote XML-RPC server to the constructor.
Use C{proxy.callRemote('foobar', *args)} to call remote method
'foobar' with *args.
@ivar user: The username with which to authenticate with the server
when making calls. If specified, overrides any username information
embedded in C{url}. If not specified, a value may be taken from
C{url} if present.
@type user: L{bytes} or L{None}
@ivar password: The password with which to authenticate with the server
when making calls. If specified, overrides any password information
embedded in C{url}. If not specified, a value may be taken from
C{url} if present.
@type password: L{bytes} or L{None}
@ivar allowNone: allow the use of None values in parameters. It's
passed to the underlying L{xmlrpclib} implementation. Defaults to
C{False}.
@type allowNone: C{bool} or L{None}
@ivar useDateTime: Accept datetime values as datetime.datetime objects.
also passed to the underlying L{xmlrpclib} implementation. Defaults to
C{False}.
@type useDateTime: C{bool}
@ivar connectTimeout: Number of seconds to wait before assuming the
connection has failed.
@type connectTimeout: C{float}
@ivar _reactor: The reactor used to create connections.
@type _reactor: Object providing L{twisted.internet.interfaces.IReactorTCP}
@ivar queryFactory: Object returning a factory for XML-RPC protocol. Use
this for testing, or to manipulate the XML-RPC parsing behavior. For
example, you may set this to a custom "debugging" factory object that
reimplements C{parseResponse} in order to log the raw XML-RPC contents
from the server before continuing on with parsing. Another possibility
is to implement your own XML-RPC marshaller here to handle non-standard
XML-RPC traffic.
@type queryFactory: L{twisted.web.xmlrpc.QueryFactory}
NF >@c C s0 |du r
ddl m} t|\}} }
} } }
| d}t|dkrB|dd}|d| _z|d| _W n tyA d| _Y nw d | _| _|d d}|d| _ z
t
|d| _ W n tyk d| _ Y nw |
| _ | j dv rwd| _ |d k| _
|dur|| _|dur|| _|| _|| _|| _|| _dS )
aX
@param url: The URL to which to post method calls. Calls will be made
over SSL if the scheme is HTTPS. If netloc contains username or
password information, these will be used to authenticate, as long as
the C{user} and C{password} arguments are not specified.
@type url: L{bytes}
Nr )reactor @ r )r N /s https)twisted.internetr r ri rb r{ r r r r intportr securer, r- connectTimeout_reactor)r! urlr r r, r- r r schemenetlocr paramsqueryfragment netlocPartsuserpasshostportr r r r#
s@
zProxy.__init__c s fdd}| | j| j|| j| j| j||| j | jrAddlm } |j
t | jd}| j j
t | j| jp7d|| jd jS | j jt | j| jpLd| jd jS ) a
Call remote XML-RPC C{method} with given arguments.
@return: a L{defer.Deferred} that will fire with the method response,
or a failure if the method failed. Generally, the failure type will
be L{Fault}, but you can also have an C{IndexError} on some buggy
servers giving empty responses.
If the deferred is cancelled before the request completes, the
connection is closed and the deferred will fire with a
L{defer.CancelledError}.
c s d _ d S r )r
disconnect)rW connectorr r r cancelK s z Proxy.callRemote..cancelr )ssl)hostnamei )timeoutP ) queryFactoryr r r r r, r- r r r optionsForClientTLSr
r
connectSSLr r
connectTCPr )r! r r" r r contextFactoryr r r
callRemote= s< zProxy.callRemote)NNFFr N)r r r r r r r# r r r r r r s /
3r )r& r r r r r r r )*r r
xmlrpc.clientclientrC urllib.parser r r r r r r r r twisted.loggerr
twisted.pythonr r twisted.python.compatr
twisted.webr r r rj rG r r r r* r& rs r r r r
ClientFactoryr r __all__r r r r s2 "E
0Z