diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2018-10-02 23:26:54 -0400 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2018-10-02 23:26:54 -0400 |
commit | c347ac8e56899c4662889d6a9f42afbd8d4646fd (patch) | |
tree | 953e52dbb21e7107b3b52e817124afc8270c2668 /cmd2/pyscript_bridge.py | |
parent | 9c5c3145cceb97d474cbb5b993033d54cc2b6d4b (diff) | |
download | cmd2-git-c347ac8e56899c4662889d6a9f42afbd8d4646fd.tar.gz |
Improved documentation
Diffstat (limited to 'cmd2/pyscript_bridge.py')
-rw-r--r-- | cmd2/pyscript_bridge.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/cmd2/pyscript_bridge.py b/cmd2/pyscript_bridge.py index 9d865b6b..4434bb58 100644 --- a/cmd2/pyscript_bridge.py +++ b/cmd2/pyscript_bridge.py @@ -251,7 +251,7 @@ class PyscriptBridge(object): def __getattr__(self, item: str): """ - Provide a way to call application commands via the PyscriptBridge + Provide functionality to call application commands as a method of PyscriptBridge ex: app.help() """ func = self._cmd2_app.cmd_func(item) @@ -278,7 +278,8 @@ class PyscriptBridge(object): def __call__(self, args: str, echo: Optional[bool]=None) -> CommandResult: """ - Call a command function (ex: do_help) + Provide functionality to call application commands by calling PyscriptBridge + ex: app('help') :param args: The string being passed to the command :param echo: If True, output will be echoed while the command runs This temporarily overrides the value of self.cmd_echo @@ -286,5 +287,6 @@ class PyscriptBridge(object): if echo is None: echo = self.cmd_echo - return _exec_cmd(self._cmd2_app, functools.partial(self._cmd2_app.onecmd_plus_hooks, args + '\n'), + return _exec_cmd(self._cmd2_app, + functools.partial(self._cmd2_app.onecmd_plus_hooks, args + '\n'), echo) |