Galaxie Shell 0.2.6 documentation


Navigation:   | Index   | Search   | Top   | Up   | Prev   | Next   |
Table of Content: |glxshell.lib.cmd module |Cmd |Cmd.cmdloop() |Cmd.complete() |Cmd.complete_man() |Cmd.completenames() |Cmd.default() |Cmd.default_completer() |Cmd.do_man() |Cmd.doc_header |Cmd.doc_leader |Cmd.emptyline() |Cmd.get_names() |Cmd.help_man() |Cmd.identchars |Cmd.intro |Cmd.lastcmd |Cmd.misc_header |Cmd.nohelp |Cmd.onecmd() |Cmd.onecmdhooks() |Cmd.parseline() |Cmd.postcmd() |Cmd.postloop() |Cmd.precmd() |Cmd.preloop() |Cmd.print_topics() |Cmd.prompt |Cmd.ruler |Cmd.undoc_header |Cmd.use_rawinput |

© Copyright 2020-2024, Galaxie Shell Team.

Top » glxshell » glxshell package » glxshell.lib package » glxshell.lib.cmd module

glxshell.lib.cmd module

class glxshell.lib.cmd.Cmd(completekey='tab')[source]

Bases: object

A simple framework for writing line-oriented command interpreters.

These are often useful for test harnesses, administrative tools, and prototypes that will later be wrapped in a more sophisticated interface.

A Cmd instance or subclass instance is a line-oriented interpreter framework. There is no good reason to instantiate Cmd itself; rather, it’s useful as a superclass of an interpreter class you define yourself in order to inherit Cmd’s methods and encapsulate action methods.

cmdloop(intro=None)[source]

Repeatedly issue a prompt, accept input, parse an initial prefix off the received input, and dispatch to action methods, passing them the remainder of the line as argument.

complete(text, state)[source]

Return the next possible completion for ‘text’.

If a command has not been entered, then complete against command list. Otherwise try to call complete_<command> to get list of completions.

complete_man(*args)[source]
completenames(text, *ignored)[source]
default(line)[source]

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.

default_completer(*ignored)[source]

Method called to complete an input line when no command-specific complete_*() method is available. By default, it returns an empty list.

do_man()
doc_header = 'Documented commands (type man <topic>):'
doc_leader = ''
emptyline()[source]

Called when an empty line is entered in response to the prompt.

If this method is not overridden, it repeats the last nonempty command entered.

get_names()[source]
static help_man()[source]
identchars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_'
intro = None
lastcmd = ''
misc_header = 'Miscellaneous help topics:'
nohelp = 'No manual entry for %s'
onecmd(line)[source]

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.

onecmdhooks(line)[source]
parseline(line)[source]

Parse the line into a command name and a string containing the arguments. Returns a tuple containing (command, args, line). ‘command’ and ‘args’ may be None if the line couldn’t be parsed.

postcmd(stop, line)[source]

Hook method executed just after a command dispatch is finished.

postloop()[source]

Hook method executed once when the cmdloop() method is about to return.

precmd(line)[source]

Hook method executed just before the command line is interpreted, but after the input prompt is generated and issued.

preloop()[source]

Hook method executed once when the cmdloop() method is called.

print_topics(header, cmds, cmdlen, maxcol)[source]
prompt = '(Cmd) '
ruler = '='
undoc_header = 'Undocumented commands:'
use_rawinput = 1

Top » glxshell » glxshell package » glxshell.lib package » glxshell.lib.cmd module

© Copyright 2020-2024, Galaxie Shell Team.
This page is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (CC BY-NC-SA 4.0).
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
See History and License for more information.

Last updated on None.
Created using Sphinx 8.0.2.