f c @ s d Z d d l m Z m Z m Z m Z m Z d d l m Z d d l Z d d l
Z
d d l Z d d l Z d d l
Z
d d l Z d d l Z d d l Z y d d l Z Wn e k
r e Z Yn Xe d d Z d d Z Gd d
d
Z Gd d d e Z Gd
d d e
j e Z Gd d d e Z Gd d d e Z Gd d d e j Z Gd d d Z Gd d d e Z Gd d d e e Z! Gd d d e e Z" e# d k rd d l$ Z$ Gd d d Z% e d d! f Z& e& j' e( e& j' d" d# d$ e& j) e% d% e e& j* e+ d& e+ d' y e& j, Wn3 e- k
re+ d( e& j. e j/ d Yn Xn d S() u XML-RPC Servers.
This module can be used to create simple XML-RPC servers
by creating a server and either installing functions, a
class instance, or by extending the SimpleXMLRPCServer
class.
It can also be used to handle XML-RPC requests in a CGI
environment using CGIXMLRPCRequestHandler.
The Doc* classes can be used to create XML-RPC servers that
serve pydoc-style documentation in response to HTTP
GET requests. This documentation is dynamically generated
based on the functions and methods registered with the
server.
A list of possible usage patterns follows:
1. Install functions:
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_function(pow)
server.register_function(lambda x,y: x+y, 'add')
server.serve_forever()
2. Install an instance:
class MyFuncs:
def __init__(self):
# make all of the sys functions available through sys.func_name
import sys
self.sys = sys
def _listMethods(self):
# implement this method so that system.listMethods
# knows to advertise the sys methods
return list_public_methods(self) + \
['sys.' + method for method in list_public_methods(self.sys)]
def pow(self, x, y): return pow(x, y)
def add(self, x, y) : return x + y
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_introspection_functions()
server.register_instance(MyFuncs())
server.serve_forever()
3. Install an instance with custom dispatch method:
class Math:
def _listMethods(self):
# this method must be present for system.listMethods
# to work
return ['add', 'pow']
def _methodHelp(self, method):
# this method must be present for system.methodHelp
# to work
if method == 'add':
return "add(2,3) => 5"
elif method == 'pow':
return "pow(x, y[, z]) => number"
else:
# By convention, return empty
# string if no help is available
return ""
def _dispatch(self, method, params):
if method == 'pow':
return pow(*params)
elif method == 'add':
return params[0] + params[1]
else:
raise ValueError('bad method')
server = SimpleXMLRPCServer(("localhost", 8000))
server.register_introspection_functions()
server.register_instance(Math())
server.serve_forever()
4. Subclass SimpleXMLRPCServer:
class MathServer(SimpleXMLRPCServer):
def _dispatch(self, method, params):
try:
# We are forcing the 'export_' prefix on methods that are
# callable through XML-RPC to prevent potential security
# problems
func = getattr(self, 'export_' + method)
except AttributeError:
raise Exception('method "%s" is not supported' % method)
else:
return func(*params)
def export_add(self, x, y):
return x + y
server = MathServer(("localhost", 8000))
server.serve_forever()
5. CGI script:
server = CGIXMLRPCRequestHandler()
server.register_function(pow)
server.handle_request()
i ( u Faultu dumpsu loadsu gzip_encodeu gzip_decode( u BaseHTTPRequestHandlerNc C sg | r | j d } n | g } x? | D]7 } | j d rP t d | q( t | | } q( W| S( uG resolve_dotted_attribute(a, 'b.c.d') => a.b.c.d
Resolves a dotted attribute name to an object. Raises
an AttributeError if any attribute in the chain starts with a '_'.
If the optional allow_dotted_names argument is false, dots are not
supported and this function operates similar to getattr(obj, attr).
u .u _u( attempt to access private attribute "%s"( u splitu
startswithu AttributeErroru getattr( u obju attru allow_dotted_namesu attrsu i( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu resolve_dotted_attributez s
u resolve_dotted_attributec s f d d t D S( uk Returns a list of attribute strings, found in the specified
object, which represent callable attributesc s; g | ]1 } | j d r t t | r | q S( u _( u
startswithu callableu getattr( u .0u member( u obj( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu
s u' list_public_methods..( u dir( u obj( ( u obju2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu list_public_methods s u list_public_methodsc B s | Ee Z d Z d Z d d d d d Z d d d Z d d d Z d d Z d
d Z
d d d d
Z d d Z d d Z
d d Z d d Z d d Z d S( u SimpleXMLRPCDispatcheru& Mix-in class that dispatches XML-RPC requests.
This class is used to register XML-RPC method handlers
and then to dispatch them. This class doesn't need to be
instanced directly when used by SimpleXMLRPCServer but it
can be instanced when used by the MultiPathXMLRPCServer
c C s7 i | _ d | _ | | _ | p$ d | _ | | _ d S( Nu utf-8( u funcsu Noneu instanceu
allow_noneu encodingu use_builtin_types( u selfu
allow_noneu encodingu use_builtin_types( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu __init__ s
u SimpleXMLRPCDispatcher.__init__c C s | | _ | | _ d S( u Registers an instance to respond to XML-RPC requests.
Only one instance can be installed at a time.
If the registered instance has a _dispatch method then that
method will be called with the name of the XML-RPC method and
its parameters as a tuple
e.g. instance._dispatch('add',(2,3))
If the registered instance does not have a _dispatch method
then the instance will be searched to find a matching method
and, if found, will be called. Methods beginning with an '_'
are considered private and will not be called by
SimpleXMLRPCServer.
If a registered function matches a XML-RPC request, then it
will be called instead of the registered instance.
If the optional allow_dotted_names argument is true and the
instance does not have a _dispatch method, method names
containing dots are supported and resolved, as long as none of
the name segments start with an '_'.
*** SECURITY WARNING: ***
Enabling the allow_dotted_names options allows intruders
to access your module's global variables and may allow
intruders to execute arbitrary code on your machine. Only
use this option on a secure, closed network.
N( u instanceu allow_dotted_names( u selfu instanceu allow_dotted_names( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu register_instance s ! u( SimpleXMLRPCDispatcher.register_instancec C s) | d k r | j } n | | j | ['add', 'subtract', 'multiple']
Returns a list of the methods supported by the server.u _listMethodsu _dispatchN( u setu funcsu keysu instanceu Noneu hasattru _listMethodsu list_public_methodsu sorted( u selfu methods( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu system_listMethods s u) SimpleXMLRPCDispatcher.system_listMethodsc C s d S( u# system.methodSignature('add') => [double, int, int]
Returns a list describing the signature of the method. In the
above example, the add method takes two integers as arguments
and returns a double result.
This server does NOT support system.methodSignature.u signatures not supported( ( u selfu method_name( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu system_methodSignature$ s u- SimpleXMLRPCDispatcher.system_methodSignaturec C s d } | | j k r% | j | } nz | j d k r t | j d rV | j j | St | j d s y t | j | | j } Wq t k
r Yq Xq n | d k r d St j | Sd S( u system.methodHelp('add') => "Adds two integers together"
Returns a string containing documentation for the specified method.u _methodHelpu _dispatchu N(
u Noneu funcsu instanceu hasattru _methodHelpu resolve_dotted_attributeu allow_dotted_namesu AttributeErroru pydocu getdoc( u selfu method_nameu method( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu system_methodHelp1 s"
u( SimpleXMLRPCDispatcher.system_methodHelpc
C s g } x | D] } | d } | d } y | j | j | | g Wq
t k
r } z& | j i | j d 6| j d 6 WYd d } ~ Xq
t j \ } } } | j i d d 6d | | f d 6 Yq
Xq
W| S( u system.multicall([{'methodName': 'add', 'params': [2, 2]}, ...]) => [[4], ...]
Allows the caller to package multiple XML-RPC calls into a single
request.
See http://www.xmlrpc.com/discuss/msgReader$1208
u
methodNameu paramsu faultCodeu faultStringNi u %s:%s( u appendu _dispatchu Faultu faultCodeu faultStringu sysu exc_info(
u selfu call_listu resultsu callu method_nameu paramsu faultu exc_typeu exc_valueu exc_tb( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu system_multicallP s
u' SimpleXMLRPCDispatcher.system_multicallc C s d } y | j | } Wnz t k
r | j d k r t | j d r[ | j j | | Sy t | j | | j } Wq t k
r Yq Xn Yn X| d k r | | St d | d S( u Dispatches the XML-RPC method.
XML-RPC calls are forwarded to a registered function that
matches the called XML-RPC method name. If no such function
exists then the call is forwarded to the registered instance,
if available.
If the registered instance has a _dispatch method then that
method will be called with the name of the XML-RPC method and
its parameters as a tuple
e.g. instance._dispatch('add',(2,3))
If the registered instance does not have a _dispatch method
then the instance will be searched to find a matching method
and, if found, will be called.
Methods beginning with an '_' are considered private and will
not be called.
u _dispatchu method "%s" is not supportedN(
u Noneu funcsu KeyErroru instanceu hasattru _dispatchu resolve_dotted_attributeu allow_dotted_namesu AttributeErroru Exception( u selfu methodu paramsu func( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu _dispatchp s"
u SimpleXMLRPCDispatcher._dispatchNF( u __name__u
__module__u __qualname__u __doc__u Falseu Noneu __init__u register_instanceu register_functionu register_introspection_functionsu register_multicall_functionsu _marshaled_dispatchu system_listMethodsu system_methodSignatureu system_methodHelpu system_multicallu _dispatch( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu SimpleXMLRPCDispatcher s $ %
u SimpleXMLRPCDispatcherc B s | Ee Z d Z d Z d Z d Z d Z d Z e j
d e j e j B Z
d d Z d d
Z d d Z d
d Z d d Z d d d d Z d S( u SimpleXMLRPCRequestHandleru Simple XML-RPC request handler class.
Handles all HTTP POST requests and attempts to decode them as
XML-RPC requests.
u /u /RPC2ix i u
\s* ([^\s;]+) \s* #content-coding
(;\s* q \s*=\s* ([0-9\.]+))? #q
c C s i } | j j d d } xl | j d D][ } | j j | } | r+ | j d } | rj t | n d } | | | j d %su' http://www.rfc-editor.org/rfc/rfc%d.txtu( http://www.python.org/dev/peps/pep-%04d/i u (u self.%sNu ( u escapeu reu compileu searchu spanu appendu groupsu replaceu intu namelinku join( u selfu textu escapeu funcsu classesu methodsu resultsu hereu patternu matchu startu endu allu schemeu rfcu pepu selfdotu nameu url( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu markup s8 " u ServerHTMLDoc.markupc C s | r | j p d d | } d } d | j | | j | f }
t j | r t j | } t j | j d d | j | j | j d | j
d | j } n] t j | r t j | } t j | j | j | j | j d | j
d | j } n d } t
| t r5| d p | } | d p/d }
n t j | }
|
| | oa| j d
| } | j |
| j | | | } | od | } d | | f S(
u; Produce HTML documentation for a function or method object.u u -u$ %si Nu annotationsu formatvalueu (...)i u' %su %su - %s
%s
( u __name__u escapeu inspectu ismethodu getfullargspecu
formatargspecu argsu varargsu varkwu defaultsu annotationsu formatvalueu
isfunctionu
isinstanceu tupleu pydocu getdocu greyu markupu preformat( u selfu objectu nameu modu funcsu classesu methodsu clu anchoru noteu titleu argsu argspecu docstringu declu doc( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu
docroutine s< u ServerHTMLDoc.docroutinec C s i } x6 | j D]( \ } } d | | | <| | | | %su #ffffffu #7799eeu %su
%s
u funcsu Methodsu #eeaa77u (
u itemsu escapeu headingu markupu preformatu sortedu appendu
docroutineu
bigsectionu join( u selfu server_nameu package_documentationu methodsu fdictu keyu valueu headu resultu docu contentsu method_items( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu docserver s"
# u ServerHTMLDoc.docserverN( u __name__u
__module__u __qualname__u __doc__u Noneu markupu
docroutineu docserver( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu
ServerHTMLDoc s
),u
ServerHTMLDocc B sV | Ee Z d Z d Z d d Z d d Z d d Z d d Z d
d Z d S(
u XMLRPCDocGeneratoru Generates documentation for an XML-RPC server.
This class is designed as mix-in and should not
be constructed directly.
c C s d | _ d | _ d | _ d S( Nu XML-RPC Server DocumentationuG This server exports the following methods through the XML-RPC protocol.( u server_nameu server_documentationu server_title( u self( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu __init__9 s u XMLRPCDocGenerator.__init__c C s
| | _ d S( u8 Set the HTML title of the generated server documentationN( u server_title( u selfu server_title( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu set_server_titleA s u# XMLRPCDocGenerator.set_server_titlec C s
| | _ d S( u7 Set the name of the generated HTML server documentationN( u server_name( u selfu server_name( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu set_server_nameF s u" XMLRPCDocGenerator.set_server_namec C s
| | _ d S( u3 Set the documentation string for the entire server.N( u server_documentation( u selfu server_documentation( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu set_server_documentationK s u+ XMLRPCDocGenerator.set_server_documentationc C s^ i } x | j D]} | | j k r8 | j | } n | j d k rd d g } t | j d r~ | j j | | d html documentation for the server
Generates HTML documentation for the server using introspection for
installed functions and instances that do not implement the
_dispatch method. Alternatively, instances can choose to implement
the _get_method_argstring(method_name) method to provide the
argument string used in the documentation and the
_methodHelp(method_name) method to provide the help text used
in the documentation.u _get_method_argstringi u _methodHelpi u _dispatchN( NN( u system_listMethodsu funcsu instanceu Noneu hasattru _get_method_argstringu _methodHelpu tupleu resolve_dotted_attributeu AttributeErroru
ServerHTMLDocu docserveru server_nameu server_documentationu pageu server_title( u selfu methodsu method_nameu methodu method_infou
documenteru
documentation( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu generate_html_documentationP s8
u. XMLRPCDocGenerator.generate_html_documentationN( u __name__u
__module__u __qualname__u __doc__u __init__u set_server_titleu set_server_nameu set_server_documentationu generate_html_documentation( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu XMLRPCDocGenerator2 s u XMLRPCDocGeneratorc B s& | Ee Z d Z d Z d d Z d S( u DocXMLRPCRequestHandleru XML-RPC and documentation request handler class.
Handles all HTTP POST requests and attempts to decode them as
XML-RPC requests.
Handles all HTTP GET requests and interprets them as requests
for documentation.
c C s | j s | j d S| j j j d } | j d | j d d | j d t t | | j | j
j | d S( u} Handles the HTTP GET request.
Interpret all HTTP GET requests as requests for server
documentation.
Nu utf-8i u Content-typeu text/htmlu Content-length( u is_rpc_path_validu
report_404u serveru generate_html_documentationu encodeu
send_responseu send_headeru stru lenu end_headersu wfileu write( u selfu response( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu do_GET s
u DocXMLRPCRequestHandler.do_GETN( u __name__u
__module__u __qualname__u __doc__u do_GET( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu DocXMLRPCRequestHandler s u DocXMLRPCRequestHandlerc B s8 | Ee Z d Z d Z e d d d d d d d Z d S( u DocXMLRPCServeru XML-RPC and HTML documentation server.
Adds the ability to serve server documentation to the capabilities
of SimpleXMLRPCServer.
c C s3 t j | | | | | | | | t j | d S( N( u SimpleXMLRPCServeru __init__u XMLRPCDocGenerator( u selfu addru requestHandleru logRequestsu
allow_noneu encodingu bind_and_activateu use_builtin_types( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu __init__ s u DocXMLRPCServer.__init__NTF( u __name__u
__module__u __qualname__u __doc__u DocXMLRPCRequestHandleru Trueu Falseu Noneu __init__( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu DocXMLRPCServer s u DocXMLRPCServerc B s2 | Ee Z d Z d Z d d Z d d Z d S( u DocCGIXMLRPCRequestHandleruJ Handler for XML-RPC data and documentation requests passed through
CGIc C sn | j j d } t d t d t | t t j j t j j j | t j j j d S( u} Handles the HTTP GET request.
Interpret all HTTP GET requests as requests for server
documentation.
u utf-8u Content-Type: text/htmlu Content-Length: %dN( u generate_html_documentationu encodeu printu lenu sysu stdoutu flushu bufferu write( u selfu response( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu
handle_get s
u% DocCGIXMLRPCRequestHandler.handle_getc C s t j | t j | d S( N( u CGIXMLRPCRequestHandleru __init__u XMLRPCDocGenerator( u self( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu __init__ s
u# DocCGIXMLRPCRequestHandler.__init__N( u __name__u
__module__u __qualname__u __doc__u
handle_getu __init__( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu DocCGIXMLRPCRequestHandler s u DocCGIXMLRPCRequestHandleru __main__c B s3 | Ee Z d Z d d Z Gd d d Z d S( u ExampleServicec C s d S( Nu 42( ( u self( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu getData s u ExampleService.getDatac B s& | Ee Z d Z e d d Z d S( u ExampleService.currentTimec C s
t j j S( N( u datetimeu now( ( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu getCurrentTime s u) ExampleService.currentTime.getCurrentTimeN( u __name__u
__module__u __qualname__u staticmethodu getCurrentTime( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu currentTime s u currentTimeN( u __name__u
__module__u __qualname__u getDatau currentTime( u
__locals__( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu ExampleService s u ExampleServiceu localhosti@ c C s | | S( N( ( u xu y( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu s u u addu allow_dotted_namesu& Serving XML-RPC on localhost port 8000uK It is advisable to run this example server within a secure, closed network.u&
Keyboard interrupt received, exiting.(0 u __doc__u
xmlrpc.clientu Faultu dumpsu loadsu gzip_encodeu gzip_decodeu http.serveru BaseHTTPRequestHandleru httpu socketserveru sysu osu reu pydocu inspectu tracebacku fcntlu ImportErroru Noneu Trueu resolve_dotted_attributeu list_public_methodsu SimpleXMLRPCDispatcheru SimpleXMLRPCRequestHandleru TCPServeru SimpleXMLRPCServeru MultiPathXMLRPCServeru CGIXMLRPCRequestHandleru HTMLDocu
ServerHTMLDocu XMLRPCDocGeneratoru DocXMLRPCRequestHandleru DocXMLRPCServeru DocCGIXMLRPCRequestHandleru __name__u datetimeu ExampleServiceu serveru register_functionu powu register_instanceu register_multicall_functionsu printu
serve_foreveru KeyboardInterruptu server_closeu exit( ( ( u2 /opt/alt/python33/lib64/python3.3/xmlrpc/server.pyu f s\ (
"(ErQ