bec-widgets 0.57.6__tar.gz → 0.57.7__tar.gz

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 
 
+## v0.57.7 (2024-06-07)
+
+### Documentation
+
+* docs: added schema of BECDockArea and BECFigure ([`828067f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/828067f486a905eb4678538df58e2bdd6c770de1))
+
+### Fix
+
+* fix: add model_config to pydantic models to allow runtime checks after creation ([`ca5e8d2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca5e8d2fbbffbf221cc5472710fef81a33ee29d6))
+
+
 ## v0.57.6 (2024-06-06)
 
 ### Fix
@@ -140,14 +151,6 @@
 
 ## v0.56.0 (2024-05-29)
 
-### Build
-
-* build: added pyside6 as dependency ([`db301b1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/db301b1be27bba76c8bb21fbff93cb4902b592a5))
-
-### Ci
-
-* ci: added tests for pyside6, pyqt6 and pyqt5, default test and e2e is python 3.11 and pyqt6 ([`855be35`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/855be3551a1372bcbebba6f8930903f99202bbca))
-
 ### Documentation
 
 * docs(examples): example apps section deleted ([`ad208a5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ad208a5ef8495c45a8b83a4850ba9a1041b42717))
@@ -155,5 +158,3 @@
 ### Fix
 
 * fix(examples): outdated examples removed (mca_plot.py, stream_plot.py, motor_example.py) ([`ddc9510`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ddc9510c2ba8dadf291809eeb5b135a105259492))
-
-* fix: compatibility adjustment to .ui loading and tests for PySide6 ([`07b99d9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/07b99d91a57a645cddd76294f48d78773e4c9ea5))

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.6
+Version: 0.57.7
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/cli/auto_updates.py

@@ -15,6 +15,7 @@ class ScanInfo(BaseModel):
     scan_report_devices: list
     monitored_devices: list
     status: str
+    model_config: dict = {"validate_assignment": True}
 
 
 class AutoUpdates:

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/utils/bec_connector.py

@@ -20,6 +20,7 @@ class ConnectionConfig(BaseModel):
     gui_id: Optional[str] = Field(
         default=None, validate_default=True, description="The GUI ID of the widget."
     )
+    model_config: dict = {"validate_assignment": True}
 
     @field_validator("gui_id")
     def generate_gui_id(cls, v, values):

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/widgets/figure/plots/image/image_processor.py

@@ -19,6 +19,7 @@ class ProcessingConfig(BaseModel):
     rotation: Optional[int] = Field(
         None, description="The rotation angle of the monitor data before displaying."
     )
+    model_config: dict = {"validate_assignment": True}
 
 
 class ImageProcessor:

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/widgets/figure/plots/plot_base.py

@@ -20,6 +20,7 @@ class AxisConfig(BaseModel):
     y_lim: Optional[tuple] = Field(None, description="The limits of the y-axis.")
     x_grid: bool = Field(False, description="Show grid on the x-axis.")
     y_grid: bool = Field(False, description="Show grid on the y-axis.")
+    model_config: dict = {"validate_assignment": True}
 
 
 class SubplotConfig(ConnectionConfig):

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/widgets/figure/plots/waveform/waveform_curve.py

@@ -17,6 +17,7 @@ class SignalData(BaseModel):
     unit: Optional[str] = None  # todo implement later
     modifier: Optional[str] = None  # todo implement later
     limits: Optional[list[float]] = None  # todo implement later
+    model_config: dict = {"validate_assignment": True}
 
 
 class Signal(BaseModel):
@@ -26,6 +27,7 @@ class Signal(BaseModel):
     x: SignalData  # TODO maybe add metadata for config gui later
     y: SignalData
     z: Optional[SignalData] = None
+    model_config: dict = {"validate_assignment": True}
 
 
 class CurveConfig(ConnectionConfig):

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/bec_widgets/widgets/spiral_progress_bar/ring.py

@@ -13,6 +13,7 @@ from bec_widgets.utils import BECConnector, ConnectionConfig
 class RingConnections(BaseModel):
     slot: Literal["on_scan_progress", "on_device_readback"] = None
     endpoint: EndpointInfo | str = None
+    model_config: dict = {"validate_assignment": True}
 
     @field_validator("endpoint")
     def validate_endpoint(cls, v, values):

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/docs/user/getting_started/quick_start.md

@@ -5,6 +5,10 @@ In order to use BEC Widgets as a plotting tool for BEC, it needs to be [installe
 ## BECDockArea
 The `bec.gui` object is your entry point to BEC Widgets. It is a [`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) instance that can be composed of multiple [`BECDock`](/api_reference/_autosummary/bec_widgets.cli.client.BECDock)s that can be attached / detached to the main area. These docks allow users to freely arrange and customize the widgets they add to the gui, providing a flexible and customizable interface to visualize data. 
 
+**Schema of the BECDockArea**
+
+![BECDockArea.png](BECDockArea.png)
+
 ## Widgets
 Widgets are the building blocks of the BEC Widgets framework. They are the visual components that allow users to interact with the data and control the behavior of the application. Each dock can contain multiple widgets, albeit we recommend for most use cases a single widget per dock. BEC Widgets provides a set of core widgets (cf. [widgets](#user.widgets)). More widgets can be added by the users, and we invite you to explore the [developer documentation](developer.widgets) to learn how to create custom widgets.
 For the introduction given here, we will focus on the `BECFigure` widget, as it is the most commonly used widget for visualizing data from BEC. The same access pattern can be used for all other widgets.

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/docs/user/widgets/bec_figure.md

@@ -3,6 +3,10 @@
 [`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) is a widget that provides a graphical user interface for creating and managing plots. It is a versatile tool that allows users to create a wide range of plots, from simple 1D waveforms to complex 2D scatter plots. BECFigure is designed to be user-friendly and interactive, enabling users to customize plots and visualize data in real-time.
 In the following, we describe 4 different type of widgets thaat are available in BECFigure. 
 
+**Schema of the BECFigure**
+
+![BECFigure.png](BECFigure.png)
+
 (user.widgets.waveform_1d)=
 ## [1D Waveform Widget](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)
 

{bec_widgets-0.57.6 → bec_widgets-0.57.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.57.6"
+version = "0.57.7"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [