steer-core 0.1.16__py3-none-any.whl → 0.1.17__py3-none-any.whl

steer_core/Apps/Components/RangeSliderComponents.py

@@ -7,16 +7,16 @@ from dash import Input, Output
 class RangeSliderWithTextInput:
     """
     A custom Dash component that combines a range slider with two text inputs for synchronized range control.
-    
+
     This component creates a user interface element consisting of a range slider and two numeric input fields
     that can be used together to set numeric ranges. The range slider provides visual feedback and easy
-    adjustment of both start and end values, while the text inputs allow for precise value entry. All 
+    adjustment of both start and end values, while the text inputs allow for precise value entry. All
     components are synchronized and share the same value constraints.
-    
+
     The component is designed for use in Dash applications where users need to input numeric ranges
     within a specified domain, with the flexibility of both visual (range slider) and precise (text inputs)
     control methods.
-    
+
     Attributes:
         id_base (dict): Base identifier dictionary used to construct unique IDs for child components
         min_val (float): Minimum allowed value for both slider and inputs
@@ -33,7 +33,7 @@ class RangeSliderWithTextInput:
         slider_id (dict): Computed ID for the range slider component
         input_start_id (dict): Computed ID for the start value input component
         input_end_id (dict): Computed ID for the end value input component
-    
+
     Example:
         >>> range_component = RangeSliderWithTextInput(
         ...     id_base={'type': 'parameter', 'index': 0},
@@ -61,12 +61,12 @@ class RangeSliderWithTextInput:
         default_val: Union[list[float], None] = None,
         with_slider_titles: bool = True,
         slider_disable: bool = False,
-        div_width: str = 'calc(90%)',
+        div_width: str = "calc(90%)",
         message: str = None,
     ):
         """
         Initialize the RangeSliderWithTextInput component.
-        
+
         Args:
             id_base (dict): Base dictionary for generating component IDs. Should contain
                            identifying information that will be extended with component-specific
@@ -94,27 +94,31 @@ class RangeSliderWithTextInput:
             message (str, optional): Optional message to display between the title
                                    and slider. If None, no message is displayed.
                                    Defaults to None.
-        
+
         Raises:
             ValueError: If min_val >= max_val, or if step <= 0, or if mark_interval <= 0,
                        or if default_val contains invalid range values.
             TypeError: If default_val is provided but not a list of numeric values.
         """
-        
+
         # Validate inputs
         if min_val >= max_val:
-            raise ValueError(f"min_val ({min_val}) must be less than max_val ({max_val})")
+            raise ValueError(
+                f"min_val ({min_val}) must be less than max_val ({max_val})"
+            )
         if step <= 0:
             raise ValueError(f"step ({step}) must be positive")
         if mark_interval <= 0:
             raise ValueError(f"mark_interval ({mark_interval}) must be positive")
-        
+
         # Validate and set default values
         if default_val is None:
             default_val = [min_val, max_val]
         else:
             if not isinstance(default_val, list) or len(default_val) != 2:
-                raise TypeError("default_val must be a list of two numeric values [start, end]")
+                raise TypeError(
+                    "default_val must be a list of two numeric values [start, end]"
+                )
             try:
                 default_val = [float(default_val[0]), float(default_val[1])]
             except (ValueError, TypeError):
@@ -135,42 +139,42 @@ class RangeSliderWithTextInput:
         self.slider_disable = slider_disable
         self.message = message
 
-        self.slider_id = self._make_id('rangeslider')
-        self.input_start_id = self._make_id('input_start')
-        self.input_end_id = self._make_id('input_end')
+        self.slider_id = self._make_id("rangeslider")
+        self.input_start_id = self._make_id("input_start")
+        self.input_end_id = self._make_id("input_end")
 
     def _make_id(self, subtype: str):
         """
         Generate a unique ID dictionary for component sub-elements.
-        
+
         Combines the base ID with component-specific subtype and property information
         to create unique identifiers for Dash callbacks and component references.
-        
+
         Args:
             subtype (str): The specific component subtype (e.g., 'rangeslider', 'input_start', 'input_end').
-        
+
         Returns:
             dict: Complete ID dictionary containing base ID information plus subtype
                   and property specifications.
-        
+
         Example:
             >>> component._make_id('rangeslider')
             {'type': 'parameter', 'index': 0, 'subtype': 'rangeslider', 'property': 'temperature_range'}
         """
-        return {**self.id_base, 'subtype': subtype, 'property': self.property_name}
+        return {**self.id_base, "subtype": subtype, "property": self.property_name}
 
     def _make_range_slider(self):
         """
         Create and configure the Dash range slider component.
-        
+
         Generates a dcc.RangeSlider with the specified range, step size, default values,
         and tick marks. The range slider provides visual feedback for range selection
         and is synchronized with the text input components.
-        
+
         Returns:
             dash.dcc.RangeSlider: Configured range slider component with ID, value constraints,
                                 tick marks, and styling options.
-        
+
         Note:
             - Tick marks are generated at intervals specified by mark_interval
             - updatemode is set to 'mouseup' to reduce callback frequency
@@ -183,22 +187,27 @@ class RangeSliderWithTextInput:
             value=self.default_val,
             step=self.step,
             disabled=self.slider_disable,
-            marks={int(i): "" for i in np.arange(self.min_val, self.max_val + self.mark_interval, self.mark_interval)},
-            updatemode='mouseup'
+            marks={
+                int(i): ""
+                for i in np.arange(
+                    self.min_val, self.max_val + self.mark_interval, self.mark_interval
+                )
+            },
+            updatemode="mouseup",
         )
 
     def _make_start_input(self):
         """
         Create and configure the Dash numeric input component for the start value.
-        
+
         Generates a dcc.Input with number type for precise start value entry.
         The input is synchronized with the range slider and provides an alternative
         method for users to specify exact start values.
-        
+
         Returns:
             dash.dcc.Input: Configured numeric input component with ID, type,
                           value constraints, styling, and step specification.
-        
+
         Note:
             - Input type is set to 'number' for numeric validation
             - Width and margin styling provides visual alignment
@@ -206,25 +215,25 @@ class RangeSliderWithTextInput:
         """
         return ds.dcc.Input(
             id=self.input_start_id,
-            type='number',
+            type="number",
             value=self.default_val[0],
             step=self.step,
-            style={'width': '80px'},
+            style={"width": "80px"},
             disabled=self.slider_disable,
         )
 
     def _make_end_input(self):
         """
         Create and configure the Dash numeric input component for the end value.
-        
+
         Generates a dcc.Input with number type for precise end value entry.
         The input is synchronized with the range slider and provides an alternative
         method for users to specify exact end values.
-        
+
         Returns:
             dash.dcc.Input: Configured numeric input component with ID, type,
                           value constraints, styling, and step specification.
-        
+
         Note:
             - Input type is set to 'number' for numeric validation
             - Width and margin styling provides visual alignment
@@ -232,22 +241,22 @@ class RangeSliderWithTextInput:
         """
         return ds.dcc.Input(
             id=self.input_end_id,
-            type='number',
+            type="number",
             value=self.default_val[1],
             step=self.step,
-            style={'margin-left': '10px', 'width': '80px'},
+            style={"margin-left": "10px", "width": "80px"},
             disabled=self.slider_disable,
         )
 
     def __call__(self):
         """
         Generate the complete component layout as a callable object.
-        
+
         Creates and returns a Dash HTML Div containing the title, optional message,
         range slider, and input components arranged in a cohesive layout. This method allows
         the class instance to be used as a callable that returns the complete
         component structure.
-        
+
         Returns:
             dash.html.Div: Complete component layout containing:
                 - Title paragraph (conditional based on with_slider_titles)
@@ -255,7 +264,7 @@ class RangeSliderWithTextInput:
                 - Range slider component in a styled container
                 - Start and end numeric input components with labels
                 - Spacing elements (line breaks)
-        
+
         Note:
             - Title display is controlled by with_slider_titles attribute
             - When title is hidden, a non-breaking space maintains layout
@@ -265,50 +274,70 @@ class RangeSliderWithTextInput:
             - Input labels provide clear indication of start/end values
         """
         slider_title = self.title if self.with_slider_titles else "\u00A0"
-        
+
         # Build the component list
         components = [
-            ds.html.P(slider_title, style={'margin-left': '20px', 'margin-bottom': '0px'})
+            ds.html.P(
+                slider_title, style={"margin-left": "20px", "margin-bottom": "0px"}
+            )
         ]
-        
+
         # Add optional message if provided
         if self.message:
             components.append(
-                ds.html.P(self.message, style={
-                    'margin-left': '20px', 
-                    'margin-bottom': '5px',
-                    'margin-top': '2px',
-                    'font-size': '0.9em',
-                    'color': '#666666',
-                    'font-style': 'italic'
-                })
+                ds.html.P(
+                    self.message,
+                    style={
+                        "margin-left": "20px",
+                        "margin-bottom": "5px",
+                        "margin-top": "2px",
+                        "font-size": "0.9em",
+                        "color": "#666666",
+                        "font-style": "italic",
+                    },
+                )
             )
-        
+
         # Add slider and input components
-        components.extend([
-            ds.html.Div([self._make_range_slider()], style={'margin-bottom': '-18px'}),
-            ds.html.Div([
-                ds.html.Span("Start:", style={'margin-left': '20px', 'margin-right': '5px'}),
-                self._make_start_input(),
-                ds.html.Span("End:", style={'margin-left': '15px', 'margin-right': '5px'}),
-                self._make_end_input(),
-            ], style={'display': 'flex', 'align-items': 'center'}),
-            ds.html.Br(), ds.html.Br()
-        ])
-
-        return ds.html.Div(components, style={'width': self.div_width, 'margin-left': '-20px'})
+        components.extend(
+            [
+                ds.html.Div(
+                    [self._make_range_slider()], style={"margin-bottom": "-18px"}
+                ),
+                ds.html.Div(
+                    [
+                        ds.html.Span(
+                            "Start:",
+                            style={"margin-left": "20px", "margin-right": "5px"},
+                        ),
+                        self._make_start_input(),
+                        ds.html.Span(
+                            "End:", style={"margin-left": "15px", "margin-right": "5px"}
+                        ),
+                        self._make_end_input(),
+                    ],
+                    style={"display": "flex", "align-items": "center"},
+                ),
+                ds.html.Br(),
+                ds.html.Br(),
+            ]
+        )
+
+        return ds.html.Div(
+            components, style={"width": self.div_width, "margin-left": "-20px"}
+        )
 
     @property
     def components(self):
         """
         Get a dictionary mapping component types to their IDs.
-        
+
         Provides easy access to the IDs of the range slider and input components
         for use in Dash callbacks and component interactions.
-        
+
         Returns:
             dict: Dictionary with component type keys mapping to their ID dictionaries.
-        
+
         Example:
             >>> component.components
             {
@@ -316,27 +345,27 @@ class RangeSliderWithTextInput:
                 'input_start': {'type': 'parameter', 'subtype': 'input_start', 'property': 'temp_range'},
                 'input_end': {'type': 'parameter', 'subtype': 'input_end', 'property': 'temp_range'}
             }
-        
+
         Note:
             This property is particularly useful for setting up Dash callbacks
             that need to reference the specific component IDs.
         """
         return {
-            'rangeslider': self.slider_id, 
-            'input_start': self.input_start_id, 
-            'input_end': self.input_end_id
+            "rangeslider": self.slider_id,
+            "input_start": self.input_start_id,
+            "input_end": self.input_end_id,
         }
-    
+
     def get_value_inputs(self):
         """
         Get Input objects for listening to component value changes.
-        
+
         Returns a list of Dash Input objects that can be used in callbacks to
         listen for value changes from the range slider or input components.
-        
+
         Returns:
             list: List containing [Input(slider_id, 'value'), Input(input_start_id, 'value'), Input(input_end_id, 'value')]
-            
+
         Example:
             >>> @app.callback(
             ...     Output('some-output', 'children'),
@@ -346,21 +375,21 @@ class RangeSliderWithTextInput:
             ...     return f"Range: {slider_range or [start_val, end_val]}"
         """
         return [
-            Input(self.slider_id, 'value'),
-            Input(self.input_start_id, 'value'),
-            Input(self.input_end_id, 'value')
+            Input(self.slider_id, "value"),
+            Input(self.input_start_id, "value"),
+            Input(self.input_end_id, "value"),
         ]
-    
+
     def get_value_outputs(self):
         """
         Get Output objects for updating component values.
-        
+
         Returns a list of Dash Output objects that can be used in callbacks to
         update the values of the range slider and input components.
-        
+
         Returns:
             list: List containing [Output(slider_id, 'value'), Output(input_start_id, 'value'), Output(input_end_id, 'value')]
-            
+
         Example:
             >>> @app.callback(
             ...     component.get_value_outputs(),
@@ -370,25 +399,25 @@ class RangeSliderWithTextInput:
             ...     return [new_range, new_range[0], new_range[1]]
         """
         return [
-            Output(self.slider_id, 'value'),
-            Output(self.input_start_id, 'value'),
-            Output(self.input_end_id, 'value')
+            Output(self.slider_id, "value"),
+            Output(self.input_start_id, "value"),
+            Output(self.input_end_id, "value"),
         ]
-    
-    def get_pattern_matching_value_inputs(self, property_name='ALL'):
+
+    def get_pattern_matching_value_inputs(self, property_name="ALL"):
         """
         Get pattern-matching Input objects for listening to multiple component instances.
-        
+
         Returns Input objects using pattern-matching to listen to all components
         with the specified property name, useful for multi-component callbacks.
-        
+
         Args:
             property_name: The property to match. Use 'ALL' for all properties,
                           or specify a specific property name.
-                          
+
         Returns:
             list: List containing pattern-matching Input objects
-            
+
         Example:
             >>> @app.callback(
             ...     Output('summary', 'children'),
@@ -397,30 +426,42 @@ class RangeSliderWithTextInput:
             ... def update_summary(slider_ranges, start_values, end_values):
             ...     return f"Total range sliders: {len(slider_ranges)}"
         """
-        slider_pattern = {'type': 'parameter', 'subtype': 'rangeslider', 'property': property_name}
-        start_pattern = {'type': 'parameter', 'subtype': 'input_start', 'property': property_name}
-        end_pattern = {'type': 'parameter', 'subtype': 'input_end', 'property': property_name}
-        
+        slider_pattern = {
+            "type": "parameter",
+            "subtype": "rangeslider",
+            "property": property_name,
+        }
+        start_pattern = {
+            "type": "parameter",
+            "subtype": "input_start",
+            "property": property_name,
+        }
+        end_pattern = {
+            "type": "parameter",
+            "subtype": "input_end",
+            "property": property_name,
+        }
+
         return [
-            Input(slider_pattern, 'value'),
-            Input(start_pattern, 'value'),
-            Input(end_pattern, 'value')
+            Input(slider_pattern, "value"),
+            Input(start_pattern, "value"),
+            Input(end_pattern, "value"),
         ]
-    
-    def get_pattern_matching_value_outputs(self, property_name='ALL'):
+
+    def get_pattern_matching_value_outputs(self, property_name="ALL"):
         """
         Get pattern-matching Output objects for updating multiple component instances.
-        
+
         Returns Output objects using pattern-matching to update all components
         with the specified property name.
-        
+
         Args:
             property_name: The property to match. Use 'ALL' for all properties,
                           or specify a specific property name.
-                          
+
         Returns:
             list: List containing pattern-matching Output objects
-            
+
         Example:
             >>> @app.callback(
             ...     component.get_pattern_matching_value_outputs('ALL'),
@@ -431,70 +472,80 @@ class RangeSliderWithTextInput:
             ...         return [[[0, 100]] * len(ranges), [0] * len(starts), [100] * len(ends)]
             ...     return [dash.no_update] * 3
         """
-        slider_pattern = {'type': 'parameter', 'subtype': 'rangeslider', 'property': property_name}
-        start_pattern = {'type': 'parameter', 'subtype': 'input_start', 'property': property_name}
-        end_pattern = {'type': 'parameter', 'subtype': 'input_end', 'property': property_name}
-        
+        slider_pattern = {
+            "type": "parameter",
+            "subtype": "rangeslider",
+            "property": property_name,
+        }
+        start_pattern = {
+            "type": "parameter",
+            "subtype": "input_start",
+            "property": property_name,
+        }
+        end_pattern = {
+            "type": "parameter",
+            "subtype": "input_end",
+            "property": property_name,
+        }
+
         return [
-            Output(slider_pattern, 'value'),
-            Output(start_pattern, 'value'),
-            Output(end_pattern, 'value')
+            Output(slider_pattern, "value"),
+            Output(start_pattern, "value"),
+            Output(end_pattern, "value"),
         ]
-    
+
     def _validate_and_clamp_range(self, range_values):
         """
         Validate and clamp range values to the component's valid domain.
-        
+
         Ensures that range values are within the min_val to max_val domain,
         maintains proper ordering (start <= end), and handles invalid values.
-        
+
         Args:
             range_values (list): The range values to validate and clamp [start, end].
-            
+
         Returns:
             list[float]: The clamped range values within the valid domain,
                         with proper ordering maintained.
         """
         if not isinstance(range_values, list) or len(range_values) != 2:
             return [self.min_val, self.max_val]
-        
+
         try:
             start, end = float(range_values[0]), float(range_values[1])
-            
+
             # Clamp to valid domain
             start = max(self.min_val, min(self.max_val, start))
             end = max(self.min_val, min(self.max_val, end))
-            
+
             # Ensure proper ordering
             if start > end:
                 start, end = end, start
-                
+
             return [start, end]
-            
+
         except (ValueError, TypeError):
             return [self.min_val, self.max_val]
-    
+
     def _validate_and_clamp_value(self, value):
         """
         Validate and clamp a single value to the component's valid range.
-        
+
         Ensures that any input value is within the min_val to max_val range
         and handles None values appropriately.
-        
+
         Args:
             value: The value to validate and clamp.
-            
+
         Returns:
             float: The clamped value within the valid range, or min_val
                    if the input value is invalid.
         """
         if value is None:
             return self.min_val
-        
+
         try:
             numeric_value = float(value)
             return max(self.min_val, min(self.max_val, numeric_value))
         except (ValueError, TypeError):
             return self.min_val
-    
-