summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-08-10 16:01:47 (GMT)
committerR David Murray <rdmurray@bitdance.com>2013-08-10 16:01:47 (GMT)
commitf22b62e26137e334e9a0beffd0de531955daf8ce (patch)
treea98d5fb518d5e09480cb70daea8bfdb62b4b908e
parent319163244aa00dd17c021aea0775c94a13bc8c97 (diff)
downloadcpython-f22b62e26137e334e9a0beffd0de531955daf8ce.zip
cpython-f22b62e26137e334e9a0beffd0de531955daf8ce.tar.gz
cpython-f22b62e26137e334e9a0beffd0de531955daf8ce.tar.bz2
#8112: Update the documenting xmlrpc server to use getfullargspec.
Before this patch it would raise an error when trying to display documentation for a method that used annotations. Patch by Claudiu Popa.
-rw-r--r--Lib/test/test_docxmlrpc.py27
-rw-r--r--Lib/xmlrpc/server.py17
-rw-r--r--Misc/NEWS3
3 files changed, 36 insertions, 11 deletions
diff --git a/Lib/test/test_docxmlrpc.py b/Lib/test/test_docxmlrpc.py
index d6ca458..7086d9a 100644
--- a/Lib/test/test_docxmlrpc.py
+++ b/Lib/test/test_docxmlrpc.py
@@ -54,8 +54,18 @@ def server(evt, numrequests):
"""
return x + y
+ def annotation(x: int):
+ """ Use function annotations. """
+ return x
+
+ class ClassWithAnnotation:
+ def method_annotation(self, x: bytes):
+ return x.decode()
+
serv.register_function(add)
serv.register_function(lambda x, y: x-y)
+ serv.register_function(annotation)
+ serv.register_instance(ClassWithAnnotation())
while numrequests > 0:
serv.handle_request()
@@ -177,10 +187,7 @@ class DocXMLRPCHTTPGETServer(unittest.TestCase):
b'method&nbsp;takes&nbsp;two&nbsp;integers&nbsp;as&nbsp;arguments'
b'<br>\nand&nbsp;returns&nbsp;a&nbsp;double&nbsp;result.<br>\n&nbsp;'
b'<br>\nThis&nbsp;server&nbsp;does&nbsp;NOT&nbsp;support&nbsp;system'
- b'.methodSignature.</tt></dd></dl>\n<dl><dt><a name="-test_method">'
- b'<strong>test_method</strong></a>(arg)</dt><dd><tt>Test&nbsp;'
- b'method\'s&nbsp;docs.&nbsp;This&nbsp;method&nbsp;truly&nbsp;does'
- b'&nbsp;very&nbsp;little.</tt></dd></dl>'), response)
+ b'.methodSignature.</tt></dd></dl>'), response)
def test_autolink_dotted_methods(self):
"""Test that selfdot values are made strong automatically in the
@@ -191,6 +198,18 @@ class DocXMLRPCHTTPGETServer(unittest.TestCase):
self.assertIn(b"""Try&nbsp;self.<strong>add</strong>,&nbsp;too.""",
response.read())
+ def test_annotations(self):
+ """ Test that annotations works as expected """
+ self.client.request("GET", "/")
+ response = self.client.getresponse()
+ self.assertIn(
+ (b'<dl><dt><a name="-annotation"><strong>annotation</strong></a>'
+ b'(x: int)</dt><dd><tt>Use&nbsp;function&nbsp;annotations.</tt>'
+ b'</dd></dl>\n<dl><dt><a name="-method_annotation"><strong>'
+ b'method_annotation</strong></a>(x: bytes)</dt></dl>'),
+ response.read())
+
+
def test_main():
support.run_unittest(DocXMLRPCHTTPGETServer)
diff --git a/Lib/xmlrpc/server.py b/Lib/xmlrpc/server.py
index 54e1726..78ca4e0 100644
--- a/Lib/xmlrpc/server.py
+++ b/Lib/xmlrpc/server.py
@@ -756,20 +756,23 @@ class ServerHTMLDoc(pydoc.HTMLDoc):
self.escape(anchor), self.escape(name))
if inspect.ismethod(object):
- args, varargs, varkw, defaults = inspect.getargspec(object)
+ args = inspect.getfullargspec(object)
# exclude the argument bound to the instance, it will be
# confusing to the non-Python user
argspec = inspect.formatargspec (
- args[1:],
- varargs,
- varkw,
- defaults,
+ args.args[1:],
+ args.varargs,
+ args.varkw,
+ args.defaults,
+ annotations=args.annotations,
formatvalue=self.formatvalue
)
elif inspect.isfunction(object):
- args, varargs, varkw, defaults = inspect.getargspec(object)
+ args = inspect.getfullargspec(object)
argspec = inspect.formatargspec(
- args, varargs, varkw, defaults, formatvalue=self.formatvalue)
+ args.args, args.varargs, args.varkw, args.defaults,
+ annotations=args.annotations,
+ formatvalue=self.formatvalue)
else:
argspec = '(...)'
diff --git a/Misc/NEWS b/Misc/NEWS
index d6a645d..635a925 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -64,6 +64,9 @@ Core and Builtins
Library
-------
+- Issue #8112: xlmrpc.server's DocXMLRPCServer server no longer raises an error
+ if methods have annotations; it now correctly displays the annotations.
+
- Issue #17998: Fix an internal error in regular expression engine.
- Issue #17557: Fix os.getgroups() to work with the modified behavior of