August 2016 - tor-commits - lists.torproject.org

[nyx/master] Basic menu item tests
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit 3d1e6b93f5677de86e61d76ab92e5383aa199a07 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 14 10:15:02 2016 -0700 Basic menu item tests Just a few MenuItem tests to get us started. --- test/__init__.py | 1 + test/menu.py | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) diff --git a/test/__init__.py b/test/__init__.py index f920114..ebb0793 100644 --- a/test/__init__.py +++ b/test/__init__.py @@ -17,6 +17,7 @@ __all__ = [ 'curses', 'installation', 'log', + 'menu', 'panel', 'popups', 'tracker', diff --git a/test/menu.py b/test/menu.py new file mode 100644 index 0000000..f0de66f --- /dev/null +++ b/test/menu.py @@ -0,0 +1,60 @@ +""" +Unit tests for nyx.menu. +""" + +import unittest + +from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup + +NO_OP = lambda: None + + +class TestMenu(unittest.TestCase): + def test_menu_item_parameters(self): + menu_item = MenuItem('Test Item', NO_OP) + + self.assertEqual('', menu_item.prefix) + self.assertEqual('Test Item', menu_item.label) + self.assertEqual('', menu_item.suffix) + self.assertEqual(None, menu_item.parent) + self.assertEqual(menu_item, menu_item.submenu) + + def test_submenu_parameters(self): + menu_item = Submenu('Test Item') + + self.assertEqual('', menu_item.prefix) + self.assertEqual('Test Item', menu_item.label) + self.assertEqual(' >', menu_item.suffix) + self.assertEqual(None, menu_item.parent) + self.assertEqual(menu_item, menu_item.submenu) + + def test_radio_menu_item_parameters(self): + group = RadioGroup(NO_OP, 'selected_item') + menu_item = RadioMenuItem('Test Item', group, 'selected_item') + + self.assertEqual('[X] ', menu_item.prefix) + self.assertEqual('Test Item', menu_item.label) + self.assertEqual('', menu_item.suffix) + self.assertEqual(None, menu_item.parent) + self.assertEqual(menu_item, menu_item.submenu) + + def test_menu_item_hierarchy(self): + root_submenu = Submenu('Root Submenu') + middle_submenu = Submenu('Middle Submenu') + + root_submenu.add(MenuItem('Middle Item 1', NO_OP)) + root_submenu.add(MenuItem('Middle Item 2', NO_OP)) + root_submenu.add(middle_submenu) + + bottom_item = MenuItem('Bottom Item', NO_OP) + middle_submenu.add(bottom_item) + + self.assertEqual(middle_submenu, bottom_item.parent) + self.assertEqual(middle_submenu, bottom_item.submenu) + self.assertEqual(bottom_item, bottom_item.next()) + self.assertEqual(bottom_item, bottom_item.prev()) + + self.assertEqual(root_submenu, middle_submenu.parent) + self.assertEqual(middle_submenu, middle_submenu.submenu) + self.assertEqual('Middle Item 1', middle_submenu.next().label) + self.assertEqual('Middle Item 2', middle_submenu.prev().label)

1 0

[nyx/master] Drop unnecessary redraw when selecting menu item
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit 3d1c6eaf7a4375d2418086f6e770fbc3d5261227 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Aug 22 09:14:50 2016 -0700 Drop unnecessary redraw when selecting menu item Selecting a menu item causes us to close the menu and perform a full redraw. As such, there's no need to perform a second redraw first (... or if there is I haven't spotted it). --- nyx/menu.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index e1f8bf3..b0764fa 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -63,8 +63,6 @@ class MenuItem(object): """ if self._callback: - control = nyx.controller.get_controller() - control.redraw() self._callback() def next(self):

1 0

[nyx/master] Group menu tests by class
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit eae46c6ce9c30155777f59be51a2a53c02673ea5 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 23 13:06:38 2016 -0700 Group menu tests by class On reflection there's no reason we can only have one TestFoo class in a module. Good way of grouping tests by individual classes - I should really improve this all throughout nyx's and stem's tests... Also adding coverage for select(). --- test/menu.py | 86 +++++++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 65 insertions(+), 21 deletions(-) diff --git a/test/menu.py b/test/menu.py index 4b03a40..683b220 100644 --- a/test/menu.py +++ b/test/menu.py @@ -6,11 +6,27 @@ import unittest from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup + +class Container(object): + value = False + + def __nonzero__(self): + return self.value + + +def action(*args): + IS_CALLED.value = True + + NO_OP = lambda: None +IS_CALLED = Container() + +class TestMenuItem(unittest.TestCase): + def setUp(self): + IS_CALLED.value = False -class TestMenu(unittest.TestCase): - def test_menu_item_parameters(self): + def test_parameters(self): menu_item = MenuItem('Test Item', NO_OP) self.assertEqual('', menu_item.prefix) @@ -22,7 +38,37 @@ class TestMenu(unittest.TestCase): self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) - def test_submenu_parameters(self): + def test_selection(self): + menu_item = MenuItem('Test Item', action) + + self.assertFalse(IS_CALLED) + menu_item.select() + self.assertTrue(IS_CALLED) + + def test_menu_item_hierarchy(self): + root_submenu = Submenu('Root Submenu') + middle_submenu = Submenu('Middle Submenu') + + root_submenu.add(MenuItem('Middle Item 1', NO_OP)) + root_submenu.add(MenuItem('Middle Item 2', NO_OP)) + root_submenu.add(middle_submenu) + + bottom_item = MenuItem('Bottom Item', NO_OP) + middle_submenu.add(bottom_item) + + self.assertEqual(middle_submenu, bottom_item.parent) + self.assertEqual(middle_submenu, bottom_item.submenu) + self.assertEqual(bottom_item, bottom_item.next) + self.assertEqual(bottom_item, bottom_item.prev) + + self.assertEqual(root_submenu, middle_submenu.parent) + self.assertEqual(middle_submenu, middle_submenu.submenu) + self.assertEqual('Middle Item 1', middle_submenu.next.label) + self.assertEqual('Middle Item 2', middle_submenu.prev.label) + + +class TestSubmenu(unittest.TestCase): + def test_parameters(self): menu_item = Submenu('Test Item') self.assertEqual('', menu_item.prefix) @@ -34,7 +80,12 @@ class TestMenu(unittest.TestCase): self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) - def test_radio_menu_item_parameters(self): + +class TestRadioMenuItem(unittest.TestCase): + def setUp(self): + IS_CALLED.value = False + + def test_parameters(self): group = RadioGroup(NO_OP, 'selected_item') menu_item = RadioMenuItem('Test Item', group, 'selected_item') @@ -47,23 +98,16 @@ class TestMenu(unittest.TestCase): self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) - def test_menu_item_hierarchy(self): - root_submenu = Submenu('Root Submenu') - middle_submenu = Submenu('Middle Submenu') - - root_submenu.add(MenuItem('Middle Item 1', NO_OP)) - root_submenu.add(MenuItem('Middle Item 2', NO_OP)) - root_submenu.add(middle_submenu) + def test_selection(self): + group = RadioGroup(action, 'other_item') + menu_item = RadioMenuItem('Test Item', group, 'selected_item') - bottom_item = MenuItem('Bottom Item', NO_OP) - middle_submenu.add(bottom_item) + menu_item.select() + self.assertTrue(IS_CALLED) - self.assertEqual(middle_submenu, bottom_item.parent) - self.assertEqual(middle_submenu, bottom_item.submenu) - self.assertEqual(bottom_item, bottom_item.next) - self.assertEqual(bottom_item, bottom_item.prev) + def test_when_already_selected(self): + group = RadioGroup(action, 'selected_item') + menu_item = RadioMenuItem('Test Item', group, 'selected_item') - self.assertEqual(root_submenu, middle_submenu.parent) - self.assertEqual(middle_submenu, middle_submenu.submenu) - self.assertEqual('Middle Item 1', middle_submenu.next.label) - self.assertEqual('Middle Item 2', middle_submenu.prev.label) + menu_item.select() + self.assertFalse(IS_CALLED)

1 0

[nyx/master] Use standard callback for radio menu items
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit cde8a21cdd5d80d7bc5093df9f9e7669233b42ea Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Aug 22 09:22:45 2016 -0700 Use standard callback for radio menu items Without the redraw there's now nothing special about RadioMenuItem compared to its parent. We can just set the callback attribute to make this simple. --- nyx/menu.py | 24 ++++-------------------- 1 file changed, 4 insertions(+), 20 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index b0764fa..f137535 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -148,33 +148,17 @@ class Submenu(MenuItem): class RadioMenuItem(MenuItem): """ - Menu item with an associated group which determines the selection. This is - for the common single argument getter/setter pattern. + Menu item with an associated group which determines the selection. """ def __init__(self, label, group, arg): - MenuItem.__init__(self, label, None) + MenuItem.__init__(self, label, lambda: group.action(arg)) self._group = group self._arg = arg @property def prefix(self): - return '[X] ' if self.is_selected() else '[ ] ' - - def is_selected(self): - """ - True if we're the selected item, false otherwise. - """ - - return self._arg == self._group.selected_arg - - def select(self): - """ - Performs the group's setter action with our argument. - """ - - if not self.is_selected(): - self._group.action(self._arg) + return '[X] ' if self._arg == self._group.selected_arg else '[ ] ' class RadioGroup(object): @@ -183,7 +167,7 @@ class RadioGroup(object): """ def __init__(self, action, selected_arg): - self.action = action + self.action = lambda arg: action(arg) if arg != self.selected_arg else None self.selected_arg = selected_arg

1 0

[nyx/master] Make next and prev attributes
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit 576f00167e8497e3fe4910d8b3f7ea790a50ce13 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Aug 22 10:32:19 2016 -0700 Make next and prev attributes Making these attributes so it matches parent and the rest. --- nyx/menu.py | 62 ++++++++++++++++++++++++------------------------------------ test/menu.py | 17 +++++++++++++---- 2 files changed, 38 insertions(+), 41 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index f137535..40b3495 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -34,6 +34,8 @@ class MenuItem(object): :var str label: text we display :var str suffix: text after our label + :var MenuItem next: menu item after this one + :var MenuItem prev: menu item before this one :var Submenu parent: submenu we reside within :var Submenu submenu: top-level submenu we reside within """ @@ -50,6 +52,14 @@ class MenuItem(object): return '' @property + def next(self): + return self._sibling(1) + + @property + def prev(self): + return self._sibling(-1) + + @property def parent(self): return self._parent @@ -65,45 +75,23 @@ class MenuItem(object): if self._callback: self._callback() - def next(self): - """ - Provides the next option for the submenu we're in, raising a ValueError - if we don't have a parent. - """ - - return self._get_sibling(1) - - def prev(self): + def _sibling(self, offset): """ - Provides the previous option for the submenu we're in, raising a ValueError - if we don't have a parent. + Provides sibling with a given offset from us. """ - return self._get_sibling(-1) + if not self._parent: + return None - def _get_sibling(self, offset): - """ - Provides our sibling with a given index offset from us, raising a - ValueError if we don't have a parent. + my_siblings = self._parent.get_children() - Arguments: - offset - index offset for the sibling to be returned - """ - - if self._parent: - my_siblings = self._parent.get_children() + try: + my_index = my_siblings.index(self) + return my_siblings[(my_index + offset) % len(my_siblings)] + except ValueError: + # submenus and children should have bidirectional references - try: - my_index = my_siblings.index(self) - return my_siblings[(my_index + offset) % len(my_siblings)] - except ValueError: - # We expect a bidirectional references between submenus and their - # children. If we don't have this then our menu's screwed up. - - msg = "The '%s' submenu doesn't contain '%s' (children: '%s')" % (self, self._parent, "', '".join(my_siblings)) - raise ValueError(msg) - else: - raise ValueError("Menu option '%s' doesn't have a parent" % self) + raise ValueError("BUG: The '%s' submenu doesn't contain '%s' (children: '%s')" % (self._parent, self.label, "', '".join(my_siblings))) class Submenu(MenuItem): @@ -488,14 +476,14 @@ class MenuCursor: self._selection.select() self._is_done = True elif key.match('up'): - self._selection = self._selection.prev() + self._selection = self._selection.prev elif key.match('down'): - self._selection = self._selection.next() + self._selection = self._selection.next elif key.match('left'): if self._selection.parent == self._selection.submenu: # shift to the previous main submenu - prev_submenu = self._selection.submenu.prev() + prev_submenu = self._selection.submenu.prev self._selection = prev_submenu.get_children()[0] else: # go up a submenu level @@ -510,7 +498,7 @@ class MenuCursor: else: # shift to the next main submenu - next_submenu = self._selection.submenu.next() + next_submenu = self._selection.submenu.next self._selection = next_submenu.get_children()[0] elif key.match('esc', 'm'): self._is_done = True diff --git a/test/menu.py b/test/menu.py index f0de66f..4b03a40 100644 --- a/test/menu.py +++ b/test/menu.py @@ -16,6 +16,9 @@ class TestMenu(unittest.TestCase): self.assertEqual('', menu_item.prefix) self.assertEqual('Test Item', menu_item.label) self.assertEqual('', menu_item.suffix) + + self.assertEqual(None, menu_item.next) + self.assertEqual(None, menu_item.prev) self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) @@ -25,6 +28,9 @@ class TestMenu(unittest.TestCase): self.assertEqual('', menu_item.prefix) self.assertEqual('Test Item', menu_item.label) self.assertEqual(' >', menu_item.suffix) + + self.assertEqual(None, menu_item.next) + self.assertEqual(None, menu_item.prev) self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) @@ -35,6 +41,9 @@ class TestMenu(unittest.TestCase): self.assertEqual('[X] ', menu_item.prefix) self.assertEqual('Test Item', menu_item.label) self.assertEqual('', menu_item.suffix) + + self.assertEqual(None, menu_item.next) + self.assertEqual(None, menu_item.prev) self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) @@ -51,10 +60,10 @@ class TestMenu(unittest.TestCase): self.assertEqual(middle_submenu, bottom_item.parent) self.assertEqual(middle_submenu, bottom_item.submenu) - self.assertEqual(bottom_item, bottom_item.next()) - self.assertEqual(bottom_item, bottom_item.prev()) + self.assertEqual(bottom_item, bottom_item.next) + self.assertEqual(bottom_item, bottom_item.prev) self.assertEqual(root_submenu, middle_submenu.parent) self.assertEqual(middle_submenu, middle_submenu.submenu) - self.assertEqual('Middle Item 1', middle_submenu.next().label) - self.assertEqual('Middle Item 2', middle_submenu.prev().label) + self.assertEqual('Middle Item 1', middle_submenu.next.label) + self.assertEqual('Middle Item 2', middle_submenu.prev.label)

1 0

[nyx/master] Replace Submenu's get_children() with property
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit 64b5de2ebafbeae7a1a81df7d739832fea0d49ac Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 23 13:18:32 2016 -0700 Replace Submenu's get_children() with property Like parent, next, prev, and other hierarchical methods making parent an attribute. Might as well get rid of is_empty() too. --- nyx/menu.py | 56 ++++++++++++++++++++++---------------------------------- test/menu.py | 21 +++++++++++++++++++++ 2 files changed, 43 insertions(+), 34 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index 40b3495..f086ae7 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -83,7 +83,7 @@ class MenuItem(object): if not self._parent: return None - my_siblings = self._parent.get_children() + my_siblings = self._parent.children try: my_index = my_siblings.index(self) @@ -97,41 +97,29 @@ class MenuItem(object): class Submenu(MenuItem): """ Menu item that lists other menu options. + + :var list children: menu items this contains """ def __init__(self, label): MenuItem.__init__(self, label, None) self.suffix = ' >' - self._children = [] + self.children = [] def add(self, menu_item): """ - Adds the given menu item to our listing. This raises a ValueError if the - item already has a parent. + Adds the given menu item to our listing. + + :param MenuItem menu_item: menu item to be added - Arguments: - menu_item - menu option to be added + :raises: **ValueError** if the item is already in a submenu """ if menu_item.parent: raise ValueError("Menu option '%s' already has a parent" % menu_item) - else: - menu_item._parent = self - self._children.append(menu_item) - - def get_children(self): - """ - Provides the menu and submenus we contain. - """ - - return list(self._children) - - def is_empty(self): - """ - True if we have no children, false otherwise. - """ - return not bool(self._children) + menu_item._parent = self + self.children.append(menu_item) class RadioMenuItem(MenuItem): @@ -470,8 +458,8 @@ class MenuCursor: if key.is_selection(): if is_selection_submenu: - if not self._selection.is_empty(): - self._selection = self._selection.get_children()[0] + if self._selection.children: + self._selection = self._selection.children[0] else: self._selection.select() self._is_done = True @@ -484,7 +472,7 @@ class MenuCursor: # shift to the previous main submenu prev_submenu = self._selection.submenu.prev - self._selection = prev_submenu.get_children()[0] + self._selection = prev_submenu.children[0] else: # go up a submenu level @@ -493,13 +481,13 @@ class MenuCursor: if is_selection_submenu: # open submenu (same as making a selection) - if not self._selection.is_empty(): - self._selection = self._selection.get_children()[0] + if self._selection.children: + self._selection = self._selection.children[0] else: # shift to the next main submenu next_submenu = self._selection.submenu.next - self._selection = next_submenu.get_children()[0] + self._selection = next_submenu.children[0] elif key.match('esc', 'm'): self._is_done = True @@ -510,7 +498,7 @@ def show_menu(): def _render(subwindow): x = 0 - for top_level_item in menu.get_children(): + for top_level_item in menu.children: if top_level_item == cursor.get_selection().submenu: selection_left[0] = x attr = UNDERLINE @@ -526,7 +514,7 @@ def show_menu(): # the file menu menu = make_menu() - cursor = MenuCursor(menu.get_children()[0].get_children()[0]) + cursor = MenuCursor(menu.children[0].children[0]) while not cursor.is_done(): # provide a message saying how to close the menu @@ -564,7 +552,7 @@ def _draw_submenu(cursor, level, top, left): # gets the size of the prefix, middle, and suffix columns - all_label_sets = [(entry.prefix, entry.label, entry.suffix) for entry in submenu.get_children()] + all_label_sets = [(entry.prefix, entry.label, entry.suffix) for entry in submenu.children] prefix_col_size = max([len(entry[0]) for entry in all_label_sets]) middle_col_size = max([len(entry[1]) for entry in all_label_sets]) suffix_col_size = max([len(entry[2]) for entry in all_label_sets]) @@ -573,15 +561,15 @@ def _draw_submenu(cursor, level, top, left): label_format = ' %%-%is%%-%is%%-%is ' % (prefix_col_size, middle_col_size, suffix_col_size) menu_width = len(label_format % ('', '', '')) - selection_top = submenu.get_children().index(selection) if selection in submenu.get_children() else 0 + selection_top = submenu.children.index(selection) if selection in submenu.children else 0 def _render(subwindow): - for y, menu_item in enumerate(submenu.get_children()): + for y, menu_item in enumerate(submenu.children): if menu_item == selection: subwindow.addstr(0, y, label_format % (menu_item.prefix, menu_item.label, menu_item.suffix), WHITE, BOLD) else: subwindow.addstr(0, y, label_format % (menu_item.prefix, menu_item.label, menu_item.suffix)) with nyx.curses.CURSES_LOCK: - nyx.curses.draw(_render, top = top, left = left, width = menu_width, height = len(submenu.get_children()), background = RED) + nyx.curses.draw(_render, top = top, left = left, width = menu_width, height = len(submenu.children), background = RED) _draw_submenu(cursor, level + 1, top + selection_top, left + menu_width) diff --git a/test/menu.py b/test/menu.py index 683b220..f3c0143 100644 --- a/test/menu.py +++ b/test/menu.py @@ -80,6 +80,27 @@ class TestSubmenu(unittest.TestCase): self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) + def test_add(self): + submenu = Submenu('Menu') + item_1 = MenuItem('Test Item 1', NO_OP) + item_2 = MenuItem('Test Item 2', NO_OP) + + self.assertEqual([], submenu.children) + + submenu.add(item_1) + self.assertEqual([item_1], submenu.children) + + submenu.add(item_2) + self.assertEqual([item_1, item_2], submenu.children) + + def test_add_raises_when_already_in_menu(self): + submenu_1 = Submenu('Menu 1') + submenu_2 = Submenu('Menu 2') + item = MenuItem('Test Item', NO_OP) + + submenu_1.add(item) + self.assertRaises(ValueError, submenu_2.add, item) + class TestRadioMenuItem(unittest.TestCase): def setUp(self):

1 0

[nyx/master] Move submenus to panels
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit c9467743eb00f282c36677ef37d6dda5e23856be Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 09:55:55 2016 -0700 Move submenus to panels Now that constructing submenus is so much simpler this fits a lot better in the Panel subclasses. This is a great simplification for the panels as well as the menu module sincel it lets us make numerous attributes and functions private. --- nyx/controller.py | 7 +-- nyx/menu.py | 141 ++---------------------------------------------- nyx/panel/__init__.py | 11 ++++ nyx/panel/config.py | 24 +++++++-- nyx/panel/connection.py | 24 ++++++++- nyx/panel/graph.py | 97 ++++++++++++++++----------------- nyx/panel/log.py | 75 +++++++++++++------------- nyx/panel/torrc.py | 43 ++++++++------- 8 files changed, 163 insertions(+), 259 deletions(-) diff --git a/nyx/controller.py b/nyx/controller.py index 8040e7e..bf7a22d 100644 --- a/nyx/controller.py +++ b/nyx/controller.py @@ -372,9 +372,7 @@ def start_nyx(): for panel_impl in control.get_all_panels(): panel_impl.set_visible(panel_impl in display_panels) - # redraws the interface if it's needed - - control.redraw(False) + control.redraw() with nyx.curses.raw_screen() as stdscr: stdscr.refresh() @@ -419,9 +417,6 @@ def start_nyx(): log.error('Error detected when reloading tor: %s' % exc.strerror) elif key.match('h'): override_key = nyx.popups.show_help() - elif key == ord('l') - 96: - # force redraw when ctrl+l is pressed - control.redraw(True) else: for panel_impl in display_panels: for keybinding in panel_impl.key_handlers(): diff --git a/nyx/menu.py b/nyx/menu.py index b0fb646..ed58613 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -10,16 +10,8 @@ import functools import nyx.controller import nyx.curses import nyx.popups -import nyx.panel.config -import nyx.panel.connection -import nyx.panel.graph -import nyx.panel.log -import nyx.panel.torrc -import nyx.controller -import nyx.tracker import stem -import stem.util.connection from nyx import tor_controller from nyx.curses import RED, WHITE, NORMAL, BOLD, UNDERLINE @@ -182,17 +174,11 @@ def make_menu(): root_menu.add(_view_menu()) - for page_panel in nyx_controller.get_display_panels(): - if isinstance(page_panel, nyx.panel.graph.GraphPanel): - root_menu.add(_graph_menu(page_panel)) - elif isinstance(page_panel, nyx.panel.log.LogPanel): - root_menu.add(_log_menu(page_panel)) - elif isinstance(page_panel, nyx.panel.connection.ConnectionPanel): - root_menu.add(_connections_menu(page_panel)) - elif isinstance(page_panel, nyx.panel.config.ConfigPanel): - root_menu.add(_configuration_menu(page_panel)) - elif isinstance(page_panel, nyx.panel.torrc.TorrcPanel): - root_menu.add(_torrc_menu(page_panel)) + for panel in nyx_controller.get_display_panels(): + submenu = panel.submenu() + + if submenu: + root_menu.add(submenu) root_menu.add(Submenu('Help', [ MenuItem('Hotkeys', nyx.popups.show_help), @@ -233,123 +219,6 @@ def _view_menu(): return view_menu -def _graph_menu(graph_panel): - """ - Graph panel submenu consisting of... - - [X] <Stat 1> - [ ] <Stat 2> - [ ] <Stat 2> - Resize... - Interval (Submenu) - Bounds (Submenu) - """ - - stat_group = RadioGroup(functools.partial(setattr, graph_panel, 'displayed_stat'), graph_panel.displayed_stat) - interval_group = RadioGroup(functools.partial(setattr, graph_panel, 'update_interval'), graph_panel.update_interval) - bounds_group = RadioGroup(functools.partial(setattr, graph_panel, 'bounds_type'), graph_panel.bounds_type) - - return Submenu('Graph', [ - RadioMenuItem('None', stat_group, None), - [RadioMenuItem(str_tools._to_camel_case(opt, divider = ' '), stat_group, opt) for opt in sorted(graph_panel.stat_options())], - MenuItem('Resize...', graph_panel.resize_graph), - Submenu('Interval', [RadioMenuItem(opt, interval_group, opt) for opt in nyx.panel.graph.Interval]), - Submenu('Bounds', [RadioMenuItem(opt, bounds_group, opt) for opt in nyx.panel.graph.Bounds]), - ]) - - -def _log_menu(log_panel): - """ - Log panel submenu consisting of... - - Events... - Snapshot... - Clear - Show / Hide Duplicates - Filter (Submenu) - """ - - log_filter = log_panel.get_filter() - filter_group = RadioGroup(log_filter.select, log_filter.selection()) - - if not log_panel.is_duplicates_visible(): - duplicate_item = MenuItem('Show Duplicates', log_panel.set_duplicate_visability, True) - else: - duplicate_item = MenuItem('Hide Duplicates', log_panel.set_duplicate_visability, False) - - return Submenu('Log', [ - MenuItem('Events...', log_panel.show_event_selection_prompt), - MenuItem('Snapshot...', log_panel.show_snapshot_prompt), - MenuItem('Clear', log_panel.clear), - duplicate_item, - Submenu('Filter', [ - RadioMenuItem('None', filter_group, None), - [RadioMenuItem(opt, filter_group, opt) for opt in log_filter.latest_selections()], - MenuItem('New...', log_panel.show_filter_prompt), - ]), - ]) - - -def _connections_menu(conn_panel): - """ - Connection panel submenu consisting of... - - Sorting... - Resolver (Submenu) - """ - - tracker = nyx.tracker.get_connection_tracker() - resolver_group = RadioGroup(tracker.set_custom_resolver, tracker.get_custom_resolver()) - - return Submenu('Connections', [ - MenuItem('Sorting...', conn_panel.show_sort_dialog), - Submenu('Resolver', [ - RadioMenuItem('auto', resolver_group, None), - [RadioMenuItem(opt, resolver_group, opt) for opt in stem.util.connection.Resolver], - ]), - ]) - - -def _configuration_menu(config_panel): - """ - Configuration panel submenu consisting of... - - Save Config... - Sorting... - Filter / Unfilter Options - """ - - return Submenu('Configuration', [ - MenuItem('Save Config...', config_panel.show_write_dialog), - MenuItem('Sorting...', config_panel.show_sort_dialog), - ]) - - -def _torrc_menu(torrc_panel): - """ - Torrc panel submenu consisting of... - - Reload - Show / Hide Comments - Show / Hide Line Numbers - """ - - if not torrc_panel._show_comments: - comments_item = MenuItem('Show Comments', torrc_panel.set_comments_visible, True) - else: - comments_item = MenuItem('Hide Comments', torrc_panel.set_comments_visible, False) - - if not torrc_panel._show_line_numbers: - line_number_item = MenuItem('Show Line Numbers', torrc_panel.set_line_number_visible, True) - else: - line_number_item = MenuItem('Hide Line Numbers', torrc_panel.set_line_number_visible, False) - - return Submenu('Torrc', [ - comments_item, - line_number_item, - ]) - - class MenuCursor: """ Tracks selection and key handling in the menu. diff --git a/nyx/panel/__init__.py b/nyx/panel/__init__.py index decb276..18a66ce 100644 --- a/nyx/panel/__init__.py +++ b/nyx/panel/__init__.py @@ -22,6 +22,7 @@ Panels consisting the nyx interface. | |- set_visible - toggles panel visiblity |- key_handlers - keyboard input accepted by the panel + |- submenu - submenu for the panel +- redraw - renders the panel content """ @@ -139,6 +140,16 @@ class Panel(object): return () + def submenu(self): + """ + Provides submenu to include when the panel is shown. + + :returns: :class:`~nyx.menu.Submenu` with the panel's options or **None** + if no submenu should be shown + """ + + return None + def redraw(self, force = True): """ Renders our panel's content to the screen. diff --git a/nyx/panel/config.py b/nyx/panel/config.py index 7640b99..424586c 100644 --- a/nyx/panel/config.py +++ b/nyx/panel/config.py @@ -16,8 +16,10 @@ import nyx.popups import stem.control import stem.manual +import stem.util.connection from nyx.curses import WHITE, NORMAL, BOLD, HIGHLIGHT +from nyx.menu import MenuItem, Submenu from nyx import DATA_DIR, tor_controller from stem.util import conf, enum, log, str_tools @@ -169,7 +171,7 @@ class ConfigPanel(nyx.panel.Panel): except stem.ControllerError as exc: log.warn('Unable to determine the configuration options tor supports: %s' % exc) - def show_sort_dialog(self): + def _show_sort_dialog(self): """ Provides the dialog for sorting our configuration options. """ @@ -181,7 +183,7 @@ class ConfigPanel(nyx.panel.Panel): self._sort_order = results self._contents = sorted(self._contents, key = lambda entry: [entry.sort_value(field) for field in self._sort_order]) - def show_write_dialog(self): + def _show_write_dialog(self): """ Confirmation dialog for saving tor's configuration. """ @@ -235,11 +237,25 @@ class ConfigPanel(nyx.panel.Panel): return ( nyx.panel.KeyHandler('arrows', 'scroll up and down', _scroll, key_func = lambda key: key.is_scroll()), nyx.panel.KeyHandler('enter', 'edit configuration option', _edit_selected_value, key_func = lambda key: key.is_selection()), - nyx.panel.KeyHandler('w', 'write torrc', self.show_write_dialog), + nyx.panel.KeyHandler('w', 'write torrc', self._show_write_dialog), nyx.panel.KeyHandler('a', 'toggle filtering', _toggle_show_all), - nyx.panel.KeyHandler('s', 'sort ordering', self.show_sort_dialog), + nyx.panel.KeyHandler('s', 'sort ordering', self._show_sort_dialog), ) + def submenu(self): + """ + Submenu consisting of... + + Save Config... + Sorting... + Filter / Unfilter Options + """ + + return Submenu('Configuration', [ + MenuItem('Save Config...', self._show_write_dialog), + MenuItem('Sorting...', self._show_sort_dialog), + ]) + def _draw(self, subwindow): contents = self._get_config_options() selected, scroll = self._scroller.selection(contents, subwindow.height - DETAILS_HEIGHT) diff --git a/nyx/panel/connection.py b/nyx/panel/connection.py index afcf457..d30742f 100644 --- a/nyx/panel/connection.py +++ b/nyx/panel/connection.py @@ -18,6 +18,7 @@ import nyx.popups import nyx.tracker from nyx.curses import WHITE, NORMAL, BOLD, HIGHLIGHT +from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup from nyx import tor_controller from stem.control import Listener @@ -296,7 +297,7 @@ class ConnectionPanel(nyx.panel.DaemonPanel): locale, count = entry.split('=', 1) self._client_locale_usage[locale] = int(count) - def show_sort_dialog(self): + def _show_sort_dialog(self): """ Provides a dialog for sorting our connections. """ @@ -384,7 +385,7 @@ class ConnectionPanel(nyx.panel.DaemonPanel): nyx.panel.KeyHandler('arrows', 'scroll up and down', _scroll, key_func = lambda key: key.is_scroll()), nyx.panel.KeyHandler('enter', 'show connection details', _show_details, key_func = lambda key: key.is_selection()), nyx.panel.KeyHandler('d', 'raw consensus descriptor', _show_descriptor), - nyx.panel.KeyHandler('s', 'sort ordering', self.show_sort_dialog), + nyx.panel.KeyHandler('s', 'sort ordering', self._show_sort_dialog), nyx.panel.KeyHandler('r', 'connection resolver', _pick_connection_resolver, 'auto' if resolver is None else resolver), ] @@ -396,6 +397,25 @@ class ConnectionPanel(nyx.panel.DaemonPanel): return tuple(options) + def submenu(self): + """ + Submenu consisting of... + + Sorting... + Resolver (Submenu) + """ + + tracker = nyx.tracker.get_connection_tracker() + resolver_group = RadioGroup(tracker.set_custom_resolver, tracker.get_custom_resolver()) + + return Submenu('Connections', [ + MenuItem('Sorting...', self._show_sort_dialog), + Submenu('Resolver', [ + RadioMenuItem('auto', resolver_group, None), + [RadioMenuItem(opt, resolver_group, opt) for opt in connection.Resolver], + ]), + ]) + def _draw(self, subwindow): controller = tor_controller() nyx_controller = nyx.controller.get_controller() diff --git a/nyx/panel/graph.py b/nyx/panel/graph.py index 9dd3244..492037e 100644 --- a/nyx/panel/graph.py +++ b/nyx/panel/graph.py @@ -15,6 +15,7 @@ Downloaded (0.0 B/sec): Uploaded (0.0 B/sec): """ import copy +import functools import time import nyx.controller @@ -25,6 +26,7 @@ import nyx.tracker from nyx import join, msg, tor_controller from nyx.curses import RED, GREEN, CYAN, BOLD, HIGHLIGHT +from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup from stem.control import EventType, Listener from stem.util import conf, enum, log, str_tools, system @@ -413,7 +415,7 @@ class GraphPanel(nyx.panel.Panel): self._displayed_stat = None if CONFIG['features.graph.type'] == 'none' else CONFIG['features.graph.type'] self._update_interval = CONFIG['features.graph.interval'] - self._bounds = CONFIG['features.graph.bound'] + self._bounds_type = CONFIG['features.graph.bound'] self._graph_height = CONFIG['features.graph.height'] self._accounting_stats = None @@ -437,42 +439,9 @@ class GraphPanel(nyx.panel.Panel): controller.add_event_listener(self._update_stats, EventType.BW) controller.add_status_listener(lambda *args: self.redraw()) - @property - def displayed_stat(self): - return self._displayed_stat - - @displayed_stat.setter - def displayed_stat(self, value): - if value is not None and value not in self._stats.keys(): - raise ValueError("%s isn't a graphed statistic" % value) - - self._displayed_stat = value - def stat_options(self): return self._stats.keys() - @property - def update_interval(self): - return self._update_interval - - @update_interval.setter - def update_interval(self, value): - if value not in Interval: - raise ValueError("%s isn't a valid graphing update interval" % value) - - self._update_interval = value - - @property - def bounds_type(self): - return self._bounds - - @bounds_type.setter - def bounds_type(self, value): - if value not in Bounds: - raise ValueError("%s isn't a valid type of bounds" % value) - - self._bounds = value - def get_height(self): """ Provides the height of the content. @@ -480,14 +449,14 @@ class GraphPanel(nyx.panel.Panel): max_height = nyx.panel.Panel.get_height(self) - if not self.displayed_stat: + if not self._displayed_stat: return 0 nyx_controller = nyx.controller.get_controller() height = DEFAULT_CONTENT_HEIGHT + self._graph_height accounting_stats = self._accounting_stats if nyx_controller.is_paused() else self._accounting_stats_paused - if self.displayed_stat == GraphStat.BANDWIDTH and accounting_stats: + if self._displayed_stat == GraphStat.BANDWIDTH and accounting_stats: height += 3 return min(max_height, height) @@ -495,7 +464,7 @@ class GraphPanel(nyx.panel.Panel): def set_graph_height(self, new_graph_height): self._graph_height = max(1, new_graph_height) - def resize_graph(self): + def _resize_graph(self): """ Prompts for user input to resize the graph panel. Options include... @@ -534,48 +503,72 @@ class GraphPanel(nyx.panel.Panel): def _pick_stats(): available_stats = sorted(self.stat_options()) options = ['None'] + [stat.capitalize() for stat in available_stats] - previous_selection = options[available_stats.index(self.displayed_stat) + 1] if self.displayed_stat else 'None' + previous_selection = options[available_stats.index(self._displayed_stat) + 1] if self._displayed_stat else 'None' selection = nyx.popups.select_from_list('Graphed Stats:', options, previous_selection) - self.displayed_stat = None if selection == 'None' else available_stats[options.index(selection) - 1] + self._displayed_stat = None if selection == 'None' else available_stats[options.index(selection) - 1] def _next_bounds(): - self.bounds_type = Bounds.next(self.bounds_type) + self._bounds_type = Bounds.next(self._bounds_type) self.redraw() def _pick_interval(): - self.update_interval = nyx.popups.select_from_list('Update Interval:', list(Interval), self.update_interval) + self._update_interval = nyx.popups.select_from_list('Update Interval:', list(Interval), self._update_interval) self.redraw() return ( - nyx.panel.KeyHandler('g', 'resize graph', self.resize_graph), - nyx.panel.KeyHandler('s', 'graphed stats', _pick_stats, self.displayed_stat if self.displayed_stat else 'none'), - nyx.panel.KeyHandler('b', 'graph bounds', _next_bounds, self.bounds_type.replace('_', ' ')), - nyx.panel.KeyHandler('i', 'graph update interval', _pick_interval, self.update_interval), + nyx.panel.KeyHandler('g', 'resize graph', self._resize_graph), + nyx.panel.KeyHandler('s', 'graphed stats', _pick_stats, self._displayed_stat if self._displayed_stat else 'none'), + nyx.panel.KeyHandler('b', 'graph bounds', _next_bounds, self._bounds_type.replace('_', ' ')), + nyx.panel.KeyHandler('i', 'graph update interval', _pick_interval, self._update_interval), ) + def submenu(self): + """ + Submenu consisting of... + + [X] <Stat 1> + [ ] <Stat 2> + [ ] <Stat 2> + Resize... + Interval (Submenu) + Bounds (Submenu) + """ + + stat_group = RadioGroup(functools.partial(setattr, self, '_displayed_stat'), self._displayed_stat) + interval_group = RadioGroup(functools.partial(setattr, self, '_update_interval'), self._update_interval) + bounds_group = RadioGroup(functools.partial(setattr, self, '_bounds_type'), self._bounds_type) + + return Submenu('Graph', [ + RadioMenuItem('None', stat_group, None), + [RadioMenuItem(str_tools._to_camel_case(opt, divider = ' '), stat_group, opt) for opt in sorted(self.stat_options())], + MenuItem('Resize...', self._resize_graph), + Submenu('Interval', [RadioMenuItem(opt, interval_group, opt) for opt in Interval]), + Submenu('Bounds', [RadioMenuItem(opt, bounds_group, opt) for opt in Bounds]), + ]) + def set_paused(self, is_pause): if is_pause: self._accounting_stats_paused = copy.copy(self._accounting_stats) self._stats_paused = dict([(key, type(self._stats[key])(self._stats[key])) for key in self._stats]) def _draw(self, subwindow): - if not self.displayed_stat: + if not self._displayed_stat: return nyx_controller = nyx.controller.get_controller() if not nyx_controller.is_paused(): - stat = self._stats[self.displayed_stat] + stat = self._stats[self._displayed_stat] accounting_stats = self._accounting_stats else: - stat = self._stats_paused[self.displayed_stat] + stat = self._stats_paused[self._displayed_stat] accounting_stats = self._accounting_stats_paused stat = type(stat)(stat) # clone the GraphCategory subgraph_height = self._graph_height + 2 # graph rows + header + x-axis label subgraph_width = min(subwindow.width / 2, CONFIG['features.graph.max_width']) - interval, bounds_type = self.update_interval, self.bounds_type + interval, bounds_type = self._update_interval, self._bounds_type subwindow.addstr(0, 0, stat.title(subwindow.width), HIGHLIGHT) @@ -604,9 +597,9 @@ class GraphPanel(nyx.panel.Panel): for stat in self._stats.values(): stat.bandwidth_event(event) - if self.displayed_stat: - param = self._stats[self.displayed_stat] - update_rate = INTERVAL_SECONDS[self.update_interval] + if self._displayed_stat: + param = self._stats[self._displayed_stat] + update_rate = INTERVAL_SECONDS[self._update_interval] if param.primary.tick % update_rate == 0: self.redraw() diff --git a/nyx/panel/log.py b/nyx/panel/log.py index 502e383..ec9e238 100644 --- a/nyx/panel/log.py +++ b/nyx/panel/log.py @@ -7,6 +7,7 @@ for. This provides prepopulation from the log file and supports filtering by regular expressions. """ +import functools import os import time @@ -21,6 +22,7 @@ import nyx.log from nyx import join, tor_controller from nyx.curses import GREEN, YELLOW, WHITE, NORMAL, BOLD, HIGHLIGHT +from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup from stem.util import conf, log @@ -111,33 +113,7 @@ class LogPanel(nyx.panel.DaemonPanel): NYX_LOGGER.emit = self._register_nyx_event - def is_duplicates_visible(self): - """ - Checks if duplicate log entries are collapsed or not. - - :returns: **True** if duplicates are shown and **False** otherwise - """ - - return self._show_duplicates - - def set_duplicate_visability(self, is_visible): - """ - Sets if duplicate log entries are collaped or expanded. - - :param bool is_visible: if **True** all log entries are shown, otherwise - they're deduplicated - """ - - self._show_duplicates = is_visible - - def get_filter(self): - """ - Provides our currently selected regex filter. - """ - - return self._filter - - def show_filter_prompt(self): + def _show_filter_prompt(self): """ Prompts the user to add a new regex filter. """ @@ -147,10 +123,9 @@ class LogPanel(nyx.panel.DaemonPanel): if regex_input: self._filter.select(regex_input) - def show_event_selection_prompt(self): + def _show_event_selection_prompt(self): """ Prompts the user to select the events being listened for. - TODO: Replace show_event_selection_prompt() with this method. """ event_types = nyx.popups.select_event_types(self._event_types) @@ -159,7 +134,7 @@ class LogPanel(nyx.panel.DaemonPanel): self._event_types = nyx.log.listen_for_events(self._register_tor_event, event_types) self.redraw() - def show_snapshot_prompt(self): + def _show_snapshot_prompt(self): """ Lets user enter a path to take a snapshot, canceling if left blank. """ @@ -173,7 +148,7 @@ class LogPanel(nyx.panel.DaemonPanel): except IOError as exc: nyx.controller.show_message('Unable to save snapshot: %s' % exc, HIGHLIGHT, max_wait = 2) - def clear(self): + def _clear(self): """ Clears the contents of the event log. """ @@ -231,12 +206,12 @@ class LogPanel(nyx.panel.DaemonPanel): if selection == 'None': self._filter.select(None) elif selection == 'New...': - self.show_filter_prompt() # prompt user to input regular expression + self._show_filter_prompt() # prompt user to input regular expression else: self._filter.select(selection) def _toggle_deduplication(): - self.set_duplicate_visability(not self.is_duplicates_visible()) + self._show_duplicates = not self._show_duplicates self.redraw() def _clear_log(): @@ -244,17 +219,43 @@ class LogPanel(nyx.panel.DaemonPanel): key_press = nyx.controller.show_message(msg, BOLD, max_wait = 30) if key_press.match('c'): - self.clear() + self._clear() return ( nyx.panel.KeyHandler('arrows', 'scroll up and down', _scroll, key_func = lambda key: key.is_scroll()), - nyx.panel.KeyHandler('a', 'save snapshot of the log', self.show_snapshot_prompt), - nyx.panel.KeyHandler('e', 'change logged events', self.show_event_selection_prompt), + nyx.panel.KeyHandler('a', 'save snapshot of the log', self._show_snapshot_prompt), + nyx.panel.KeyHandler('e', 'change logged events', self._show_event_selection_prompt), nyx.panel.KeyHandler('f', 'log regex filter', _pick_filter, 'enabled' if self._filter.selection() else 'disabled'), - nyx.panel.KeyHandler('u', 'duplicate log entries', _toggle_deduplication, 'visible' if self.is_duplicates_visible() else 'hidden'), + nyx.panel.KeyHandler('u', 'duplicate log entries', _toggle_deduplication, 'visible' if self._show_duplicates else 'hidden'), nyx.panel.KeyHandler('c', 'clear event log', _clear_log), ) + def submenu(self): + """ + Submenu consisting of... + + Events... + Snapshot... + Clear + Show / Hide Duplicates + Filter (Submenu) + """ + + filter_group = RadioGroup(self._filter.select, self._filter.selection()) + duplicates_label, duplicates_arg = ('Hide Duplicates', False) if self._show_duplicates else ('Show Duplicates', True) + + return Submenu('Log', [ + MenuItem('Events...', self._show_event_selection_prompt), + MenuItem('Snapshot...', self._show_snapshot_prompt), + MenuItem('Clear', self._clear), + MenuItem(duplicates_label, functools.partial(setattr, self, '_show_duplicates'), duplicates_arg), + Submenu('Filter', [ + RadioMenuItem('None', filter_group, None), + [RadioMenuItem(opt, filter_group, opt) for opt in self._filter.latest_selections()], + MenuItem('New...', self._show_filter_prompt), + ]), + ]) + def set_paused(self, is_pause): if is_pause: self._event_log_paused = self._event_log.clone() diff --git a/nyx/panel/torrc.py b/nyx/panel/torrc.py index 0bdaf2c..d5e890e 100644 --- a/nyx/panel/torrc.py +++ b/nyx/panel/torrc.py @@ -5,12 +5,14 @@ Panel displaying the torrc or nyxrc with the validation done against it. """ +import functools import math import string import nyx.curses from nyx.curses import RED, GREEN, YELLOW, CYAN, WHITE, BOLD, HIGHLIGHT +from nyx.menu import MenuItem, Submenu from nyx import expand_path, msg, panel, tor_controller from stem import ControllerError @@ -68,26 +70,6 @@ class TorrcPanel(panel.Panel): self._torrc_load_error = msg('panel.torrc.unable_to_load_torrc', error = exc_msg) self._torrc_content = None - def set_comments_visible(self, is_visible): - """ - Sets if comments and blank lines are shown or stripped. - - :var bool is_visible: shows comments if true, strips otherwise - """ - - self._show_comments = is_visible - self.redraw() - - def set_line_number_visible(self, is_visible): - """ - Sets if line numbers are shown or hidden. - - :var bool is_visible: displays line numbers if true, hides otherwise - """ - - self._show_line_numbers = is_visible - self.redraw() - def key_handlers(self): def _scroll(key): page_height = self.get_height() - 1 @@ -97,10 +79,10 @@ class TorrcPanel(panel.Panel): self.redraw() def _toggle_comment_stripping(): - self.set_comments_visible(not self._show_comments) + self._show_comments = not self._show_comments def _toggle_line_numbers(): - self.set_line_number_visible(not self._show_line_numbers) + self._show_line_numbers = not self._show_line_numbers return ( nyx.panel.KeyHandler('arrows', 'scroll up and down', _scroll, key_func = lambda key: key.is_scroll()), @@ -108,6 +90,23 @@ class TorrcPanel(panel.Panel): nyx.panel.KeyHandler('l', 'line numbering', _toggle_line_numbers, 'on' if self._show_line_numbers else 'off'), ) + def submenu(self): + """ + Submenu consisting of... + + Reload + Show / Hide Comments + Show / Hide Line Numbers + """ + + comments_label, comments_arg = ('Hide Comments', False) if self._show_comments else ('Show Comments', True) + line_number_label, line_number_arg = ('Hide Line Numbers', False) if self._show_line_numbers else ('Show Line Numbers', True) + + return Submenu('Torrc', [ + MenuItem(comments_label, functools.partial(setattr, self, '_show_comments'), comments_arg), + MenuItem(line_number_label, functools.partial(setattr, self, '_show_line_numbers'), line_number_arg), + ]) + def _draw(self, subwindow): scroll = self._scroller.location(self._last_content_height, subwindow.height - 1)

1 0

[nyx/master] Allow children through the Submenu constructor
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit d15e2f4cfef5fd60a82824eb0c10b8cdb1433dd3 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Aug 23 13:37:27 2016 -0700 Allow children through the Submenu constructor Usually we want to use add() but in a couple particularly simple cases it's nicer to just pass them into the constructor. --- nyx/menu.py | 22 +++++++++++++--------- test/menu.py | 9 +++++++++ 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index f086ae7..71dd738 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -101,11 +101,15 @@ class Submenu(MenuItem): :var list children: menu items this contains """ - def __init__(self, label): + def __init__(self, label, children = None): MenuItem.__init__(self, label, None) self.suffix = ' >' self.children = [] + if children: + for child in children: + self.add(child) + def add(self, menu_item): """ Adds the given menu item to our listing. @@ -247,10 +251,10 @@ def make_help_menu(): About """ - help_menu = Submenu('Help') - help_menu.add(MenuItem('Hotkeys', nyx.popups.show_help)) - help_menu.add(MenuItem('About', nyx.popups.show_about)) - return help_menu + return Submenu('Help', [ + MenuItem('Hotkeys', nyx.popups.show_help), + MenuItem('About', nyx.popups.show_about), + ]) def make_graph_menu(graph_panel): @@ -394,10 +398,10 @@ def make_configuration_menu(config_panel): config_panel - instance of the configuration panel """ - config_menu = Submenu('Configuration') - config_menu.add(MenuItem('Save Config...', config_panel.show_write_dialog)) - config_menu.add(MenuItem('Sorting...', config_panel.show_sort_dialog)) - return config_menu + return Submenu('Configuration', [ + MenuItem('Save Config...', config_panel.show_write_dialog), + MenuItem('Sorting...', config_panel.show_sort_dialog), + ]) def make_torrc_menu(torrc_panel): diff --git a/test/menu.py b/test/menu.py index f3c0143..fdf3352 100644 --- a/test/menu.py +++ b/test/menu.py @@ -80,6 +80,15 @@ class TestSubmenu(unittest.TestCase): self.assertEqual(None, menu_item.parent) self.assertEqual(menu_item, menu_item.submenu) + self.assertEqual([], menu_item.children) + + menu_item = Submenu('Test Item', [ + MenuItem('Test Item 1', NO_OP), + MenuItem('Test Item 2', NO_OP), + ]) + + self.assertEqual(2, len(menu_item.children)) + def test_add(self): submenu = Submenu('Menu') item_1 = MenuItem('Test Item 1', NO_OP)

1 0

[nyx/master] Fix menu tests for python3
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit f3f8e99c91b336256a81a01d34faaa6aabfae372 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 24 08:30:04 2016 -0700 Fix menu tests for python3 LOTS of other test failures but might as well correct this one while we're here. Python 2.x and 3.x have different methods for converting objects to a boolean value so including both. --- test/menu.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/test/menu.py b/test/menu.py index 2aa0e4b..a0772b2 100644 --- a/test/menu.py +++ b/test/menu.py @@ -11,7 +11,10 @@ class Container(object): value = False def __nonzero__(self): - return bool(self.value) + return bool(self.value) # for python 2.x + + def __bool__(self): + return bool(self.value) # for python 3.x def action(*args):

1 0

[nyx/master] Condense menu creation
by atagar＠torproject.org 27 Aug '16

27 Aug '16

commit d5d569d2d99f2d9fc658fed01b21d7733b5fc31a Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 24 11:01:44 2016 -0700 Condense menu creation Taking a quick pass through all our functions that create menus, condensing them using the new constructor capabilities we added. Much shorter and simpler. :) --- nyx/menu.py | 298 ++++++++++++++++++++++-------------------------------------- 1 file changed, 109 insertions(+), 189 deletions(-) diff --git a/nyx/menu.py b/nyx/menu.py index 7a42fd1..b0fb646 100644 --- a/nyx/menu.py +++ b/nyx/menu.py @@ -111,22 +111,26 @@ class Submenu(MenuItem): if children: for child in children: - self.add(child) + if isinstance(child, list): + self.add(*child) + else: + self.add(child) - def add(self, menu_item): + def add(self, *menu_items): """ Adds the given menu item to our listing. - :param MenuItem menu_item: menu item to be added + :param list menu_items: menu item to be added :raises: **ValueError** if the item is already in a submenu """ - if menu_item.parent: - raise ValueError("Menu option '%s' already has a parent" % menu_item) + for menu_item in menu_items: + if menu_item.parent: + raise ValueError("Menu option '%s' already has a parent" % menu_item) - menu_item._parent = self - self.children.append(menu_item) + menu_item._parent = self + self.children.append(menu_item) class RadioMenuItem(MenuItem): @@ -159,243 +163,160 @@ def make_menu(): Constructs the base menu and all of its contents. """ - base_menu = Submenu('') - base_menu.add(make_actions_menu()) - base_menu.add(make_view_menu()) + nyx_controller = nyx.controller.get_controller() - control = nyx.controller.get_controller() + if not nyx_controller.is_paused(): + pause_item = MenuItem('Pause', nyx_controller.set_paused, True) + else: + pause_item = MenuItem('Unpause', nyx_controller.set_paused, False) + + root_menu = Submenu('') + + root_menu.add(Submenu('Actions', [ + MenuItem('Close Menu', None), + MenuItem('New Identity', nyx_controller.header_panel().send_newnym), + MenuItem('Reset Tor', tor_controller().signal, stem.Signal.RELOAD), + pause_item, + MenuItem('Exit', nyx_controller.quit), + ])) - for page_panel in control.get_display_panels(): + root_menu.add(_view_menu()) + + for page_panel in nyx_controller.get_display_panels(): if isinstance(page_panel, nyx.panel.graph.GraphPanel): - base_menu.add(make_graph_menu(page_panel)) + root_menu.add(_graph_menu(page_panel)) elif isinstance(page_panel, nyx.panel.log.LogPanel): - base_menu.add(make_log_menu(page_panel)) + root_menu.add(_log_menu(page_panel)) elif isinstance(page_panel, nyx.panel.connection.ConnectionPanel): - base_menu.add(make_connections_menu(page_panel)) + root_menu.add(_connections_menu(page_panel)) elif isinstance(page_panel, nyx.panel.config.ConfigPanel): - base_menu.add(make_configuration_menu(page_panel)) + root_menu.add(_configuration_menu(page_panel)) elif isinstance(page_panel, nyx.panel.torrc.TorrcPanel): - base_menu.add(make_torrc_menu(page_panel)) + root_menu.add(_torrc_menu(page_panel)) - base_menu.add(make_help_menu()) + root_menu.add(Submenu('Help', [ + MenuItem('Hotkeys', nyx.popups.show_help), + MenuItem('About', nyx.popups.show_about), + ])) - return base_menu + return root_menu -def make_actions_menu(): - """ - Submenu consisting of... - Close Menu - New Identity - Reset Tor - Pause / Unpause - Exit +def _view_menu(): """ + View submenu consisting of... - control = nyx.controller.get_controller() - controller = tor_controller() - header_panel = control.header_panel() - - actions_menu = Submenu('Actions') - actions_menu.add(MenuItem('Close Menu', None)) - actions_menu.add(MenuItem('New Identity', header_panel.send_newnym)) - actions_menu.add(MenuItem('Reset Tor', controller.signal, stem.Signal.RELOAD)) - - if control.is_paused(): - actions_menu.add(MenuItem('Unpause', control.set_paused, False)) - else: - actions_menu.add(MenuItem('Pause', control.set_paused, True)) - - actions_menu.add(MenuItem('Exit', control.quit)) - - return actions_menu - - -def make_view_menu(): - """ - Submenu consisting of... [X] <Page 1> [ ] <Page 2> [ ] etc... Color (Submenu) """ - view_menu = Submenu('View') - control = nyx.controller.get_controller() - - if control.get_page_count() > 0: - page_group = RadioGroup(control.set_page, control.get_page()) + nyx_controller = nyx.controller.get_controller() - for i in range(control.get_page_count()): - page_panels = control.get_display_panels(page_number = i) - label = ' / '.join([type(panel).__name__.replace('Panel', '') for panel in page_panels]) + view_menu = Submenu('View') + page_group = RadioGroup(nyx_controller.set_page, nyx_controller.get_page()) - view_menu.add(RadioMenuItem(label, page_group, i)) + for i in range(nyx_controller.get_page_count()): + page_panels = nyx_controller.get_display_panels(page_number = i) + label = ' / '.join([type(panel).__name__.replace('Panel', '') for panel in page_panels]) + view_menu.add(RadioMenuItem(label, page_group, i)) if nyx.curses.is_color_supported(): - color_menu = Submenu('Color') color_group = RadioGroup(nyx.curses.set_color_override, nyx.curses.get_color_override()) - color_menu.add(RadioMenuItem('All', color_group, None)) - - for color in nyx.curses.Color: - color_menu.add(RadioMenuItem(str_tools._to_camel_case(color), color_group, color)) - - view_menu.add(color_menu) + view_menu.add(Submenu('Color', [ + RadioMenuItem('All', color_group, None), + [RadioMenuItem(str_tools._to_camel_case(opt), color_group, opt) for opt in nyx.curses.Color], + ])) return view_menu -def make_help_menu(): - """ - Submenu consisting of... - Hotkeys - About +def _graph_menu(graph_panel): """ + Graph panel submenu consisting of... - return Submenu('Help', [ - MenuItem('Hotkeys', nyx.popups.show_help), - MenuItem('About', nyx.popups.show_about), - ]) - - -def make_graph_menu(graph_panel): - """ - Submenu for the graph panel, consisting of... [X] <Stat 1> [ ] <Stat 2> [ ] <Stat 2> Resize... Interval (Submenu) Bounds (Submenu) - - Arguments: - graph_panel - instance of the graph panel """ - graph_menu = Submenu('Graph') - - # stats options - stat_group = RadioGroup(functools.partial(setattr, graph_panel, 'displayed_stat'), graph_panel.displayed_stat) - available_stats = graph_panel.stat_options() - available_stats.sort() - - for stat_key in ['None'] + available_stats: - label = str_tools._to_camel_case(stat_key, divider = ' ') - stat_key = None if stat_key == 'None' else stat_key - graph_menu.add(RadioMenuItem(label, stat_group, stat_key)) - - # resizing option - - graph_menu.add(MenuItem('Resize...', graph_panel.resize_graph)) - - # interval submenu - - interval_menu = Submenu('Interval') interval_group = RadioGroup(functools.partial(setattr, graph_panel, 'update_interval'), graph_panel.update_interval) - - for interval in nyx.panel.graph.Interval: - interval_menu.add(RadioMenuItem(interval, interval_group, interval)) - - graph_menu.add(interval_menu) - - # bounds submenu - - bounds_menu = Submenu('Bounds') bounds_group = RadioGroup(functools.partial(setattr, graph_panel, 'bounds_type'), graph_panel.bounds_type) - for bounds_type in nyx.panel.graph.Bounds: - bounds_menu.add(RadioMenuItem(bounds_type, bounds_group, bounds_type)) - - graph_menu.add(bounds_menu) - - return graph_menu + return Submenu('Graph', [ + RadioMenuItem('None', stat_group, None), + [RadioMenuItem(str_tools._to_camel_case(opt, divider = ' '), stat_group, opt) for opt in sorted(graph_panel.stat_options())], + MenuItem('Resize...', graph_panel.resize_graph), + Submenu('Interval', [RadioMenuItem(opt, interval_group, opt) for opt in nyx.panel.graph.Interval]), + Submenu('Bounds', [RadioMenuItem(opt, bounds_group, opt) for opt in nyx.panel.graph.Bounds]), + ]) -def make_log_menu(log_panel): +def _log_menu(log_panel): """ - Submenu for the log panel, consisting of... + Log panel submenu consisting of... + Events... Snapshot... Clear Show / Hide Duplicates Filter (Submenu) - - Arguments: - log_panel - instance of the log panel """ - log_menu = Submenu('Log') - - log_menu.add(MenuItem('Events...', log_panel.show_event_selection_prompt)) - log_menu.add(MenuItem('Snapshot...', log_panel.show_snapshot_prompt)) - log_menu.add(MenuItem('Clear', log_panel.clear)) - - if log_panel.is_duplicates_visible(): - log_menu.add(MenuItem('Hide Duplicates', log_panel.set_duplicate_visability, False)) - else: - log_menu.add(MenuItem('Show Duplicates', log_panel.set_duplicate_visability, True)) - - # filter submenu - log_filter = log_panel.get_filter() - - filter_menu = Submenu('Filter') filter_group = RadioGroup(log_filter.select, log_filter.selection()) - filter_menu.add(RadioMenuItem('None', filter_group, None)) - - for option in log_filter.latest_selections(): - filter_menu.add(RadioMenuItem(option, filter_group, option)) - - filter_menu.add(MenuItem('New...', log_panel.show_filter_prompt)) - log_menu.add(filter_menu) - - return log_menu + if not log_panel.is_duplicates_visible(): + duplicate_item = MenuItem('Show Duplicates', log_panel.set_duplicate_visability, True) + else: + duplicate_item = MenuItem('Hide Duplicates', log_panel.set_duplicate_visability, False) + + return Submenu('Log', [ + MenuItem('Events...', log_panel.show_event_selection_prompt), + MenuItem('Snapshot...', log_panel.show_snapshot_prompt), + MenuItem('Clear', log_panel.clear), + duplicate_item, + Submenu('Filter', [ + RadioMenuItem('None', filter_group, None), + [RadioMenuItem(opt, filter_group, opt) for opt in log_filter.latest_selections()], + MenuItem('New...', log_panel.show_filter_prompt), + ]), + ]) -def make_connections_menu(conn_panel): +def _connections_menu(conn_panel): """ - Submenu for the connections panel, consisting of... - Sorting... - Resolver (Submenu) + Connection panel submenu consisting of... - Arguments: - conn_panel - instance of the connections panel + Sorting... + Resolver (Submenu) """ - connections_menu = Submenu('Connections') - - # sorting option - - connections_menu.add(MenuItem('Sorting...', conn_panel.show_sort_dialog)) - - # resolver submenu - - conn_resolver = nyx.tracker.get_connection_tracker() - resolver_menu = Submenu('Resolver') - resolver_group = RadioGroup(conn_resolver.set_custom_resolver, conn_resolver.get_custom_resolver()) - - resolver_menu.add(RadioMenuItem('auto', resolver_group, None)) - - for option in stem.util.connection.Resolver: - resolver_menu.add(RadioMenuItem(option, resolver_group, option)) + tracker = nyx.tracker.get_connection_tracker() + resolver_group = RadioGroup(tracker.set_custom_resolver, tracker.get_custom_resolver()) - connections_menu.add(resolver_menu) - - return connections_menu + return Submenu('Connections', [ + MenuItem('Sorting...', conn_panel.show_sort_dialog), + Submenu('Resolver', [ + RadioMenuItem('auto', resolver_group, None), + [RadioMenuItem(opt, resolver_group, opt) for opt in stem.util.connection.Resolver], + ]), + ]) -def make_configuration_menu(config_panel): +def _configuration_menu(config_panel): """ - Submenu for the configuration panel, consisting of... + Configuration panel submenu consisting of... + Save Config... Sorting... Filter / Unfilter Options - - Arguments: - config_panel - instance of the configuration panel """ return Submenu('Configuration', [ @@ -404,30 +325,29 @@ def make_configuration_menu(config_panel): ]) -def make_torrc_menu(torrc_panel): +def _torrc_menu(torrc_panel): """ - Submenu for the torrc panel, consisting of... + Torrc panel submenu consisting of... + Reload Show / Hide Comments Show / Hide Line Numbers - - Arguments: - torrc_panel - instance of the torrc panel """ - torrc_menu = Submenu('Torrc') - - if torrc_panel._show_comments: - torrc_menu.add(MenuItem('Hide Comments', torrc_panel.set_comments_visible, False)) + if not torrc_panel._show_comments: + comments_item = MenuItem('Show Comments', torrc_panel.set_comments_visible, True) else: - torrc_menu.add(MenuItem('Show Comments', torrc_panel.set_comments_visible, True)) + comments_item = MenuItem('Hide Comments', torrc_panel.set_comments_visible, False) - if torrc_panel._show_line_numbers: - torrc_menu.add(MenuItem('Hide Line Numbers', torrc_panel.set_line_number_visible, False)) + if not torrc_panel._show_line_numbers: + line_number_item = MenuItem('Show Line Numbers', torrc_panel.set_line_number_visible, True) else: - torrc_menu.add(MenuItem('Show Line Numbers', torrc_panel.set_line_number_visible, True)) + line_number_item = MenuItem('Hide Line Numbers', torrc_panel.set_line_number_visible, False) - return torrc_menu + return Submenu('Torrc', [ + comments_item, + line_number_item, + ]) class MenuCursor:

1 0