more on type hinting, remove unecessary function comments

This commit is contained in:
Huy Pham 2020-01-13 12:03:13 -08:00
parent 7bbd6aa353
commit eb5f2c5648
34 changed files with 169 additions and 326 deletions

View file

@ -13,10 +13,6 @@ class Menubar(tk.Menu):
def __init__(self, master, app, cnf={}, **kwargs):
"""
Create a CoreMenubar instance
:param master:
:param tkinter.Menu menubar: menubar object
:param coretk.app.Application app: application object
"""
super().__init__(master, cnf, **kwargs)
self.master.config(menu=self)
@ -27,8 +23,6 @@ class Menubar(tk.Menu):
def draw(self):
"""
Create core menubar and bind the hot keys to their matching command
:return: nothing
"""
self.draw_file_menu()
self.draw_edit_menu()
@ -42,8 +36,6 @@ class Menubar(tk.Menu):
def draw_file_menu(self):
"""
Create file menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(
@ -81,8 +73,6 @@ class Menubar(tk.Menu):
def draw_edit_menu(self):
"""
Create edit menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(label="Preferences", command=self.menuaction.gui_preferences)
@ -112,8 +102,6 @@ class Menubar(tk.Menu):
def draw_canvas_menu(self):
"""
Create canvas menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(
@ -136,8 +124,6 @@ class Menubar(tk.Menu):
def draw_view_menu(self):
"""
Create view menu
:return: nothing
"""
view_menu = tk.Menu(self)
self.create_show_menu(view_menu)
@ -152,9 +138,6 @@ class Menubar(tk.Menu):
def create_show_menu(self, view_menu: tk.Menu):
"""
Create the menu items in View/Show
:param tkinter.Menu view_menu: the view menu
:return: nothing
"""
menu = tk.Menu(view_menu)
menu.add_command(label="All", state=tk.DISABLED)
@ -172,9 +155,6 @@ class Menubar(tk.Menu):
def create_experimental_menu(self, tools_menu: tk.Menu):
"""
Create experimental menu item and the sub menu items inside
:param tkinter.Menu tools_menu: tools menu
:return: nothing
"""
menu = tk.Menu(tools_menu)
menu.add_command(label="Plugins...", state=tk.DISABLED)
@ -185,9 +165,6 @@ class Menubar(tk.Menu):
def create_random_menu(self, topology_generator_menu: tk.Menu):
"""
Create random menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
# list of number of random nodes to create
@ -200,9 +177,6 @@ class Menubar(tk.Menu):
def create_grid_menu(self, topology_generator_menu: tk.Menu):
"""
Create grid menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology_generator_menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
# list of number of nodes to create
@ -215,9 +189,6 @@ class Menubar(tk.Menu):
def create_connected_grid_menu(self, topology_generator_menu: tk.Menu):
"""
Create connected grid menu items and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(1, 11, 1):
@ -232,9 +203,6 @@ class Menubar(tk.Menu):
def create_chain_menu(self, topology_generator_menu: tk.Menu):
"""
Create chain menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
# number of nodes to create
@ -247,9 +215,6 @@ class Menubar(tk.Menu):
def create_star_menu(self, topology_generator_menu: tk.Menu):
"""
Create star menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(3, 26, 1):
@ -260,9 +225,6 @@ class Menubar(tk.Menu):
def create_cycle_menu(self, topology_generator_menu: tk.Menu):
"""
Create cycle menu item and the sub items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(3, 25, 1):
@ -273,9 +235,6 @@ class Menubar(tk.Menu):
def create_wheel_menu(self, topology_generator_menu: tk.Menu):
"""
Create wheel menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(4, 26, 1):
@ -286,9 +245,6 @@ class Menubar(tk.Menu):
def create_cube_menu(self, topology_generator_menu: tk.Menu):
"""
Create cube menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(2, 7, 1):
@ -299,9 +255,6 @@ class Menubar(tk.Menu):
def create_clique_menu(self, topology_generator_menu: tk.Menu):
"""
Create clique menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology generator menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
for i in range(3, 25, 1):
@ -312,9 +265,6 @@ class Menubar(tk.Menu):
def create_bipartite_menu(self, topology_generator_menu: tk.Menu):
"""
Create bipartite menu item and the sub menu items inside
:param tkinter.Menu topology_generator_menu: topology_generator_menu
:return: nothing
"""
menu = tk.Menu(topology_generator_menu)
temp = 24
@ -331,10 +281,6 @@ class Menubar(tk.Menu):
def create_topology_generator_menu(self, tools_menu: tk.Menu):
"""
Create topology menu item and its sub menu items
:param tkinter.Menu tools_menu: tools menu
:return: nothing
"""
menu = tk.Menu(tools_menu)
self.create_random_menu(menu)
@ -352,8 +298,6 @@ class Menubar(tk.Menu):
def draw_tools_menu(self):
"""
Create tools menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(label="Auto rearrange all", state=tk.DISABLED)
@ -374,9 +318,6 @@ class Menubar(tk.Menu):
def create_observer_widgets_menu(self, widget_menu: tk.Menu):
"""
Create observer widget menu item and create the sub menu items inside
:param tkinter.Menu widget_menu: widget_menu
:return: nothing
"""
var = tk.StringVar(value="none")
menu = tk.Menu(widget_menu)
@ -412,9 +353,6 @@ class Menubar(tk.Menu):
def create_adjacency_menu(self, widget_menu: tk.Menu):
"""
Create adjacency menu item and the sub menu items inside
:param tkinter.Menu widget_menu: widget menu
:return: nothing
"""
menu = tk.Menu(widget_menu)
menu.add_command(label="OSPFv2", state=tk.DISABLED)
@ -426,8 +364,6 @@ class Menubar(tk.Menu):
def draw_widgets_menu(self):
"""
Create widget menu
:return: nothing
"""
menu = tk.Menu(self)
self.create_observer_widgets_menu(menu)
@ -443,8 +379,6 @@ class Menubar(tk.Menu):
def draw_session_menu(self):
"""
Create session menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(
@ -461,8 +395,6 @@ class Menubar(tk.Menu):
def draw_help_menu(self):
"""
Create help menu
:return: nothing
"""
menu = tk.Menu(self)
menu.add_command(