codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ConsoleUI: Tidy up help output and limit command usage message to one line

This commit is contained in:
Calum Lind 2013-05-16 02:35:28 +01:00
parent 3101104738
commit 836acbf02b
1 changed files with 20 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
deluge/ui/console/main.py
View File

@ -64,30 +64,18 @@ class Console(_UI):
def __init__(self): def __init__(self):
super(Console, self).__init__("console") super(Console, self).__init__("console")
group = optparse.OptionGroup(self.parser, "Console Options","These options control how " group = optparse.OptionGroup(self.parser, "Console Options", "These daemon connect options will be "
"the console connects to the daemon. These options will be " "used for commands, or if console ui autoconnect is enabled.")
"used if you pass a command, or if you have autoconnect " group.add_option("-d", "--daemon", dest="daemon_addr")
"enabled for the console ui.") group.add_option("-p", "--port", dest="daemon_port", type="int")
group.add_option("-u", "--username", dest="daemon_user")
group.add_option("-d","--daemon",dest="daemon_addr", group.add_option("-P", "--password", dest="daemon_pass")
action="store",type="str",default="127.0.0.1",
help="Set the address of the daemon to connect to."
" [default: %default]")
group.add_option("-p","--port",dest="daemon_port",
help="Set the port to connect to the daemon on. [default: %default]",
action="store",type="int",default=58846)
group.add_option("-u","--username",dest="daemon_user",
help="Set the username to connect to the daemon with. [default: %default]",
action="store",type="string")
group.add_option("-P","--password",dest="daemon_pass",
help="Set the password to connect to the daemon with. [default: %default]",
action="store",type="string")
self.parser.add_option_group(group) self.parser.add_option_group(group)
self.cmds = load_commands(os.path.join(UI_PATH, 'commands')) self.console_cmds = load_commands(os.path.join(UI_PATH, 'commands'))
class CommandOptionGroup(optparse.OptionGroup): class CommandOptionGroup(optparse.OptionGroup):
def __init__(self, parser, title, description=None, cmds = None): def __init__(self, parser, title, description=None, cmds=None):
optparse.OptionGroup.__init__(self,parser,title,description) optparse.OptionGroup.__init__(self,parser, title, description)
self.cmds = cmds self.cmds = cmds
def format_help(self, formatter): def format_help(self, formatter):
@ -103,23 +91,22 @@ class Console(_UI):
cname = "/".join(allnames) cname = "/".join(allnames)
result += formatter.format_heading(" - ".join([cname,cmd.__doc__])) result += formatter.format_heading(" - ".join([cname,cmd.__doc__]))
formatter.indent() formatter.indent()
result += "%*s%s\n" % (formatter.current_indent, "", cmd.usage) result += "%*s%s\n" % (formatter.current_indent, "", cmd.usage.split('\n')[0])
formatter.dedent() formatter.dedent()
formatter.dedent() formatter.dedent()
return result return result
cmd_group = CommandOptionGroup(self.parser, "Console Commands", cmd_group = CommandOptionGroup(self.parser, "Console Commands",
description="The following commands can be issued at the " description="""These commands can be issued from the command line.
"command line. Commands should be quoted, so, for example, " They require quoting and multiple commands separated by ';'
"to pause torrent with id 'abc' you would run: '%s " e.g. Pause torrent with id 'abcd' and get information for id 'efgh':
"\"pause abc\"'"%os.path.basename(sys.argv[0]), `%s \"pause abcd; info efgh\"`"""
cmds=self.cmds) % os.path.basename(sys.argv[0]), cmds=self.console_cmds)
self.parser.add_option_group(cmd_group) self.parser.add_option_group(cmd_group)
def start(self): def start(self):
super(Console, self).start() super(Console, self).start()
ConsoleUI(self.args,self.cmds,(self.options.daemon_addr, ConsoleUI(self.args, self.console_cmds, (self.options.daemon_addr, self.options.daemon_port,
self.options.daemon_port,self.options.daemon_user, self.options.daemon_user, self.options.daemon_pass))
self.options.daemon_pass))
def start(): def start():
Console().start() Console().start()
@ -302,7 +289,7 @@ def load_commands(command_dir, exclude=[]):
class ConsoleUI(component.Component): class ConsoleUI(component.Component):
def __init__(self, args=None, cmds = None, daemon = None): def __init__(self, args=None, cmds=None, daemon=None):
component.Component.__init__(self, "ConsoleUI", 2) component.Component.__init__(self, "ConsoleUI", 2)
# keep track of events for the log view # keep track of events for the log view
@ -335,10 +322,9 @@ class ConsoleUI(component.Component):
from commander import Commander from commander import Commander
cmdr = Commander(cmds) cmdr = Commander(cmds)
if daemon: if daemon:
cmdr.exec_args(args,*daemon) cmdr.exec_args(args, *daemon)
else: else:
cmdr.exec_args(args,None,None,None,None) cmdr.exec_args(args, None, None, None, None)
self.coreconfig = CoreConfig() self.coreconfig = CoreConfig()
if self.interactive and not deluge.common.windows_check(): if self.interactive and not deluge.common.windows_check():