Code

Changes between Version 31 and Version 32 of XML-RPC


Ignore:
Timestamp:
07/18/07 14:25:58 (7 years ago)
Author:
anonymous
Comment:

spam revert

Legend:

Unmodified
Added
Removed
Modified
  • XML-RPC

    v31 v32  
    1 adobe%252Bphotoshop%252B9%252B%252B%25255BURL%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252D9.html%252B%25255Dadobe%252Bphotoshop%252B9%25255B%25252FURL%25255D%252B%252B%252B%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252D9.html%252B%25253Eadobe%252Bphotoshop%252B9%25253C%25252Fa%25253E%252B%252B%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252D9.html%252Badobe%252Bphotoshop%252B9%252B%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Ddownload.html%252B%25253Eadobe%252Bphotoshop%252Bdownload%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dcs2.html%252B%25253Eadobe%252Bphotoshop%252Bcs2%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252D90.html%252B%25253Eadobe%252Bphotoshop%252B9.0%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fdownload%25252Dadobe%25252Dphotoshop%25252D9.html%252B%25253Edownload%252Badobe%252Bphotoshop%252B9%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fdownload%25252Dadobe%25252Dphotoshop%25252Dcs2.html%252B%25253Edownload%252Badobe%252Bphotoshop%252Bcs2%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fdownload%25252Dphotoshop%25252D9.html%252B%25253Edownload%252Bphotoshop%252B9%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dcs2%25252Ddownload.html%252B%25253Eadobe%252Bphotoshop%252Bcs2%252Bdownload%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dcs%25252D2.html%252B%25253Eadobe%252Bphotoshop%252Bcs%252B2%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dcs.html%252B%25253Eadobe%252Bphotoshop%252Bcs%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dbook.html%252B%25253Eadobe%252Bphotoshop%252Bbook%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dmac.html%252B%25253Eadobe%252Bphotoshop%252Bmac%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Findex.html%252B%25253Eadobe%252Bphotoshop%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252D9.html%252B%25253Eadobe%252Bphotoshop%252B9%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fadobe%25252Dphotoshop%25252Dcs%25252Ddownload.html%252B%25253Eadobe%252Bphotoshop%252Bcs%252Bdownload%25253C%25252Fa%25253E%25250D%25250A%25253Ca%252Bhref%25253D%252Bhttp%25253A%25252F%25252Fphotoshop.soft4downloads.info%25252Fdownload%25252Dphotoshop%25252Dcs2.html%252B%25253Edownload%252Bphotoshop%252Bcs2%25253C%25252Fa%25253E%25250D%25250Ad 
     1= XML-RPC = 
     2 
     3 
     4NOTE: All credit for this code goes to Crast in irc.freenode.net:#django... 
     5 
     6This uses SimpleXMLRPCDispatcher which is part of the standard Python lib in 2.4 (And possibly earlier versions). 
     7 
     8 
     9In 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. 
     10 
     11I've included it here.  Feel free to fiddle with it and make it your own ... All this code is '''post-mr''' 
     12 
     13Any 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. 
     14 
     15First, setup your urls.py to map an XML-RPC service: 
     16 
     17 
     18{{{ 
     19#!python 
     20urlpatterns = patterns('', 
     21    # XML-RPC 
     22     (r'^xml_rpc_srv/', 'yourproject.yourapp.xmlrpc.rpc_handler'), 
     23) 
     24}}} 
     25 
     26 
     27Then, in the appropriate place, create a file called xmlrpc.py 
     28 
     29 
     30{{{ 
     31#!python 
     32# Patchless XMLRPC Service for Django 
     33# Kind of hacky, and stolen from Crast on irc.freenode.net:#django 
     34# Self documents as well, so if you call it from outside of an XML-RPC Client 
     35# it tells you about itself and its methods 
     36# 
     37# Brendan W. McAdams <brendan.mcadams@thewintergrp.com> 
     38 
     39# SimpleXMLRPCDispatcher lets us register xml-rpc calls w/o 
     40# running a full XMLRPC Server.  It's up to us to dispatch data 
     41 
     42from SimpleXMLRPCServer import SimpleXMLRPCDispatcher 
     43from django.http import HttpResponse 
     44 
     45# Create a Dispatcher; this handles the calls and translates info to function maps 
     46#dispatcher = SimpleXMLRPCDispatcher() # Python 2.4 
     47dispatcher = SimpleXMLRPCDispatcher(allow_none=False, encoding=None) # Python 2.5 
     48 
     49  
     50 
     51def rpc_handler(request): 
     52        """ 
     53        the actual handler: 
     54        if you setup your urls.py properly, all calls to the xml-rpc service 
     55        should be routed through here. 
     56        If post data is defined, it assumes it's XML-RPC and tries to process as such 
     57        Empty post assumes you're viewing from a browser and tells you about the service. 
     58        """ 
     59 
     60        response = HttpResponse() 
     61        if len(request.POST): 
     62                response.write(dispatcher._marshaled_dispatch(request.raw_post_data)) 
     63        else: 
     64                response.write("<b>This is an XML-RPC Service.</b><br>") 
     65                response.write("You need to invoke it using an XML-RPC Client!<br>") 
     66                response.write("The following methods are available:<ul>") 
     67                methods = dispatcher.system_listMethods() 
     68 
     69                for method in methods: 
     70                        # right now, my version of SimpleXMLRPCDispatcher always 
     71                        # returns "signatures not supported"... :( 
     72                        # but, in an ideal world it will tell users what args are expected 
     73                        sig = dispatcher.system_methodSignature(method) 
     74 
     75                        # this just reads your docblock, so fill it in! 
     76                        help =  dispatcher.system_methodHelp(method) 
     77 
     78                        response.write("<li><b>%s</b>: [%s] %s" % (method, sig, help)) 
     79 
     80                response.write("</ul>") 
     81                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>') 
     82 
     83        response['Content-length'] = str(len(response.content)) 
     84        return response 
     85 
     86def multiply(a, b): 
     87        """ 
     88        Multiplication is fun! 
     89        Takes two arguments, which are multiplied together. 
     90        Returns the result of the multiplication! 
     91        """ 
     92        return a*b 
     93 
     94# you have to manually register all functions that are xml-rpc-able with the dispatcher 
     95# the dispatcher then maps the args down. 
     96# The first argument is the actual method, the second is what to call it from the XML-RPC side... 
     97dispatcher.register_function(multiply, 'multiply') 
     98}}} 
     99 
     100That's it! 
     101 
     102You can pretty much write a standard python function in there, just be sure to register it with the dispatcher when you're done.   
     103 
     104Here's a quick and dirty client example for testing: 
     105 
     106{{{ 
     107#!python 
     108import sys 
     109import xmlrpclib 
     110rpc_srv = xmlrpclib.ServerProxy("http://localhost:8000/xml_rpc_srv/") 
     111result = rpc_srv.multiply( int(sys.argv[1]), int(sys.argv[2])) 
     112print "%d * %d = %d" % (sys.argv[1], sys.argv[2], result) 
     113}}} 
     114 
     115Based 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). 
     116 
     117Have fun! 
     118 
     119- [mailto:brendan.mcadams@NOSPAM.thewintergrp.com  Brendan W. McAdams <brendan.mcadams@NOSPAM.thewintergrp.com>] 
     120 
     121---- 
     122 
     123I 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>] 
     124 
     125---- 
     126 
     127I'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]