Code

Changes between Version 19 and Version 20 of XML-RPC


Ignore:
Timestamp:
06/19/07 02:54:42 (7 years ago)
Author:
Bob
Comment:

discount%2Bdance%2Bshoes%2B%2B%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddance%252Dshoes.html%2B%255Ddiscount%2Bdance%2Bshoes%255B%252FURL%255D%2B%2B%2B%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddance%252Dshoes.html%2B%253Ediscount%2Bdance%2Bshoes%253C%252Fa%253E%2B%2B%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddance%252Dshoes.html%2Bdiscount%2Bdance%2Bshoes%2B%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Findex.html%2B%253Ediscount%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fwomens%252Ddiscount%252Dshoes.html%2B%255Dwomens%2Bdiscount%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dgolf%252Dshoes.html%2B%253Ediscount%2Bgolf%2Bshoes%253C%252Fa%253E%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fwomens%252Ddiscount%252Dshoes.html%2B%253Ewomens%2Bdiscount%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dbridal%252Dshoes.html%2B%255Ddiscount%2Bbridal%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dpuma%252Dshoes.html%2B%253Ediscount%2Bpuma%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Findex.html%2B%255Ddiscount%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddesigner%252Dshoes.html%2B%253Ediscount%2Bdesigner%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddesigner%252Dshoes.html%2B%255Ddiscount%2Bdesigner%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Drunning%252Dshoes.html%2B%253Ediscount%2Brunning%2Bshoes%253C%252Fa%253E%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dbridal%252Dshoes.html%2B%253Ediscount%2Bbridal%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dshoes%252Dwarehouse.html%2B%255Ddiscount%2Bshoes%2Bwarehouse%255B%252FURL%255D%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fcover%252Ddiscount%252Dshoes.html%2B%255Dcover%2Bdiscount%2Bshoes%255B%252FURL%255D%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddance%252Dshoes.html%2B%255Ddiscount%2Bdance%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fcover%252Ddiscount%252Dshoes.html%2B%253Ecover%2Bdiscount%2Bshoes%253C%252Fa%253E%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Ddance%252Dshoes.html%2B%253Ediscount%2Bdance%2Bshoes%253C%252Fa%253E%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dpuma%252Dshoes.html%2B%255Ddiscount%2Bpuma%2Bshoes%255B%252FURL%255D%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dgolf%252Dshoes.html%2B%255Ddiscount%2Bgolf%2Bshoes%255B%252FURL%255D%250D%250A%255BURL%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Drunning%252Dshoes.html%2B%255Ddiscount%2Brunning%2Bshoes%255B%252FURL%255D%250D%250A%253Ca%2Bhref%253D%2Bhttp%253A%252F%252Fgeocities.com%252Fshoeshere%252Fdiscount%252Dshoes%252Fdiscount%252Dshoes%252Dwarehouse.html%2B%253Ediscount%2Bshoes%2Bwarehouse%253C%252Fa%253E%250D%250A

Legend:

Unmodified
Added
Removed
Modified
  • XML-RPC

    v19 v20  
    1 = XML-RPC = 
    2  
    3 NOTE: All credit for this code goes to Crast in irc.freenode.net:#django... 
    4  
    5 This uses SimpleXMLRPCDispatcher which is part of the standard Python lib in 2.4 (And possibly earlier versions). 
    6  
    7  
    8 In discussing ways of handling XML-RPC for Django, I realised I really needed a way to do it without patching Django's code.  Crast in #django came up with a great solution, which I have modified and tweaked a bit. 
    9  
    10 I've included it here.  Feel free to fiddle with it and make it your own ... All this code is '''post-mr''' 
    11  
    12 Any crappy & garbage code is completely mine; I'm still learning Python so bear with me.  The hacks I added for self-documentation output are just that; any improvements to them would probably be a good thing. 
    13  
    14 First, setup your urls.py to map an XML-RPC service: 
    15  
    16  
    17 {{{ 
    18 #!python 
    19 urlpatterns = patterns('', 
    20     # XML-RPC 
    21      (r'^xml_rpc_srv/', 'yourproject.yourapp.xmlrpc.rpc_handler'), 
    22 ) 
    23 }}} 
    24  
    25  
    26 Then, in the appropriate place, create a file called xmlrpc.py 
    27  
    28  
    29 {{{ 
    30 #!python 
    31 # Patchless XMLRPC Service for Django 
    32 # Kind of hacky, and stolen from Crast on irc.freenode.net:#django 
    33 # Self documents as well, so if you call it from outside of an XML-RPC Client 
    34 # it tells you about itself and its methods 
    35 # 
    36 # Brendan W. McAdams <brendan.mcadams@thewintergrp.com> 
    37  
    38 # SimpleXMLRPCDispatcher lets us register xml-rpc calls w/o 
    39 # running a full XMLRPC Server.  It's up to us to dispatch data 
    40  
    41 from SimpleXMLRPCServer import SimpleXMLRPCDispatcher 
    42 from django.http import HttpResponse 
    43  
    44 # Create a Dispatcher; this handles the calls and translates info to function maps 
    45 #dispatcher = SimpleXMLRPCDispatcher() # Python 2.4 
    46 dispatcher = SimpleXMLRPCDispatcher(allow_none=False, encoding=None) # Python 2.5 
    47  
    48   
    49  
    50 def rpc_handler(request): 
    51         """ 
    52         the actual handler: 
    53         if you setup your urls.py properly, all calls to the xml-rpc service 
    54         should be routed through here. 
    55         If post data is defined, it assumes it's XML-RPC and tries to process as such 
    56         Empty post assumes you're viewing from a browser and tells you about the service. 
    57         """ 
    58  
    59         response = HttpResponse() 
    60         if len(request.POST): 
    61                 response.write(dispatcher._marshaled_dispatch(request.raw_post_data)) 
    62         else: 
    63                 response.write("<b>This is an XML-RPC Service.</b><br>") 
    64                 response.write("You need to invoke it using an XML-RPC Client!<br>") 
    65                 response.write("The following methods are available:<ul>") 
    66                 methods = dispatcher.system_listMethods() 
    67  
    68                 for method in methods: 
    69                         # right now, my version of SimpleXMLRPCDispatcher always 
    70                         # returns "signatures not supported"... :( 
    71                         # but, in an ideal world it will tell users what args are expected 
    72                         sig = dispatcher.system_methodSignature(method) 
    73  
    74                         # this just reads your docblock, so fill it in! 
    75                         help =  dispatcher.system_methodHelp(method) 
    76  
    77                         response.write("<li><b>%s</b>: [%s] %s" % (method, sig, help)) 
    78  
    79                 response.write("</ul>") 
    80                 response.write('<a href="http://www.djangoproject.com/"> <img src="http://media.djangoproject.com/img/badges/djangomade124x25_grey.gif" border="0" alt="Made with Django." title="Made with Django."></a>') 
    81  
    82         response['Content-length'] = str(len(response.content)) 
    83         return response 
    84  
    85 def multiply(a, b): 
    86         """ 
    87         Multiplication is fun! 
    88         Takes two arguments, which are multiplied together. 
    89         Returns the result of the multiplication! 
    90         """ 
    91         return a*b 
    92  
    93 # you have to manually register all functions that are xml-rpc-able with the dispatcher 
    94 # the dispatcher then maps the args down. 
    95 # The first argument is the actual method, the second is what to call it from the XML-RPC side... 
    96 dispatcher.register_function(multiply, 'multiply') 
    97 }}} 
    98  
    99 That's it! 
    100  
    101 You can pretty much write a standard python function in there, just be sure to register it with the dispatcher when you're done.   
    102  
    103 Here's a quick and dirty client example for testing: 
    104  
    105 {{{ 
    106 #!python 
    107 import sys 
    108 import xmlrpclib 
    109 rpc_srv = xmlrpclib.ServerProxy("http://localhost:8000/xml_rpc_srv/") 
    110 result = rpc_srv.multiply( int(sys.argv[1]), int(sys.argv[2])) 
    111 print "%d * %d = %d" % (sys.argv[1], sys.argv[2], result) 
    112 }}} 
    113  
    114 Based on experience, I do recommend that you use Dictionaries for your args rather than long args, but I think that's personal preference (It allows named arguments, eliminates 'out of order' argument issues and it makes the code more self-documenting). 
    115  
    116 Have fun! 
    117  
    118 - [mailto:brendan.mcadams@NOSPAM.thewintergrp.com  Brendan W. McAdams <brendan.mcadams@NOSPAM.thewintergrp.com>] 
    119  
    120 ---- 
    121  
    122 I wrote up [http://www.personal-api.com/train/2007/feb/01/pingbacks-xml-rpc-and-django/ a modified version of the XML-RPC view] that uses a template for documentation. -- [mailto:hackerblinks+django@gmail.com Adam Blinkinsop <hackerblinks+django@gmail.com>] 
    123  
    124 ---- 
    125  
    126 I've taken the basics of the SimpleXMLRPCDispatcher above and have turned it into a distributable Django app, [http://code.google.com/p/django-xmlrpc django_xmlrpc]. -- [mailto:graham.binns+django-xmlrpc@gmail.com Graham Binns] 
     1discount%252Bdance%252Bshoes%252B%252B%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddance%25252Dshoes.html%252B%25255Ddiscount%252Bdance%252Bshoes%25255B%25252FURL%25255D%252B%252B%252B%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddance%25252Dshoes.html%252B%25253Ediscount%252Bdance%252Bshoes%25253C%25252Fa%25253E%252B%252B%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddance%25252Dshoes.html%252Bdiscount%252Bdance%252Bshoes%252B%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Findex.html%252B%25253Ediscount%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fwomens%25252Ddiscount%25252Dshoes.html%252B%25255Dwomens%252Bdiscount%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dgolf%25252Dshoes.html%252B%25253Ediscount%252Bgolf%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fwomens%25252Ddiscount%25252Dshoes.html%252B%25253Ewomens%252Bdiscount%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dbridal%25252Dshoes.html%252B%25255Ddiscount%252Bbridal%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dpuma%25252Dshoes.html%252B%25253Ediscount%252Bpuma%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Findex.html%252B%25255Ddiscount%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddesigner%25252Dshoes.html%252B%25253Ediscount%252Bdesigner%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddesigner%25252Dshoes.html%252B%25255Ddiscount%252Bdesigner%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Drunning%25252Dshoes.html%252B%25253Ediscount%252Brunning%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dbridal%25252Dshoes.html%252B%25253Ediscount%252Bbridal%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dshoes%25252Dwarehouse.html%252B%25255Ddiscount%252Bshoes%252Bwarehouse%25255B%25252FURL%25255D%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fcover%25252Ddiscount%25252Dshoes.html%252B%25255Dcover%252Bdiscount%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddance%25252Dshoes.html%252B%25255Ddiscount%252Bdance%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fcover%25252Ddiscount%25252Dshoes.html%252B%25253Ecover%252Bdiscount%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Ddance%25252Dshoes.html%252B%25253Ediscount%252Bdance%252Bshoes%25253C%25252Fa%25253E%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dpuma%25252Dshoes.html%252B%25255Ddiscount%252Bpuma%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dgolf%25252Dshoes.html%252B%25255Ddiscount%252Bgolf%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Drunning%25252Dshoes.html%252B%25255Ddiscount%252Brunning%252Bshoes%25255B%25252FURL%25255D%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fgeocities.com%25252Fshoeshere%25252Fdiscount%25252Dshoes%25252Fdiscount%25252Dshoes%25252Dwarehouse.html%252B%25253Ediscount%252Bshoes%252Bwarehouse%25253C%25252Fa%25253E%25250D%25250A