deluge.ui.console.cmdline package

Subpackages

• deluge.ui.console.cmdline.commands package
  • Submodules
  • deluge.ui.console.cmdline.commands.add module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.cache module
    • Command
      • Command.handle()
  • deluge.ui.console.cmdline.commands.config module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
      • Command.usage
    • json_eval()
  • deluge.ui.console.cmdline.commands.connect module
    • Command
      • Command.add_arguments()
      • Command.add_parser()
      • Command.handle()
      • Command.usage
  • deluge.ui.console.cmdline.commands.debug module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.gui module
    • Command
      • Command.handle()
      • Command.interactive_only
  • deluge.ui.console.cmdline.commands.halt module
    • Command
      • Command.handle()
  • deluge.ui.console.cmdline.commands.help module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.info module
    • Command
      • Command.add_arguments()
      • Command.add_subparser()
      • Command.complete()
      • Command.epilog
      • Command.handle()
      • Command.show_file_info()
      • Command.show_info()
      • Command.show_peer_info()
      • Command.sort_help
  • deluge.ui.console.cmdline.commands.manage module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
      • Command.usage
  • deluge.ui.console.cmdline.commands.move module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.pause module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
      • Command.usage
  • deluge.ui.console.cmdline.commands.plugin module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.quit module
    • Command
      • Command.aliases
      • Command.handle()
      • Command.interactive_only
  • deluge.ui.console.cmdline.commands.recheck module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
      • Command.usage
  • deluge.ui.console.cmdline.commands.resume module
    • Command
      • Command.add_arguments()
      • Command.complete()
      • Command.handle()
      • Command.usage
  • deluge.ui.console.cmdline.commands.rm module
    • Command
      • Command.add_arguments()
      • Command.aliases
      • Command.complete()
      • Command.handle()
  • deluge.ui.console.cmdline.commands.status module
    • Command
      • Command.add_arguments()
      • Command.handle()
      • Command.print_status()
  • deluge.ui.console.cmdline.commands.update_tracker module
    • Command
      • Command.add_arguments()
      • Command.aliases
      • Command.complete()
      • Command.handle()
      • Command.usage
  • Module contents
    • BaseCommand
      • BaseCommand.add_arguments()
      • BaseCommand.add_subparser()
      • BaseCommand.aliases
      • BaseCommand.complete()
      • BaseCommand.create_parser()
      • BaseCommand.description
      • BaseCommand.epilog
      • BaseCommand.handle()
      • BaseCommand.interactive_only
      • BaseCommand.name
      • BaseCommand.name_with_alias
      • BaseCommand.split()
      • BaseCommand.usage

Submodules

deluge.ui.console.cmdline.command module

class deluge.ui.console.cmdline.command.BaseCommand

Bases: object

add_arguments(parser)

add_subparser(subparsers)

aliases = []

complete(text, *args)

create_parser()

property description

epilog = ''

handle(options)

interactive_only = False

property name

property name_with_alias

split(text)

usage = None

class deluge.ui.console.cmdline.command.Commander(cmds, interactive=False)

Bases: object

do_command(cmd_line)

Run a console command.

Parameters:

cmd_line (str) – Console command.

Returns:

Deferred – A deferred that fires when the command has been executed.

exec_command(options, *args)

Execute a console command.

Parameters:

options (argparse.Namespace) – The command to execute.

Returns:

Deferred – A deferred that fires when command has been executed.

exit(status=0, msg=None)

parse_command(cmd_line)

Parse a console command and process with argparse.

Parameters:

cmd_line (str) – Console command.

Returns:

argparse.Namespace – The parsed command.

write(line)

Module contents