misc feedback

Author: Mike Prosser

examples/all_types/all_types_panel.py

@@ -37,8 +37,4 @@
             st.text_input(label=name, value=default_value, key=name)
 
     with col3:
-        value = panel.get_value(name)
-        value_with_default = panel.get_value(name, default_value=default_value)
-        st.write(value_with_default)
-        if str(value) != str(value_with_default):
-            st.write("(", value, ")")
+        st.write(panel.get_value(name, default_value=default_value))

examples/nidaqmx/nidaqmx_continuous_analog_input_panel.py

@@ -38,28 +38,28 @@
 is_running = panel.get_value("is_running", False)
 
 if is_running:
-    st.button(r"⏹️ $\large{\textbf{Stop}}$", key="stop_button")
+    st.button(r"⏹️ Stop", key="stop_button")
 else:
-    st.button(r"▶️ $\large{\textbf{Run}}$", key="run_button")
+    st.button(r"▶️ Run", key="run_button")
 
 thermocouple_data = panel.get_value("thermocouple_data", [0.0])
 voltage_data = panel.get_value("voltage_data", [0.0])
 sample_rate = panel.get_value("sample_rate", 0.0)
 
 # Create two-column layout for the entire interface
-left_col, right_col = st.columns([1, 1])
+left_column, right_column = st.columns([1, 1])
 
 # Left column - Channel tabs and Timing Settings
-with left_col:
+with left_column:
     # Channel Settings tabs
     with st.container(border=True):
         st.header("Channel Settings")
         voltage_tab, thermocouple_tab = st.tabs(["Voltage", "Thermocouple"])
 
         voltage_tab.header("Voltage")
         with voltage_tab:
-            channel_left, channel_right = st.columns(2)
-            with channel_left:
+            channel_left_column, channel_right_column = st.columns(2)
+            with channel_left_column:
                 st.selectbox(options=["Dev1/ai0"], label="Physical Channels", disabled=True)
                 st.number_input(
                     "Min Value",
@@ -75,7 +75,7 @@
                     disabled=panel.get_value("is_running", False),
                     key="voltage_max_value",
                 )
-            with channel_right:
+            with channel_right_column:
                 ni.enum_selectbox(
                     panel,
                     label="Terminal Configuration",
@@ -86,8 +86,8 @@
 
         thermocouple_tab.header("Thermocouple")
         with thermocouple_tab:
-            channel_left, channel_middle, channel_right = st.columns(3)
-            with channel_left:
+            channel_left_column, channel_middle_column, channel_right_column = st.columns(3)
+            with channel_left_column:
                 st.selectbox(options=["Dev1/ai1"], label="Physical Channel", disabled=True)
                 st.number_input(
                     "Min Value",
@@ -103,7 +103,7 @@
                     disabled=panel.get_value("is_running", False),
                     key="thermocouple_max_value",
                 )
-            with channel_middle:
+            with channel_middle_column:
                 ni.enum_selectbox(
                     panel,
                     label="Units",
@@ -118,7 +118,7 @@
                     disabled=panel.get_value("is_running", False),
                     key="thermocouple_type",
                 )
-            with channel_right:
+            with channel_right_column:
                 ni.enum_selectbox(
                     panel,
                     label="CJC Source",
@@ -137,8 +137,8 @@
     # Timing Settings section in left column
     with st.container(border=True):
         st.header("Timing Settings")
-        timing_left, timing_right = st.columns(2)
-        with timing_left:
+        timing_left_column, timing_right_column = st.columns(2)
+        with timing_left_column:
             st.selectbox(
                 options=["OnboardClock"],
                 label="Sample Clock Source",
@@ -152,7 +152,7 @@
                 disabled=panel.get_value("is_running", False),
                 key="sample_rate_input",
             )
-        with timing_right:
+        with timing_right_column:
             st.number_input(
                 "Samples per Loop",
                 value=3000,
@@ -168,7 +168,7 @@
             )
 
 # Right column - Graph and Logging Settings
-with right_col:
+with right_column:
     with st.container(border=True):
         # Graph section
         st.header("Voltage & Thermocouple")
@@ -217,18 +217,18 @@
     # Logging Settings section in right column
     with st.container(border=True):
         st.header("Logging Settings")
-        logging_left, logging_right = st.columns(2)
-        with logging_left:
+        logging_left_column, logging_right_column = st.columns(2)
+        with logging_left_column:
             ni.enum_selectbox(
                 panel,
                 label="Logging Mode",
                 value=LoggingMode.OFF,
                 disabled=panel.get_value("is_running", False),
                 key="logging_mode",
             )
-        with logging_right:
-            col1, col2 = st.columns([3, 1])
-            with col1:
+        with logging_right_column:
+            left_sub_column, right_sub_column = st.columns([3, 1])
+            with left_sub_column:
                 tdms_file_path = st.text_input(
                     label="TDMS File Path",
                     disabled=panel.get_value("is_running", False),

src/nipanel/_panel_value_accessor.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import collections
 import enum
 from abc import ABC
 from typing import TypeVar, overload
@@ -16,7 +17,13 @@
 class PanelValueAccessor(ABC):
     """This class allows you to access values for a panel's controls."""
 
-    __slots__ = ["_panel_client", "_panel_id", "_notify_on_set_value", "__weakref__"]
+    __slots__ = [
+        "_panel_client",
+        "_panel_id",
+        "_notify_on_set_value",
+        "_last_values",
+        "__weakref__",
+    ]
 
     def __init__(
         self,
@@ -39,6 +46,7 @@ def __init__(
         )
         self._panel_id = panel_id
         self._notify_on_set_value = notify_on_set_value
+        self._last_values = collections.defaultdict(lambda: object())
 
     @property
     def panel_id(self) -> str:
@@ -93,3 +101,16 @@ def set_value(self, value_id: str, value: object) -> None:
         self._panel_client.set_value(
             self._panel_id, value_id, value, notify=self._notify_on_set_value
         )
+        self._last_values[value_id] = value
+
+    def set_value_if_changed(self, value_id: str, value: object) -> None:
+        """Set the value for a control on the panel only if it has changed since the last call.
+
+        This method helps reduce unnecessary updates when the value hasn't changed.
+
+        Args:
+            value_id: The id of the value
+            value: The value to set
+        """
+        if value != self._last_values[value_id]:
+            self.set_value(value_id, value)

src/nipanel/_streamlit_panel_value_accessor.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import collections
 from typing import final
 
 import grpc
@@ -18,8 +17,6 @@ class StreamlitPanelValueAccessor(PanelValueAccessor):
     This class should only be used within a Streamlit script.
     """
 
-    __slots__ = ["_last_values"]
-
     def __init__(
         self,
         panel_id: str,
@@ -46,19 +43,3 @@ def __init__(
             grpc_channel_pool=grpc_channel_pool,
             grpc_channel=grpc_channel,
         )
-        self._last_values: collections.defaultdict[str, object] = collections.defaultdict(
-            lambda: object()
-        )
-
-    def set_value_if_changed(self, value_id: str, value: object) -> None:
-        """Set the value for a control on the panel only if it has changed since the last call.
-
-        This method helps reduce unnecessary updates when the value hasn't changed.
-
-        Args:
-            value_id: The id of the value
-            value: The value to set
-        """
-        if value != self._last_values[value_id]:
-            self.set_value(value_id, value)
-            self._last_values[value_id] = value

src/nipanel/controls/_enum_selectbox.py

@@ -7,17 +7,17 @@
 
 from nipanel._streamlit_panel_value_accessor import StreamlitPanelValueAccessor
 
-T = TypeVar("T", bound=Enum)
+TEnumType = TypeVar("TEnumType", bound=Enum)
 
 
 def enum_selectbox(
     panel: StreamlitPanelValueAccessor,
     label: str,
-    value: T,
+    value: TEnumType,
     key: str,
     disabled: bool = False,
     format_func: Callable[[Any], str] = lambda x: x[0],
-) -> T:
+) -> TEnumType:
     """Create a selectbox for an Enum.
 
     The selectbox will display the names of all the enum values, and when a value is selected,

src/nipanel/controls/_flag_checkboxes.py

@@ -1,23 +1,23 @@
 """A set of checkboxes for selecting Flag enum values."""
 
 from enum import Flag
-from typing import TypeVar, Callable
+from typing import TypeVar, Callable, Optional
 
 import streamlit as st
 
 from nipanel._streamlit_panel_value_accessor import StreamlitPanelValueAccessor
 
-T = TypeVar("T", bound=Flag)
+TFlagType = TypeVar("TFlagType", bound=Flag)
 
 
 def flag_checkboxes(
     panel: StreamlitPanelValueAccessor,
     label: str,
-    value: T,
+    value: TFlagType,
     key: str,
-    disabled: bool = False,
+    disabled_values: Optional[TFlagType] = None,
     label_formatter: Callable[[Flag], str] = lambda x: str(x.name),
-) -> T:
+) -> TFlagType:
     """Create a set of checkboxes for a Flag enum.
 
     This will display a checkbox for each individual flag value in the enum. When checkboxes
@@ -29,7 +29,8 @@ def flag_checkboxes(
         label: Label to display above the checkboxes
         value: The default Flag enum value (also determines the specific Flag enum type)
         key: Key to use for storing the Flag value in the panel
-        disabled: Whether the checkboxes should be disabled
+        disabled_values: A Flag enum value indicating which flags should be disabled.
+                         If None or flag_type(0), no checkboxes are disabled.
         label_formatter: Function that formats the flag to a string for display. Default
                          uses flag.name.
 
@@ -49,20 +50,23 @@ def flag_checkboxes(
 
     # Create a container for flag checkboxes
     flag_container = st.container(border=True)
-    selected_flags = flag_type(0)  # Start with no flags
 
-    # If default value is set, use it as the initial state
-    if value:
-        selected_flags = value
+    # Use the provided value as the initial state for selected flags
+    selected_flags = value
 
     # Create a checkbox for each flag
     for flag in flag_values:
         is_selected = bool(selected_flags & flag)
+
+        is_disabled = False
+        if disabled_values is not None:
+            is_disabled = bool(disabled_values & flag)
+
         if flag_container.checkbox(
             label=label_formatter(flag),
             value=is_selected,
             key=f"{key}_{flag.name}",
-            disabled=disabled,
+            disabled=is_disabled,
         ):
             selected_flags |= flag
         else: