Change cliconf get() method signature with explicit args (#33341)

* Change cliconf get() method signature to explicit args instead of *args and **kwargs

* updates doc string

lib/ansible/plugins/cliconf/__init__.py

@@ -150,22 +150,16 @@ class CliconfBase(with_metaclass(ABCMeta, object)):
         pass
 
     @abstractmethod
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
         """Execute specified command on remote device
         This method will retrieve the specified data and
         return it to the caller as a string.
         :args:
-             arg[0] command: command in string format to be executed on remote device
+             command: command in string format to be executed on remote device
-             arg[1] prompt: the expected prompt generated by executing command.
+             prompt: the expected prompt generated by executing command.
                             This can be a string or a list of strings (optional)
-             arg[2] answer: the string to respond to the prompt with (optional)
+             answer: the string to respond to the prompt with (optional)
-             arg[3] sendonly: bool to disable waiting for response, default is false (optional)
+             sendonly: bool to disable waiting for response, default is false (optional)
-        :kwargs:
-            :command: the command string to execute
-            :prompt: the expected prompt generated by executing command.
-                     This can be a string or a list of strings
-            :answer: the string to respond to the prompt with
-            :sendonly: bool to disable waiting for response
         :returns: Returns output received from remote device as byte string
         """
         pass

lib/ansible/plugins/cliconf/aireos.py

@@ -69,8 +69,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'config'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/aruba.py

@@ -70,8 +70,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/asa.py

@@ -67,8 +67,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/enos.py

@@ -85,8 +85,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/eos.py

@@ -62,8 +62,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/ios.py

@@ -67,8 +67,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/iosxr.py

@@ -66,8 +66,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def commit(self, comment=None):
         if comment:

lib/ansible/plugins/cliconf/ironware.py

@@ -70,8 +70,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/junos.py

@@ -69,12 +69,10 @@ class Cliconf(CliconfBase):
         for cmd in chain(['configure'], to_list(command)):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        command = kwargs.get('command')
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
-        return self.send_command(command)
 
-    def commit(self, *args, **kwargs):
+    def commit(self, comment=None):
-        comment = kwargs.get('comment', None)
         command = b'commit'
         if comment:
             command += b' comment {0}'.format(comment)

lib/ansible/plugins/cliconf/mlnxos.py

@@ -59,8 +59,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure terminal'], to_list(command), [b'exit']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/nxos.py

@@ -51,8 +51,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure'], to_list(command), [b'end']):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

lib/ansible/plugins/cliconf/vyos.py

@@ -58,8 +58,8 @@ class Cliconf(CliconfBase):
         for cmd in chain([b'configure'], to_list(command)):
             self.send_command(cmd)
 
-    def get(self, *args, **kwargs):
+    def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(*args, **kwargs)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def commit(self, comment=None):
         if comment: