pimlico.cli.shell.base module

class ShellCommand

Bases: future.types.newobject.newobject

Base class used to provide commands for exploring a particular datatype. A basic set of commands is provided for all datatypes, but specific datatype classes may provide their own, by overriding the shell_commands attribute.

commands = []

help_text = None

execute(shell, *args, **kwargs)

Execute the command. Get the dataset reader as shell.data.

Parameters:

• shell – DataShell instance. Reader available as shell.data
• args – Args given by the user
• kwargs – Named args given by the user as key=val

class DataShell(data, commands, *args, **kwargs)

Bases: cmd.Cmd

Terminal shell for querying datatypes.

prompt = '>>> '

get_names()

do_EOF(line)

Exits the shell

preloop()

postloop()

emptyline()

Don’t repeat the last command (default): ignore empty lines

default(line)

We use this to handle commands that can’t be handled using the do_ pattern. Also handles the default fallback, which is to execute Python.

cmdloop(intro=None)

exception ShellError

Bases: exceptions.Exception