bec/bec_widgets
1
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2026-03-04 16:02:51 +01:00
Code Activity

docs: docstring for config dialog

Browse Source
This commit is contained in:
perl_d
2025-06-18 11:02:25 +02:00
committed by David Perl
parent b6cef2d27b
commit 1925e6ac7f
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
bec_widgets/widgets/services/device_browser/device_item/device_config_dialog.py
View File

@@ -67,6 +67,15 @@ class DeviceConfigDialog(BECWidget, QDialog):
config_helper: ConfigHelper | None = None,
**kwargs,
):
"""A dialog to edit the configuration of a device in BEC. Generated from the pydantic model
for device specification in bec_lib.atlas_models.
Args:
parent (QObject): the parent QObject
device (str | None): the name of the device. used with the "update" action to prefill the dialog and validate entries.
config_helper (ConfigHelper | None): a ConfigHelper object for communication with Redis, will be created if necessary.
action (Literal["update", "add"]): the action which the form should perform on application or acceptance.
"""
super().__init__(parent=parent, **kwargs)
self._config_helper = config_helper or ConfigHelper(
self.client.connector, self.client._service_name