SCons :: Script :: Interactive :: SConsInteractiveCmd :: Class SConsInteractiveCmd

Class SConsInteractiveCmd

cmd.Cmd --+
          |
         SConsInteractiveCmd

build [TARGETS]         Build the specified TARGETS and their dependencies.
                        'b' is a synonym.
clean [TARGETS]         Clean (remove) the specified TARGETS and their
                        dependencies.  'c' is a synonym.
exit                    Exit SCons interactive mode.
help [COMMAND]          Prints help for the specified COMMAND.  'h' and
                        '?' are synonyms.
shell [COMMANDLINE]     Execute COMMANDLINE in a subshell.  'sh' and '!'
                        are synonyms.
version                 Prints SCons version information.

Instance Methods

[hide private]

__init__(self, **kw)
Instantiate a line-oriented interpreter framework.

source code

default(self, argv)
Called on an input line when the command prefix is not recognized.

source code

onecmd(self, line)
Interpret the argument as though it had been typed in response to the prompt.

source code

do_build(self, argv)
build [TARGETS] Build the specified TARGETS and their dependencies.

source code

do_clean(self, argv)
clean [TARGETS] Clean (remove) the specified TARGETS and their dependencies.

source code

do_EOF(self, argv)

source code

_do_one_help(self, arg)

source code

_doc_to_help(self, obj)

source code

_strip_initial_spaces(self, s)

source code

do_exit(self, argv)
exit Exit SCons interactive mode.

source code

do_help(self, argv)
help [COMMAND] Prints help for the specified COMMAND.

source code

do_shell(self, argv)
shell [COMMANDLINE] Execute COMMANDLINE in a subshell.

source code

do_version(self, argv)
version Prints SCons version information.

source code

Inherited from cmd.Cmd: cmdloop, columnize, complete, complete_help, completedefault, completenames, emptyline, get_names, parseline, postcmd, postloop, precmd, preloop, print_topics

Class Variables

[hide private]

synonyms = {'b': 'build', 'c': 'clean', 'h': 'help', 'scons': ...

Inherited from cmd.Cmd: doc_header, doc_leader, identchars, intro, lastcmd, misc_header, nohelp, prompt, ruler, undoc_header, use_rawinput

Method Details

[hide private]

init(self, **kw)
(Constructor)

source code

Instantiate a line-oriented interpreter framework.

The optional argument 'completekey' is the readline name of a
completion key; it defaults to the Tab key. If completekey is
not None and the readline module is available, command completion
is done automatically. The optional arguments stdin and stdout
specify alternate input and output file objects; if not specified,
sys.stdin and sys.stdout are used.

Overrides: cmd.Cmd.__init__: (inherited documentation)

default(self, argv)

source code

Called on an input line when the command prefix is not recognized.

If this method is not overridden, it prints an error message and
returns.

Overrides: cmd.Cmd.default: (inherited documentation)

onecmd(self, line)

source code

Interpret the argument as though it had been typed in response
to the prompt.

This may be overridden, but should not normally need to be;
see the precmd() and postcmd() methods for useful execution hooks.
The return value is a flag indicating whether interpretation of
commands by the interpreter should stop.

Overrides: cmd.Cmd.onecmd: (inherited documentation)

do_build(self, argv)

source code

build [TARGETS]         Build the specified TARGETS and their
dependencies.  'b' is a synonym.

do_clean(self, argv)

source code

clean [TARGETS]         Clean (remove) the specified TARGETS
and their dependencies.  'c' is a synonym.

do_help(self, argv)

source code

help [COMMAND]          Prints help for the specified COMMAND.  'h'
and '?' are synonyms.

Overrides: cmd.Cmd.do_help

do_shell(self, argv)

source code

shell [COMMANDLINE]     Execute COMMANDLINE in a subshell.  'sh' and
'!' are synonyms.

Class Variable Details

[hide private]

synonyms

Value:

{'b': 'build',
 'c': 'clean',
 'h': 'help',
 'scons': 'build',
 'sh': 'shell'}

Class SConsInteractiveCmd

__init__(self, **kw) (Constructor)

default(self, argv)

onecmd(self, line)

do_build(self, argv)

do_clean(self, argv)

do_help(self, argv)

do_shell(self, argv)

synonyms

init(self, **kw)
(Constructor)