Exscript.emulators.command module

Defines the behavior of commands by mapping commands to functions.

class Exscript.emulators.command.CommandSet(strict=True)

Bases: future.types.newobject.newobject

A set of commands to be used by the Dummy adapter.

__init__(strict=True)

Constructor.

add(command, response)

Register a command/response pair.

The command may be either a string (which is then automatically compiled into a regular expression), or a pre-compiled regular expression object.

If the given response handler is a string, it is sent as the response to any command that matches the given regular expression. If the given response handler is a function, it is called with the command passed as an argument.

Parameters:

• command (str|regex) – A string or a compiled regular expression.
• response (function|str) – A reponse, or a response handler.

add_from_file(filename, handler_decorator=None)

Wrapper around add() that reads the handlers from the file with the given name. The file is a Python script containing a list named ‘commands’ of tuples that map command names to handlers.

Parameters:

• filename (str) – The name of the file containing the tuples.
• handler_decorator (function) – A function that is used to decorate each of the handlers in the file.

eval(command)

Evaluate the given string against all registered commands and return the defined response.

Parameters:command (str) – The command that is evaluated. Return type:str or None Returns:The response, if one was defined.