summaryrefslogtreecommitdiff
path: root/cmd2
diff options
context:
space:
mode:
authorEric Lin <anselor@gmail.com>2020-07-21 17:18:38 -0400
committeranselor <anselor@gmail.com>2020-08-04 13:38:08 -0400
commitc05d2b0480f284a83dfe868b1aad3d780174c289 (patch)
treeac3cb591b694718c7865e602181e870435f2ecf8 /cmd2
parent372676d479dff8bb07f9361deddd63b17ce7c9d3 (diff)
downloadcmd2-git-c05d2b0480f284a83dfe868b1aad3d780174c289.tar.gz
Removed support for functions outside of CommandSets
Diffstat (limited to 'cmd2')
-rw-r--r--cmd2/__init__.py2
-rw-r--r--cmd2/cmd2.py85
-rw-r--r--cmd2/command_definition.py25
3 files changed, 12 insertions, 100 deletions
diff --git a/cmd2/__init__.py b/cmd2/__init__.py
index 70a52f70..1fb01b16 100644
--- a/cmd2/__init__.py
+++ b/cmd2/__init__.py
@@ -28,7 +28,7 @@ if cmd2_parser_module is not None:
# Get the current value for argparse_custom.DEFAULT_ARGUMENT_PARSER
from .argparse_custom import DEFAULT_ARGUMENT_PARSER
from .cmd2 import Cmd
-from .command_definition import CommandSet, with_default_category, register_command
+from .command_definition import CommandSet, with_default_category
from .constants import COMMAND_NAME, DEFAULT_SHORTCUTS
from .decorators import with_argument_list, with_argparser, with_argparser_and_unknown_args, with_category
from .exceptions import Cmd2ArgparseError, SkipPostcommandHooks
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 2215f818..affd395f 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -46,7 +46,7 @@ from typing import Any, Callable, Dict, Iterable, List, Mapping, Optional, Tuple
from . import ansi, constants, plugin, utils
from .argparse_custom import DEFAULT_ARGUMENT_PARSER, CompletionItem
from .clipboard import can_clip, get_paste_buffer, write_to_paste_buffer
-from .command_definition import _REGISTERED_COMMANDS, CommandSet, _partial_passthru
+from .command_definition import CommandSet, _partial_passthru
from .constants import COMMAND_FUNC_PREFIX, COMPLETER_FUNC_PREFIX, HELP_FUNC_PREFIX
from .decorators import with_argparser
from .exceptions import Cmd2ShlexError, EmbeddedConsoleExit, EmptyStatement, RedirectionError, SkipPostcommandHooks
@@ -90,6 +90,7 @@ except ImportError: # pragma: no cover
class _SavedReadlineSettings:
"""readline settings that are backed up when switching between readline environments"""
+
def __init__(self):
self.completer = None
self.delims = ''
@@ -98,6 +99,7 @@ class _SavedReadlineSettings:
class _SavedCmd2Env:
"""cmd2 environment settings that are backed up when entering an interactive Python shell"""
+
def __init__(self):
self.readline_settings = _SavedReadlineSettings()
self.readline_module = None
@@ -397,15 +399,7 @@ class Cmd(cmd.Cmd):
self.matches_sorted = False
def _autoload_commands(self) -> None:
- """
- Load modular command definitions.
- :return: None
- """
-
- # start by loading registered functions as commands
- for cmd_name in _REGISTERED_COMMANDS.keys():
- self.install_registered_command(cmd_name)
-
+ """Load modular command definitions."""
# Search for all subclasses of CommandSet, instantiate them if they weren't provided in the constructor
all_commandset_defs = CommandSet.__subclasses__()
existing_commandset_types = [type(command_set) for command_set in self._installed_command_sets]
@@ -418,12 +412,11 @@ class Cmd(cmd.Cmd):
cmdset = cmdset_type()
self.install_command_set(cmdset)
- def install_command_set(self, cmdset: CommandSet):
+ def install_command_set(self, cmdset: CommandSet) -> None:
"""
Installs a CommandSet, loading all commands defined in the CommandSet
:param cmdset: CommandSet to load
- :return: None
"""
existing_commandset_types = [type(command_set) for command_set in self._installed_command_sets]
if type(cmdset) in existing_commandset_types:
@@ -525,64 +518,6 @@ class Cmd(cmd.Cmd):
cmdset.on_unregister(self)
self._installed_command_sets.remove(cmdset)
- def install_registered_command(self, cmd_name: str):
- cmd_completer = None
- cmd_help = None
-
- if cmd_name not in _REGISTERED_COMMANDS:
- raise KeyError('Command ' + cmd_name + ' has not been registered')
-
- cmd_func = _REGISTERED_COMMANDS[cmd_name]
-
- module = inspect.getmodule(cmd_func)
-
- module_funcs = [mf for mf in inspect.getmembers(module) if inspect.isfunction(mf[1])]
- for mf in module_funcs:
- if mf[0] == COMPLETER_FUNC_PREFIX + cmd_name:
- cmd_completer = mf[1]
- elif mf[0] == HELP_FUNC_PREFIX + cmd_name:
- cmd_help = mf[1]
- if cmd_completer is not None and cmd_help is not None:
- break
-
- self.install_command_function(cmd_name, cmd_func, cmd_completer, cmd_help)
-
- def install_command_function(self,
- cmd_name: str,
- cmd_func: Callable,
- cmd_completer: Optional[Callable],
- cmd_help: Optional[Callable]):
- """
- Installs a command by passing in functions for the command, completion, and help
-
- :param cmd_name: name of the command to install
- :param cmd_func: function to handle the command
- :param cmd_completer: completion function for the command
- :param cmd_help: help generator for the command
- :return: None
- """
- self.__install_command_function(cmd_name, types.MethodType(cmd_func, self))
-
- self._installed_functions.append(cmd_name)
- if cmd_completer is not None:
- self.__install_completer_function(cmd_name, types.MethodType(cmd_completer, self))
- if cmd_help is not None:
- self.__install_help_function(cmd_name, types.MethodType(cmd_help, self))
-
- def uninstall_command(self, cmd_name: str):
- """
- Uninstall an installed command and any associated completer or help functions
- :param cmd_name: Command to uninstall
- """
- if cmd_name in self._installed_functions:
- delattr(self, COMMAND_FUNC_PREFIX + cmd_name)
-
- if hasattr(self, COMPLETER_FUNC_PREFIX + cmd_name):
- delattr(self, COMPLETER_FUNC_PREFIX + cmd_name)
- if hasattr(self, HELP_FUNC_PREFIX + cmd_name):
- delattr(self, HELP_FUNC_PREFIX + cmd_name)
- self._installed_functions.remove(cmd_name)
-
def add_settable(self, settable: Settable) -> None:
"""
Convenience method to add a settable parameter to ``self.settables``
@@ -2156,7 +2091,8 @@ class Cmd(cmd.Cmd):
if proc.returncode is not None:
subproc_stdin.close()
new_stdout.close()
- raise RedirectionError('Pipe process exited with code {} before command could run'.format(proc.returncode))
+ raise RedirectionError(
+ 'Pipe process exited with code {} before command could run'.format(proc.returncode))
else:
redir_saved_state.redirecting = True
cmd_pipe_proc_reader = utils.ProcReader(proc, self.stdout, sys.stderr)
@@ -2165,7 +2101,8 @@ class Cmd(cmd.Cmd):
elif statement.output:
import tempfile
if (not statement.output_to) and (not self._can_clip):
- raise RedirectionError("Cannot redirect to paste buffer; missing 'pyperclip' and/or pyperclip dependencies")
+ raise RedirectionError(
+ "Cannot redirect to paste buffer; missing 'pyperclip' and/or pyperclip dependencies")
# Redirecting to a file
elif statement.output_to:
@@ -2271,7 +2208,6 @@ class Cmd(cmd.Cmd):
# Check to see if this command should be stored in history
if statement.command not in self.exclude_from_history and \
statement.command not in self.disabled_commands and add_to_history:
-
self.history.append(statement)
stop = func(statement)
@@ -3358,7 +3294,7 @@ class Cmd(cmd.Cmd):
if 'gnureadline' in sys.modules:
# Restore what the readline module pointed to
if cmd2_env.readline_module is None:
- del(sys.modules['readline'])
+ del (sys.modules['readline'])
else:
sys.modules['readline'] = cmd2_env.readline_module
@@ -3387,6 +3323,7 @@ class Cmd(cmd.Cmd):
other arguments. (Defaults to None)
:return: True if running of commands should stop
"""
+
def py_quit():
"""Function callable from the interactive Python console to exit that environment"""
raise EmbeddedConsoleExit
diff --git a/cmd2/command_definition.py b/cmd2/command_definition.py
index d9925969..0645de2a 100644
--- a/cmd2/command_definition.py
+++ b/cmd2/command_definition.py
@@ -16,11 +16,6 @@ try: # pragma: no cover
except ImportError: # pragma: no cover
pass
-_REGISTERED_COMMANDS = {} # type: Dict[str, Callable]
-"""
-Registered command tuples. (command, ``do_`` function)
-"""
-
def _partial_passthru(func: Callable, *args, **kwargs) -> functools.partial:
"""
@@ -52,26 +47,6 @@ def _partial_passthru(func: Callable, *args, **kwargs) -> functools.partial:
return passthru_type(func, *args, **kwargs)
-def register_command(cmd_func: Callable):
- """
- Decorator that allows an arbitrary function to be automatically registered as a command.
- If there is a ``help_`` or ``complete_`` function that matches this command, that will also be registered.
-
- :param cmd_func: Function to register as a cmd2 command
- :type cmd_func: Callable[[cmd2.Cmd, Union[Statement, argparse.Namespace]], None]
- :return:
- """
- assert cmd_func.__name__.startswith(COMMAND_FUNC_PREFIX), 'Command functions must start with `do_`'
-
- cmd_name = cmd_func.__name__[len(COMMAND_FUNC_PREFIX):]
-
- if cmd_name not in _REGISTERED_COMMANDS:
- _REGISTERED_COMMANDS[cmd_name] = cmd_func
- else:
- raise KeyError('Command ' + cmd_name + ' is already registered')
- return cmd_func
-
-
def with_default_category(category: str):
"""
Decorator that applies a category to all ``do_*`` command methods in a class that do not already