Allow custom method names other than the default on server side

This new feature is usefull for a user that wants to use dot ('.') in
the xmlrpc method names available in its xmlrpc server.

Indeed, this is not possible in python function definition.
Therefore, this feature can be used to "simulate" nested methods.

The implementation of this feature does not use true nested methods
(i.e. in subclasses of the main class, inheriting from handler.XMLRPCView).

Instead, it simply allows the user to overwrite the method names thanks
to a `METHOD_NAMES` dictionary attribute in the user class (the one
inheriting from `handler.XMLRPCView`).

This approach has been used in order to not modify the whole code
structure of the 'handler.py' and still offer 'nested' methods from the
client point of view.

The README.rst and the tests have been updated and completed
accordingly.

Signed-off-by: Armand Bénéteau <[email protected]>

Author: ArmandBENETEAU

README.rst

@@ -31,10 +31,12 @@ Server example
 
     from aiohttp import web
     from aiohttp_xmlrpc import handler
-    from tornado.testing import *
+    from aiohttp_xmlrpc.handler import rename
 
 
     class XMLRPCExample(handler.XMLRPCView):
+
+        @rename("nested.test")
         def rpc_test(self):
             return None
 
@@ -47,6 +49,7 @@ Server example
         def rpc_args_kwargs(self, *args, **kwargs):
             return len(args) + len(kwargs)
 
+        @rename("nested.exception")
         def rpc_exception(self):
             raise Exception("YEEEEEE!!!")
 
@@ -59,6 +62,7 @@ Server example
 
 
 
+
 Client example
 --------------
 
@@ -72,11 +76,11 @@ Client example
     client = ServerProxy("http://127.0.0.1:8080/", loop=loop)
 
     async def main():
-        print(await client.test())
+        # 'nested.test' method call
+        print(await client.nested.test())
 
-        # Or via __getitem__
-        method = client['args']
-        print(await method(1, 2, 3))
+        # 'args' method call
+        print(await client.args(1, 2, 3))
 
         client.close()
 

aiohttp_xmlrpc/handler.py

@@ -42,13 +42,16 @@ def __new__(cls, clsname, superclasses, attributedict):
             if not key.startswith(instance.METHOD_PREFIX):
                 continue
 
+            # Get the value of the corresponding function
             value = getattr(instance, key)
 
             method_name = getattr(value, "__xmlrpc_name__", None)
             if method_name is None:
                 method_name = key.replace(instance.METHOD_PREFIX, "", 1)
 
             allowed_methods[method_name] = key
+
+            # Add the arg mapping in all cases
             argmapping[method_name] = inspect.getfullargspec(value)
 
         setattr(

examples/client.py

@@ -7,14 +7,13 @@
 
 
 async def main():
-    print(await client.test())
+    # 'nested.test' method call
+    print(await client.nested.test())
 
-    # Or via __getitem__
-    method = client['args']
-    print(await method(1, 2, 3))
-
-    client.close()
+    # 'args' method call
+    print(await client.args(1, 2, 3))
 
+    await client.close()
 
 if __name__ == "__main__":
     loop.run_until_complete(main())

examples/server.py

@@ -1,8 +1,11 @@
 from aiohttp import web
 from aiohttp_xmlrpc import handler
+from aiohttp_xmlrpc.handler import rename
 
 
 class XMLRPCExample(handler.XMLRPCView):
+
+    @rename("nested.test")
     def rpc_test(self):
         return None
 
@@ -15,6 +18,7 @@ def rpc_kwargs(self, **kwargs):
     def rpc_args_kwargs(self, *args, **kwargs):
         return len(args) + len(kwargs)
 
+    @rename("nested.exception")
     def rpc_exception(self):
         raise Exception("YEEEEEE!!!")
 

tests/test_handler.py

@@ -17,6 +17,7 @@
 
 
 class XMLRPCMain(handler.XMLRPCView):
+
     def rpc_test(self):
         return None
 
@@ -54,14 +55,19 @@ def rpc_dict_kw_only_args(self, d, *, foo, **kw):
         return (d, foo, kw)
 
     @rename("method_with.new_name")
-    def rpc_ranamed(self):
+    def rpc_renamed(self):
         return "renamed_function"
 
 
 class XMLRPCChild(XMLRPCMain):
+
     def rpc_child(self):
         return 42
 
+    @rename("child.test")
+    def rpc_child_nested_method(self):
+        return "My name has the nested format and I am in child class"
+
 
 def create_app(loop):
     app = web.Application()
@@ -224,3 +230,10 @@ async def test_13_kw_only_args(client):
 async def test_14_method_renaming(client):
     result = await client.method_with.new_name()
     assert result == "renamed_function"
+
+
+async def test_15_nested_method_in_child(aiohttp_xmlrpc_client):
+    client = await aiohttp_xmlrpc_client(create_app, path="/clone")
+
+    result = await client.child.test()
+    assert result == "My name has the nested format and I am in child class"