valve_changes_window

  1"""
  2This module defines the ValveChanges class, a Tkinter Toplevel window designed
  3to act as a confirmation dialog window for auto-generated valve timing adjustments.
  4
  5It presents the user with a summary of proposed changes to valve open durations
  6before they are applied to the system configuration.
  7The user can either confirm the changes, triggering a callback function to `views.valve_testing.valve_testing_window`, or
  8abort the changes, closing the dialog without further action. It relies on
  9`system_config` for valve configuration and `views.gui_common.GUIUtils` for
 10standard widget creation and window management.
 11"""
 12
 13import tkinter as tk
 14import toml
 15import system_config
 16
 17###TYPE HINTS###
 18from typing import Callable
 19###TYPE HINTS###
 20
 21from views.gui_common import GUIUtils
 22
 23
 24rig_config = system_config.get_rig_config()
 25
 26with open(rig_config, "r") as f:
 27    VALVE_CONFIG = toml.load(f)["valve_config"]
 28
 29# pull total valves constant from toml config
 30TOTAL_VALVES = VALVE_CONFIG["TOTAL_CURRENT_VALVES"]
 31
 32VALVES_PER_SIDE = TOTAL_VALVES // 2
 33
 34
 35# lambda: self.confirm_valve_changes(side_one, side_two, side_one_old, side_two_old
 36class ValveChanges(tk.Toplevel):
 37    """
 38    Implements a Tkinter Toplevel window to display and confirm proposed valve duration changes.
 39
 40    This window acts as a confirmation step, showing the user which valves are
 41    being changed and their old vs. new duration values (in microseconds).
 42    It provides "Confirm Changes" and "ABORT CHANGES" buttons. Confirming
 43    triggers a callback function passed during initialization; aborting simply
 44    destroys the window. Uses `views.gui_common.GUIUtils` for window centering and icon setting.
 45
 46    Attributes
 47    ----------
 48    - **`valve_changes`** (*List[Tuple[int, Tuple[int, int]]]*): A list where each element is a tuple containing the valve number (int)
 49        and another tuple with (old_duration, new_duration).
 50    - **`confirm_callback`** (*Callable*): The function to execute when the "Confirm Changes" button is pressed.
 51    - **`valve_frame`** (*tk.Frame*): The main container frame holding the side-by-side valve change displays.
 52    - **`side_one_valves_frame`** (*tk.Frame*): Frame displaying changes for valves on the first side (e.g., 1-8).
 53    - **`side_two_valves_frame`** (*tk.Frame*): Frame displaying changes for valves on the second side (e.g., 9-16).
 54    - **`buttons_frame`** (*tk.Frame*): Frame containing the Confirm and Abort buttons.
 55
 56    Methods
 57    -------
 58    - `create_interface`()
 59        Constructs the main GUI layout, including frames and buttons.
 60    - `confirmation`()
 61        Executes the stored callback function and then destroys the window.
 62    - `create_valve_change_labels`()
 63        Populates the side frames with labels detailing the old and new duration for each changed valve.
 64    """
 65
 66    def __init__(
 67        self,
 68        valve_changes: list[tuple[int, tuple[int, int]]],
 69        confirm_callback: Callable,
 70    ):
 71        """
 72        Initializes the ValveChanges confirmation Toplevel window.
 73
 74        Parameters
 75        ----------
 76        - **valve_changes** (*List[Tuple[int, Tuple[int, int]]]*): A list containing tuples for each valve change.
 77          Each inner tuple has the format `(valve_number, (old_duration_microseconds, new_duration_microseconds))`.
 78        - **confirm_callback** (*Callable*): The function that should be called if the user confirms the changes.
 79          This function takes no arguments.
 80
 81        Raises
 82        ------
 83        - Propagates exceptions from `GUIUtils` methods during icon setting or window centering.
 84        """
 85        super().__init__()
 86        self.title("CONFIRM VALVE DURATION CHANGES")
 87        self.bind("<Control-w>", lambda event: self.withdraw())
 88
 89        self.grid_columnconfigure(0, weight=1)
 90        self.grid_columnconfigure(1, weight=1)
 91
 92        self.grid_rowconfigure(0, weight=1)
 93
 94        self.resizable(False, False)
 95
 96        self.valve_changes = valve_changes
 97        self.confirm_callback = confirm_callback
 98
 99        self.create_interface()
100
101        self.update_idletasks()
102        GUIUtils.center_window(self)
103
104        window_icon_path = GUIUtils.get_window_icon_path()
105        GUIUtils.set_program_icon(self, icon_path=window_icon_path)
106
107    def create_interface(self):
108        """
109        Constructs the main GUI elements within the Toplevel window.
110
111        Creates the frames to hold the valve change information side-by-side,
112        populates them using `create_valve_change_labels`, and adds the
113        'Confirm' and 'Abort' buttons.
114        """
115
116        self.valve_frame = tk.Frame(
117            self, highlightbackground="black", highlightthickness=1
118        )
119
120        self.valve_frame.grid(row=0, column=0, pady=10, padx=10, sticky="nsew")
121
122        self.valve_frame.grid_columnconfigure(0, weight=1)
123        self.valve_frame.grid_columnconfigure(1, weight=1)
124
125        self.valve_frame.grid_rowconfigure(0, weight=1)
126
127        self.side_one_valves_frame = tk.Frame(
128            self.valve_frame, highlightbackground="black", highlightthickness=1
129        )
130        self.side_one_valves_frame.grid(row=0, column=0, pady=10, padx=10, sticky="ew")
131
132        self.side_two_valves_frame = tk.Frame(
133            self.valve_frame, highlightbackground="black", highlightthickness=1
134        )
135        self.side_two_valves_frame.grid(row=0, column=1, pady=10, padx=10, sticky="ew")
136
137        for i in range(2):
138            self.side_one_valves_frame.grid_columnconfigure(i, weight=1)
139            self.side_two_valves_frame.grid_columnconfigure(i, weight=1)
140
141        for i in range(8):
142            self.side_one_valves_frame.grid_rowconfigure(i, weight=1)
143            self.side_two_valves_frame.grid_rowconfigure(i, weight=1)
144
145        self.create_valve_change_labels()
146
147        self.buttons_frame = tk.Frame(
148            self, highlightbackground="black", highlightthickness=1
149        )
150        self.buttons_frame.grid(row=1, column=0, pady=10, padx=10, sticky="ew")
151        self.buttons_frame.grid_rowconfigure(0, weight=1)
152        self.buttons_frame.grid_columnconfigure(0, weight=1)
153        self.buttons_frame.grid_columnconfigure(1, weight=1)
154
155        confirm = tk.Button(
156            self.buttons_frame,
157            text="Confirm Changes",
158            command=lambda: self.confirmation(),
159            bg="green",
160            font=("Helvetica", 20),
161            width=20,
162        )
163        confirm.grid(row=0, column=0, sticky="w", padx=5, ipadx=10, ipady=10)
164
165        abort = tk.Button(
166            self.buttons_frame,
167            text="ABORT CHANGES",
168            command=lambda: self.destroy(),
169            bg="tomato",
170            font=("Helvetica", 20),
171            width=20,
172        )
173        abort.grid(row=0, column=1, sticky="e", padx=5, ipadx=10, ipady=10)
174
175    def confirmation(self):
176        """
177        Handles the confirmation action.
178
179        Executes the `confirm_callback` function that was provided during
180        class initialization and then closes (destroys) this confirmation window.
181        """
182        self.confirm_callback()
183        self.destroy()
184
185    def create_valve_change_labels(self):
186        """
187        Generates and places the labels detailing each valve duration change.
188
189        Iterates through the `self.valve_changes` list. For each change, it
190        determines which side frame (left or right) the valve belongs to and
191        creates two labels: one for the valve number and one showing the
192        'From old_duration --> new_duration' information. Labels are placed
193        in sequence within the appropriate side frame.
194        """
195
196        valve = None
197        frame = None
198        side_one_row = 0
199        side_two_row = 0
200        column = 0
201
202        for valve, durations in self.valve_changes:
203            valve = valve
204            old_duration = durations[0]
205            new_duration = durations[1]
206
207            if valve <= VALVES_PER_SIDE:
208                frame = self.side_one_valves_frame
209                row = side_one_row
210                column = 0
211            else:
212                frame = self.side_two_valves_frame
213                row = side_two_row
214                column = 1
215
216            label = tk.Label(
217                frame,
218                text=f"Valve {valve}",
219                bg="grey",
220                font=("Helvetica", 24),
221                highlightthickness=1,
222                highlightbackground="dark blue",
223                height=3,
224                width=26,
225            )
226            label.grid(row=row, column=column, padx=10, pady=10, sticky="nsew")
227
228            label = tk.Label(
229                frame,
230                text=f"From {old_duration} --> {new_duration}",
231                bg="light blue",
232                font=("Helvetica", 24),
233                highlightthickness=1,
234                highlightbackground="dark blue",
235                height=3,
236                width=26,
237            )
238            label.grid(row=row + 1, column=column, padx=10, pady=10, sticky="nsew")
239
240            if valve <= VALVES_PER_SIDE:
241                side_one_row += 2
242            else:
243                side_two_row += 2