deluge.ui.console package
Subpackages
- deluge.ui.console.cmdline package
- Subpackages
- deluge.ui.console.cmdline.commands package
- Submodules
- deluge.ui.console.cmdline.commands.add module
- deluge.ui.console.cmdline.commands.cache module
- deluge.ui.console.cmdline.commands.config module
- deluge.ui.console.cmdline.commands.connect module
- deluge.ui.console.cmdline.commands.debug module
- deluge.ui.console.cmdline.commands.gui module
- deluge.ui.console.cmdline.commands.halt module
- deluge.ui.console.cmdline.commands.help module
- deluge.ui.console.cmdline.commands.info module
- deluge.ui.console.cmdline.commands.manage module
- deluge.ui.console.cmdline.commands.move module
- deluge.ui.console.cmdline.commands.pause module
- deluge.ui.console.cmdline.commands.plugin module
- deluge.ui.console.cmdline.commands.quit module
- deluge.ui.console.cmdline.commands.recheck module
- deluge.ui.console.cmdline.commands.resume module
- deluge.ui.console.cmdline.commands.rm module
- deluge.ui.console.cmdline.commands.status module
- deluge.ui.console.cmdline.commands.update_tracker module
- Module contents
- deluge.ui.console.cmdline.commands package
- Submodules
- deluge.ui.console.cmdline.command module
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
Commander
- Module contents
- Subpackages
- deluge.ui.console.modes package
- Subpackages
- deluge.ui.console.modes.preferences package
- deluge.ui.console.modes.torrentlist package
- Submodules
- deluge.ui.console.modes.torrentlist.add_torrents_popup module
- deluge.ui.console.modes.torrentlist.filtersidebar module
- deluge.ui.console.modes.torrentlist.queue_mode module
- deluge.ui.console.modes.torrentlist.search_mode module
- deluge.ui.console.modes.torrentlist.torrentactions module
- deluge.ui.console.modes.torrentlist.torrentlist module
- deluge.ui.console.modes.torrentlist.torrentview module
- deluge.ui.console.modes.torrentlist.torrentviewcolumns module
- Module contents
- Submodules
- deluge.ui.console.modes.add_util module
- deluge.ui.console.modes.addtorrents module
- deluge.ui.console.modes.basemode module
- deluge.ui.console.modes.cmdline module
- deluge.ui.console.modes.connectionmanager module
ConnectionManager
ConnectionManager.add_host()
ConnectionManager.add_popup()
ConnectionManager.delete_host()
ConnectionManager.on_resize()
ConnectionManager.pause()
ConnectionManager.read_input()
ConnectionManager.refresh()
ConnectionManager.resume()
ConnectionManager.start()
ConnectionManager.update()
ConnectionManager.update_hosts_status()
ConnectionManager.update_select_host_popup()
- deluge.ui.console.modes.eventview module
- deluge.ui.console.modes.torrentdetail module
TorrentDetail
TorrentDetail.back_to_overview()
TorrentDetail.build_file_list()
TorrentDetail.build_prio_list()
TorrentDetail.do_priority()
TorrentDetail.draw_files()
TorrentDetail.expcol_cur_file()
TorrentDetail.file_list_down()
TorrentDetail.file_list_up()
TorrentDetail.on_resize()
TorrentDetail.pause()
TorrentDetail.read_input()
TorrentDetail.refresh()
TorrentDetail.render_header()
TorrentDetail.set_state()
TorrentDetail.set_torrent_id()
TorrentDetail.show_priority_popup()
TorrentDetail.start()
TorrentDetail.update()
- Module contents
- Subpackages
- deluge.ui.console.utils package
- Submodules
- deluge.ui.console.utils.colors module
- deluge.ui.console.utils.column module
- deluge.ui.console.utils.common module
- deluge.ui.console.utils.config module
- deluge.ui.console.utils.curses_util module
- deluge.ui.console.utils.format_utils module
delete_alt_backspace()
f_progressbar()
f_seedrank_dash()
format_column()
format_date_dash()
format_date_never()
format_float()
format_pieces()
format_priority()
format_progress()
format_queue()
format_row()
format_seeds_peers()
format_size()
format_speed()
format_time()
ftotal_sized()
pad_string()
remove_formatting()
shorten_hash()
strwidth()
trim_string()
wrap_string()
- Module contents
- deluge.ui.console.widgets package
- Submodules
- deluge.ui.console.widgets.fields module
- deluge.ui.console.widgets.inputpane module
BaseInputPane
BaseInputPane.add_checked_input()
BaseInputPane.add_checkedplus_input()
BaseInputPane.add_combo_input()
BaseInputPane.add_divider_field()
BaseInputPane.add_float_spin_input()
BaseInputPane.add_header()
BaseInputPane.add_info_field()
BaseInputPane.add_int_spin_input()
BaseInputPane.add_select_input()
BaseInputPane.add_spaces()
BaseInputPane.add_text()
BaseInputPane.add_text_area()
BaseInputPane.add_text_field()
BaseInputPane.add_text_input()
BaseInputPane.ensure_active_visible()
BaseInputPane.get_content_height()
BaseInputPane.get_input()
BaseInputPane.get_values()
BaseInputPane.handle_read()
BaseInputPane.immediate_action_cb()
BaseInputPane.move()
BaseInputPane.move_active()
BaseInputPane.move_active_down()
BaseInputPane.move_active_up()
BaseInputPane.render_inputs()
BaseInputPane.visible_content_pane_width
- deluge.ui.console.widgets.popup module
- deluge.ui.console.widgets.sidebar module
- deluge.ui.console.widgets.statusbars module
- deluge.ui.console.widgets.window module
BaseWindow
BaseWindow.__init__()
BaseWindow.add_string()
BaseWindow.draw_scroll_indicator()
BaseWindow.ensure_content_pane_height()
BaseWindow.getmaxyx()
BaseWindow.height
BaseWindow.hidden()
BaseWindow.hide()
BaseWindow.move_window()
BaseWindow.refresh()
BaseWindow.resize_window()
BaseWindow.set_title()
BaseWindow.show()
BaseWindow.visible_content_pane_height
BaseWindow.visible_content_pane_size
BaseWindow.visible_content_pane_width
BaseWindow.width
- Module contents
BaseInputPane
BaseInputPane.add_checked_input()
BaseInputPane.add_checkedplus_input()
BaseInputPane.add_combo_input()
BaseInputPane.add_divider_field()
BaseInputPane.add_float_spin_input()
BaseInputPane.add_header()
BaseInputPane.add_info_field()
BaseInputPane.add_int_spin_input()
BaseInputPane.add_select_input()
BaseInputPane.add_spaces()
BaseInputPane.add_text()
BaseInputPane.add_text_area()
BaseInputPane.add_text_field()
BaseInputPane.add_text_input()
BaseInputPane.ensure_active_visible()
BaseInputPane.get_content_height()
BaseInputPane.get_input()
BaseInputPane.get_values()
BaseInputPane.handle_read()
BaseInputPane.immediate_action_cb()
BaseInputPane.move()
BaseInputPane.move_active()
BaseInputPane.move_active_down()
BaseInputPane.move_active_up()
BaseInputPane.render_inputs()
BaseInputPane.visible_content_pane_width
BaseWindow
BaseWindow.__init__()
BaseWindow.add_string()
BaseWindow.draw_scroll_indicator()
BaseWindow.ensure_content_pane_height()
BaseWindow.getmaxyx()
BaseWindow.height
BaseWindow.hidden()
BaseWindow.hide()
BaseWindow.move_window()
BaseWindow.refresh()
BaseWindow.resize_window()
BaseWindow.set_title()
BaseWindow.show()
BaseWindow.visible_content_pane_height
BaseWindow.visible_content_pane_size
BaseWindow.visible_content_pane_width
BaseWindow.width
StatusBars
Submodules
deluge.ui.console.console module
- class deluge.ui.console.console.Console(*args, **kwargs)
Bases:
UI
- cmd_description = 'Console or command-line user interface'
- start()
- class deluge.ui.console.console.LogStream
Bases:
object
- flush()
- out = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>
- write(data)
- deluge.ui.console.console.load_commands(command_dir)
deluge.ui.console.eventlog module
- class deluge.ui.console.eventlog.EventLog
Bases:
Component
Prints out certain events as they are received from the core.
- on_config_value_changed(key, value)
- on_new_version_available(version)
- on_plugin_disabled(name)
- on_plugin_enabled(name)
- on_session_paused()
- on_session_resumed()
- on_torrent_added(torrent_id, from_state)
- on_torrent_finished(torrent_id)
- on_torrent_removed(torrent_id)
- on_torrent_state_changed(torrent_id, state)
- write(s)
deluge.ui.console.main module
- class deluge.ui.console.main.ConsoleUI(options, cmds, log_stream)
Bases:
Component
,TermResizeHandler
- exec_args(options)
Execute console commands from command line.
- get_torrent_name(torrent_id)
- is_active_mode(mode)
- match_torrent(string)
Returns a list of torrent_id matches for the string. It will search both torrent_ids and torrent names, but will only return torrent_ids.
- Parameters:
string – str, the string to match on
- Returns:
list of matching torrent_ids. Will return an empty list if no matches are found.
- match_torrents(strings)
- on_client_disconnect()
- on_resize(*args)
Handler for SIGWINCH when terminal changes size
- on_torrent_added(event, from_state=False)
- on_torrent_removed(event)
- quit()
- register_mode(mode, set_mode=False)
- run(stdscr)
This method is called by the curses.wrapper to start the mainloop and screen.
- Parameters:
stdscr (_curses.curses window) – curses screen passed in from curses.wrapper.
- set_batch_write(batch)
- set_mode(mode_name, refresh=False)
- start()
- start_components()
- start_console()
- start_ui()
Start the console UI.
- Note: When running console UI reactor.run() will be called which
effectively blocks this function making the return value insignificant. However, when running unit tests, the reacor is replaced by a mock object, leaving the return deferred object necessary for the tests to run properly.
- Returns:
Deferred –
- If valid commands are provided, a deferred that fires when
all commands are executed. Else None is returned.
- switch_mode(func, error_smg)
- tab_complete_path(line, path_type='file', ext='', sort='name', dirs_first=True)
- tab_complete_torrent(line)
- write(s)
- write_event(s)
deluge.ui.console.parser module
- class deluge.ui.console.parser.ConsoleBaseParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)
Bases:
ArgumentParser
- format_help()
Differs from ArgumentParser.format_help by adding the raw epilog as formatted in the string. Default behavior mangles the formatting.
- class deluge.ui.console.parser.ConsoleCommandParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)
Bases:
ConsoleBaseParser
- parse_args(args=None)
Parse known UI args and handle common and process group options.
Notes
If started by deluge entry script this has already been done.
- Parameters:
args (list, optional) – The arguments to parse.
- Returns:
argparse.Namespace – The parsed arguments.
- class deluge.ui.console.parser.OptionParser(**kwargs)
Bases:
ConsoleBaseParser
- error(msg: string)
Print a usage message incorporating ‘msg’ to stderr and exit. If you override this in a subclass, it should not return – it should either exit or raise an exception.
- exit(status=0, msg=None)
- format_help()
Return help formatted with colors.
- print_help(_file=None)
- print_usage(_file=None)
- exception deluge.ui.console.parser.OptionParserError
Bases:
Exception
Module contents
- deluge.ui.console.start()
- deluge.ui.console.test_start()
Entry point for tests
A workaround for unit tests which require a deferred object to be returned to run properly due to mocking the Twisted reactor.