Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Permalinkcpython/Lib/cmd.py/
Go to file
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
master
cpython/Lib/cmd.py/Jump to
Code definitions CmdClass__init__FunctioncmdloopFunctionprecmdFunctionpostcmdFunctionpreloopFunctionpostloopFunctionparselineFunctiononecmdFunctionemptylineFunctiondefaultFunctioncompletedefaultFunctioncompletenamesFunctioncompleteFunctionget_namesFunctioncomplete_helpFunctiondo_helpFunctiondelFunctionprint_topicsFunctioncolumnizeFunctiondelFunction
Go to fileJump to
CmdClass__init__FunctioncmdloopFunctionprecmdFunctionpostcmdFunctionpreloopFunctionpostloopFunctionparselineFunctiononecmdFunctionemptylineFunctiondefaultFunctioncompletedefaultFunctioncompletenamesFunctioncompleteFunctionget_namesFunctioncomplete_helpFunctiondo_helpFunctiondelFunctionprint_topicsFunctioncolumnizeFunctiondelFunction
- Go to file
Copy path
18 contributors
Users who have contributed to this file
| """A generic class to build line-oriented command interpreters. | |
| Interpreters constructed with this class obey the following conventions: | |
| 1. End of file on input is processed as the command 'EOF'. | |
| 2. A command is parsed out of each line by collecting the prefix composed | |
| of characters in the identchars member. | |
| 3. A command `foo' is dispatched to a method 'do_foo()'; the do_ method | |
| is passed a single argument consisting of the remainder of the line. | |
| 4. Typing an empty line repeats the last command. (Actually, it calls the | |
| method `emptyline', which may be overridden in a subclass.) | |
| 5. There is a predefined `help' method. Given an argument `topic', it | |
| calls the command `help_topic'. With no arguments, it lists all topics | |
| with defined help_ functions, broken into up to three topics; documented | |
| commands, miscellaneous help topics, and undocumented commands. | |
| 6. The command '?' is a synonym for `help'. The command '!' is a synonym | |
| for `shell', if a do_shell method exists. | |
| 7. If completion is enabled, completing commands will be done automatically, | |
| and completing of commands args is done by calling complete_foo() with | |
| arguments text, line, begidx, endidx. text is string we are matching | |
| against, all returned matches must begin with it. line is the current | |
| input line (lstripped), begidx and endidx are the beginning and end | |
| indexes of the text being matched, which could be used to provide | |
| different completion depending upon which position the argument is in. | |
| The `default' method may be overridden to intercept commands for which there | |
| is no do_ method. | |
| The `completedefault' method may be overridden to intercept completions for | |
| commands that have no complete_ method. | |
| The data member `self.ruler' sets the character used to draw separator lines | |
| in the help messages. If empty, no ruler line is drawn. It defaults to "=". | |
| If the value of `self.intro' is nonempty when the cmdloop method is called, | |
| it is printed out on interpreter startup. This value may be overridden | |
| via an optional argument to the cmdloop() method. | |
| The data members `self.doc_header', `self.misc_header', and | |
| `self.undoc_header' set the headers used for the help function's | |
| listings of documented functions, miscellaneous topics, and undocumented | |
| functions respectively. | |
| """ | |
| importstring,sys | |
| __all__= ["Cmd"] | |
| PROMPT='(Cmd) ' | |
| IDENTCHARS=string.ascii_letters+string.digits+'_' | |
| classCmd: | |
| """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. | |
| """ | |
| prompt=PROMPT | |
| identchars=IDENTCHARS | |
| ruler='=' | |
| lastcmd='' | |
| intro=None | |
| doc_leader="" | |
| doc_header="Documented commands (type help <topic>):" | |
| misc_header="Miscellaneous help topics:" | |
| undoc_header="Undocumented commands:" | |
| nohelp="*** No help on %s" | |
| use_rawinput=1 | |
| def__init__(self,completekey='tab',stdin=None,stdout=None): | |
| """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. | |
| """ | |
| ifstdinisnotNone: | |
| self.stdin=stdin | |
| else: | |
| self.stdin=sys.stdin | |
| ifstdoutisnotNone: | |
| self.stdout=stdout | |
| else: | |
| self.stdout=sys.stdout | |
| self.cmdqueue= [] | |
| self.completekey=completekey | |
| defcmdloop(self,intro=None): | |
| """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. | |
| """ | |
| self.preloop() | |
| ifself.use_rawinputandself.completekey: | |
| try: | |
| importreadline | |
| self.old_completer=readline.get_completer() | |
| readline.set_completer(self.complete) | |
| readline.parse_and_bind(self.completekey+": complete") | |
| exceptImportError: | |
| pass | |
| try: | |
| ifintroisnotNone: | |
| self.intro=intro | |
| ifself.intro: | |
| self.stdout.write(str(self.intro)+"\n") | |
| stop=None | |
| whilenotstop: | |
| ifself.cmdqueue: | |
| line=self.cmdqueue.pop(0) | |
| else: | |
| ifself.use_rawinput: | |
| try: | |
| line=input(self.prompt) | |
| exceptEOFError: | |
| line='EOF' | |
| else: | |
| self.stdout.write(self.prompt) | |
| self.stdout.flush() | |
| line=self.stdin.readline() | |
| ifnotlen(line): | |
| line='EOF' | |
| else: | |
| line=line.rstrip('\r\n') | |
| line=self.precmd(line) | |
| stop=self.onecmd(line) | |
| stop=self.postcmd(stop,line) | |
| self.postloop() | |
| finally: | |
| ifself.use_rawinputandself.completekey: | |
| try: | |
| importreadline | |
| readline.set_completer(self.old_completer) | |
| exceptImportError: | |
| pass | |
| defprecmd(self,line): | |
| """Hook method executed just before the command line is | |
| interpreted, but after the input prompt is generated and issued. | |
| """ | |
| returnline | |
| defpostcmd(self,stop,line): | |
| """Hook method executed just after a command dispatch is finished.""" | |
| returnstop | |
| defpreloop(self): | |
| """Hook method executed once when the cmdloop() method is called.""" | |
| pass | |
| defpostloop(self): | |
| """Hook method executed once when the cmdloop() method is about to | |
| return. | |
| """ | |
| pass | |
| defparseline(self,line): | |
| """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. | |
| """ | |
| line=line.strip() | |
| ifnotline: | |
| returnNone,None,line | |
| elifline[0]=='?': | |
| line='help '+line[1:] | |
| elifline[0]=='!': | |
| ifhasattr(self,'do_shell'): | |
| line='shell '+line[1:] | |
| else: | |
| returnNone,None,line | |
| i,n=0,len(line) | |
| whilei<nandline[i]inself.identchars:i=i+1 | |
| cmd,arg=line[:i],line[i:].strip() | |
| returncmd,arg,line | |
| defonecmd(self,line): | |
| """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. | |
| """ | |
| cmd,arg,line=self.parseline(line) | |
| ifnotline: | |
| returnself.emptyline() | |
| ifcmdisNone: | |
| returnself.default(line) | |
| self.lastcmd=line | |
| ifline=='EOF' : | |
| self.lastcmd='' | |
| ifcmd=='': | |
| returnself.default(line) | |
| else: | |
| try: | |
| func=getattr(self,'do_'+cmd) | |
| exceptAttributeError: | |
| returnself.default(line) | |
| returnfunc(arg) | |
| defemptyline(self): | |
| """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. | |
| """ | |
| ifself.lastcmd: | |
| returnself.onecmd(self.lastcmd) | |
| defdefault(self,line): | |
| """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. | |
| """ | |
| self.stdout.write('*** Unknown syntax: %s\n'%line) | |
| defcompletedefault(self,*ignored): | |
| """Method called to complete an input line when no command-specific | |
| complete_*() method is available. | |
| By default, it returns an empty list. | |
| """ | |
| return [] | |
| defcompletenames(self,text,*ignored): | |
| dotext='do_'+text | |
| return [a[3:]forainself.get_names()ifa.startswith(dotext)] | |
| defcomplete(self,text,state): | |
| """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. | |
| """ | |
| ifstate==0: | |
| importreadline | |
| origline=readline.get_line_buffer() | |
| line=origline.lstrip() | |
| stripped=len(origline)-len(line) | |
| begidx=readline.get_begidx()-stripped | |
| endidx=readline.get_endidx()-stripped | |
| ifbegidx>0: | |
| cmd,args,foo=self.parseline(line) | |
| ifcmd=='': | |
| compfunc=self.completedefault | |
| else: | |
| try: | |
| compfunc=getattr(self,'complete_'+cmd) | |
| exceptAttributeError: | |
| compfunc=self.completedefault | |
| else: | |
| compfunc=self.completenames | |
| self.completion_matches=compfunc(text,line,begidx,endidx) | |
| try: | |
| returnself.completion_matches[state] | |
| exceptIndexError: | |
| returnNone | |
| defget_names(self): | |
| # This method used to pull in base class attributes | |
| # at a time dir() didn't do it yet. | |
| returndir(self.__class__) | |
| defcomplete_help(self,*args): | |
| commands=set(self.completenames(*args)) | |
| topics=set(a[5:]forainself.get_names() | |
| ifa.startswith('help_'+args[0])) | |
| returnlist(commands|topics) | |
| defdo_help(self,arg): | |
| 'List available commands with "help" or detailed help with "help cmd".' | |
| ifarg: | |
| # XXX check arg syntax | |
| try: | |
| func=getattr(self,'help_'+arg) | |
| exceptAttributeError: | |
| try: | |
| doc=getattr(self,'do_'+arg).__doc__ | |
| ifdoc: | |
| self.stdout.write("%s\n"%str(doc)) | |
| return | |
| exceptAttributeError: | |
| pass | |
| self.stdout.write("%s\n"%str(self.nohelp% (arg,))) | |
| return | |
| func() | |
| else: | |
| names=self.get_names() | |
| cmds_doc= [] | |
| cmds_undoc= [] | |
| help= {} | |
| fornameinnames: | |
| ifname[:5]=='help_': | |
| help[name[5:]]=1 | |
| names.sort() | |
| # There can be duplicates if routines overridden | |
| prevname='' | |
| fornameinnames: | |
| ifname[:3]=='do_': | |
| ifname==prevname: | |
| continue | |
| prevname=name | |
| cmd=name[3:] | |
| ifcmdinhelp: | |
| cmds_doc.append(cmd) | |
| delhelp[cmd] | |
| elifgetattr(self,name).__doc__: | |
| cmds_doc.append(cmd) | |
| else: | |
| cmds_undoc.append(cmd) | |
| self.stdout.write("%s\n"%str(self.doc_leader)) | |
| self.print_topics(self.doc_header,cmds_doc,15,80) | |
| self.print_topics(self.misc_header,list(help.keys()),15,80) | |
| self.print_topics(self.undoc_header,cmds_undoc,15,80) | |
| defprint_topics(self,header,cmds,cmdlen,maxcol): | |
| ifcmds: | |
| self.stdout.write("%s\n"%str(header)) | |
| ifself.ruler: | |
| self.stdout.write("%s\n"%str(self.ruler*len(header))) | |
| self.columnize(cmds,maxcol-1) | |
| self.stdout.write("\n") | |
| defcolumnize(self,list,displaywidth=80): | |
| """Display a list of strings as a compact set of columns. | |
| Each column is only as wide as necessary. | |
| Columns are separated by two spaces (one was not legible enough). | |
| """ | |
| ifnotlist: | |
| self.stdout.write("<empty>\n") | |
| return | |
| nonstrings= [iforiinrange(len(list)) | |
| ifnotisinstance(list[i],str)] | |
| ifnonstrings: | |
| raiseTypeError("list[i] not a string for i in %s" | |
| %", ".join(map(str,nonstrings))) | |
| size=len(list) | |
| ifsize==1: | |
| self.stdout.write('%s\n'%str(list[0])) | |
| return | |
| # Try every row count from 1 upwards | |
| fornrowsinrange(1,len(list)): | |
| ncols= (size+nrows-1)//nrows | |
| colwidths= [] | |
| totwidth=-2 | |
| forcolinrange(ncols): | |
| colwidth=0 | |
| forrowinrange(nrows): | |
| i=row+nrows*col | |
| ifi>=size: | |
| break | |
| x=list[i] | |
| colwidth=max(colwidth,len(x)) | |
| colwidths.append(colwidth) | |
| totwidth+=colwidth+2 | |
| iftotwidth>displaywidth: | |
| break | |
| iftotwidth<=displaywidth: | |
| break | |
| else: | |
| nrows=len(list) | |
| ncols=1 | |
| colwidths= [0] | |
| forrowinrange(nrows): | |
| texts= [] | |
| forcolinrange(ncols): | |
| i=row+nrows*col | |
| ifi>=size: | |
| x="" | |
| else: | |
| x=list[i] | |
| texts.append(x) | |
| whiletextsandnottexts[-1]: | |
| deltexts[-1] | |
| forcolinrange(len(texts)): | |
| texts[col]=texts[col].ljust(colwidths[col]) | |
| self.stdout.write("%s\n"%str(" ".join(texts))) |