add type hinting to set_options() for ease of use

Author: ragardner

docs/CHANGELOG.md

@@ -2,6 +2,9 @@
 #### Addressed:
 - [#313](https://github.com/ragardner/tksheet/issues/313).
 
+#### Improved:
+- For ease of use only, added type hinting to function `set_options()`.
+
 ### Version 7.5.14
 #### Removed:
 - Removed settings for cut_contents, copy_contents and the new plain equivalent added in `7.5.13`. These settings now use the same as the usual cut and copy settings.

tksheet/sheet.py

@@ -12,7 +12,7 @@
 from re import IGNORECASE, escape, sub
 from timeit import default_timer
 from tkinter import ttk
-from typing import Any, Literal
+from typing import Any, Literal, Unpack
 
 from .column_headers import ColumnHeaders
 from .constants import (
@@ -78,7 +78,7 @@
     Span,
 )
 from .row_index import RowIndex
-from .sheet_options import new_sheet_options
+from .sheet_options import SetOptions, new_sheet_options
 from .sorting import fast_sort_key, natural_sort_key, version_sort_key  # noqa: F401
 from .themes import (
     theme_black,
@@ -4162,7 +4162,7 @@ def close_text_editor(self, set_data: bool = True) -> Sheet:
 
     # Sheet Options and Other Functions
 
-    def set_options(self, redraw: bool = True, **kwargs) -> Sheet:
+    def set_options(self, redraw: bool = True, **kwargs: Unpack[SetOptions]) -> Sheet:
         enabled = tuple(self.MT.enabled_bindings)
         for k, v in kwargs.items():
             if k in self.ops and v != self.ops[k]:

tksheet/sheet_options.py

@@ -2,6 +2,7 @@
 
 import csv
 import tkinter as tk
+from typing import Callable, List, Optional, TypedDict, Union
 
 from .constants import (  # noqa: F401
     ICON_ADD,
@@ -376,3 +377,340 @@ def new_sheet_options() -> DotDict:
             "tooltip_hover_delay": 1200,
         }
     )
+
+
+class SetOptions(TypedDict, total=False):
+    # Colors
+    popup_menu_fg: str
+    popup_menu_bg: str
+    popup_menu_highlight_bg: str
+    popup_menu_highlight_fg: str
+    index_hidden_rows_expander_bg: str
+    header_hidden_columns_expander_bg: str
+    header_bg: str
+    header_border_fg: str
+    header_grid_fg: str
+    header_fg: str
+    header_editor_bg: str
+    header_editor_fg: str
+    header_editor_select_bg: str
+    header_editor_select_fg: str
+    header_selected_cells_bg: str
+    header_selected_cells_fg: str
+    index_bg: str
+    index_border_fg: str
+    index_grid_fg: str
+    index_fg: str
+    index_editor_bg: str
+    index_editor_fg: str
+    index_editor_select_bg: str
+    index_editor_select_fg: str
+    index_selected_cells_bg: str
+    index_selected_cells_fg: str
+    top_left_bg: str
+    top_left_fg: str
+    top_left_fg_highlight: str
+    table_bg: str
+    table_grid_fg: str
+    table_fg: str
+    table_editor_bg: str
+    table_editor_fg: str
+    table_editor_select_bg: str
+    table_editor_select_fg: str
+    table_selected_box_cells_fg: str
+    table_selected_box_rows_fg: str
+    table_selected_box_columns_fg: str
+    table_selected_cells_border_fg: str
+    table_selected_cells_bg: str
+    table_selected_cells_fg: str
+    resizing_line_fg: str
+    drag_and_drop_bg: str
+    outline_color: str
+    header_selected_columns_bg: str
+    header_selected_columns_fg: str
+    index_selected_rows_bg: str
+    index_selected_rows_fg: str
+    table_selected_rows_border_fg: str
+    table_selected_rows_bg: str
+    table_selected_rows_fg: str
+    table_selected_columns_border_fg: str
+    table_selected_columns_bg: str
+    table_selected_columns_fg: str
+    tree_arrow_fg: str
+    selected_cells_tree_arrow_fg: str
+    selected_rows_tree_arrow_fg: str
+    vertical_scroll_background: str
+    horizontal_scroll_background: str
+    vertical_scroll_troughcolor: str
+    horizontal_scroll_troughcolor: str
+    vertical_scroll_lightcolor: str
+    horizontal_scroll_lightcolor: str
+    vertical_scroll_darkcolor: str
+    horizontal_scroll_darkcolor: str
+    vertical_scroll_relief: str
+    horizontal_scroll_relief: str
+    vertical_scroll_troughrelief: str
+    horizontal_scroll_troughrelief: str
+    vertical_scroll_bordercolor: str
+    horizontal_scroll_bordercolor: str
+    vertical_scroll_active_bg: str
+    horizontal_scroll_active_bg: str
+    vertical_scroll_not_active_bg: str
+    horizontal_scroll_not_active_bg: str
+    vertical_scroll_pressed_bg: str
+    horizontal_scroll_pressed_bg: str
+    vertical_scroll_active_fg: str
+    horizontal_scroll_active_fg: str
+    vertical_scroll_not_active_fg: str
+    horizontal_scroll_not_active_fg: str
+    vertical_scroll_pressed_fg: str
+    horizontal_scroll_pressed_fg: str
+
+    # Fonts
+    popup_menu_font: FontTuple
+    table_font: FontTuple
+    header_font: FontTuple
+    index_font: FontTuple
+
+    # Edit menu items
+    edit_header_label: str
+    edit_header_accelerator: str
+    edit_header_image: tk.PhotoImage
+    edit_header_compound: str
+    edit_index_label: str
+    edit_index_accelerator: str
+    edit_index_image: tk.PhotoImage
+    edit_index_compound: str
+    edit_cell_label: str
+    edit_cell_accelerator: str
+    edit_cell_image: tk.PhotoImage
+    edit_cell_compound: str
+
+    # Cut/copy/paste/delete
+    cut_label: str
+    cut_accelerator: str
+    cut_image: tk.PhotoImage
+    cut_compound: str
+    copy_label: str
+    copy_accelerator: str
+    copy_image: tk.PhotoImage
+    copy_compound: str
+    copy_plain_label: str
+    copy_plain_accelerator: str
+    copy_plain_image: tk.PhotoImage
+    copy_plain_compound: str
+    paste_label: str
+    paste_accelerator: str
+    paste_image: tk.PhotoImage
+    paste_compound: str
+    delete_label: str
+    delete_accelerator: str
+    delete_image: tk.PhotoImage
+    delete_compound: str
+    clear_contents_label: str
+    clear_contents_accelerator: str
+    clear_contents_image: tk.PhotoImage
+    clear_contents_compound: str
+
+    # Column/row operations
+    delete_columns_label: str
+    delete_columns_accelerator: str
+    delete_columns_image: tk.PhotoImage
+    delete_columns_compound: str
+    insert_columns_left_label: str
+    insert_columns_left_accelerator: str
+    insert_columns_left_image: tk.PhotoImage
+    insert_columns_left_compound: str
+    insert_columns_right_label: str
+    insert_columns_right_accelerator: str
+    insert_columns_right_image: tk.PhotoImage
+    insert_columns_right_compound: str
+    insert_column_label: str
+    insert_column_accelerator: str
+    insert_column_image: tk.PhotoImage
+    insert_column_compound: str
+    delete_rows_label: str
+    delete_rows_accelerator: str
+    delete_rows_image: tk.PhotoImage
+    delete_rows_compound: str
+    insert_rows_above_label: str
+    insert_rows_above_accelerator: str
+    insert_rows_above_image: tk.PhotoImage
+    insert_rows_above_compound: str
+    insert_rows_below_label: str
+    insert_rows_below_accelerator: str
+    insert_rows_below_image: tk.PhotoImage
+    insert_rows_below_compound: str
+    insert_row_label: str
+    insert_row_accelerator: str
+    insert_row_image: tk.PhotoImage
+    insert_row_compound: str
+
+    # Sorting
+    sort_cells_label: str
+    sort_cells_x_label: str
+    sort_row_label: str
+    sort_column_label: str
+    sort_rows_label: str
+    sort_columns_label: str
+    sort_cells_reverse_label: str
+    sort_cells_x_reverse_label: str
+    sort_row_reverse_label: str
+    sort_column_reverse_label: str
+    sort_rows_reverse_label: str
+    sort_columns_reverse_label: str
+    sort_cells_accelerator: str
+    sort_cells_x_accelerator: str
+    sort_row_accelerator: str
+    sort_column_accelerator: str
+    sort_rows_accelerator: str
+    sort_columns_accelerator: str
+    sort_cells_reverse_accelerator: str
+    sort_cells_x_reverse_accelerator: str
+    sort_row_reverse_accelerator: str
+    sort_column_reverse_accelerator: str
+    sort_rows_reverse_accelerator: str
+    sort_columns_reverse_accelerator: str
+    sort_cells_image: tk.PhotoImage
+    sort_cells_x_image: tk.PhotoImage
+    sort_row_image: tk.PhotoImage
+    sort_column_image: tk.PhotoImage
+    sort_rows_image: tk.PhotoImage
+    sort_columns_image: tk.PhotoImage
+    sort_cells_compound: str
+    sort_cells_x_compound: str
+    sort_row_compound: str
+    sort_column_compound: str
+    sort_rows_compound: str
+    sort_columns_compound: str
+    sort_cells_reverse_image: tk.PhotoImage
+    sort_cells_x_reverse_image: tk.PhotoImage
+    sort_row_reverse_image: tk.PhotoImage
+    sort_column_reverse_image: tk.PhotoImage
+    sort_rows_reverse_image: tk.PhotoImage
+    sort_columns_reverse_image: tk.PhotoImage
+    sort_cells_reverse_compound: str
+    sort_cells_x_reverse_compound: str
+    sort_row_reverse_compound: str
+    sort_column_reverse_compound: str
+    sort_rows_reverse_compound: str
+    sort_columns_reverse_compound: str
+
+    # Select/undo/redo
+    select_all_label: str
+    select_all_accelerator: str
+    select_all_image: tk.PhotoImage
+    select_all_compound: str
+    undo_label: str
+    undo_accelerator: str
+    undo_image: tk.PhotoImage
+    undo_compound: str
+    redo_label: str
+    redo_accelerator: str
+    redo_image: tk.PhotoImage
+    redo_compound: str
+
+    # Bindings
+    rc_bindings: List[str]
+    copy_bindings: List[str]
+    copy_plain_bindings: List[str]
+    cut_bindings: List[str]
+    paste_bindings: List[str]
+    undo_bindings: List[str]
+    redo_bindings: List[str]
+    delete_bindings: List[str]
+    select_all_bindings: List[str]
+    select_columns_bindings: List[str]
+    select_rows_bindings: List[str]
+    row_start_bindings: List[str]
+    table_start_bindings: List[str]
+    tab_bindings: List[str]
+    up_bindings: List[str]
+    right_bindings: List[str]
+    down_bindings: List[str]
+    left_bindings: List[str]
+    shift_up_bindings: List[str]
+    shift_right_bindings: List[str]
+    shift_down_bindings: List[str]
+    shift_left_bindings: List[str]
+    prior_bindings: List[str]
+    next_bindings: List[str]
+    find_bindings: List[str]
+    find_next_bindings: List[str]
+    find_previous_bindings: List[str]
+    toggle_replace_bindings: List[str]
+    escape_bindings: List[str]
+
+    # Scrollbar options
+    vertical_scroll_borderwidth: int
+    horizontal_scroll_borderwidth: int
+    vertical_scroll_gripcount: int
+    horizontal_scroll_gripcount: int
+    vertical_scroll_arrowsize: Union[str, int]
+    horizontal_scroll_arrowsize: Union[str, int]
+
+    # Other options
+    set_cell_sizes_on_zoom: bool
+    auto_resize_columns: Optional[int]
+    auto_resize_rows: Optional[int]
+    to_clipboard_dialect: csv.Dialect
+    to_clipboard_delimiter: str
+    to_clipboard_quotechar: str
+    to_clipboard_lineterminator: str
+    from_clipboard_delimiters: Union[str, List[str]]
+    show_dropdown_borders: bool
+    show_default_header_for_empty: bool
+    show_default_index_for_empty: bool
+    default_header_height: str
+    default_row_height: str
+    default_column_width: int
+    default_row_index_width: int
+    default_row_index: str
+    default_header: str
+    page_up_down_select_row: bool
+    paste_can_expand_x: bool
+    paste_can_expand_y: bool
+    paste_insert_column_limit: Optional[int]
+    paste_insert_row_limit: Optional[int]
+    arrow_key_down_right_scroll_page: bool
+    cell_auto_resize_enabled: bool
+    auto_resize_row_index: bool
+    max_undos: int
+    column_drag_and_drop_perform: bool
+    row_drag_and_drop_perform: bool
+    empty_horizontal: int
+    empty_vertical: int
+    horizontal_grid_to_end_of_window: bool
+    vertical_grid_to_end_of_window: bool
+    show_vertical_grid: bool
+    show_horizontal_grid: bool
+    display_selected_fg_over_highlights: bool
+    show_selected_cells_border: bool
+    edit_cell_tab: str
+    edit_cell_return: str
+    editor_del_key: str
+    treeview: bool
+    treeview_indent: str
+    rounded_boxes: bool
+    alternate_color: str
+    allow_cell_overflow: bool
+    table_wrap: str
+    header_wrap: str
+    index_wrap: str
+    min_column_width: int
+    max_column_width: float
+    max_header_height: float
+    max_row_height: float
+    max_index_width: float
+    show_top_left: Optional[bool]
+    sort_key: Callable[[str], str]
+    tooltips: bool
+    user_can_create_notes: bool
+    note_corners: bool
+    tooltip_width: int
+    tooltip_height: int
+    tooltip_hover_delay: int
+
+    # Additional keys not in the dict
+    name: str
+    outline_thickness: int