From 6749a39dbee21cac00983bfc7d12e08e5b8e912d Mon Sep 17 00:00:00 2001 From: Kedar K <4506537+kedarX@users.noreply.github.com> Date: Tue, 28 Nov 2017 21:40:58 +0530 Subject: [PATCH] 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 | 16 +++++----------- lib/ansible/plugins/cliconf/aireos.py | 4 ++-- lib/ansible/plugins/cliconf/aruba.py | 4 ++-- lib/ansible/plugins/cliconf/asa.py | 4 ++-- lib/ansible/plugins/cliconf/enos.py | 4 ++-- lib/ansible/plugins/cliconf/eos.py | 4 ++-- lib/ansible/plugins/cliconf/ios.py | 4 ++-- lib/ansible/plugins/cliconf/iosxr.py | 4 ++-- lib/ansible/plugins/cliconf/ironware.py | 4 ++-- lib/ansible/plugins/cliconf/junos.py | 8 +++----- lib/ansible/plugins/cliconf/mlnxos.py | 4 ++-- lib/ansible/plugins/cliconf/nxos.py | 4 ++-- lib/ansible/plugins/cliconf/vyos.py | 4 ++-- 13 files changed, 30 insertions(+), 38 deletions(-) diff --git a/lib/ansible/plugins/cliconf/__init__.py b/lib/ansible/plugins/cliconf/__init__.py index c1a0dc38208..da2f442d566 100644 --- a/lib/ansible/plugins/cliconf/__init__.py +++ b/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 - arg[1] prompt: the expected prompt generated by executing command. + command: command in string format to be executed on remote device + 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) - arg[3] 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 + answer: the string to respond to the prompt with (optional) + sendonly: bool to disable waiting for response, default is false (optional) :returns: Returns output received from remote device as byte string """ pass diff --git a/lib/ansible/plugins/cliconf/aireos.py b/lib/ansible/plugins/cliconf/aireos.py index 08339daddbb..ad7511bd8da 100644 --- a/lib/ansible/plugins/cliconf/aireos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/aruba.py b/lib/ansible/plugins/cliconf/aruba.py index ccb2cf71248..6229d1482a1 100644 --- a/lib/ansible/plugins/cliconf/aruba.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/asa.py b/lib/ansible/plugins/cliconf/asa.py index fde32c69a2c..5c49e310594 100644 --- a/lib/ansible/plugins/cliconf/asa.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/enos.py b/lib/ansible/plugins/cliconf/enos.py index 1092fea5c25..751052e3e00 100644 --- a/lib/ansible/plugins/cliconf/enos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/eos.py b/lib/ansible/plugins/cliconf/eos.py index 400d55fbbb3..0dfb3d35b81 100644 --- a/lib/ansible/plugins/cliconf/eos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/ios.py b/lib/ansible/plugins/cliconf/ios.py index 68a3ce413d1..578e8f405ce 100644 --- a/lib/ansible/plugins/cliconf/ios.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/iosxr.py b/lib/ansible/plugins/cliconf/iosxr.py index fe890c22cc9..2d487bb239d 100644 --- a/lib/ansible/plugins/cliconf/iosxr.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def commit(self, comment=None): if comment: diff --git a/lib/ansible/plugins/cliconf/ironware.py b/lib/ansible/plugins/cliconf/ironware.py index 2b80aa26671..4506a648495 100644 --- a/lib/ansible/plugins/cliconf/ironware.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/junos.py b/lib/ansible/plugins/cliconf/junos.py index da6039a386a..6b043d89f2b 100644 --- a/lib/ansible/plugins/cliconf/junos.py +++ b/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): - command = kwargs.get('command') - return self.send_command(command) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) - def commit(self, *args, **kwargs): - comment = kwargs.get('comment', None) + def commit(self, comment=None): command = b'commit' if comment: command += b' comment {0}'.format(comment) diff --git a/lib/ansible/plugins/cliconf/mlnxos.py b/lib/ansible/plugins/cliconf/mlnxos.py index 3e5e05a5ad2..36680709da8 100644 --- a/lib/ansible/plugins/cliconf/mlnxos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/nxos.py b/lib/ansible/plugins/cliconf/nxos.py index 2f58aec7b5b..abab932f635 100644 --- a/lib/ansible/plugins/cliconf/nxos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def get_capabilities(self): result = {} diff --git a/lib/ansible/plugins/cliconf/vyos.py b/lib/ansible/plugins/cliconf/vyos.py index c8e5d819864..f4b8cb240a6 100644 --- a/lib/ansible/plugins/cliconf/vyos.py +++ b/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): - return self.send_command(*args, **kwargs) + def get(self, command, prompt=None, answer=None, sendonly=False): + return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly) def commit(self, comment=None): if comment: