瀏覽代碼

getAPIVersion() instead of getProtocolVersion()

Chris McDonough 18 年之前
父節點
當前提交
e981212acb
共有 4 個文件被更改,包括 16 次插入16 次删除
  1. 3 3
      CHANGES.txt
  2. 9 9
      src/supervisor/tests.py
  3. 1 1
      src/supervisor/ui/status.html
  4. 3 3
      src/supervisor/xmlrpc.py

+ 3 - 3
CHANGES.txt

@@ -12,9 +12,9 @@ Next Release
     Mike Naberezny).
 
   - The XML-RPC method supervisor.getVersion() has been renamed for 
-    clarity to supervisor.getProtocolVersion().  The old name is
-    aliased for compatibility but is deprecated and will be removed 
-    in a future version (Mike Naberezny).
+    clarity to supervisor.getAPIVersion().  The old name is aliased 
+    for compatibility but is deprecated and will be removed in a
+    future version (Mike Naberezny).
 
   - Improved web interface styling (Mike Naberezny, Derek DeVries)
 

+ 9 - 9
src/supervisor/tests.py

@@ -409,17 +409,17 @@ class SupervisorNamespaceXMLRPCInterfaceTests(TestBase):
         self._assertRPCError(xmlrpc.Faults.SHUTDOWN_STATE, interface._update,
                              'foo')
 
-    def test_getProtocolVersion(self):
+    def test_getAPIVersion(self):
         supervisord = DummySupervisor()
         interface = self._makeOne(supervisord)
-        version = interface.getProtocolVersion()
+        version = interface.getAPIVersion()
         self.assertEqual(version, xmlrpc.RPC_VERSION)
-        self.assertEqual(interface.update_text, 'getProtocolVersion')
+        self.assertEqual(interface.update_text, 'getAPIVersion')
 
-    def test_getProtocolVersion_aliased_to_deprecated_getVersion(self):
+    def test_getAPIVersion_aliased_to_deprecated_getVersion(self):
         supervisord = DummySupervisor()
         interface = self._makeOne(supervisord)
-        self.assertEqual(interface.getProtocolVersion, interface.getVersion)
+        self.assertEqual(interface.getAPIVersion, interface.getVersion)
 
     def test_getSupervisorVersion(self):
         supervisord = DummySupervisor()
@@ -1891,15 +1891,15 @@ class XMLRPCHandlerTests(unittest.TestCase):
         subinterfaces = [('supervisor', DummySupervisorRPCNamespace())]
         handler = self._makeOne(supervisor, subinterfaces)
         import xmlrpclib
-        data = xmlrpclib.dumps((), 'supervisor.getProtocolVersion')
+        data = xmlrpclib.dumps((), 'supervisor.getAPIVersion')
         request = DummyRequest('/what/ever', None, None, None)
         handler.continue_request(data, request)
         logdata = supervisor.options.logger.data
         self.assertEqual(len(logdata), 2)
         self.assertEqual(logdata[0],
-               u'XML-RPC method called: supervisor.getProtocolVersion()')
+               u'XML-RPC method called: supervisor.getAPIVersion()')
         self.assertEqual(logdata[1],
-            u'XML-RPC method supervisor.getProtocolVersion() returned successfully')
+            u'XML-RPC method supervisor.getAPIVersion() returned successfully')
         self.assertEqual(len(request.producers), 1)
         xml_response = request.producers[0]
         response = xmlrpclib.loads(xml_response)
@@ -2996,7 +2996,7 @@ class DummySupervisorRPCNamespace:
     _restarted = False
     _shutdown = False
 
-    def getProtocolVersion(self):
+    def getAPIVersion(self):
         return '1.0'
 
     def readProcessLog(self, name, offset, length):

+ 1 - 1
src/supervisor/ui/status.html

@@ -56,7 +56,7 @@
         <a href="http://agendaless.com/">Agendaless Consulting</a>
       </div>
       <div class="right">
-        design by <a href="http://maintainable.com">Maintainable Software</a>
+        Design by <a href="http://maintainable.com">Maintainable Software</a>
       </div>
     </div>
   </div>

+ 3 - 3
src/supervisor/xmlrpc.py

@@ -182,15 +182,15 @@ class SupervisorNamespaceRPCInterface:
 
     # RPC API methods
 
-    def getProtocolVersion(self):
+    def getAPIVersion(self):
         """ Return the version of the RPC API used by supervisord
 
         @return string version version id
         """
-        self._update('getProtocolVersion')
+        self._update('getAPIVersion')
         return RPC_VERSION
 
-    getVersion = getProtocolVersion # b/w compatibility with releases before 2.3
+    getVersion = getAPIVersion # b/w compatibility with releases before 2.3
 
     def getSupervisorVersion(self):
         """ Return the version of the supervisor package in use by supervisord