fix: prel. support for config_plotter with widgets instead of items

.git_hooks/pre-commit

@@ -1,3 +1,2 @@
-black --line-length=100 $(git diff --cached --name-only --diff-filter=ACM -- '*.py')
-isort --line-length=100 --profile=black --multi-line=3 --trailing-comma $(git diff --cached --name-only --diff-filter=ACM -- '*.py')
-git add $(git diff --cached --name-only --diff-filter=ACM -- '*.py')
+black --line-length=100 $(git diff --cached --name-only --diff-filter=ACM -- '***.py')
+git add $(git diff --cached --name-only --diff-filter=ACM -- '***.py')

.gitlab-ci.yml

@@ -1,95 +1,29 @@
 # This file is a template, and might need editing before it works on your project.
 # Official language image. Look for the different tagged releases at:
 # https://hub.docker.com/r/library/python/tags/
-image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:3.11
+image: $CI_DOCKER_REGISTRY/python:3.9
 #commands to run in the Docker container before starting each job.
 variables:
   DOCKER_TLS_CERTDIR: ""
-  BEC_CORE_BRANCH:
-    description: bec branch
-    value: main
-  OPHYD_DEVICES_BRANCH:
-    description: ophyd_devices branch
-    value: main
-  CHILD_PIPELINE_BRANCH: $CI_DEFAULT_BRANCH
-  CHECK_PKG_VERSIONS:
-    description: Whether to run additional tests against min/max/random selection of dependencies. Set to 1 for running. 
-    value: 0
-
-workflow:
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-    - if: $CI_PIPELINE_SOURCE == "web"
-    - if: $CI_PIPELINE_SOURCE == "pipeline"
-    - if: $CI_PIPELINE_SOURCE == "parent_pipeline"
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
-    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
-      when: never
-    - if: $CI_COMMIT_BRANCH
-
-include:
-  - template: Security/Secret-Detection.gitlab-ci.yml
-  - project: "bec/awi_utils"
-    file: "/templates/check-packages-job.yml"
-    inputs:
-      stage: test
-      path: "."
-      pytest_args: "-v,--random-order,tests/unit_tests"
-      ignore_dep_group: "pyqt6"
-      pip_args: ".[dev,pyside6]"
 
 # different stages in the pipeline
 stages:
   - Formatter
-  - test
-  - AdditionalTests
-  - End2End
+  - Unittests
   - Deploy
 
-.install-qt-webengine-deps: &install-qt-webengine-deps
-  - apt-get -y install libnss3 libxdamage1 libasound2 libatomic1 libxcursor1
-  - export QTWEBENGINE_DISABLE_SANDBOX=1
-
-.clone-repos: &clone-repos
-  - echo -e "\033[35;1m Using branch $BEC_CORE_BRANCH of BEC CORE \033[0;m";
-  - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
-  - echo -e "\033[35;1m Using branch $OPHYD_DEVICES_BRANCH of OPHYD_DEVICES \033[0;m";
-  - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
-  - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
-
-.install-repos: &install-repos
-  - pip install -e ./ophyd_devices
-  - pip install -e ./bec/bec_lib[dev]
-  - pip install -e ./bec/bec_ipython_client
-
-.install-os-packages: &install-os-packages
-  - apt-get update
-  - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb
-  - *install-qt-webengine-deps
-
-before_script:
-  - if [[ "$CI_PROJECT_PATH" != "bec/bec_widgets" ]]; then
-    echo -e "\033[35;1m Using branch $CHILD_PIPELINE_BRANCH of BEC Widgets \033[0;m";
-    test -d bec_widgets || git clone --branch $CHILD_PIPELINE_BRANCH https://gitlab.psi.ch/bec/bec_widgets.git; cd bec_widgets;
-    fi
-
 formatter:
   stage: Formatter
   needs: []
   script:
-    - pip install black isort
-    - isort --check --diff ./
-    - black --check --diff --color ./
-  rules:
-    - if: $CI_PROJECT_PATH == "bec/bec_widgets"
-
+    - pip install black
+    - black --check --diff --color --line-length=100 ./
 pylint:
   stage: Formatter
   needs: []
-  before_script:
-    - pip install pylint pylint-exit anybadge
-    - pip install -e .[dev,pyqt6]
   script:
+    - pip install pylint pylint-exit anybadge
+    - pip install -e .[dev]
     - mkdir ./pylint
     - pylint ./bec_widgets --output-format=text --output=./pylint/pylint.log | tee ./pylint/pylint.log || pylint-exit $?
     - PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log)
@@ -99,134 +33,25 @@ pylint:
     paths:
       - ./pylint/
     expire_in: 1 week
-  rules:
-    - if: $CI_PROJECT_PATH == "bec/bec_widgets"
-
-pylint-check:
-  stage: Formatter
-  needs: []
-  allow_failure: true
-  before_script:
-    - pip install pylint pylint-exit anybadge
-    - apt-get update
-    - apt-get install -y bc
-  script:
-    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
-    # Identify changed Python files
-    - if [ "$CI_PIPELINE_SOURCE" == "merge_request_event" ]; then
-      TARGET_BRANCH_COMMIT_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME);
-      CHANGED_FILES=$(git diff --name-only $TARGET_BRANCH_COMMIT_SHA HEAD | grep '\.py$' || true);
-      else
-      CHANGED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA | grep '\.py$' || true);
-      fi
-    - if [ -z "$CHANGED_FILES" ]; then echo "No Python files changed."; exit 0; fi
-
-    - echo "Changed Python files:"
-      - $CHANGED_FILES
-    # Run pylint only on changed files
-    - mkdir ./pylint
-    - pylint $CHANGED_FILES --output-format=text | tee ./pylint/pylint_changed_files.log || pylint-exit $?
-    - PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint_changed_files.log)
-    - echo "Pylint score is $PYLINT_SCORE"
-
-    # Fail the job if the pylint score is below 9
-    - if [ "$(echo "$PYLINT_SCORE < 9" | bc)" -eq 1 ]; then echo "Your pylint score is below the acceptable threshold (9)."; exit 1; fi
-  artifacts:
-    paths:
-      - ./pylint/
-    expire_in: 1 week
-  rules:
-    - if: $CI_PROJECT_PATH == "bec/bec_widgets"
 
 tests:
-  stage: test
+  stage: Unittests
   needs: []
   variables:
-    QT_QPA_PLATFORM: "offscreen"
+      QT_QPA_PLATFORM: "offscreen"
   script:
-    - *clone-repos
-    - *install-os-packages
-    - *install-repos
-    - pip install -e .[dev,pyqt6]
-    - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --maxfail=2 --random-order --full-trace ./tests/unit_tests
+    - apt-get update
+    - apt-get install -y libgl1-mesa-glx x11-utils libxkbcommon-x11-0 
+    - pip install .[dev]
+    - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --random-order --full-trace ./tests
     - coverage report
     - coverage xml
   coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
   artifacts:
     reports:
       junit: report.xml
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
-    paths:
-      - tests/reference_failures/
-    when: always
+      cobertura: coverage.xml
 
-test-matrix:
-  parallel:
-    matrix:
-      - PYTHON_VERSION:
-          - "3.10"
-          - "3.11"
-          - "3.12"
-        QT_PCKG:
-          - "pyside6"
-          - "pyqt6"
-
-  stage: AdditionalTests
-  needs: []
-  variables:
-    QT_QPA_PLATFORM: "offscreen"
-    PYTHON_VERSION: ""
-    QT_PCKG: ""
-  image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:$PYTHON_VERSION
-  script:
-    - *clone-repos
-    - *install-os-packages
-    - *install-repos
-    - pip install -e .[dev,$QT_PCKG]
-    - pytest -v --maxfail=2 --junitxml=report.xml --random-order ./tests/unit_tests
-
-end-2-end-conda:
-  stage: End2End
-  needs: []
-  image: continuumio/miniconda3
-  allow_failure: false
-  variables:
-    QT_QPA_PLATFORM: "offscreen"
-  script:
-    - *clone-repos
-    - *install-os-packages
-    - conda config --prepend channels conda-forge
-    - conda config --set channel_priority strict
-    - conda config --set always_yes yes --set changeps1 no
-    - conda create -q -n test-environment python=3.11
-    - conda init bash
-    - source ~/.bashrc
-    - conda activate test-environment
-
-    - cd ./bec
-    - source ./bin/install_bec_dev.sh -t
-    - cd ../
-    - pip install -e ./ophyd_devices
-
-    - pip install -e .[dev,pyqt6]
-    - cd ./tests/end-2-end
-    - pytest -v --start-servers --flush-redis --random-order
-
-  artifacts:
-    when: on_failure
-    paths:
-      - ./logs/*.log
-    expire_in: 1 week
-
-  rules:
-    - if: '$CI_PIPELINE_SOURCE == "schedule"'
-    - if: '$CI_PIPELINE_SOURCE == "web"'
-    - if: '$CI_PIPELINE_SOURCE == "pipeline"'
-    - if: '$CI_PIPELINE_SOURCE == "parent_pipeline"'
-    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"'
-    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "production"'
 
 semver:
   stage: Deploy
@@ -242,29 +67,31 @@ semver:
     - git fetch --tags
     - git tag
 
-    # build and publish package
-    - pip install python-semantic-release==9.* wheel build twine
+    # build
+    - pip install python-semantic-release wheel
     - export GL_TOKEN=$CI_UPDATES
-    - semantic-release -vv version
-
-    # check if any artifacts were created
-    - if [ ! -d dist ]; then echo No release will be made; exit 0; fi
-    - twine upload dist/* -u __token__ -p $CI_PYPI_TOKEN --skip-existing
-    - semantic-release publish
-
+    - export REPOSITORY_USERNAME=__token__
+    - export REPOSITORY_PASSWORD=$CI_PYPI_TOKEN
+    - >
+      semantic-release publish -v DEBUG 
+      -D version_variable=./setup.py:__version__  
+      -D hvcs=gitlab 
+      
   allow_failure: false
   rules:
-    - if: '$CI_COMMIT_REF_NAME == "main" && $CI_PROJECT_PATH == "bec/bec_widgets"'
+    - if: '$CI_COMMIT_REF_NAME == "master"'
 
-pages:
-  stage: Deploy
-  needs: ["semver"]
-  variables:
-    TARGET_BRANCH: $CI_COMMIT_REF_NAME
-  rules:
-    - if: "$CI_COMMIT_TAG != null"
-      variables:
-        TARGET_BRANCH: $CI_COMMIT_TAG
-    - if: '$CI_COMMIT_REF_NAME == "main" && $CI_PROJECT_PATH == "bec/bec_widgets"'
-  script:
-    - curl -X POST -d "branches=$CI_COMMIT_REF_NAME" -d "token=$RTD_TOKEN" https://readthedocs.org/api/v2/webhook/bec-widgets/253243/
+# pages:
+#   stage: Deploy
+#   needs: ["tests"]
+#   script:
+#     - git clone --branch $OPHYD_DEVICES_BRANCH https://oauth2:$CI_OPHYD_DEVICES_KEY@gitlab.psi.ch/bec/ophyd_devices.git
+#     - export OPHYD_DEVICES_PATH=$PWD/ophyd_devices    
+#     - pip install -r ./docs/source/requirements.txt
+#     - apt-get install -y gcc
+#     - *install-bec-services    
+#     - cd ./docs/source; make html
+#     - curl -X POST -d "branches=$CI_COMMIT_REF_NAME" -d "token=$RTD_TOKEN" https://readthedocs.org/api/v2/webhook/beamline-experiment-control/221870/
+#   rules:
+#     - if: '$CI_COMMIT_REF_NAME == "master"'
+#     - if: '$CI_COMMIT_REF_NAME == "production"'

.gitlab/issue_templates/bug_report_template.md

@@ -1,17 +0,0 @@
-## Bug report
-
-## Summary
-
-[Provide a brief description of the bug.]
-
-## Expected Behavior vs Actual Behavior
-
-[Describe what you expected to happen and what actually happened.]
-
-## Steps to Reproduce
-
-[Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.]
-
-## Related Issues
-
-[Paste links to any related issues or feature requests.]

.gitlab/issue_templates/documentation_update_template.md

@@ -1,27 +0,0 @@
-## Documentation Section
-
-[Specify the section or page of the documentation that needs updating]
-
-## Current Information
-
-[Provide the current information in the documentation that needs to be updated]
-
-## Proposed Update
-
-[Describe the proposed update or correction. Be specific about the changes that need to be made]
-
-## Reason for Update
-
-[Explain the reason for the documentation update. Include any recent changes, new features, or corrections that necessitate the update]
-
-## Additional Context
-
-[Include any additional context or information that can help the documentation team understand the update better]
-
-## Attachments
-
-[Attach any files, screenshots, or references that can assist in making the documentation update]
-
-## Priority
-
-[Assign a priority level to the documentation update based on its urgency. Use a scale such as Low, Medium, High]

.gitlab/issue_templates/feature_request_template.md

@@ -1,40 +0,0 @@
-## Feature Summary
-
-[Provide a brief and clear summary of the new feature you are requesting]
-
-## Problem Description
-
-[Explain the problem or need that this feature aims to address. Be specific about the issues or gaps in the current functionality]
-
-## Use Case
-
-[Describe a real-world scenario or use case where this feature would be beneficial. Explain how it would improve the user experience or workflow]
-
-## Proposed Solution
-
-[If you have a specific solution in mind, describe it here. Explain how it would work and how it would address the problem described above]
-
-## Benefits
-
-[Explain the benefits and advantages of implementing this feature. Highlight how it adds value to the product or improves user satisfaction]
-
-## Alternatives Considered
-
-[If you've considered alternative solutions or workarounds, mention them here. Explain why the proposed feature is the preferred option]
-
-## Impact on Existing Functionality
-
-[Discuss how the new feature might impact or interact with existing features. Address any potential conflicts or dependencies]
-
-## Priority
-
-[Assign a priority level to the feature request based on its importance. Use a scale such as Low, Medium, High]
-
-## Attachments
-
-[Include any relevant attachments, such as sketches, diagrams, or references that can help the development team understand your feature request better]
-
-## Additional Information
-
-[Provide any additional information that might be relevant to the feature request, such as user feedback, market trends, or similar features in other products]
-

.gitlab/merge_request_templates/default.md

@@ -1,28 +0,0 @@
-## Description
-
-[Provide a brief description of the changes introduced by this merge request.]
-
-## Related Issues
-
-[Cite any related issues or feature requests that are addressed or resolved by this merge request. Use the gitlab syntax for linking issues, for example, `fixes #123` or `closes #123`.]
-
-## Type of Change
-
-- Change 1
-- Change 2
-
-## Potential side effects
-
-[Describe any potential side effects or risks of merging this MR.]
-
-## Screenshots / GIFs (if applicable)
-
-[Include any relevant screenshots or GIFs to showcase the changes made.]
-
-## Additional Comments
-
-[Add any additional comments or information that may be helpful for reviewers.]
-
-## Definition of Done
-- [ ] Documentation is up-to-date.
-

.pylintrc

@@ -1,581 +0,0 @@
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code.
-extension-pkg-allow-list=PyQt6, PySide6, pyqtgraph
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
-# for backward compatibility.)
-extension-pkg-whitelist=
-
-# Return non-zero exit code if any of these messages/categories are detected,
-# even if score is above --fail-under value. Syntax same as enable. Messages
-# specified are enabled, while categories only check already-enabled messages.
-fail-on=
-
-# Specify a score threshold to be exceeded before program exits with error.
-fail-under=8.0
-
-# Files or directories to be skipped. They should be base names, not paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against paths and can be in Posix or Windows format.
-ignore-paths=
-
-# Files or directories matching the regex patterns are skipped. The regex
-# matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
-# number of processors available to use.
-jobs=1
-
-# Control the amount of potential inferred values when inferring a single
-# object. This can help the performance when dealing with large functions or
-# complex, nested conditions.
-limit-inference-results=100
-
-# List of plugins (as comma separated values of python module names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Minimum Python version to use for version dependent checks. Will default to
-# the version used to run pylint.
-py-version=3.10
-
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once). You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use "--disable=all --enable=classes
-# --disable=W".
-disable=missing-module-docstring,
-        missing-class-docstring,
-        import-error,
-        no-name-in-module,
-        raw-checker-failed,
-        bad-inline-option,
-        locally-disabled,
-        file-ignored,
-        suppressed-message,
-        deprecated-pragma,
-        use-symbolic-message-instead,
-        unused-wildcard-import,
-        logging-fstring-interpolation,
-        line-too-long,
-        too-many-instance-attributes,
-        wrong-import-order
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=c-extension-no-member
-
-
-[REPORTS]
-
-# Python expression which should return a score less than or equal to 10. You
-# have access to the variables 'error', 'warning', 'refactor', and 'convention'
-# which contain the number of messages in each category, as well as 'statement'
-# which is the total number of statements analyzed. This score is used by the
-# global evaluation report (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details.
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio). You can also give a reporter class, e.g.
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages.
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-# Complete name of functions that never returns. When checking for
-# inconsistent-return-statements if a never returning function is called then
-# it will be considered as an explicit return statement and no message will be
-# printed.
-never-returning-functions=sys.exit,argparse.parse_error
-
-
-[LOGGING]
-
-# The type of string formatting that logging methods do. `old` means using %
-# formatting, `new` is for `{}` formatting.
-logging-format-style=old
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format.
-logging-modules=logging
-
-
-[SPELLING]
-
-# Limits count of emitted suggestions for spelling mistakes.
-max-spelling-suggestions=4
-
-# Spelling dictionary name. Available dictionaries: none. To make it work,
-# install the 'python-enchant' package.
-spelling-dict=
-
-# List of comma separated words that should be considered directives if they
-# appear and the beginning of a comment and should not be checked.
-spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains the private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to the private dictionary (see the
-# --spelling-private-dict-file option) instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,
-      XXX,
-      TODO
-
-# Regular expression of note tags to take in consideration.
-#notes-rgx=
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# class is considered mixin if its name matches the mixin-class-rgx option.
-ignore-mixin-members=yes
-
-# Tells whether to warn about missing members when the owner of the attribute
-# is inferred to be None.
-ignore-none=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis). It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-# Regex pattern to define which classes are considered mixins ignore-mixin-
-# members is set to 'yes'
-mixin-class-rgx=.*[Mm]ixin
-
-# List of decorators that change the signature of a decorated function.
-signature-mutators=
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid defining new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of names allowed to shadow builtins
-allowed-redefined-builtins=
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,
-          _cb
-
-# A regular expression matching the name of dummy variables (i.e. expected to
-# not be used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore.
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-expected-line-ending-format=
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module.
-max-module-lines=1000
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Comments are removed from the similarity computation
-ignore-comments=yes
-
-# Docstrings are removed from the similarity computation
-ignore-docstrings=yes
-
-# Imports are removed from the similarity computation
-ignore-imports=no
-
-# Signatures are removed from the similarity computation
-ignore-signatures=no
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-
-[BASIC]
-
-# Naming style matching correct argument names.
-argument-naming-style=snake_case
-
-# Regular expression matching correct argument names. Overrides argument-
-# naming-style.
-#argument-rgx=
-
-# Naming style matching correct attribute names.
-attr-naming-style=snake_case
-
-# Regular expression matching correct attribute names. Overrides attr-naming-
-# style.
-#attr-rgx=
-
-# Bad variable names which should always be refused, separated by a comma.
-bad-names=foo,
-          bar,
-          baz,
-          toto,
-          tutu,
-          tata
-
-# Bad variable names regexes, separated by a comma. If names match any regex,
-# they will always be refused
-bad-names-rgxs=
-
-# Naming style matching correct class attribute names.
-class-attribute-naming-style=any
-
-# Regular expression matching correct class attribute names. Overrides class-
-# attribute-naming-style.
-#class-attribute-rgx=
-
-# Naming style matching correct class constant names.
-class-const-naming-style=UPPER_CASE
-
-# Regular expression matching correct class constant names. Overrides class-
-# const-naming-style.
-#class-const-rgx=
-
-# Naming style matching correct class names.
-class-naming-style=PascalCase
-
-# Regular expression matching correct class names. Overrides class-naming-
-# style.
-#class-rgx=
-
-# Naming style matching correct constant names.
-const-naming-style=UPPER_CASE
-
-# Regular expression matching correct constant names. Overrides const-naming-
-# style.
-#const-rgx=
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Naming style matching correct function names.
-function-naming-style=snake_case
-
-# Regular expression matching correct function names. Overrides function-
-# naming-style.
-#function-rgx=
-
-# Good variable names which should always be accepted, separated by a comma.
-good-names=i,
-           ii,
-           jj,
-           kk,
-           dr,
-           j,
-           k,
-           ex,
-           Run,
-           cb,
-           _
-
-# Good variable names regexes, separated by a comma. If names match any regex,
-# they will always be accepted
-good-names-rgxs=.*scanID.*,.*RID.*,.*pointID.*,.*ID.*,.*_2D.*,.*_1D.*
-
-# Include a hint for the correct naming format with invalid-name.
-include-naming-hint=no
-
-# Naming style matching correct inline iteration names.
-inlinevar-naming-style=any
-
-# Regular expression matching correct inline iteration names. Overrides
-# inlinevar-naming-style.
-#inlinevar-rgx=
-
-# Naming style matching correct method names.
-method-naming-style=snake_case
-
-# Regular expression matching correct method names. Overrides method-naming-
-# style.
-#method-rgx=
-
-# Naming style matching correct module names.
-module-naming-style=snake_case
-
-# Regular expression matching correct module names. Overrides module-naming-
-# style.
-#module-rgx=
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-# These decorators are taken in consideration only for invalid-name.
-property-classes=abc.abstractproperty
-
-# Naming style matching correct variable names.
-variable-naming-style=snake_case
-
-# Regular expression matching correct variable names. Overrides variable-
-# naming-style.
-#variable-rgx=
-
-
-[STRING]
-
-# This flag controls whether inconsistent-quotes generates a warning when the
-# character used as a quote delimiter is used inconsistently within a module.
-check-quote-consistency=no
-
-# This flag controls whether the implicit-str-concat should generate a warning
-# on implicit string concatenation in sequences defined over several lines.
-check-str-concat-over-line-jumps=no
-
-
-[IMPORTS]
-
-# List of modules that can be imported at any level, not just the top level
-# one.
-allow-any-import-level=
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma.
-deprecated-modules=
-
-# Output a graph (.gv or any supported image format) of external dependencies
-# to the given file (report RP0402 must not be disabled).
-ext-import-graph=
-
-# Output a graph (.gv or any supported image format) of all (i.e. internal and
-# external) dependencies to the given file (report RP0402 must not be
-# disabled).
-import-graph=
-
-# Output a graph (.gv or any supported image format) of internal dependencies
-# to the given file (report RP0402 must not be disabled).
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-# Couples of modules and preferred modules, separated by a comma.
-preferred-modules=
-
-
-[CLASSES]
-
-# Warn about protected attribute access inside special methods
-check-protected-access-in-special-methods=no
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,
-                      __new__,
-                      setUp,
-                      __post_init__
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,
-                  _fields,
-                  _replace,
-                  _source,
-                  _make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=cls
-
-
-[DESIGN]
-
-# List of regular expressions of class ancestor names to ignore when counting
-# public methods (see R0903)
-exclude-too-few-public-methods=
-
-# List of qualified class names to ignore when counting class parents (see
-# R0901)
-ignored-parents=
-
-# Maximum number of arguments for function / method.
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Maximum number of boolean expressions in an if statement (see R0916).
-max-bool-expr=5
-
-# Maximum number of branch for function / method body.
-max-branches=12
-
-# Maximum number of locals for function / method body.
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body.
-max-returns=6
-
-# Maximum number of statements in function / method body.
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception

.readthedocs.yaml

@@ -1,25 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-20.04
-  tools:
-    python: "3.10"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
-
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs
-python:
-   install:
-   - requirements: docs/requirements.txt

CHANGELOG.md

@@ -1,214 +1,15 @@
-# CHANGELOG
+# Changelog
 
+<!--next-version-placeholder-->
 
-## v1.7.0 (2024-12-02)
+## v0.2.0 (2023-07-13)
 
-### Bug Fixes
+### Feature
 
-- **tests**: Add test for Console widget
-  ([`da579b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da579b6d213bcdf28c40c1a9e4e2535fdde824fb))
+* Move ivan's qtwidgets to bec-widgets ([`34e5ed2`](https://gitlab.psi.ch/bec/bec-widgets/-/commit/34e5ed2cf7e6128a51c110db8870d9560f2b2831))
 
-### Features
+## v0.1.0 (2023-07-11)
 
-- **console**: Add "prompt" signal to inform when shell is at prompt
-  ([`3aeb0b6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3aeb0b66fbeb03d3d0ee60e108cc6b98fd9aa9b9))
+### Feature
 
-- **console**: Add 'terminate' and 'send_ctrl_c' methods to Console
-  ([`02086ae`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02086aeae09233ec4e6ccc0e6a17f2b078d500b8))
-
-.terminate() ends the started process, sending SIGTERM signal. If process is not dead after optional
-  timeout, SIGKILL is sent. .send_ctrl_c() sends SIGINT to the child process, and waits for prompt
-  until optional timeout is reached. Timeouts raise 'TimeoutError' exception.
-
-
-## v1.6.0 (2024-11-27)
-
-### Bug Fixes
-
-- Add back accidentally removed variables
-  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
-
-- Differentiate click and drag for DeviceItem, adapt tests accordingly
-  ([`cffcdf2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cffcdf292363249bcc7efa9d130431d0bc727fda))
-
-This fixes the blocking "QDrag.exec_()" on Linux, indeed before the drag'n'drop operation was
-  started with a simple click and it was waiting for drop forever. Now there are 2 different cases,
-  click or drag'n'drop - the drag'n'drop test actually moves the mouse and releases the button.
-
-- Do not quit automatically when last window is "closed"
-  ([`96e255e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/96e255e4ef394eb79006a66d13e06775ae235667))
-
-Qt confuses closed and hidden
-
-- No need to call inspect.signature - it can fail on methods coming from C (like Qt methods)
-  ([`6029246`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/60292465e9e52d3248ae681c68c07298b9b3ce14))
-
-- **rpc**: Gui hide/show also hide/show all floating docks
-  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
-
-- **server**: Use dock area by default
-  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
-
-- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
-  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
-
-Depending on the test, auto-updates are enabled or not.
-
-### Features
-
-- '._auto_updates_enabled' attribute can be used to activate auto updates installation in
-  BECDockArea
-  ([`31d8703`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/31d87036c9801e639a7ca6fc003c90e0c4edb19d))
-
-- Add '--hide' argument to BEC GUI server
-  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
-
-- Add main window container widget
-  ([`f80ec33`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f80ec33ae5a261dbcab901ae30f4cc802316e554))
-
-- Add rpc_id member to client objects
-  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
-
-- Asynchronous .start() for GUI
-  ([`2047e48`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2047e484d5a4b2f5ea494a1e49035b35b1bbde35))
-
-- Do not take focus when GUI is loaded
-  ([`1f71d8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f71d8e5eded9952f9b34bfc427e2ff44cf5fc18))
-
-- **client**: Add show()/hide() methods to "gui" object
-  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
-
-- **server**: Add main window, with proper gui_id derived from given id
-  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
-
-
-## v1.5.3 (2024-11-21)
-
-### Bug Fixes
-
-- **alignment_1d**: Fix imports after widget module refactor
-  ([`e71e3b2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e71e3b2956feb3f3051e538432133f6e85bbd5a8))
-
-### Continuous Integration
-
-- Fix ci syntax for package-dep-job
-  ([`6e39bdb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6e39bdbf53b147c8ff163527b45691835ce9a2eb))
-
-
-## v1.5.2 (2024-11-18)
-
-### Bug Fixes
-
-- Support for bec v3
-  ([`746359b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/746359b2cc07a317473907adfcabbe5fe5d1b64c))
-
-
-## v1.5.1 (2024-11-14)
-
-### Bug Fixes
-
-- **plugin_utils**: Plugin utils are able to detect classes for plugin creation based on class
-  attribute rather than if it is top level widget
-  ([`7a1b874`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7a1b8748a433f854671ac95f2eaf4604e6b8df20))
-
-### Refactoring
-
-- **widgets**: Widget module structure reorganised
-  ([`aab0229`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/aab0229a4067ad626de919e38a5c8a2e9e7b03c2))
-
-
-## v1.5.0 (2024-11-12)
-
-### Bug Fixes
-
-- **crosshair**: Crosshair adapted for multi waveform widget
-  ([`0cd85ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0cd85ed9fa5b67a6ecce89985cd4f54b7bbe3a4b))
-
-### Documentation
-
-- **multi_waveform**: Docs added
-  ([`42d4f18`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/42d4f182f790a97687ca3b6d0e72866070a89767))
-
-### Features
-
-- **multi-waveform**: New widget added
-  ([`f3a39a6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f3a39a69e29d490b3023a508ced18028c4205772))
-
-
-## v1.4.1 (2024-11-12)
-
-### Bug Fixes
-
-- **positioner_box**: Adjusted default signals
-  ([`8e5c0ad`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8e5c0ad8c8eff5a9308169bc663d2b7230f0ebb1))
-
-
-## v1.4.0 (2024-11-11)
-
-### Bug Fixes
-
-- **crosshair**: Label of coordinates of TextItem displays numbers in general format
-  ([`11e5937`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/11e5937ae0f3c1413acd4e66878a692ebe4ef7d0))
-
-- **crosshair**: Label of coordinates of TextItem is updated according to the current theme of qapp
-  ([`4f31ea6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f31ea655cf6190e141e6a2720a2d6da517a2b5b))
-
-- **crosshair**: Log is separately scaled for backend logic and for signal emit
-  ([`b2eb71a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b2eb71aae0b6a7c82158f2d150ae1e31411cfdeb))
-
-### Features
-
-- **crosshair**: Textitem to display crosshair coordinates
-  ([`035136d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/035136d5171ec5f4311d15a9aa5bad2bdbc1f6cb))
-
-### Testing
-
-- **crosshair**: Tests extended
-  ([`64df805`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64df805a9ed92bb97e580ac3bc0a1bbd2b1cb81e))
-
-
-## v1.3.3 (2024-11-07)
-
-### Bug Fixes
-
-- **scan_control**: Devicelineedit kwargs readings changed to get name of the positioner
-  ([`5fabd4b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5fabd4bea95bafd2352102686357cc1db80813fd))
-
-### Documentation
-
-- Update outdated text in docs
-  ([`4f0693c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f0693cae34b391d75884837e1ae6353a0501868))
-
-
-## v1.3.2 (2024-11-05)
-
-### Bug Fixes
-
-- **plot_base**: Legend text color is changed when changing dark-light theme
-  ([`2304c9f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2304c9f8497c1ab1492f3e6690bb79b0464c0df8))
-
-### Build System
-
-- Pyside6 version fixed 6.7.2
-  ([`c6e48ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c6e48ec1fe5aaee6a7c7a6f930f1520cd439cdb2))
-
-
-## v1.3.1 (2024-10-31)
-
-### Bug Fixes
-
-- **ophyd_kind_util**: Kind enums are imported from the bec widget util class
-  ([`940ee65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/940ee6552c1ee8d9b4e4a74c62351f2e133ab678))
-
-
-## v1.3.0 (2024-10-30)
-
-### Bug Fixes
-
-- **colors**: Extend color map validation for matplotlib and colorcet maps (if available)
-  ([`14dd8c5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/14dd8c5b2947c92f6643b888d71975e4e8d4ee88))
-
-### Features
-
-- **colormap_button**: Colormap button with menu to select colormap filtered by the colormap type
-  ([`b039933`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b039933405e2fbe92bd81bd0748e79e8d443a741))
+* Added config plotter ([`db274c6`](https://gitlab.psi.ch/bec/bec-widgets/-/commit/db274c644f643f830c35b6a92edd328bf7e24f59))

LICENSE

@@ -1,29 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2023, bec
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,74 +1,2 @@
 # BEC Widgets
 
-BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Experiment Control)](https://gitlab.psi.ch/bec/bec).
-## Installation
-
-Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets:
-
-```bash
-pip install bec_widgets PyQt6
-```
-
-For development purposes, you can clone the repository and install the package locally in editable mode:
-
-```bash
-git clone https://gitlab.psi.ch/bec/bec-widgets
-cd bec_widgets
-pip install -e .[dev,pyqt6]
-```
-
-BEC Widgets currently supports both Pyside6 and PyQt6, however, no default distribution is specified. As a result, users must install one of the supported
-Python Qt distributions manually.
-
-To select a specific Python Qt distribution, install the package with an additional tag:
-
-```bash
-pip install bec_widgets[pyqt6]
-```
-or 
-
-```bash
-pip install bec_widgets[pyside6]
-```
-## Documentation
-
-Documentation of BEC Widgets can be found [here](https://bec-widgets.readthedocs.io/en/latest/). The documentation of the BEC can be found [here](https://bec.readthedocs.io/en/latest/).
-
-## Contributing
-
-All commits should use the Angular commit scheme:
-
-> #### <a name="commit-header"></a>Angular Commit Message Header
-> 
-> ```
-> <type>(<scope>): <short summary>
->   │       │             │
->   │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
->   │       │
->   │       └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
->   │                          elements|forms|http|language-service|localize|platform-browser|
->   │                          platform-browser-dynamic|platform-server|router|service-worker|
->   │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|ngcc|ve|
->   │                          devtools
->   │
->   └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
-> ```
-> 
-> The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
-
-> ##### Type
-> 
-> Must be one of the following:
-> 
-> * **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
-> * **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
-> * **docs**: Documentation only changes
-> * **feat**: A new feature
-> * **fix**: A bug fix
-> * **perf**: A code change that improves performance
-> * **refactor**: A code change that neither fixes a bug nor adds a feature
-> * **test**: Adding missing tests or correcting existing tests
-
-## License
-
-[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)

bec_widgets/applications/alignment/alignment_1d/alignment_1d.py

@@ -1,198 +0,0 @@
-""" This module contains the GUI for the 1D alignment application.
-It is a preliminary version of the GUI, which will be added to the main branch and steadily updated to be improved.
-"""
-
-import os
-from typing import Optional
-
-from bec_lib.device import Signal as BECSignal
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import QSize
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication
-
-import bec_widgets
-from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
-from bec_widgets.utils import UILoader
-from bec_widgets.utils.bec_dispatcher import BECDispatcher
-from bec_widgets.utils.colors import get_accent_colors
-from bec_widgets.widgets.control.buttons.stop_button.stop_button import StopButton
-from bec_widgets.widgets.control.device_control.positioner_group.positioner_group import (
-    PositionerGroup,
-)
-from bec_widgets.widgets.dap.lmfit_dialog.lmfit_dialog import LMFitDialog
-from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
-from bec_widgets.widgets.progress.bec_progressbar.bec_progressbar import BECProgressBar
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-logger = bec_logger.logger
-
-
-class Alignment1D:
-    """Alignment GUI to perform 1D scans"""
-
-    def __init__(self, client=None, gui_id: Optional[str] = None) -> None:
-        """Initialization
-
-        Args:
-            config: Configuration of the application.
-            client: BEC client object.
-            gui_id: GUI ID.
-        """
-        self.bec_dispatcher = BECDispatcher(client=client)
-        self.client = self.bec_dispatcher.client if client is None else client
-        QApplication.instance().aboutToQuit.connect(self.close)
-        self.dev = self.client.device_manager.devices
-
-        self._accent_colors = get_accent_colors()
-        self.ui_file = "alignment_1d.ui"
-        self.ui = None
-        self.progress_bar = None
-        self.waveform = None
-        self.init_ui()
-
-    def init_ui(self):
-        """Initialise the UI from QT Designer file"""
-        current_path = os.path.dirname(__file__)
-        self.ui = UILoader(None).loader(os.path.join(current_path, self.ui_file))
-        # Customize the plotting widget
-        self.waveform = self.ui.findChild(BECWaveformWidget, "bec_waveform_widget")
-        self._customise_bec_waveform_widget()
-        # Setup comboboxes for motor and signal selection
-        # FIXME after changing the filtering in the combobox
-        self._setup_signal_combobox()
-        # Setup motor indicator
-        self._setup_motor_indicator()
-        # Setup progress bar
-        self._setup_progress_bar()
-        # Add actions buttons
-        self._customise_buttons()
-        # Hook scaninfo updates
-        self.bec_dispatcher.connect_slot(self.scan_status_callback, MessageEndpoints.scan_status())
-
-    def show(self):
-        return self.ui.show()
-
-    ##############################
-    ############ SLOTS ###########
-    ##############################
-
-    @Slot(dict, dict)
-    def scan_status_callback(self, content: dict, _) -> None:
-        """This slot allows to enable/disable the UI critical components when a scan is running"""
-        if content["status"] in ["open"]:
-            self.enable_ui(False)
-        elif content["status"] in ["aborted", "halted", "closed"]:
-            self.enable_ui(True)
-
-    @Slot(tuple)
-    def move_to_center(self, move_request: tuple) -> None:
-        """Move the selected motor to the center"""
-        motor = self.ui.device_combobox.currentText()
-        if move_request[0] in ["center", "center1", "center2"]:
-            pos = move_request[1]
-        self.dev.get(motor).move(float(pos), relative=False)
-
-    @Slot()
-    def reset_progress_bar(self) -> None:
-        """Reset the progress bar"""
-        self.progress_bar.set_value(0)
-        self.progress_bar.set_minimum(0)
-
-    @Slot(dict, dict)
-    def update_progress_bar(self, content: dict, _) -> None:
-        """Hook to update the progress bar
-
-        Args:
-            content: Content of the scan progress message.
-            metadata: Metadata of the message.
-        """
-        if content["max_value"] == 0:
-            self.progress_bar.set_value(0)
-            return
-        self.progress_bar.set_maximum(content["max_value"])
-        self.progress_bar.set_value(content["value"])
-
-    @Slot()
-    def clear_queue(self) -> None:
-        """Clear the scan queue"""
-        self.queue.request_queue_reset()
-
-    ##############################
-    ######## END OF SLOTS ########
-    ##############################
-
-    def enable_ui(self, enable: bool) -> None:
-        """Enable or disable the UI components"""
-        # Enable/disable motor and signal selection
-        self.ui.device_combobox_2.setEnabled(enable)
-        # Enable/disable DAP selection
-        self.ui.dap_combo_box.setEnabled(enable)
-        # Enable/disable Scan Button
-        # self.ui.scan_button.setEnabled(enable)
-        # Disable move to buttons in LMFitDialog
-        self.ui.findChild(LMFitDialog).set_actions_enabled(enable)
-
-    def _customise_buttons(self) -> None:
-        """Add action buttons for the Action Control.
-        In addition, we are adding a callback to also clear the queue to the stop button
-        to ensure that upon clicking the button, no scans from another client may be queued
-        which would be confusing without the queue widget.
-        """
-        fit_dialog = self.ui.findChild(LMFitDialog)
-        fit_dialog.active_action_list = ["center", "center1", "center2"]
-        fit_dialog.move_action.connect(self.move_to_center)
-        stop_button = self.ui.findChild(StopButton)
-        stop_button.button.setText("Stop and Clear Queue")
-        stop_button.button.clicked.connect(self.clear_queue)
-
-    def _customise_bec_waveform_widget(self) -> None:
-        """Customise the BEC Waveform Widget, i.e. clear the toolbar"""
-        self.waveform.toolbar.clear()
-
-    def _setup_motor_indicator(self) -> None:
-        """Setup the arrow item"""
-        self.waveform.waveform.tick_item.add_to_plot()
-        positioner_box = self.ui.findChild(PositionerGroup)
-        positioner_box.position_update.connect(self.waveform.waveform.tick_item.set_position)
-        self.waveform.waveform.tick_item.set_position(0)
-
-    def _setup_signal_combobox(self) -> None:
-        """Setup signal selection"""
-        # FIXME after changing the filtering in the combobox
-        signals = [name for name in self.dev if isinstance(self.dev.get(name), BECSignal)]
-        self.ui.device_combobox_2.setCurrentText(signals[0])
-        self.ui.device_combobox_2.set_device_filter("Signal")
-
-    def _setup_progress_bar(self) -> None:
-        """Setup progress bar"""
-        # FIXME once the BECScanProgressBar is implemented
-        self.progress_bar = self.ui.findChild(BECProgressBar, "bec_progress_bar")
-        self.progress_bar.set_value(0)
-        self.ui.bec_waveform_widget.new_scan.connect(self.reset_progress_bar)
-        self.bec_dispatcher.connect_slot(self.update_progress_bar, MessageEndpoints.scan_progress())
-
-    def close(self):
-        logger.info("Disconnecting", repr(self.bec_dispatcher))
-        self.bec_dispatcher.disconnect_all()
-        logger.info("Shutting down BEC Client", repr(self.client))
-        self.client.shutdown()
-
-
-def main():
-    import sys
-
-    app = QApplication(sys.argv)
-    icon = QIcon()
-    icon.addFile(
-        os.path.join(MODULE_PATH, "assets", "app_icons", "alignment_1d.png"), size=QSize(48, 48)
-    )
-    app.setWindowIcon(icon)
-    window = Alignment1D()
-    window.show()
-    sys.exit(app.exec_())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/applications/alignment/alignment_1d/alignment_1d.ui

@@ -1,615 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>mainWindow</class>
- <widget class="QMainWindow" name="mainWindow">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>1611</width>
-    <height>1019</height>
-   </rect>
-  </property>
-  <property name="windowTitle">
-   <string>Alignment tool</string>
-  </property>
-  <widget class="QWidget" name="widget">
-   <layout class="QVBoxLayout" name="verticalLayout_2">
-    <item>
-     <widget class="QWidget" name="widget" native="true">
-      <property name="sizePolicy">
-       <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-        <horstretch>0</horstretch>
-        <verstretch>0</verstretch>
-       </sizepolicy>
-      </property>
-      <layout class="QHBoxLayout" name="horizontalLayout_5">
-       <item>
-        <widget class="DarkModeButton" name="dark_mode_button"/>
-       </item>
-       <item>
-        <spacer name="horizontalSpacer_6">
-         <property name="orientation">
-          <enum>Qt::Orientation::Horizontal</enum>
-         </property>
-         <property name="sizeHint" stdset="0">
-          <size>
-           <width>40</width>
-           <height>20</height>
-          </size>
-         </property>
-        </spacer>
-       </item>
-       <item>
-        <widget class="BECStatusBox" name="bec_status_box">
-         <property name="compact_view" stdset="0">
-          <bool>true</bool>
-         </property>
-         <property name="label" stdset="0">
-          <string>BEC Servers</string>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <spacer name="horizontalSpacer_3">
-         <property name="orientation">
-          <enum>Qt::Orientation::Horizontal</enum>
-         </property>
-         <property name="sizeHint" stdset="0">
-          <size>
-           <width>40</width>
-           <height>20</height>
-          </size>
-         </property>
-        </spacer>
-       </item>
-       <item>
-        <widget class="BECQueue" name="bec_queue">
-         <property name="compact_view" stdset="0">
-          <bool>true</bool>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <spacer name="horizontalSpacer_5">
-         <property name="orientation">
-          <enum>Qt::Orientation::Horizontal</enum>
-         </property>
-         <property name="sizeHint" stdset="0">
-          <size>
-           <width>40</width>
-           <height>20</height>
-          </size>
-         </property>
-        </spacer>
-       </item>
-       <item>
-        <widget class="QRadioButton" name="radioButton">
-         <property name="enabled">
-          <bool>false</bool>
-         </property>
-         <property name="text">
-          <string>SLS Light On</string>
-         </property>
-         <property name="checkable">
-          <bool>true</bool>
-         </property>
-         <property name="checked">
-          <bool>true</bool>
-         </property>
-         <property name="autoExclusive">
-          <bool>false</bool>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <spacer name="horizontalSpacer_7">
-         <property name="orientation">
-          <enum>Qt::Orientation::Horizontal</enum>
-         </property>
-         <property name="sizeHint" stdset="0">
-          <size>
-           <width>40</width>
-           <height>20</height>
-          </size>
-         </property>
-        </spacer>
-       </item>
-       <item>
-        <widget class="QRadioButton" name="radioButton_3">
-         <property name="enabled">
-          <bool>false</bool>
-         </property>
-         <property name="text">
-          <string>BEAMLINE Checks</string>
-         </property>
-         <property name="checkable">
-          <bool>true</bool>
-         </property>
-         <property name="checked">
-          <bool>true</bool>
-         </property>
-         <property name="autoExclusive">
-          <bool>false</bool>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <spacer name="horizontalSpacer_4">
-         <property name="orientation">
-          <enum>Qt::Orientation::Horizontal</enum>
-         </property>
-         <property name="sizeHint" stdset="0">
-          <size>
-           <width>40</width>
-           <height>20</height>
-          </size>
-         </property>
-        </spacer>
-       </item>
-       <item>
-        <widget class="StopButton" name="stop_button">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="MinimumExpanding" vsizetype="MinimumExpanding">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="minimumSize">
-          <size>
-           <width>200</width>
-           <height>40</height>
-          </size>
-         </property>
-         <property name="maximumSize">
-          <size>
-           <width>200</width>
-           <height>40</height>
-          </size>
-         </property>
-        </widget>
-       </item>
-      </layout>
-     </widget>
-    </item>
-    <item>
-     <widget class="BECProgressBar" name="bec_progress_bar">
-      <property name="minimumSize">
-       <size>
-        <width>0</width>
-        <height>25</height>
-       </size>
-      </property>
-      <property name="maximumSize">
-       <size>
-        <width>16777215</width>
-        <height>25</height>
-       </size>
-      </property>
-     </widget>
-    </item>
-    <item>
-     <widget class="QTabWidget" name="tabWidget">
-      <property name="sizePolicy">
-       <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
-        <horstretch>0</horstretch>
-        <verstretch>0</verstretch>
-       </sizepolicy>
-      </property>
-      <property name="currentIndex">
-       <number>0</number>
-      </property>
-      <widget class="QWidget" name="ControlTab">
-       <attribute name="title">
-        <string>Alignment Control</string>
-       </attribute>
-       <layout class="QHBoxLayout" name="horizontalLayout_6">
-        <item>
-         <widget class="QWidget" name="widget_4" native="true">
-          <property name="sizePolicy">
-           <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
-            <horstretch>1</horstretch>
-            <verstretch>0</verstretch>
-           </sizepolicy>
-          </property>
-          <layout class="QVBoxLayout" name="verticalLayout_3">
-           <item>
-            <widget class="ScanControl" name="scan_control">
-             <property name="current_scan" stdset="0">
-              <string>line_scan</string>
-             </property>
-             <property name="hide_arg_box" stdset="0">
-              <bool>false</bool>
-             </property>
-             <property name="hide_scan_selection_combobox" stdset="0">
-              <bool>true</bool>
-             </property>
-             <property name="hide_add_remove_buttons" stdset="0">
-              <bool>true</bool>
-             </property>
-            </widget>
-           </item>
-           <item>
-            <widget class="PositionerGroup" name="positioner_group"/>
-           </item>
-           <item>
-            <spacer name="verticalSpacer">
-             <property name="orientation">
-              <enum>Qt::Orientation::Vertical</enum>
-             </property>
-             <property name="sizeHint" stdset="0">
-              <size>
-               <width>20</width>
-               <height>40</height>
-              </size>
-             </property>
-            </spacer>
-           </item>
-          </layout>
-         </widget>
-        </item>
-        <item>
-         <widget class="QWidget" name="widget_3" native="true">
-          <property name="sizePolicy">
-           <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
-            <horstretch>4</horstretch>
-            <verstretch>0</verstretch>
-           </sizepolicy>
-          </property>
-          <layout class="QVBoxLayout" name="verticalLayout">
-           <item>
-            <widget class="QWidget" name="widget_2" native="true">
-             <property name="sizePolicy">
-              <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-               <horstretch>0</horstretch>
-               <verstretch>0</verstretch>
-              </sizepolicy>
-             </property>
-             <layout class="QHBoxLayout" name="horizontalLayout_3">
-              <item>
-               <widget class="QLabel" name="label_2">
-                <property name="font">
-                 <font/>
-                </property>
-                <property name="text">
-                 <string>Monitor</string>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <widget class="DeviceComboBox" name="device_combobox_2"/>
-              </item>
-              <item>
-               <widget class="QLabel" name="label_3">
-                <property name="font">
-                 <font/>
-                </property>
-                <property name="text">
-                 <string>LMFit Model</string>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <widget class="DapComboBox" name="dap_combo_box"/>
-              </item>
-              <item>
-               <widget class="QLabel" name="label">
-                <property name="text">
-                 <string>Enable ROI</string>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <widget class="ToggleSwitch" name="toggle_switch">
-                <property name="sizePolicy">
-                 <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
-                  <horstretch>3</horstretch>
-                  <verstretch>0</verstretch>
-                 </sizepolicy>
-                </property>
-                <property name="toolTip">
-                 <string>Activate linear region select for LMFit</string>
-                </property>
-                <property name="layoutDirection">
-                 <enum>Qt::LayoutDirection::LeftToRight</enum>
-                </property>
-                <property name="checked" stdset="0">
-                 <bool>false</bool>
-                </property>
-               </widget>
-              </item>
-              <item>
-               <spacer name="horizontalSpacer_8">
-                <property name="orientation">
-                 <enum>Qt::Orientation::Horizontal</enum>
-                </property>
-                <property name="sizeHint" stdset="0">
-                 <size>
-                  <width>40</width>
-                  <height>20</height>
-                 </size>
-                </property>
-               </spacer>
-              </item>
-             </layout>
-            </widget>
-           </item>
-           <item>
-            <widget class="BECWaveformWidget" name="bec_waveform_widget">
-             <property name="sizePolicy">
-              <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
-               <horstretch>0</horstretch>
-               <verstretch>1</verstretch>
-              </sizepolicy>
-             </property>
-             <property name="minimumSize">
-              <size>
-               <width>600</width>
-               <height>450</height>
-              </size>
-             </property>
-             <property name="clear_curves_on_plot_update" stdset="0">
-              <bool>true</bool>
-             </property>
-            </widget>
-           </item>
-           <item>
-            <widget class="LMFitDialog" name="lm_fit_dialog">
-             <property name="sizePolicy">
-              <sizepolicy hsizetype="Preferred" vsizetype="Minimum">
-               <horstretch>0</horstretch>
-               <verstretch>0</verstretch>
-              </sizepolicy>
-             </property>
-             <property name="minimumSize">
-              <size>
-               <width>0</width>
-               <height>190</height>
-              </size>
-             </property>
-             <property name="always_show_latest" stdset="0">
-              <bool>true</bool>
-             </property>
-             <property name="hide_curve_selection" stdset="0">
-              <bool>true</bool>
-             </property>
-             <property name="hide_summary" stdset="0">
-              <bool>true</bool>
-             </property>
-            </widget>
-           </item>
-          </layout>
-         </widget>
-        </item>
-       </layout>
-      </widget>
-      <widget class="QWidget" name="tab_2">
-       <attribute name="title">
-        <string>Logbook</string>
-       </attribute>
-       <layout class="QHBoxLayout" name="horizontalLayout_4">
-        <property name="leftMargin">
-         <number>2</number>
-        </property>
-        <property name="topMargin">
-         <number>2</number>
-        </property>
-        <property name="rightMargin">
-         <number>2</number>
-        </property>
-        <property name="bottomMargin">
-         <number>2</number>
-        </property>
-        <item>
-         <widget class="WebsiteWidget" name="website_widget">
-          <property name="url" stdset="0">
-           <string>https://scilog.psi.ch/login</string>
-          </property>
-         </widget>
-        </item>
-       </layout>
-      </widget>
-     </widget>
-    </item>
-   </layout>
-  </widget>
- </widget>
- <customwidgets>
-  <customwidget>
-   <class>DapComboBox</class>
-   <extends>QWidget</extends>
-   <header>dap_combo_box</header>
-  </customwidget>
-  <customwidget>
-   <class>StopButton</class>
-   <extends>QWidget</extends>
-   <header>stop_button</header>
-  </customwidget>
-  <customwidget>
-   <class>WebsiteWidget</class>
-   <extends>QWidget</extends>
-   <header>website_widget</header>
-  </customwidget>
-  <customwidget>
-   <class>BECQueue</class>
-   <extends>QWidget</extends>
-   <header>bec_queue</header>
-  </customwidget>
-  <customwidget>
-   <class>ScanControl</class>
-   <extends>QWidget</extends>
-   <header>scan_control</header>
-  </customwidget>
-  <customwidget>
-   <class>ToggleSwitch</class>
-   <extends>QWidget</extends>
-   <header>toggle_switch</header>
-  </customwidget>
-  <customwidget>
-   <class>BECProgressBar</class>
-   <extends>QWidget</extends>
-   <header>bec_progress_bar</header>
-  </customwidget>
-  <customwidget>
-   <class>DarkModeButton</class>
-   <extends>QWidget</extends>
-   <header>dark_mode_button</header>
-  </customwidget>
-  <customwidget>
-   <class>PositionerGroup</class>
-   <extends>QWidget</extends>
-   <header>positioner_group</header>
-  </customwidget>
-  <customwidget>
-   <class>BECWaveformWidget</class>
-   <extends>QWidget</extends>
-   <header>bec_waveform_widget</header>
-  </customwidget>
-  <customwidget>
-   <class>DeviceComboBox</class>
-   <extends>QComboBox</extends>
-   <header>device_combobox</header>
-  </customwidget>
-  <customwidget>
-   <class>LMFitDialog</class>
-   <extends>QWidget</extends>
-   <header>lm_fit_dialog</header>
-  </customwidget>
-  <customwidget>
-   <class>BECStatusBox</class>
-   <extends>QWidget</extends>
-   <header>bec_status_box</header>
-  </customwidget>
- </customwidgets>
- <resources/>
- <connections>
-  <connection>
-   <sender>toggle_switch</sender>
-   <signal>enabled(bool)</signal>
-   <receiver>bec_waveform_widget</receiver>
-   <slot>toogle_roi_select(bool)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>1042</x>
-     <y>212</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>1416</x>
-     <y>322</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>bec_waveform_widget</sender>
-   <signal>dap_summary_update(QVariantMap,QVariantMap)</signal>
-   <receiver>lm_fit_dialog</receiver>
-   <slot>update_summary_tree(QVariantMap,QVariantMap)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>1099</x>
-     <y>258</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>1157</x>
-     <y>929</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>device_combobox_2</sender>
-   <signal>currentTextChanged(QString)</signal>
-   <receiver>bec_waveform_widget</receiver>
-   <slot>plot(QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>577</x>
-     <y>215</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>1416</x>
-     <y>427</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>device_combobox_2</sender>
-   <signal>currentTextChanged(QString)</signal>
-   <receiver>dap_combo_box</receiver>
-   <slot>select_y_axis(QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>577</x>
-     <y>215</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>909</x>
-     <y>215</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>dap_combo_box</sender>
-   <signal>new_dap_config(QString,QString,QString)</signal>
-   <receiver>bec_waveform_widget</receiver>
-   <slot>add_dap(QString,QString,QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>909</x>
-     <y>215</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>1416</x>
-     <y>447</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>scan_control</sender>
-   <signal>device_selected(QString)</signal>
-   <receiver>positioner_group</receiver>
-   <slot>set_positioners(QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>230</x>
-     <y>306</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>187</x>
-     <y>926</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>scan_control</sender>
-   <signal>device_selected(QString)</signal>
-   <receiver>bec_waveform_widget</receiver>
-   <slot>set_x(QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>187</x>
-     <y>356</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>972</x>
-     <y>509</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>scan_control</sender>
-   <signal>device_selected(QString)</signal>
-   <receiver>dap_combo_box</receiver>
-   <slot>select_x_axis(QString)</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>187</x>
-     <y>356</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>794</x>
-     <y>202</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

bec_widgets/applications/bec_app.py

@@ -1,84 +0,0 @@
-"""
-Launcher for BEC GUI Applications
-
-Application must be located in bec_widgets/applications ;
-in order for the launcher to find the application, it has to be put in
-a subdirectory with the same name as the main Python module:
-
-/bec_widgets/applications
-    ├── alignment
-    │   └── alignment_1d
-    │       └── alignment_1d.py
-    ├── other_app
-        └── other_app.py
-
-The tree above would contain 2 applications, alignment_1d and other_app.
-
-The Python module for the application must have `if __name__ == "__main__":`
-in order for the launcher to execute it (it is run with `python -m`).
-"""
-
-import argparse
-import os
-import sys
-
-MODULE_PATH = os.path.dirname(__file__)
-
-
-def find_apps(base_dir: str) -> list[str]:
-    matching_modules = []
-
-    for root, dirs, files in os.walk(base_dir):
-        parent_dir = os.path.basename(root)
-
-        for file in files:
-            if file.endswith(".py") and file != "__init__.py":
-                file_name_without_ext = os.path.splitext(file)[0]
-
-                if file_name_without_ext == parent_dir:
-                    rel_path = os.path.relpath(root, base_dir)
-                    module_path = rel_path.replace(os.sep, ".")
-
-                    module_name = f"{module_path}.{file_name_without_ext}"
-                    matching_modules.append((file_name_without_ext, module_name))
-
-    return matching_modules
-
-
-def main():
-    parser = argparse.ArgumentParser(description="BEC application launcher")
-
-    parser.add_argument("-m", "--module", type=str, help="The module to run (string argument).")
-
-    # Add a positional argument for the module, which acts as a fallback if -m is not provided
-    parser.add_argument(
-        "positional_module",
-        nargs="?",  # This makes the positional argument optional
-        help="Positional argument that is treated as module if -m is not specified.",
-    )
-
-    args = parser.parse_args()
-    # If the -m/--module is not provided, fallback to the positional argument
-    module = args.module if args.module else args.positional_module
-
-    if module:
-        for app_name, app_module in find_apps(MODULE_PATH):
-            if module in (app_name, app_module):
-                print("Starting:", app_name)
-                python_executable = sys.executable
-
-                # Replace the current process with the new Python module
-                os.execvp(
-                    python_executable,
-                    [python_executable, "-m", f"bec_widgets.applications.{app_module}"],
-                )
-        print(f"Error: cannot find application {module}")
-
-    # display list of apps
-    print("Available applications:")
-    for app, _ in find_apps(MODULE_PATH):
-        print(f"  - {app}")
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/cli.py

@@ -0,0 +1,98 @@
+import argparse
+import os
+from threading import RLock
+
+from PyQt5 import uic
+from PyQt5.QtCore import pyqtSignal
+from PyQt5.QtWidgets import QApplication, QMainWindow
+from scan_plot import BECScanPlot
+
+from bec_lib.core import BECMessage, MessageEndpoints, RedisConnector
+
+
+class BEC_UI(QMainWindow):
+    new_scan_data = pyqtSignal(dict)
+    new_dap_data = pyqtSignal(dict)  # signal per proc instance?
+    new_scan = pyqtSignal()
+
+    def __init__(self, uipath):
+        super().__init__()
+        self._scan_channels = set()
+        self._dap_channels = set()
+
+        self._scan_thread = None
+        self._dap_threads = []
+
+        ui = uic.loadUi(uipath, self)
+
+        _, fname = os.path.split(uipath)
+        self.setWindowTitle(fname)
+
+        for sp in ui.findChildren(BECScanPlot):
+            for chan in (sp.x_channel, *sp.y_channel_list):
+                if chan.startswith("dap."):
+                    chan = chan.partition("dap.")[-1]
+                    self._dap_channels.add(chan)
+                else:
+                    self._scan_channels.add(chan)
+
+            sp.initialize()  # TODO: move this elsewhere?
+
+            self.new_scan_data.connect(sp.redraw_scan)  # TODO: merge
+            self.new_dap_data.connect(sp.redraw_dap)
+            self.new_scan.connect(sp.clearData)
+
+        # Scan setup
+        self._scan_id = None
+        scan_lock = RLock()
+
+        def _scan_cb(msg):
+            msg = BECMessage.ScanMessage.loads(msg.value)
+            with scan_lock:
+                scan_id = msg[0].content["scanID"]
+                if self._scan_id != scan_id:
+                    self._scan_id = scan_id
+                    self.new_scan.emit()
+            self.new_scan_data.emit(msg[0].content["data"])
+
+        bec_connector = RedisConnector("localhost:6379")
+
+        if self._scan_channels:
+            scan_readback = MessageEndpoints.scan_segment()
+            self._scan_thread = bec_connector.consumer(
+                topics=scan_readback,
+                cb=_scan_cb,
+            )
+            self._scan_thread.start()
+
+        # DAP setup
+        def _proc_cb(msg):
+            msg = BECMessage.ProcessedDataMessage.loads(msg.value)
+            self.new_dap_data.emit(msg.content["data"])
+
+        if self._dap_channels:
+            for chan in self._dap_channels:
+                proc_ep = MessageEndpoints.processed_data(chan)
+                dap_thread = bec_connector.consumer(topics=proc_ep, cb=_proc_cb)
+                dap_thread.start()
+                self._dap_threads.append(dap_thread)
+
+        self.show()
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="bec-pyqt", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+    )
+
+    parser.add_argument("uipath", type=str, help="Path to a BEC ui file")
+
+    args, rem = parser.parse_known_args()
+
+    app = QApplication(rem)
+    BEC_UI(args.uipath)
+    app.exec_()
+
+
+if __name__ == "__main__":
+    main()

bec_widgets/cli/__init__.py

@@ -1 +0,0 @@
-from .client import *

bec_widgets/cli/auto_updates.py

@@ -1,184 +0,0 @@
-from __future__ import annotations
-
-import threading
-from queue import Queue
-from typing import TYPE_CHECKING
-
-from pydantic import BaseModel
-
-if TYPE_CHECKING:
-    from .client import BECDockArea, BECFigure
-
-
-class ScanInfo(BaseModel):
-    scan_id: str
-    scan_number: int
-    scan_name: str
-    scan_report_devices: list
-    monitored_devices: list
-    status: str
-    model_config: dict = {"validate_assignment": True}
-
-
-class AutoUpdates:
-    create_default_dock: bool = False
-    enabled: bool = False
-    dock_name: str = None
-
-    def __init__(self, gui: BECDockArea):
-        self.gui = gui
-        self.msg_queue = Queue()
-        self.auto_update_thread = None
-        self._shutdown_sentinel = object()
-        self.start()
-
-    def start(self):
-        """
-        Start the auto update thread.
-        """
-        self.auto_update_thread = threading.Thread(target=self.process_queue)
-        self.auto_update_thread.start()
-
-    def start_default_dock(self):
-        """
-        Create a default dock for the auto updates.
-        """
-        dock = self.gui.add_dock("default_figure")
-        dock.add_widget("BECFigure")
-        self.dock_name = "default_figure"
-
-    @staticmethod
-    def get_scan_info(msg) -> ScanInfo:
-        """
-        Update the script with the given data.
-        """
-        info = msg.info
-        status = msg.status
-        scan_id = msg.scan_id
-        scan_number = info.get("scan_number", 0)
-        scan_name = info.get("scan_name", "Unknown")
-        scan_report_devices = info.get("scan_report_devices", [])
-        monitored_devices = info.get("readout_priority", {}).get("monitored", [])
-        monitored_devices = [dev for dev in monitored_devices if dev not in scan_report_devices]
-        return ScanInfo(
-            scan_id=scan_id,
-            scan_number=scan_number,
-            scan_name=scan_name,
-            scan_report_devices=scan_report_devices,
-            monitored_devices=monitored_devices,
-            status=status,
-        )
-
-    def get_default_figure(self) -> BECFigure | None:
-        """
-        Get the default figure from the GUI.
-        """
-        dock = self.gui.panels.get(self.dock_name, [])
-        if not dock:
-            return None
-        widgets = dock.widget_list
-        if not widgets:
-            return None
-        return widgets[0]
-
-    def run(self, msg):
-        """
-        Run the update function if enabled.
-        """
-        if not self.enabled:
-            return
-        if msg.status != "open":
-            return
-        info = self.get_scan_info(msg)
-        self.handler(info)
-
-    def process_queue(self):
-        """
-        Process the message queue.
-        """
-        while True:
-            msg = self.msg_queue.get()
-            if msg is self._shutdown_sentinel:
-                break
-            self.run(msg)
-
-    @staticmethod
-    def get_selected_device(monitored_devices, selected_device):
-        """
-        Get the selected device for the plot. If no device is selected, the first
-        device in the monitored devices list is selected.
-        """
-        if selected_device:
-            return selected_device
-        if len(monitored_devices) > 0:
-            sel_device = monitored_devices[0]
-            return sel_device
-        return None
-
-    def handler(self, info: ScanInfo) -> None:
-        """
-        Default update function.
-        """
-        if info.scan_name == "line_scan" and info.scan_report_devices:
-            self.simple_line_scan(info)
-            return
-        if info.scan_name == "grid_scan" and info.scan_report_devices:
-            self.simple_grid_scan(info)
-            return
-        if info.scan_report_devices:
-            self.best_effort(info)
-            return
-
-    def simple_line_scan(self, info: ScanInfo) -> None:
-        """
-        Simple line scan.
-        """
-        fig = self.get_default_figure()
-        if not fig:
-            return
-        dev_x = info.scan_report_devices[0]
-        dev_y = self.get_selected_device(info.monitored_devices, self.gui.selected_device)
-        if not dev_y:
-            return
-        fig.clear_all()
-        plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number} - {dev_y}")
-        plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
-
-    def simple_grid_scan(self, info: ScanInfo) -> None:
-        """
-        Simple grid scan.
-        """
-        fig = self.get_default_figure()
-        if not fig:
-            return
-        dev_x = info.scan_report_devices[0]
-        dev_y = info.scan_report_devices[1]
-        dev_z = self.get_selected_device(info.monitored_devices, self.gui.selected_device)
-        fig.clear_all()
-        plt = fig.plot(
-            x_name=dev_x, y_name=dev_y, z_name=dev_z, label=f"Scan {info.scan_number} - {dev_z}"
-        )
-        plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
-
-    def best_effort(self, info: ScanInfo) -> None:
-        """
-        Best effort scan.
-        """
-        fig = self.get_default_figure()
-        if not fig:
-            return
-        dev_x = info.scan_report_devices[0]
-        dev_y = self.get_selected_device(info.monitored_devices, self.gui.selected_device)
-        if not dev_y:
-            return
-        fig.clear_all()
-        plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number} - {dev_y}")
-        plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
-
-    def shutdown(self):
-        """
-        Shutdown the auto update thread.
-        """
-        self.msg_queue.put(self._shutdown_sentinel)
-        if self.auto_update_thread:
-            self.auto_update_thread.join()

bec_widgets/cli/client_utils.py

@@ -1,403 +0,0 @@
-from __future__ import annotations
-
-import importlib
-import importlib.metadata as imd
-import json
-import os
-import select
-import subprocess
-import threading
-import time
-import uuid
-from functools import wraps
-from typing import TYPE_CHECKING
-
-from bec_lib.client import BECClient
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.logger import bec_logger
-from bec_lib.utils.import_utils import isinstance_based_on_class_name, lazy_import, lazy_import_from
-
-import bec_widgets.cli.client as client
-from bec_widgets.cli.auto_updates import AutoUpdates
-
-if TYPE_CHECKING:
-    from bec_lib.device import DeviceBase
-
-messages = lazy_import("bec_lib.messages")
-# from bec_lib.connector import MessageObject
-MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
-BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
-
-logger = bec_logger.logger
-
-
-def rpc_call(func):
-    """
-    A decorator for calling a function on the server.
-
-    Args:
-        func: The function to call.
-
-    Returns:
-        The result of the function call.
-    """
-
-    @wraps(func)
-    def wrapper(self, *args, **kwargs):
-        # we could rely on a strict type check here, but this is more flexible
-        # moreover, it would anyway crash for objects...
-        out = []
-        for arg in args:
-            if hasattr(arg, "name"):
-                arg = arg.name
-            out.append(arg)
-        args = tuple(out)
-        for key, val in kwargs.items():
-            if hasattr(val, "name"):
-                kwargs[key] = val.name
-        if not self.gui_is_alive():
-            raise RuntimeError("GUI is not alive")
-        return self._run_rpc(func.__name__, *args, **kwargs)
-
-    return wrapper
-
-
-def _get_output(process, logger) -> None:
-    log_func = {process.stdout: logger.debug, process.stderr: logger.error}
-    stream_buffer = {process.stdout: [], process.stderr: []}
-    try:
-        os.set_blocking(process.stdout.fileno(), False)
-        os.set_blocking(process.stderr.fileno(), False)
-        while process.poll() is None:
-            readylist, _, _ = select.select([process.stdout, process.stderr], [], [], 1)
-            for stream in (process.stdout, process.stderr):
-                buf = stream_buffer[stream]
-                if stream in readylist:
-                    buf.append(stream.read(4096))
-                output, _, remaining = "".join(buf).rpartition("\n")
-                if output:
-                    log_func[stream](output)
-                    buf.clear()
-                    buf.append(remaining)
-    except Exception as e:
-        logger.error(f"Error reading process output: {str(e)}")
-
-
-def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger=None) -> None:
-    """
-    Start the plot in a new process.
-
-    Logger must be a logger object with "debug" and "error" functions,
-    or it can be left to "None" as default. None means output from the
-    process will not be captured.
-    """
-    # pylint: disable=subprocess-run-check
-    command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__, "--hide"]
-    if config:
-        if isinstance(config, dict):
-            config = json.dumps(config)
-        command.extend(["--config", str(config)])
-
-    env_dict = os.environ.copy()
-    env_dict["PYTHONUNBUFFERED"] = "1"
-
-    if logger is None:
-        stdout_redirect = subprocess.DEVNULL
-        stderr_redirect = subprocess.DEVNULL
-    else:
-        stdout_redirect = subprocess.PIPE
-        stderr_redirect = subprocess.PIPE
-
-    process = subprocess.Popen(
-        command,
-        text=True,
-        start_new_session=True,
-        stdout=stdout_redirect,
-        stderr=stderr_redirect,
-        env=env_dict,
-    )
-    if logger is None:
-        process_output_processing_thread = None
-    else:
-        process_output_processing_thread = threading.Thread(
-            target=_get_output, args=(process, logger)
-        )
-        process_output_processing_thread.start()
-    return process, process_output_processing_thread
-
-
-class RepeatTimer(threading.Timer):
-    def run(self):
-        while not self.finished.wait(self.interval):
-            self.function(*self.args, **self.kwargs)
-
-
-class BECGuiClientMixin:
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        self._auto_updates_enabled = True
-        self._auto_updates = None
-        self._gui_started_timer = None
-        self._gui_started_event = threading.Event()
-        self._process = None
-        self._process_output_processing_thread = None
-        self._target_endpoint = MessageEndpoints.scan_status()
-        self._selected_device = None
-
-    @property
-    def auto_updates(self):
-        if self._auto_updates_enabled:
-            self._gui_started_event.wait()
-        return self._auto_updates
-
-    def shutdown_auto_updates(self):
-        if self._auto_updates_enabled:
-            if self._auto_updates is not None:
-                self._auto_updates.shutdown()
-                self._auto_updates = None
-
-    def _get_update_script(self) -> AutoUpdates | None:
-        eps = imd.entry_points(group="bec.widgets.auto_updates")
-        for ep in eps:
-            if ep.name == "plugin_widgets_update":
-                try:
-                    spec = importlib.util.find_spec(ep.module)
-                    # if the module is not found, we skip it
-                    if spec is None:
-                        continue
-                    return ep.load()(gui=self)
-                except Exception as e:
-                    logger.error(f"Error loading auto update script from plugin: {str(e)}")
-        return None
-
-    @property
-    def selected_device(self):
-        """
-        Selected device for the plot.
-        """
-        return self._selected_device
-
-    @selected_device.setter
-    def selected_device(self, device: str | DeviceBase):
-        if isinstance_based_on_class_name(device, "bec_lib.device.DeviceBase"):
-            self._selected_device = device.name
-        elif isinstance(device, str):
-            self._selected_device = device
-        else:
-            raise ValueError("Device must be a string or a device object")
-
-    def _start_update_script(self) -> None:
-        self._client.connector.register(
-            self._target_endpoint, cb=self._handle_msg_update, parent=self
-        )
-
-    @staticmethod
-    def _handle_msg_update(msg: MessageObject, parent: BECGuiClientMixin) -> None:
-        if parent.auto_updates is not None:
-            # pylint: disable=protected-access
-            parent._update_script_msg_parser(msg.value)
-
-    def _update_script_msg_parser(self, msg: messages.BECMessage) -> None:
-        if isinstance(msg, messages.ScanStatusMessage):
-            if not self.gui_is_alive():
-                return
-            if self._auto_updates_enabled:
-                self.auto_updates.msg_queue.put(msg)
-
-    def _gui_post_startup(self):
-        if self._auto_updates_enabled:
-            if self._auto_updates is None:
-                auto_updates = self._get_update_script()
-                if auto_updates is None:
-                    AutoUpdates.create_default_dock = True
-                    AutoUpdates.enabled = True
-                    auto_updates = AutoUpdates(gui=self)
-                if auto_updates.create_default_dock:
-                    auto_updates.start_default_dock()
-                    # fig = auto_updates.get_default_figure()
-                self._auto_updates = auto_updates
-        self._gui_started_event.set()
-        self.show_all()
-
-    def start_server(self, wait=False) -> None:
-        """
-        Start the GUI server, and execute callback when it is launched
-        """
-        if self._process is None or self._process.poll() is not None:
-            logger.success("GUI starting...")
-            self._gui_started_event.clear()
-            self._start_update_script()
-            self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id, self.__class__, self._client._service_config.config, logger=logger
-            )
-
-            def gui_started_callback(callback):
-                try:
-                    if callable(callback):
-                        callback()
-                finally:
-                    threading.current_thread().cancel()
-
-            self._gui_started_timer = RepeatTimer(
-                1, lambda: self.gui_is_alive() and gui_started_callback(self._gui_post_startup)
-            )
-            self._gui_started_timer.start()
-
-        if wait:
-            self._gui_started_event.wait()
-
-    def show_all(self):
-        self._gui_started_event.wait()
-        rpc_client = RPCBase(gui_id=f"{self._gui_id}:window", parent=self)
-        rpc_client._run_rpc("show")
-
-    def hide_all(self):
-        self._gui_started_event.wait()
-        rpc_client = RPCBase(gui_id=f"{self._gui_id}:window", parent=self)
-        rpc_client._run_rpc("hide")
-
-    def close(self) -> None:
-        """
-        Close the gui window.
-        """
-        if self._gui_started_timer is not None:
-            self._gui_started_timer.cancel()
-            self._gui_started_timer.join()
-
-        if self._process is None:
-            return
-
-        if self._process:
-            logger.success("Stopping GUI...")
-            self._process.terminate()
-            if self._process_output_processing_thread:
-                self._process_output_processing_thread.join()
-            self._process.wait()
-            self._process = None
-        self.shutdown_auto_updates()
-
-
-class RPCResponseTimeoutError(Exception):
-    """Exception raised when an RPC response is not received within the expected time."""
-
-    def __init__(self, request_id, timeout):
-        super().__init__(
-            f"RPC response not received within {timeout} seconds for request ID {request_id}"
-        )
-
-
-class RPCBase:
-    def __init__(self, gui_id: str = None, config: dict = None, parent=None) -> None:
-        self._client = BECClient()  # BECClient is a singleton; here, we simply get the instance
-        self._config = config if config is not None else {}
-        self._gui_id = gui_id if gui_id is not None else str(uuid.uuid4())[:5]
-        self._parent = parent
-        self._msg_wait_event = threading.Event()
-        self._rpc_response = None
-        super().__init__()
-        # print(f"RPCBase: {self._gui_id}")
-
-    def __repr__(self):
-        type_ = type(self)
-        qualname = type_.__qualname__
-        return f"<{qualname} object at {hex(id(self))}>"
-
-    @property
-    def _root(self):
-        """
-        Get the root widget. This is the BECFigure widget that holds
-        the anchor gui_id.
-        """
-        parent = self
-        # pylint: disable=protected-access
-        while parent._parent is not None:
-            parent = parent._parent
-        return parent
-
-    def _run_rpc(self, method, *args, wait_for_rpc_response=True, timeout=3, **kwargs):
-        """
-        Run the RPC call.
-
-        Args:
-            method: The method to call.
-            args: The arguments to pass to the method.
-            wait_for_rpc_response: Whether to wait for the RPC response.
-            kwargs: The keyword arguments to pass to the method.
-
-        Returns:
-            The result of the RPC call.
-        """
-        request_id = str(uuid.uuid4())
-        rpc_msg = messages.GUIInstructionMessage(
-            action=method,
-            parameter={"args": args, "kwargs": kwargs, "gui_id": self._gui_id},
-            metadata={"request_id": request_id},
-        )
-
-        # pylint: disable=protected-access
-        receiver = self._root._gui_id
-        if wait_for_rpc_response:
-            self._rpc_response = None
-            self._msg_wait_event.clear()
-            self._client.connector.register(
-                MessageEndpoints.gui_instruction_response(request_id),
-                cb=self._on_rpc_response,
-                parent=self,
-            )
-
-        self._client.connector.set_and_publish(MessageEndpoints.gui_instructions(receiver), rpc_msg)
-
-        if wait_for_rpc_response:
-            try:
-                finished = self._msg_wait_event.wait(10)
-                if not finished:
-                    raise RPCResponseTimeoutError(request_id, timeout)
-            finally:
-                self._msg_wait_event.clear()
-                self._client.connector.unregister(
-                    MessageEndpoints.gui_instruction_response(request_id), cb=self._on_rpc_response
-                )
-            # get class name
-            if not self._rpc_response.accepted:
-                raise ValueError(self._rpc_response.message["error"])
-            msg_result = self._rpc_response.message.get("result")
-            self._rpc_response = None
-            return self._create_widget_from_msg_result(msg_result)
-
-    @staticmethod
-    def _on_rpc_response(msg: MessageObject, parent: RPCBase) -> None:
-        msg = msg.value
-        parent._msg_wait_event.set()
-        parent._rpc_response = msg
-
-    def _create_widget_from_msg_result(self, msg_result):
-        if msg_result is None:
-            return None
-        if isinstance(msg_result, list):
-            return [self._create_widget_from_msg_result(res) for res in msg_result]
-        if isinstance(msg_result, dict):
-            if "__rpc__" not in msg_result:
-                return {
-                    key: self._create_widget_from_msg_result(val) for key, val in msg_result.items()
-                }
-            cls = msg_result.pop("widget_class", None)
-            msg_result.pop("__rpc__", None)
-
-            if not cls:
-                return msg_result
-
-            cls = getattr(client, cls)
-            # print(msg_result)
-            return cls(parent=self, **msg_result)
-        return msg_result
-
-    def gui_is_alive(self):
-        """
-        Check if the GUI is alive.
-        """
-        heart = self._client.connector.get(MessageEndpoints.gui_heartbeat(self._root._gui_id))
-        if heart is None:
-            return False
-        if heart.status == messages.BECStatus.RUNNING:
-            return True
-        return False

bec_widgets/cli/generate_cli.py

@@ -1,207 +0,0 @@
-# pylint: disable=missing-module-docstring
-from __future__ import annotations
-
-import argparse
-import inspect
-import os
-import sys
-
-import black
-import isort
-from qtpy.QtCore import Property as QtProperty
-
-from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator
-from bec_widgets.utils.plugin_utils import BECClassContainer, get_custom_classes
-
-if sys.version_info >= (3, 11):
-    from typing import get_overloads
-else:
-    print(
-        "Python version is less than 3.11, using dummy function for get_overloads. "
-        "If you want to use the real function 'typing.get_overloads()', please use Python 3.11 or later."
-    )
-
-    def get_overloads(_obj):
-        """
-        Dummy function for Python versions before 3.11.
-        """
-        return []
-
-
-class ClientGenerator:
-    def __init__(self):
-        self.header = """# This file was automatically generated by generate_cli.py\n
-from __future__ import annotations
-import enum
-from typing import Literal, Optional, overload
-
-from bec_widgets.cli.client_utils import RPCBase, rpc_call, BECGuiClientMixin
-
-# pylint: skip-file"""
-
-        self.content = ""
-
-    def generate_client(self, class_container: BECClassContainer):
-        """
-        Generate the client for the published classes.
-
-        Args:
-            class_container: The class container with the classes to generate the client for.
-        """
-        rpc_top_level_classes = class_container.rpc_top_level_classes
-        rpc_top_level_classes.sort(key=lambda x: x.__name__)
-        connector_classes = class_container.connector_classes
-        connector_classes.sort(key=lambda x: x.__name__)
-
-        self.write_client_enum(rpc_top_level_classes)
-        for cls in connector_classes:
-            self.content += "\n\n"
-            self.generate_content_for_class(cls)
-
-    def write_client_enum(self, published_classes: list[type]):
-        """
-        Write the client enum to the content.
-        """
-        self.content += """
-class Widgets(str, enum.Enum):
-    \"\"\"
-    Enum for the available widgets.
-    \"\"\"
-    """
-        for cls in published_classes:
-            self.content += f'{cls.__name__} = "{cls.__name__}"\n    '
-
-    def generate_content_for_class(self, cls):
-        """
-        Generate the content for the class.
-
-        Args:
-            cls: The class for which to generate the content.
-        """
-
-        class_name = cls.__name__
-
-        # Generate the content
-        if cls.__name__ == "BECDockArea":
-            self.content += f"""
-class {class_name}(RPCBase, BECGuiClientMixin):"""
-        else:
-            self.content += f"""
-class {class_name}(RPCBase):"""
-        if not cls.USER_ACCESS:
-            self.content += """...
-    """
-        for method in cls.USER_ACCESS:
-            is_property_setter = False
-            obj = getattr(cls, method, None)
-            if obj is None:
-                obj = getattr(cls, method.split(".setter")[0], None)
-                is_property_setter = True
-                method = method.split(".setter")[0]
-            if obj is None:
-                raise AttributeError(
-                    f"Method {method} not found in class {cls.__name__}. Please check the USER_ACCESS list."
-                )
-            if isinstance(obj, (property, QtProperty)):
-                # for the cli, we can map qt properties to regular properties
-                if is_property_setter:
-                    self.content += f"""
-    @{method}.setter
-    @rpc_call"""
-                else:
-                    self.content += """
-    @property
-    @rpc_call"""
-
-                sig = str(inspect.signature(obj.fget))
-                doc = inspect.getdoc(obj.fget)
-            else:
-                sig = str(inspect.signature(obj))
-                doc = inspect.getdoc(obj)
-                overloads = get_overloads(obj)
-                for overload in overloads:
-                    sig_overload = str(inspect.signature(overload))
-                    self.content += f"""
-    @overload
-    def {method}{str(sig_overload)}: ...
-    """
-
-                self.content += """
-    @rpc_call"""
-            self.content += f"""
-    def {method}{str(sig)}:
-        \"\"\"
-{doc}
-        \"\"\""""
-
-    def write(self, file_name: str):
-        """
-        Write the content to a file, automatically formatted with black.
-
-        Args:
-            file_name(str): The name of the file to write to.
-        """
-        # Combine header and content, then format with black
-        full_content = self.header + "\n" + self.content
-        try:
-            formatted_content = black.format_str(full_content, mode=black.FileMode(line_length=100))
-        except black.NothingChanged:
-            formatted_content = full_content
-
-        isort.Config(
-            profile="black",
-            line_length=100,
-            multi_line_output=3,
-            include_trailing_comma=True,
-            known_first_party=["bec_widgets"],
-        )
-        formatted_content = isort.code(formatted_content)
-
-        with open(file_name, "w", encoding="utf-8") as file:
-            file.write(formatted_content)
-
-
-def main():
-    """
-    Main entry point for the script, controlled by command line arguments.
-    """
-
-    parser = argparse.ArgumentParser(description="Auto-generate the client for RPC widgets")
-    parser.add_argument("--core", action="store_true", help="Whether to generate the core client")
-
-    args = parser.parse_args()
-
-    if args.core:
-        current_path = os.path.dirname(__file__)
-        client_path = os.path.join(current_path, "client.py")
-
-        rpc_classes = get_custom_classes("bec_widgets")
-
-        generator = ClientGenerator()
-        generator.generate_client(rpc_classes)
-        generator.write(client_path)
-
-        for cls in rpc_classes.plugins:
-            plugin = DesignerPluginGenerator(cls)
-            if not hasattr(plugin, "info"):
-                continue
-
-            # if the class directory already has a register, plugin and pyproject file, skip
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"register_{plugin.info.plugin_name_snake}.py")
-            ):
-                continue
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}_plugin.py")
-            ):
-                continue
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}.pyproject")
-            ):
-                continue
-            plugin.run()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    sys.argv = ["generate_cli.py", "--core"]
-    main()

bec_widgets/cli/rpc_register.py

@@ -1,82 +0,0 @@
-from __future__ import annotations
-
-from threading import Lock
-from weakref import WeakValueDictionary
-
-from qtpy.QtCore import QObject
-
-
-class RPCRegister:
-    """
-    A singleton class that keeps track of all the RPC objects registered in the system for CLI usage.
-    """
-
-    _instance = None
-    _initialized = False
-    _lock = Lock()
-
-    def __new__(cls, *args, **kwargs):
-        if cls._instance is None:
-            cls._instance = super(RPCRegister, cls).__new__(cls)
-            cls._initialized = False
-        return cls._instance
-
-    def __init__(self):
-        if self._initialized:
-            return
-        self._rpc_register = WeakValueDictionary()
-        self._initialized = True
-
-    def add_rpc(self, rpc: QObject):
-        """
-        Add an RPC object to the register.
-
-        Args:
-            rpc(QObject): The RPC object to be added to the register.
-        """
-        if not hasattr(rpc, "gui_id"):
-            raise ValueError("RPC object must have a 'gui_id' attribute.")
-        self._rpc_register[rpc.gui_id] = rpc
-
-    def remove_rpc(self, rpc: str):
-        """
-        Remove an RPC object from the register.
-
-        Args:
-            rpc(str): The RPC object to be removed from the register.
-        """
-        if not hasattr(rpc, "gui_id"):
-            raise ValueError(f"RPC object {rpc} must have a 'gui_id' attribute.")
-        self._rpc_register.pop(rpc.gui_id, None)
-
-    def get_rpc_by_id(self, gui_id: str) -> QObject:
-        """
-        Get an RPC object by its ID.
-
-        Args:
-            gui_id(str): The ID of the RPC object to be retrieved.
-
-        Returns:
-            QObject: The RPC object with the given ID.
-        """
-        rpc_object = self._rpc_register.get(gui_id, None)
-        return rpc_object
-
-    def list_all_connections(self) -> dict:
-        """
-        List all the registered RPC objects.
-
-        Returns:
-            dict: A dictionary containing all the registered RPC objects.
-        """
-        with self._lock:
-            connections = dict(self._rpc_register)
-        return connections
-
-    @classmethod
-    def reset_singleton(cls):
-        """
-        Reset the singleton instance.
-        """
-        cls._instance = None
-        cls._initialized = False

bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,55 +0,0 @@
-from __future__ import annotations
-
-from bec_widgets.utils import BECConnector
-
-
-class RPCWidgetHandler:
-    """Handler class for creating widgets from RPC messages."""
-
-    def __init__(self):
-        self._widget_classes = None
-
-    @property
-    def widget_classes(self):
-        """
-        Get the available widget classes.
-
-        Returns:
-            dict: The available widget classes.
-        """
-        if self._widget_classes is None:
-            self.update_available_widgets()
-        return self._widget_classes
-
-    def update_available_widgets(self):
-        """
-        Update the available widgets.
-
-        Returns:
-            None
-        """
-        from bec_widgets.utils.plugin_utils import get_custom_classes
-
-        clss = get_custom_classes("bec_widgets")
-        self._widget_classes = {cls.__name__: cls for cls in clss.widgets}
-
-    def create_widget(self, widget_type, **kwargs) -> BECConnector:
-        """
-        Create a widget from an RPC message.
-
-        Args:
-            widget_type(str): The type of the widget.
-            **kwargs: The keyword arguments for the widget.
-
-        Returns:
-            widget(BECConnector): The created widget.
-        """
-        if self._widget_classes is None:
-            self.update_available_widgets()
-        widget_class = self._widget_classes.get(widget_type)
-        if widget_class:
-            return widget_class(**kwargs)
-        raise ValueError(f"Unknown widget type: {widget_type}")
-
-
-widget_handler = RPCWidgetHandler()

bec_widgets/cli/server.py

@@ -1,255 +0,0 @@
-from __future__ import annotations
-
-import json
-import signal
-import sys
-from contextlib import redirect_stderr, redirect_stdout
-from typing import Union
-
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.logger import bec_logger
-from bec_lib.service_config import ServiceConfig
-from bec_lib.utils.import_utils import lazy_import
-from qtpy.QtCore import Qt, QTimer
-
-from bec_widgets.cli.rpc_register import RPCRegister
-from bec_widgets.utils import BECDispatcher
-from bec_widgets.utils.bec_connector import BECConnector
-from bec_widgets.widgets.containers.dock import BECDockArea
-from bec_widgets.widgets.containers.figure import BECFigure
-from bec_widgets.widgets.containers.main_window.main_window import BECMainWindow
-
-messages = lazy_import("bec_lib.messages")
-logger = bec_logger.logger
-
-
-class BECWidgetsCLIServer:
-
-    def __init__(
-        self,
-        gui_id: str,
-        dispatcher: BECDispatcher = None,
-        client=None,
-        config=None,
-        gui_class: Union[BECFigure, BECDockArea] = BECFigure,
-    ) -> None:
-        self.status = messages.BECStatus.BUSY
-        self.dispatcher = BECDispatcher(config=config) if dispatcher is None else dispatcher
-        self.client = self.dispatcher.client if client is None else client
-        self.client.start()
-        self.gui_id = gui_id
-        self.gui = gui_class(gui_id=self.gui_id)
-        self.rpc_register = RPCRegister()
-        self.rpc_register.add_rpc(self.gui)
-
-        self.dispatcher.connect_slot(
-            self.on_rpc_update, MessageEndpoints.gui_instructions(self.gui_id)
-        )
-
-        # Setup QTimer for heartbeat
-        self._heartbeat_timer = QTimer()
-        self._heartbeat_timer.timeout.connect(self.emit_heartbeat)
-        self._heartbeat_timer.start(200)
-
-        self.status = messages.BECStatus.RUNNING
-        logger.success(f"Server started with gui_id: {self.gui_id}")
-
-    def on_rpc_update(self, msg: dict, metadata: dict):
-        request_id = metadata.get("request_id")
-        logger.debug(f"Received RPC instruction: {msg}, metadata: {metadata}")
-        try:
-            obj = self.get_object_from_config(msg["parameter"])
-            method = msg["action"]
-            args = msg["parameter"].get("args", [])
-            kwargs = msg["parameter"].get("kwargs", {})
-            res = self.run_rpc(obj, method, args, kwargs)
-        except Exception as e:
-            logger.error(f"Error while executing RPC instruction: {e}")
-            self.send_response(request_id, False, {"error": str(e)})
-        else:
-            logger.debug(f"RPC instruction executed successfully: {res}")
-            self.send_response(request_id, True, {"result": res})
-
-    def send_response(self, request_id: str, accepted: bool, msg: dict):
-        self.client.connector.set_and_publish(
-            MessageEndpoints.gui_instruction_response(request_id),
-            messages.RequestResponseMessage(accepted=accepted, message=msg),
-            expire=60,
-        )
-
-    def get_object_from_config(self, config: dict):
-        gui_id = config.get("gui_id")
-        obj = self.rpc_register.get_rpc_by_id(gui_id)
-        if obj is None:
-            raise ValueError(f"Object with gui_id {gui_id} not found")
-        return obj
-
-    def run_rpc(self, obj, method, args, kwargs):
-        logger.debug(f"Running RPC instruction: {method} with args: {args}, kwargs: {kwargs}")
-        method_obj = getattr(obj, method)
-        # check if the method accepts args and kwargs
-        if not callable(method_obj):
-            if not args:
-                res = method_obj
-            else:
-                setattr(obj, method, args[0])
-                res = None
-        else:
-            res = method_obj(*args, **kwargs)
-
-        if isinstance(res, list):
-            res = [self.serialize_object(obj) for obj in res]
-        elif isinstance(res, dict):
-            res = {key: self.serialize_object(val) for key, val in res.items()}
-        else:
-            res = self.serialize_object(res)
-        return res
-
-    def serialize_object(self, obj):
-        if isinstance(obj, BECConnector):
-            return {
-                "gui_id": obj.gui_id,
-                "widget_class": obj.__class__.__name__,
-                "config": obj.config.model_dump(),
-                "__rpc__": True,
-            }
-        return obj
-
-    def emit_heartbeat(self):
-        logger.trace(f"Emitting heartbeat for {self.gui_id}")
-        self.client.connector.set(
-            MessageEndpoints.gui_heartbeat(self.gui_id),
-            messages.StatusMessage(name=self.gui_id, status=self.status, info={}),
-            expire=10,
-        )
-
-    def shutdown(self):  # TODO not sure if needed when cleanup is done at level of BECConnector
-        logger.info(f"Shutting down server with gui_id: {self.gui_id}")
-        self.status = messages.BECStatus.IDLE
-        self._heartbeat_timer.stop()
-        self.emit_heartbeat()
-        self.gui.close()
-        self.client.shutdown()
-
-
-class SimpleFileLikeFromLogOutputFunc:
-    def __init__(self, log_func):
-        self._log_func = log_func
-        self._buffer = []
-
-    def write(self, buffer):
-        self._buffer.append(buffer)
-
-    def flush(self):
-        lines, _, remaining = "".join(self._buffer).rpartition("\n")
-        if lines:
-            self._log_func(lines)
-        self._buffer = [remaining]
-
-    def close(self):
-        return
-
-
-def _start_server(gui_id: str, gui_class: Union[BECFigure, BECDockArea], config: str | None = None):
-    if config:
-        try:
-            config = json.loads(config)
-            service_config = ServiceConfig(config=config)
-        except (json.JSONDecodeError, TypeError):
-            service_config = ServiceConfig(config_path=config)
-    else:
-        # if no config is provided, use the default config
-        service_config = ServiceConfig()
-
-    # bec_logger.configure(
-    #     service_config.redis,
-    #     QtRedisConnector,
-    #     service_name="BECWidgetsCLIServer",
-    #     service_config=service_config.service_config,
-    # )
-    server = BECWidgetsCLIServer(gui_id=gui_id, config=service_config, gui_class=gui_class)
-    return server
-
-
-def main():
-    import argparse
-    import os
-
-    from qtpy.QtCore import QSize
-    from qtpy.QtGui import QIcon
-    from qtpy.QtWidgets import QApplication
-
-    import bec_widgets
-
-    bec_logger.level = bec_logger.LOGLEVEL.DEBUG
-    if __name__ != "__main__":
-        # if not running as main, set the log level to critical
-        # pylint: disable=protected-access
-        bec_logger._stderr_log_level = bec_logger.LOGLEVEL.CRITICAL
-
-    parser = argparse.ArgumentParser(description="BEC Widgets CLI Server")
-    parser.add_argument("--id", type=str, help="The id of the server")
-    parser.add_argument(
-        "--gui_class",
-        type=str,
-        help="Name of the gui class to be rendered. Possible values: \n- BECFigure\n- BECDockArea",
-    )
-    parser.add_argument("--config", type=str, help="Config file or config string.")
-    parser.add_argument("--hide", action="store_true", help="Hide on startup")
-
-    args = parser.parse_args()
-
-    if args.gui_class == "BECFigure":
-        gui_class = BECFigure
-    elif args.gui_class == "BECDockArea":
-        gui_class = BECDockArea
-    else:
-        print(
-            "Please specify a valid gui_class to run. Use -h for help."
-            "\n Starting with default gui_class BECFigure."
-        )
-        gui_class = BECDockArea
-
-    with redirect_stdout(SimpleFileLikeFromLogOutputFunc(logger.info)):
-        with redirect_stderr(SimpleFileLikeFromLogOutputFunc(logger.error)):
-            app = QApplication(sys.argv)
-            app.setQuitOnLastWindowClosed(False)
-            app.setApplicationName("BEC Figure")
-            module_path = os.path.dirname(bec_widgets.__file__)
-            icon = QIcon()
-            icon.addFile(
-                os.path.join(module_path, "assets", "app_icons", "bec_widgets_icon.png"),
-                size=QSize(48, 48),
-            )
-            app.setWindowIcon(icon)
-
-            server = _start_server(args.id, gui_class, args.config)
-
-            win = BECMainWindow(gui_id=f"{server.gui_id}:window")
-            win.setAttribute(Qt.WA_ShowWithoutActivating)
-            win.setWindowTitle("BEC Widgets")
-
-            RPCRegister().add_rpc(win)
-
-            gui = server.gui
-            win.setCentralWidget(gui)
-            win.resize(800, 600)
-            if not args.hide:
-                win.show()
-
-            app.aboutToQuit.connect(server.shutdown)
-
-            def sigint_handler(*args):
-                # display message, for people to let it terminate gracefully
-                print("Caught SIGINT, exiting")
-                app.quit()
-
-            signal.signal(signal.SIGINT, sigint_handler)
-            signal.signal(signal.SIGTERM, sigint_handler)
-
-            sys.exit(app.exec())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    sys.argv = ["bec_widgets.cli.server", "--id", "e2860", "--gui_class", "BECDockArea"]
-    main()

bec_widgets/config_plotter.py

@@ -0,0 +1,138 @@
+from typing import List
+
+import numpy as np
+import pyqtgraph as pg
+from PyQt5.QtWidgets import QApplication, QGridLayout, QSizePolicy, QWidget
+from pyqtgraph import mkPen
+from pyqtgraph.Qt import QtCore
+
+
+class ConfigPlotter(QWidget):
+    """
+    ConfigPlotter is a widget that can be used to plot data from multiple channels
+    in a grid layout. The layout is specified by a list of dicts, where each dict
+    specifies the position of the plot in the grid, the channels to plot, and the
+    type of plot to use. The plot type is specified by the name of the pyqtgraph
+    item to use. For example, to plot a single channel in a PlotItem, the config
+    would look like this:
+
+    config = [
+        {
+            "cols": 1,
+            "rows": 1,
+            "y": 0,
+            "x": 0,
+            "config": {"channels": ["a"], "label_xy": ["", "a"], "item": "PlotItem"},
+        }
+    ]
+
+    """
+
+    def __init__(self, configs: List[dict], parent=None):
+        super(ConfigPlotter, self).__init__()
+        self.configs = configs
+        self.plots = {}
+        self._init_ui()
+        self._init_plots()
+
+    def _init_ui(self):
+        pg.setConfigOption("background", "w")
+        pg.setConfigOption("foreground", "k")
+        self.layout = QGridLayout()
+        self.setLayout(self.layout)
+        self.pen = mkPen(color=(56, 76, 107), width=4, style=QtCore.Qt.SolidLine)
+        self.show()
+
+    def _init_plots(self):
+        for config in self.configs:
+            channels = config["config"]["channels"]
+            for channel in channels:
+                # call the corresponding init function, e.g. init_plotitem
+                init_func = getattr(self, f"init_{config['config']['item']}")
+                init_func(channel, config)
+
+                # self.init_ImageItem(channel, config["config"], item)
+
+    def init_PlotItem(self, channel: str, config: dict):
+        """
+        Initialize a PlotItem
+
+        Args:
+            channel(str): channel to plot
+            config(dict): config dict for the channel
+        """
+        # pylint: disable=invalid-name
+        plot_widget = pg.PlotWidget()
+        plot_widget.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
+        self.layout.addWidget(plot_widget, config["y"], config["x"], config["rows"], config["cols"])
+        plot_data = plot_widget.plot(np.random.rand(100), pen=self.pen)
+        # item.setLabel("left", channel)
+        # self.plots[channel] = {"item": item, "plot_data": plot_data}
+
+    def init_ImageItem(self, channel: str, config: dict):
+        """
+        Initialize an ImageItem
+
+        Args:
+            channel(str): channel to plot
+            config(dict): config dict for the channel
+        """
+        # pylint: disable=invalid-name
+        item = pg.PlotItem()
+        self.layout.addItem(
+            item,
+            row=config["y"],
+            col=config["x"],
+            rowspan=config["rows"],
+            colspan=config["cols"],
+        )
+        img = pg.ImageItem()
+        item.addItem(img)
+        img.setImage(np.random.rand(100, 100))
+        self.plots[channel] = {"item": item, "plot_data": img}
+
+    def init_ImageView(self, channel: str, config: dict):
+        """
+        Initialize an ImageView
+
+        Args:
+            channel(str): channel to plot
+            config(dict): config dict for the channel
+        """
+        # pylint: disable=invalid-name
+        img = pg.ImageView()
+        img.setImage(np.random.rand(100, 100))
+        self.layout.addWidget(img, config["y"], config["x"], config["rows"], config["cols"])
+        self.plots[channel] = {"item": img, "plot_data": img}
+
+
+if __name__ == "__main__":
+    import sys
+
+    CONFIG = [
+        {
+            "cols": 1,
+            "rows": 1,
+            "y": 0,
+            "x": 0,
+            "config": {"channels": ["a"], "label_xy": ["", "a"], "item": "PlotItem"},
+        },
+        {
+            "cols": 1,
+            "rows": 1,
+            "y": 1,
+            "x": 0,
+            "config": {"channels": ["b"], "label_xy": ["", "b"], "item": "PlotItem"},
+        },
+        {
+            "cols": 1,
+            "rows": 2,
+            "y": 0,
+            "x": 1,
+            "config": {"channels": ["c"], "label_xy": ["", "c"], "item": "ImageView"},
+        },
+    ]
+
+    app = QApplication(sys.argv)
+    win = ConfigPlotter(CONFIG)
+    pg.exec()

bec_widgets/examples/general_app/general_app.py

@@ -1,92 +0,0 @@
-import os
-import sys
-
-from qtpy.QtCore import QSize
-from qtpy.QtGui import QActionGroup, QIcon
-from qtpy.QtWidgets import QApplication, QMainWindow, QStyle
-
-import bec_widgets
-from bec_widgets.examples.general_app.web_links import BECWebLinksMixin
-from bec_widgets.utils.colors import apply_theme
-from bec_widgets.utils.ui_loader import UILoader
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-class BECGeneralApp(QMainWindow):
-    def __init__(self, parent=None):
-        super(BECGeneralApp, self).__init__(parent)
-        ui_file_path = os.path.join(os.path.dirname(__file__), "general_app.ui")
-        self.load_ui(ui_file_path)
-
-        self.resize(1280, 720)
-
-        self.ini_ui()
-
-    def ini_ui(self):
-        self._setup_icons()
-        self._hook_menubar_docs()
-        self._hook_theme_bar()
-
-    def load_ui(self, ui_file):
-        loader = UILoader(self)
-        self.ui = loader.loader(ui_file)
-        self.setCentralWidget(self.ui)
-
-    def _hook_menubar_docs(self):
-        # BEC Docs
-        self.ui.action_BEC_docs.triggered.connect(BECWebLinksMixin.open_bec_docs)
-        # BEC Widgets Docs
-        self.ui.action_BEC_widgets_docs.triggered.connect(BECWebLinksMixin.open_bec_widgets_docs)
-        # Bug report
-        self.ui.action_bug_report.triggered.connect(BECWebLinksMixin.open_bec_bug_report)
-
-    def change_theme(self, theme):
-        apply_theme(theme)
-
-    def _setup_icons(self):
-        help_icon = QApplication.style().standardIcon(QStyle.SP_MessageBoxQuestion)
-        bug_icon = QApplication.style().standardIcon(QStyle.SP_MessageBoxInformation)
-        computer_icon = QIcon.fromTheme("computer")
-        widget_icon = QIcon(os.path.join(MODULE_PATH, "assets", "designer_icons", "dock_area.png"))
-
-        self.ui.action_BEC_docs.setIcon(help_icon)
-        self.ui.action_BEC_widgets_docs.setIcon(help_icon)
-        self.ui.action_bug_report.setIcon(bug_icon)
-
-        self.ui.central_tab.setTabIcon(0, widget_icon)
-        self.ui.central_tab.setTabIcon(1, computer_icon)
-
-    def _hook_theme_bar(self):
-        self.ui.action_light.setCheckable(True)
-        self.ui.action_dark.setCheckable(True)
-
-        # Create an action group to make sure only one can be checked at a time
-        theme_group = QActionGroup(self)
-        theme_group.addAction(self.ui.action_light)
-        theme_group.addAction(self.ui.action_dark)
-        theme_group.setExclusive(True)
-
-        # Connect the actions to the theme change method
-
-        self.ui.action_light.triggered.connect(lambda: self.change_theme("light"))
-        self.ui.action_dark.triggered.connect(lambda: self.change_theme("dark"))
-
-        self.ui.action_dark.trigger()
-
-
-def main():  # pragma: no cover
-
-    app = QApplication(sys.argv)
-    icon = QIcon()
-    icon.addFile(
-        os.path.join(MODULE_PATH, "assets", "app_icons", "BEC-General-App.png"), size=QSize(48, 48)
-    )
-    app.setWindowIcon(icon)
-    main_window = BECGeneralApp()
-    main_window.show()
-    sys.exit(app.exec_())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/examples/general_app/general_app.ui

@@ -1,262 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
-    <class>MainWindow</class>
-    <widget class="QMainWindow" name="MainWindow">
-        <property name="geometry">
-            <rect>
-                <x>0</x>
-                <y>0</y>
-                <width>1718</width>
-                <height>1139</height>
-            </rect>
-        </property>
-        <property name="windowTitle">
-            <string>MainWindow</string>
-        </property>
-        <property name="tabShape">
-            <enum>QTabWidget::TabShape::Rounded</enum>
-        </property>
-        <widget class="QWidget" name="centralwidget">
-            <layout class="QVBoxLayout" name="verticalLayout_3">
-                <item>
-                    <widget class="QTabWidget" name="central_tab">
-                        <property name="currentIndex">
-                            <number>0</number>
-                        </property>
-                        <widget class="QWidget" name="dock_area_tab">
-                            <attribute name="title">
-                                <string>Dock Area</string>
-                            </attribute>
-                            <layout class="QVBoxLayout" name="verticalLayout">
-                                <property name="leftMargin">
-                                    <number>2</number>
-                                </property>
-                                <property name="topMargin">
-                                    <number>1</number>
-                                </property>
-                                <property name="rightMargin">
-                                    <number>2</number>
-                                </property>
-                                <property name="bottomMargin">
-                                    <number>2</number>
-                                </property>
-                                <item>
-                                    <widget class="BECDockArea" name="dock_area"/>
-                                </item>
-                            </layout>
-                        </widget>
-                        <widget class="QWidget" name="vscode_tab">
-                            <attribute name="icon">
-                                <iconset theme="QIcon::ThemeIcon::Computer"/>
-                            </attribute>
-                            <attribute name="title">
-                                <string>Visual Studio Code</string>
-                            </attribute>
-                            <layout class="QVBoxLayout" name="verticalLayout_2">
-                                <property name="leftMargin">
-                                    <number>2</number>
-                                </property>
-                                <property name="topMargin">
-                                    <number>1</number>
-                                </property>
-                                <property name="rightMargin">
-                                    <number>2</number>
-                                </property>
-                                <property name="bottomMargin">
-                                    <number>2</number>
-                                </property>
-                                <item>
-                                    <widget class="VSCodeEditor" name="vscode"/>
-                                </item>
-                            </layout>
-                        </widget>
-                    </widget>
-                </item>
-            </layout>
-        </widget>
-        <widget class="QMenuBar" name="menubar">
-            <property name="geometry">
-                <rect>
-                    <x>0</x>
-                    <y>0</y>
-                    <width>1718</width>
-                    <height>31</height>
-                </rect>
-            </property>
-            <widget class="QMenu" name="menuHelp">
-                <property name="title">
-                    <string>Help</string>
-                </property>
-                <addaction name="action_BEC_docs"/>
-                <addaction name="action_BEC_widgets_docs"/>
-                <addaction name="action_bug_report"/>
-            </widget>
-            <widget class="QMenu" name="menuTheme">
-                <property name="title">
-                    <string>Theme</string>
-                </property>
-                <addaction name="action_light"/>
-                <addaction name="action_dark"/>
-            </widget>
-            <addaction name="menuTheme"/>
-            <addaction name="menuHelp"/>
-        </widget>
-        <widget class="QStatusBar" name="statusbar"/>
-        <widget class="QDockWidget" name="dock_scan_control">
-            <property name="windowTitle">
-                <string>Scan Control</string>
-            </property>
-            <attribute name="dockWidgetArea">
-                <number>2</number>
-            </attribute>
-            <widget class="QWidget" name="dockWidgetContents_2">
-                <layout class="QVBoxLayout" name="verticalLayout_4">
-                    <item>
-                        <widget class="ScanControl" name="scan_control"/>
-                    </item>
-                </layout>
-            </widget>
-        </widget>
-        <widget class="QDockWidget" name="dock_status_2">
-            <property name="windowTitle">
-                <string>BEC Service Status</string>
-            </property>
-            <attribute name="dockWidgetArea">
-                <number>2</number>
-            </attribute>
-            <widget class="QWidget" name="dockWidgetContents_3">
-                <layout class="QVBoxLayout" name="verticalLayout_5">
-                    <property name="leftMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="topMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="rightMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="bottomMargin">
-                        <number>0</number>
-                    </property>
-                    <item>
-                        <widget class="BECStatusBox" name="bec_status_box_2"/>
-                    </item>
-                </layout>
-            </widget>
-        </widget>
-        <widget class="QDockWidget" name="dock_queue">
-            <property name="windowTitle">
-                <string>Scan Queue</string>
-            </property>
-            <attribute name="dockWidgetArea">
-                <number>2</number>
-            </attribute>
-            <widget class="QWidget" name="dockWidgetContents_4">
-                <layout class="QVBoxLayout" name="verticalLayout_6">
-                    <property name="leftMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="topMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="rightMargin">
-                        <number>0</number>
-                    </property>
-                    <property name="bottomMargin">
-                        <number>0</number>
-                    </property>
-                    <item>
-                        <widget class="BECQueue" name="bec_queue">
-                            <row/>
-                            <column/>
-                            <column/>
-                            <column/>
-                            <item row="0" column="0"/>
-                            <item row="0" column="1"/>
-                            <item row="0" column="2"/>
-                        </widget>
-                    </item>
-                </layout>
-            </widget>
-        </widget>
-        <action name="action_BEC_docs">
-            <property name="icon">
-                <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
-            </property>
-            <property name="text">
-                <string>BEC Docs</string>
-            </property>
-        </action>
-        <action name="action_BEC_widgets_docs">
-            <property name="icon">
-                <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
-            </property>
-            <property name="text">
-                <string>BEC Widgets Docs</string>
-            </property>
-        </action>
-        <action name="action_bug_report">
-            <property name="icon">
-                <iconset theme="QIcon::ThemeIcon::DialogError"/>
-            </property>
-            <property name="text">
-                <string>Bug Report</string>
-            </property>
-        </action>
-        <action name="action_light">
-            <property name="checkable">
-                <bool>true</bool>
-            </property>
-            <property name="text">
-                <string>Light</string>
-            </property>
-        </action>
-        <action name="action_dark">
-            <property name="checkable">
-                <bool>true</bool>
-            </property>
-            <property name="text">
-                <string>Dark</string>
-            </property>
-        </action>
-    </widget>
-    <customwidgets>
-        <customwidget>
-            <class>WebsiteWidget</class>
-            <extends>QWebEngineView</extends>
-            <header>website_widget</header>
-        </customwidget>
-        <customwidget>
-            <class>BECQueue</class>
-            <extends>QTableWidget</extends>
-            <header>bec_queue</header>
-        </customwidget>
-        <customwidget>
-            <class>ScanControl</class>
-            <extends>QWidget</extends>
-            <header>scan_control</header>
-        </customwidget>
-        <customwidget>
-            <class>VSCodeEditor</class>
-            <extends>WebsiteWidget</extends>
-            <header>vs_code_editor</header>
-        </customwidget>
-        <customwidget>
-            <class>BECStatusBox</class>
-            <extends>QWidget</extends>
-            <header>bec_status_box</header>
-        </customwidget>
-        <customwidget>
-            <class>BECDockArea</class>
-            <extends>QWidget</extends>
-            <header>dock_area</header>
-        </customwidget>
-        <customwidget>
-            <class>QWebEngineView</class>
-            <extends></extends>
-            <header location="global">QtWebEngineWidgets/QWebEngineView</header>
-        </customwidget>
-    </customwidgets>
-    <resources/>
-    <connections/>
-</ui>

bec_widgets/examples/general_app/web_links.py

@@ -1,15 +0,0 @@
-import webbrowser
-
-
-class BECWebLinksMixin:
-    @staticmethod
-    def open_bec_docs():
-        webbrowser.open("https://beamline-experiment-control.readthedocs.io/en/latest/")
-
-    @staticmethod
-    def open_bec_widgets_docs():
-        webbrowser.open("https://bec.readthedocs.io/projects/bec-widgets/en/latest/")
-
-    @staticmethod
-    def open_bec_bug_report():
-        webbrowser.open("https://gitlab.psi.ch/groups/bec/-/issues/")

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -1,217 +0,0 @@
-import os
-
-import numpy as np
-import pyqtgraph as pg
-from bec_qthemes import material_icon
-from qtpy.QtWidgets import (
-    QApplication,
-    QGroupBox,
-    QHBoxLayout,
-    QSplitter,
-    QTabWidget,
-    QVBoxLayout,
-    QWidget,
-)
-
-from bec_widgets.utils import BECDispatcher
-from bec_widgets.utils.colors import apply_theme
-from bec_widgets.widgets.containers.dock import BECDockArea
-from bec_widgets.widgets.containers.figure import BECFigure
-from bec_widgets.widgets.editors.jupyter_console.jupyter_console import BECJupyterConsole
-
-
-class JupyterConsoleWindow(QWidget):  # pragma: no cover:
-    """A widget that contains a Jupyter console linked to BEC Widgets with full API access (contains Qt and pyqtgraph API)."""
-
-    def __init__(self, parent=None):
-        super().__init__(parent)
-
-        self._init_ui()
-
-        # console push
-        if self.console.inprocess is True:
-            self.console.kernel_manager.kernel.shell.push(
-                {
-                    "np": np,
-                    "pg": pg,
-                    "fig": self.figure,
-                    "dock": self.dock,
-                    "w1": self.w1,
-                    "w2": self.w2,
-                    "w3": self.w3,
-                    "w4": self.w4,
-                    "w5": self.w5,
-                    "w6": self.w6,
-                    "w7": self.w7,
-                    "w8": self.w8,
-                    "w9": self.w9,
-                    "w10": self.w10,
-                    "d0": self.d0,
-                    "d1": self.d1,
-                    "d2": self.d2,
-                    "wave": self.wf,
-                    # "bar": self.bar,
-                    # "cm": self.colormap,
-                    "im": self.im,
-                    "mm": self.mm,
-                    "mw": self.mw,
-                }
-            )
-
-    def _init_ui(self):
-        self.layout = QHBoxLayout(self)
-
-        # Horizontal splitter
-        splitter = QSplitter(self)
-        self.layout.addWidget(splitter)
-
-        tab_widget = QTabWidget(splitter)
-
-        first_tab = QWidget()
-        first_tab_layout = QVBoxLayout(first_tab)
-        self.dock = BECDockArea(gui_id="dock")
-        first_tab_layout.addWidget(self.dock)
-        tab_widget.addTab(first_tab, "Dock Area")
-
-        second_tab = QWidget()
-        second_tab_layout = QVBoxLayout(second_tab)
-        self.figure = BECFigure(parent=self, gui_id="figure")
-        second_tab_layout.addWidget(self.figure)
-        tab_widget.addTab(second_tab, "BEC Figure")
-
-        group_box = QGroupBox("Jupyter Console", splitter)
-        group_box_layout = QVBoxLayout(group_box)
-        self.console = BECJupyterConsole(inprocess=True)
-        group_box_layout.addWidget(self.console)
-
-        # add stuff to figure
-        self._init_figure()
-
-        # init dock for testing
-        self._init_dock()
-
-        self.setWindowTitle("Jupyter Console Window")
-
-    def _init_figure(self):
-        self.w1 = self.figure.plot(
-            x_name="samx",
-            y_name="bpm4i",
-            # title="Standard Plot with sync device, custom labels - w1",
-            # x_label="Motor Position",
-            # y_label="Intensity (A.U.)",
-            row=0,
-            col=0,
-        )
-        self.w1.set(
-            title="Standard Plot with sync device, custom labels - w1",
-            x_label="Motor Position",
-            y_label="Intensity (A.U.)",
-        )
-        self.w2 = self.figure.motor_map("samx", "samy", row=0, col=1)
-        self.w3 = self.figure.image(
-            "eiger", color_map="viridis", vrange=(0, 100), title="Eiger Image - w3", row=0, col=2
-        )
-        self.w4 = self.figure.plot(
-            x_name="samx",
-            y_name="samy",
-            z_name="bpm4i",
-            color_map_z="magma",
-            new=True,
-            title="2D scatter plot - w4",
-            row=0,
-            col=3,
-        )
-        self.w5 = self.figure.plot(
-            y_name="bpm4i",
-            new=True,
-            title="Best Effort Plot - w5",
-            dap="GaussianModel",
-            row=1,
-            col=0,
-        )
-        self.w6 = self.figure.plot(
-            x_name="timestamp", y_name="bpm4i", new=True, title="Timestamp Plot - w6", row=1, col=1
-        )
-        self.w7 = self.figure.plot(
-            x_name="index", y_name="bpm4i", new=True, title="Index Plot - w7", row=1, col=2
-        )
-        self.w8 = self.figure.plot(
-            y_name="monitor_async", new=True, title="Async Plot - Best Effort - w8", row=2, col=0
-        )
-        self.w9 = self.figure.plot(
-            x_name="timestamp",
-            y_name="monitor_async",
-            new=True,
-            title="Async Plot - timestamp - w9",
-            row=2,
-            col=1,
-        )
-        self.w10 = self.figure.plot(
-            x_name="index",
-            y_name="monitor_async",
-            new=True,
-            title="Async Plot - index - w10",
-            row=2,
-            col=2,
-        )
-
-    def _init_dock(self):
-
-        self.d0 = self.dock.add_dock(name="dock_0")
-        self.mm = self.d0.add_widget("BECMotorMapWidget")
-        self.mm.change_motors("samx", "samy")
-
-        self.d1 = self.dock.add_dock(name="dock_1", position="right")
-        self.im = self.d1.add_widget("BECImageWidget")
-        self.im.image("waveform", "1d")
-
-        self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.wf = self.d2.add_widget("BECFigure", row=0, col=0)
-
-        self.mw = self.wf.multi_waveform(monitor="waveform")  # , config=config)
-        # self.wf.plot(x_name="samx", y_name="bpm3a")
-        # self.wf.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
-        # self.bar = self.d2.add_widget("RingProgressBar", row=0, col=1)
-        # self.bar.set_diameter(200)
-
-        # self.d3 = self.dock.add_dock(name="dock_3", position="bottom")
-        # self.colormap = pg.GradientWidget()
-        # self.d3.add_widget(self.colormap, row=0, col=0)
-
-        self.dock.save_state()
-
-    def closeEvent(self, event):
-        """Override to handle things when main window is closed."""
-        self.dock.cleanup()
-        self.dock.close()
-        self.figure.cleanup()
-        self.figure.close()
-        self.console.close()
-
-        super().closeEvent(event)
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    import bec_widgets
-
-    module_path = os.path.dirname(bec_widgets.__file__)
-
-    app = QApplication(sys.argv)
-    app.setApplicationName("Jupyter Console")
-    app.setApplicationDisplayName("Jupyter Console")
-    apply_theme("dark")
-    icon = material_icon("terminal", color="#434343", filled=True)
-    app.setWindowIcon(icon)
-
-    bec_dispatcher = BECDispatcher()
-    client = bec_dispatcher.client
-    client.start()
-
-    win = JupyterConsoleWindow()
-    win.show()
-    win.resize(1200, 800)
-
-    app.aboutToQuit.connect(win.close)
-    sys.exit(app.exec_())

bec_widgets/examples/plugin_example_pyside/main.py

@@ -1,18 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-
-"""PySide6 port of the Qt Designer taskmenuextension example from Qt v6.x"""
-
-import sys
-
-from bec_ipython_client.main import BECIPythonClient
-from qtpy.QtWidgets import QApplication
-
-from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
-
-if __name__ == "__main__":  # pragma: no cover
-    app = QApplication(sys.argv)
-    window = TicTacToe()
-    window.state = "-X-XO----"
-    window.show()
-    sys.exit(app.exec())

bec_widgets/examples/plugin_example_pyside/registertictactoe.py

@@ -1,13 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-
-from qtpy.QtDesigner import QPyDesignerCustomWidgetCollection
-
-from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
-from bec_widgets.examples.plugin_example_pyside.tictactoeplugin import TicTacToePlugin
-
-# Set PYSIDE_DESIGNER_PLUGINS to point to this directory and load the plugin
-
-
-if __name__ == "__main__":  # pragma: no cover
-    QPyDesignerCustomWidgetCollection.addCustomWidget(TicTacToePlugin())

bec_widgets/examples/plugin_example_pyside/taskmenuextension.pyproject

@@ -1,4 +0,0 @@
-{
-    "files": ["tictactoe.py", "main.py", "registertictactoe.py", "tictactoeplugin.py",
-    "tictactoetaskmenu.py"]
-}

bec_widgets/examples/plugin_example_pyside/tictactoe.py

@@ -1,135 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-
-from qtpy.QtCore import Property, QPoint, QRect, QSize, Qt, Slot
-from qtpy.QtGui import QPainter, QPen
-from qtpy.QtWidgets import QWidget
-
-EMPTY = "-"
-CROSS = "X"
-NOUGHT = "O"
-DEFAULT_STATE = "---------"
-
-
-class TicTacToe(QWidget):  # pragma: no cover
-    def __init__(self, parent=None):
-        super().__init__(parent)
-        self._state = DEFAULT_STATE
-        self._turn_number = 0
-
-    def minimumSizeHint(self):
-        return QSize(200, 200)
-
-    def sizeHint(self):
-        return QSize(200, 200)
-
-    def setState(self, new_state):
-        self._turn_number = 0
-        self._state = DEFAULT_STATE
-        for position in range(min(9, len(new_state))):
-            mark = new_state[position]
-            if mark == CROSS or mark == NOUGHT:
-                self._turn_number += 1
-                self._change_state_at(position, mark)
-            position += 1
-        self.update()
-
-    def state(self):
-        return self._state
-
-    @Slot()
-    def clear_board(self):
-        self._state = DEFAULT_STATE
-        self._turn_number = 0
-        self.update()
-
-    def _change_state_at(self, pos, new_state):
-        self._state = self._state[:pos] + new_state + self._state[pos + 1 :]
-
-    def mousePressEvent(self, event):
-        if self._turn_number == 9:
-            self.clear_board()
-            return
-        for position in range(9):
-            cell = self._cell_rect(position)
-            if cell.contains(event.position().toPoint()):
-                if self._state[position] == EMPTY:
-                    new_state = CROSS if self._turn_number % 2 == 0 else NOUGHT
-                    self._change_state_at(position, new_state)
-                    self._turn_number += 1
-                    self.update()
-
-    def paintEvent(self, event):
-        with QPainter(self) as painter:
-            painter.setRenderHint(QPainter.Antialiasing)
-
-            painter.setPen(QPen(Qt.darkGreen, 1))
-            painter.drawLine(self._cell_width(), 0, self._cell_width(), self.height())
-            painter.drawLine(2 * self._cell_width(), 0, 2 * self._cell_width(), self.height())
-            painter.drawLine(0, self._cell_height(), self.width(), self._cell_height())
-            painter.drawLine(0, 2 * self._cell_height(), self.width(), 2 * self._cell_height())
-
-            painter.setPen(QPen(Qt.darkBlue, 2))
-
-            for position in range(9):
-                cell = self._cell_rect(position)
-                if self._state[position] == CROSS:
-                    painter.drawLine(cell.topLeft(), cell.bottomRight())
-                    painter.drawLine(cell.topRight(), cell.bottomLeft())
-                elif self._state[position] == NOUGHT:
-                    painter.drawEllipse(cell)
-
-            painter.setPen(QPen(Qt.yellow, 3))
-
-            for position in range(0, 8, 3):
-                if (
-                    self._state[position] != EMPTY
-                    and self._state[position + 1] == self._state[position]
-                    and self._state[position + 2] == self._state[position]
-                ):
-                    y = self._cell_rect(position).center().y()
-                    painter.drawLine(0, y, self.width(), y)
-                    self._turn_number = 9
-
-            for position in range(3):
-                if (
-                    self._state[position] != EMPTY
-                    and self._state[position + 3] == self._state[position]
-                    and self._state[position + 6] == self._state[position]
-                ):
-                    x = self._cell_rect(position).center().x()
-                    painter.drawLine(x, 0, x, self.height())
-                    self._turn_number = 9
-
-            if (
-                self._state[0] != EMPTY
-                and self._state[4] == self._state[0]
-                and self._state[8] == self._state[0]
-            ):
-                painter.drawLine(0, 0, self.width(), self.height())
-                self._turn_number = 9
-
-            if (
-                self._state[2] != EMPTY
-                and self._state[4] == self._state[2]
-                and self._state[6] == self._state[2]
-            ):
-                painter.drawLine(0, self.height(), self.width(), 0)
-                self._turn_number = 9
-
-    def _cell_rect(self, position):
-        h_margin = self.width() / 30
-        v_margin = self.height() / 30
-        row = int(position / 3)
-        column = position - 3 * row
-        pos = QPoint(column * self._cell_width() + h_margin, row * self._cell_height() + v_margin)
-        size = QSize(self._cell_width() - 2 * h_margin, self._cell_height() - 2 * v_margin)
-        return QRect(pos, size)
-
-    def _cell_width(self):
-        return self.width() / 3
-
-    def _cell_height(self):
-        return self.height() / 3
-
-    state = Property(str, state, setState)

bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py

@@ -1,73 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-import os
-
-from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-
-import bec_widgets
-from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
-from bec_widgets.examples.plugin_example_pyside.tictactoetaskmenu import TicTacToeTaskMenuFactory
-from bec_widgets.utils.bec_designer import designer_material_icon
-
-DOM_XML = """
-<ui language='c++'>
-    <widget class='TicTacToe' name='ticTacToe'>
-        <property name='geometry'>
-            <rect>
-                <x>0</x>
-                <y>0</y>
-                <width>200</width>
-                <height>200</height>
-            </rect>
-        </property>
-        <property name='state'>
-            <string>-X-XO----</string>
-        </property>
-    </widget>
-</ui>
-"""
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-class TicTacToePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
-    def __init__(self):
-        super().__init__()
-        self._form_editor = None
-
-    def createWidget(self, parent):
-        t = TicTacToe(parent)
-        return t
-
-    def domXml(self):
-        return DOM_XML
-
-    def group(self):
-        return "Games"
-
-    def icon(self):
-        return designer_material_icon("sports_esports")
-
-    def includeFile(self):
-        return "tictactoe"
-
-    def initialize(self, form_editor):
-        self._form_editor = form_editor
-        manager = form_editor.extensionManager()
-        iid = TicTacToeTaskMenuFactory.task_menu_iid()
-        manager.registerExtensions(TicTacToeTaskMenuFactory(manager), iid)
-
-    def isContainer(self):
-        return False
-
-    def isInitialized(self):
-        return self._form_editor is not None
-
-    def name(self):
-        return "TicTacToe"
-
-    def toolTip(self):
-        return "Tic Tac Toe Example, demonstrating class QDesignerTaskMenuExtension (Python)"
-
-    def whatsThis(self):
-        return self.toolTip()

bec_widgets/examples/plugin_example_pyside/tictactoetaskmenu.py

@@ -1,68 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-
-from qtpy.QtDesigner import QExtensionFactory, QPyDesignerTaskMenuExtension
-from qtpy.QtGui import QAction
-from qtpy.QtWidgets import QDialog, QDialogButtonBox, QVBoxLayout
-
-from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
-from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
-
-
-class TicTacToeDialog(QDialog):  # pragma: no cover
-    def __init__(self, parent):
-        super().__init__(parent)
-        layout = QVBoxLayout(self)
-        self._ticTacToe = TicTacToe(self)
-        layout.addWidget(self._ticTacToe)
-        button_box = QDialogButtonBox(
-            QDialogButtonBox.Ok | QDialogButtonBox.Cancel | QDialogButtonBox.Reset
-        )
-        button_box.accepted.connect(self.accept)
-        button_box.rejected.connect(self.reject)
-        reset_button = button_box.button(QDialogButtonBox.Reset)
-        reset_button.clicked.connect(self._ticTacToe.clear_board)
-        layout.addWidget(button_box)
-
-    def set_state(self, new_state):
-        self._ticTacToe.setState(new_state)
-
-    def state(self):
-        return self._ticTacToe.state
-
-
-class TicTacToeTaskMenu(QPyDesignerTaskMenuExtension):
-    def __init__(self, ticTacToe, parent):
-        super().__init__(parent)
-        self._ticTacToe = ticTacToe
-        self._edit_state_action = QAction("Edit State...", None)
-        self._edit_state_action.triggered.connect(self._edit_state)
-
-    def taskActions(self):
-        return [self._edit_state_action]
-
-    def preferredEditAction(self):
-        return self._edit_state_action
-
-    @Slot()
-    def _edit_state(self):
-        dialog = TicTacToeDialog(self._ticTacToe)
-        dialog.set_state(self._ticTacToe.state)
-        if dialog.exec() == QDialog.Accepted:
-            self._ticTacToe.state = dialog.state()
-
-
-class TicTacToeTaskMenuFactory(QExtensionFactory):
-    def __init__(self, extension_manager):
-        super().__init__(extension_manager)
-
-    @staticmethod
-    def task_menu_iid():
-        return "org.qt-project.Qt.Designer.TaskMenu"
-
-    def createExtension(self, object, iid, parent):
-        if iid != TicTacToeTaskMenuFactory.task_menu_iid():
-            return None
-        if object.__class__.__name__ != "TicTacToe":
-            return None
-        return TicTacToeTaskMenu(object, parent)

bec_widgets/qt_utils/compact_popup.py

@@ -1,268 +0,0 @@
-import time
-from types import SimpleNamespace
-
-from bec_qthemes import material_icon
-from qtpy.QtCore import Property, Qt, Signal
-from qtpy.QtGui import QColor
-from qtpy.QtWidgets import (
-    QDialog,
-    QHBoxLayout,
-    QLabel,
-    QPushButton,
-    QSizePolicy,
-    QSpacerItem,
-    QVBoxLayout,
-    QWidget,
-)
-
-from bec_widgets.utils.colors import get_accent_colors
-
-
-class LedLabel(QLabel):
-    success_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:1, y2:1, stop:0 %s, stop:1 %s);"
-    emergency_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:0.92, y2:0.988636, stop:0 %s, stop:1 %s);"
-    warning_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.232, y1:0.272, x2:0.98, y2:0.959773, stop:0 %s, stop:1 %s);"
-    default_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.04, y1:0.0565909, x2:0.799, y2:0.795, stop:0 %s, stop:1 %s);"
-
-    def __init__(self, parent=None):
-        super().__init__(parent)
-
-        self.palette = get_accent_colors()
-        if self.palette is None:
-            # no theme!
-            self.palette = SimpleNamespace(
-                default=QColor("blue"),
-                success=QColor("green"),
-                warning=QColor("orange"),
-                emergency=QColor("red"),
-            )
-        self.setState("default")
-        self.setFixedSize(20, 20)
-
-    def setState(self, state: str):
-        match state:
-            case "success":
-                r, g, b, a = self.palette.success.getRgb()
-                self.setStyleSheet(
-                    LedLabel.success_led
-                    % (
-                        f"rgba({r},{g},{b},{a})",
-                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
-                    )
-                )
-            case "default":
-                r, g, b, a = self.palette.default.getRgb()
-                self.setStyleSheet(
-                    LedLabel.default_led
-                    % (
-                        f"rgba({r},{g},{b},{a})",
-                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
-                    )
-                )
-            case "warning":
-                r, g, b, a = self.palette.warning.getRgb()
-                self.setStyleSheet(
-                    LedLabel.warning_led
-                    % (
-                        f"rgba({r},{g},{b},{a})",
-                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
-                    )
-                )
-            case "emergency":
-                r, g, b, a = self.palette.emergency.getRgb()
-                self.setStyleSheet(
-                    LedLabel.emergency_led
-                    % (
-                        f"rgba({r},{g},{b},{a})",
-                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
-                    )
-                )
-            case unknown_state:
-                raise ValueError(
-                    f"Unknown state {repr(unknown_state)}, must be one of default, success, warning or emergency"
-                )
-
-
-class PopupDialog(QDialog):
-    def __init__(self, content_widget):
-        self.parent = content_widget.parent()
-        self.content_widget = content_widget
-
-        super().__init__(self.parent)
-
-        self.setAttribute(Qt.WA_DeleteOnClose)
-
-        self.content_widget.setParent(self)
-        QVBoxLayout(self)
-        self.layout().addWidget(self.content_widget)
-        self.content_widget.setVisible(True)
-
-    def closeEvent(self, event):
-        self.content_widget.setVisible(False)
-        self.content_widget.setParent(self.parent)
-        self.done(True)
-
-
-class CompactPopupWidget(QWidget):
-    """Container widget, that can display its content or have a compact form,
-    in this case clicking on a small button pops the contained widget up.
-
-    In the compact form, a LED-like indicator shows a status indicator.
-    """
-
-    expand = Signal(bool)
-
-    def __init__(self, parent=None, layout=QVBoxLayout):
-        super().__init__(parent)
-
-        self._popup_window = None
-        self._expand_popup = True
-
-        QVBoxLayout(self)
-        self.compact_view_widget = QWidget(self)
-        self.compact_view_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
-        QHBoxLayout(self.compact_view_widget)
-        self.compact_view_widget.layout().setSpacing(0)
-        self.compact_view_widget.layout().setContentsMargins(0, 0, 0, 0)
-        self.compact_view_widget.layout().addSpacerItem(
-            QSpacerItem(0, 0, QSizePolicy.Expanding, QSizePolicy.Fixed)
-        )
-        self.compact_label = QLabel(self.compact_view_widget)
-        self.compact_status = LedLabel(self.compact_view_widget)
-        self.compact_show_popup = QPushButton(self.compact_view_widget)
-        self.compact_show_popup.setFlat(True)
-        self.compact_show_popup.setIcon(
-            material_icon(icon_name="expand_content", size=(10, 10), convert_to_pixmap=False)
-        )
-        self.compact_view_widget.layout().addWidget(self.compact_label)
-        self.compact_view_widget.layout().addWidget(self.compact_status)
-        self.compact_view_widget.layout().addWidget(self.compact_show_popup)
-        self.compact_view_widget.setVisible(False)
-        self.layout().addWidget(self.compact_view_widget)
-        self.container = QWidget(self)
-        self.layout().addWidget(self.container)
-        self.container.setVisible(True)
-        layout(self.container)
-        self.layout = self.container.layout()
-
-        self.compact_show_popup.clicked.connect(self.show_popup)
-
-    def set_global_state(self, state: str):
-        """Set the LED-indicator state
-
-        The LED indicator represents the 'global' state. State can be one of the
-        following: "default", "success", "warning", "emergency"
-        """
-        self.compact_status.setState(state)
-
-    def show_popup(self):
-        """Display the contained widgets in a popup dialog"""
-        if self._expand_popup:
-            # show popup
-            self._popup_window = PopupDialog(self.container)
-            self._popup_window.show()
-            self._popup_window.finished.connect(lambda: self.expand.emit(False))
-            self.expand.emit(True)
-        else:
-            if self.compact_view:
-                # expand in place
-                self.compact_view = False
-                self.compact_view_widget.setVisible(True)
-                self.compact_label.setVisible(False)
-                self.compact_status.setVisible(False)
-                self.compact_show_popup.setIcon(
-                    material_icon(
-                        icon_name="collapse_content", size=(10, 10), convert_to_pixmap=False
-                    )
-                )
-                self.expand.emit(True)
-            else:
-                # back to compact form
-                self.compact_label.setVisible(True)
-                self.compact_status.setVisible(True)
-                self.compact_show_popup.setIcon(
-                    material_icon(
-                        icon_name="expand_content", size=(10, 10), convert_to_pixmap=False
-                    )
-                )
-                self.compact_view = True
-                self.expand.emit(False)
-
-    def setSizePolicy(self, size_policy1, size_policy2=None):
-        # setting size policy on the compact popup widget will set
-        # the policy for the container, and for itself
-        if size_policy2 is None:
-            # assuming first form: setSizePolicy(QSizePolicy)
-            self.container.setSizePolicy(size_policy1)
-            QWidget.setSizePolicy(self, size_policy1)
-        else:
-            self.container.setSizePolicy(size_policy1, size_policy2)
-            QWidget.setSizePolicy(self, size_policy1, size_policy2)
-
-    def addWidget(self, widget):
-        """Add a widget to the popup container
-
-        The popup container corresponds to the "full view" (not compact)
-        The widget is reparented to the container, and added to the container layout
-        """
-        widget.setParent(self.container)
-        self.container.layout().addWidget(widget)
-
-    @Property(bool)
-    def compact_view(self):
-        return self.compact_label.isVisible()
-
-    @compact_view.setter
-    def compact_view(self, set_compact: bool):
-        """Sets the compact form
-
-        If set_compact is True, the compact view is displayed ; otherwise,
-        the full view is displayed. This is handled by toggling visibility of
-        the container widget or the compact view widget.
-        """
-        if set_compact:
-            self.compact_view_widget.setVisible(True)
-            self.container.setVisible(False)
-            QWidget.setSizePolicy(self, QSizePolicy.Fixed, QSizePolicy.Fixed)
-        else:
-            self.compact_view_widget.setVisible(False)
-            self.container.setVisible(True)
-            QWidget.setSizePolicy(self, self.container.sizePolicy())
-        if self.parentWidget():
-            self.parentWidget().adjustSize()
-        else:
-            self.adjustSize()
-
-    @Property(str)
-    def label(self):
-        return self.compact_label.text()
-
-    @label.setter
-    def label(self, compact_label_text: str):
-        """Set the label text associated to the compact view"""
-        self.compact_label.setText(compact_label_text)
-
-    @Property(str)
-    def tooltip(self):
-        return self.compact_label.toolTip()
-
-    @tooltip.setter
-    def tooltip(self, tooltip: str):
-        """Set the tooltip text associated to the compact view"""
-        self.compact_label.setToolTip(tooltip)
-        self.compact_status.setToolTip(tooltip)
-
-    @Property(bool)
-    def expand_popup(self):
-        return self._expand_popup
-
-    @expand_popup.setter
-    def expand_popup(self, popup: bool):
-        self._expand_popup = popup
-
-    def closeEvent(self, event):
-        # Called by Qt, on closing - since the children widgets can be
-        # BECWidgets, it is good to explicitely call 'close' on them,
-        # to ensure proper resources cleanup
-        for child in self.container.findChildren(QWidget, options=Qt.FindDirectChildrenOnly):
-            child.close()

bec_widgets/qt_utils/error_popups.py

@@ -1,214 +0,0 @@
-import functools
-import sys
-import traceback
-
-from qtpy.QtCore import QObject, Qt, Signal, Slot
-from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget
-
-
-def SafeSlot(*slot_args, **slot_kwargs):  # pylint: disable=invalid-name
-    """Function with args, acting like a decorator, applying "error_managed" decorator + Qt Slot
-    to the passed function, to display errors instead of potentially raising an exception
-
-    'popup_error' keyword argument can be passed with boolean value if a dialog should pop up,
-    otherwise error display is left to the original exception hook
-    """
-    popup_error = bool(slot_kwargs.pop("popup_error", False))
-
-    def error_managed(method):
-        @Slot(*slot_args, **slot_kwargs)
-        @functools.wraps(method)
-        def wrapper(*args, **kwargs):
-            try:
-                return method(*args, **kwargs)
-            except Exception:
-                ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=popup_error)
-
-        return wrapper
-
-    return error_managed
-
-
-class WarningPopupUtility(QObject):
-    """
-    Utility class to show warning popups in the application.
-    """
-
-    @SafeSlot(str, str, str, QWidget)
-    def show_warning_message(self, title, message, detailed_text, widget):
-        msg = QMessageBox(widget)
-        msg.setIcon(QMessageBox.Warning)
-        msg.setWindowTitle(title)
-        msg.setText(message)
-        msg.setStandardButtons(QMessageBox.Ok)
-        msg.setDetailedText(detailed_text)
-        msg.exec_()
-
-    def show_warning(self, title: str, message: str, detailed_text: str, widget: QWidget = None):
-        """
-        Show a warning message with the given title, message, and detailed text.
-
-        Args:
-            title (str): The title of the warning message.
-            message (str): The main text of the warning message.
-            detailed_text (str): The detailed text to show when the user expands the message.
-            widget (QWidget): The parent widget for the message box.
-        """
-        self.show_warning_message(title, message, detailed_text, widget)
-
-
-_popup_utility_instance = None
-
-
-class _ErrorPopupUtility(QObject):
-    """
-    Utility class to manage error popups in the application to show error messages to the users.
-    This class is singleton and the error popup can be enabled or disabled globally or attach to widget methods with decorator @error_managed.
-    """
-
-    error_occurred = Signal(str, str, QWidget)
-
-    def __init__(self, parent=None):
-        super().__init__(parent=parent)
-        self.error_occurred.connect(self.show_error_message)
-        self.enable_error_popup = False
-        self._initialized = True
-        sys.excepthook = self.custom_exception_hook
-
-    @SafeSlot(str, str, QWidget)
-    def show_error_message(self, title, message, widget):
-        detailed_text = self.format_traceback(message)
-        error_message = self.parse_error_message(detailed_text)
-
-        msg = QMessageBox(widget)
-        msg.setIcon(QMessageBox.Critical)
-        msg.setWindowTitle(title)
-        msg.setText(error_message)
-        msg.setStandardButtons(QMessageBox.Ok)
-        msg.setDetailedText(detailed_text)
-        msg.setTextInteractionFlags(Qt.TextSelectableByMouse)
-        msg.setMinimumWidth(600)
-        msg.setMinimumHeight(400)
-        msg.exec_()
-
-    def format_traceback(self, traceback_message: str) -> str:
-        """
-        Format the traceback message to be displayed in the error popup by adding indentation to each line.
-
-        Args:
-            traceback_message(str): The traceback message to be formatted.
-
-        Returns:
-            str: The formatted traceback message.
-        """
-        formatted_lines = []
-        lines = traceback_message.split("\n")
-        for line in lines:
-            formatted_lines.append("    " + line)  # Add indentation to each line
-        return "\n".join(formatted_lines)
-
-    def parse_error_message(self, traceback_message):
-        lines = traceback_message.split("\n")
-        error_message = "Error occurred. See details."
-        capture = False
-        captured_message = []
-
-        for line in lines:
-            if "raise" in line:
-                capture = True
-                continue
-            if capture:
-                if line.strip() and not line.startswith("  File "):
-                    captured_message.append(line.strip())
-                else:
-                    break
-
-        if captured_message:
-            error_message = " ".join(captured_message)
-        return error_message
-
-    def custom_exception_hook(self, exctype, value, tb, popup_error=False):
-        if popup_error or self.enable_error_popup:
-            error_message = traceback.format_exception(exctype, value, tb)
-            self.error_occurred.emit(
-                "Method error" if popup_error else "Application Error",
-                "".join(error_message),
-                self.parent(),
-            )
-        else:
-            sys.__excepthook__(exctype, value, tb)  # Call the original excepthook
-
-    def enable_global_error_popups(self, state: bool):
-        """
-        Enable or disable global error popups for all applications.
-
-        Args:
-            state(bool): True to enable error popups, False to disable error popups.
-        """
-        self.enable_error_popup = bool(state)
-
-
-def ErrorPopupUtility():
-    global _popup_utility_instance
-    if not _popup_utility_instance:
-        _popup_utility_instance = _ErrorPopupUtility()
-    return _popup_utility_instance
-
-
-class ExampleWidget(QWidget):  # pragma: no cover
-    """
-    Example widget to demonstrate error handling with the ErrorPopupUtility.
-
-    Warnings -> This example works properly only with PySide6, PyQt6 has a bug with the error handling.
-    """
-
-    def __init__(self, parent=None):
-        super().__init__(parent=parent)
-        self.init_ui()
-        self.warning_utility = WarningPopupUtility(self)
-
-    def init_ui(self):
-        self.layout = QVBoxLayout(self)
-
-        # Button to trigger method with error handling
-        self.error_button = QPushButton("Trigger Handled Error", self)
-        self.error_button.clicked.connect(self.method_with_error_handling)
-        self.layout.addWidget(self.error_button)
-
-        # Button to trigger method without error handling
-        self.normal_button = QPushButton("Trigger Normal Error", self)
-        self.normal_button.clicked.connect(self.method_without_error_handling)
-        self.layout.addWidget(self.normal_button)
-
-        # Button to trigger warning popup
-        self.warning_button = QPushButton("Trigger Warning", self)
-        self.warning_button.clicked.connect(self.trigger_warning)
-        self.layout.addWidget(self.warning_button)
-
-    @SafeSlot(popup_error=True)
-    def method_with_error_handling(self):
-        """This method raises an error and the exception is handled by the decorator."""
-        raise ValueError("This is a handled error.")
-
-    @SafeSlot()
-    def method_without_error_handling(self):
-        """This method raises an error and the exception is not handled here."""
-        raise ValueError("This is an unhandled error.")
-
-    @SafeSlot()
-    def trigger_warning(self):
-        """Trigger a warning using the WarningPopupUtility."""
-        self.warning_utility.show_warning(
-            title="Warning",
-            message="This is a warning message.",
-            detailed_text="This is the detailed text of the warning message.",
-            widget=self,
-        )
-
-
-if __name__ == "__main__":  # pragma: no cover
-
-    app = QApplication(sys.argv)
-    widget = ExampleWidget()
-    widget.show()
-    sys.exit(app.exec_())

bec_widgets/qt_utils/palette_viewer.py

@@ -1,183 +0,0 @@
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import (
-    QApplication,
-    QFrame,
-    QGridLayout,
-    QHBoxLayout,
-    QLabel,
-    QScrollArea,
-    QSizePolicy,
-    QVBoxLayout,
-    QWidget,
-)
-
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import get_accent_colors, get_theme_palette
-from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
-
-
-class PaletteViewer(BECWidget, QWidget):
-    """
-    This class is a widget that displays current palette colors.
-    """
-
-    ICON_NAME = "palette"
-
-    def __init__(self, *args, parent=None, **kwargs):
-        super().__init__(*args, theme_update=True, **kwargs)
-        QWidget.__init__(self, parent=parent)
-        self.setFixedSize(400, 600)
-        layout = QVBoxLayout(self)
-        dark_mode_button = DarkModeButton(self)
-        layout.addWidget(dark_mode_button)
-
-        # Create a scroll area to hold the color boxes
-        scroll_area = QScrollArea(self)
-        scroll_area.setWidgetResizable(True)
-        scroll_area.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-
-        # Create a frame to hold the color boxes
-        self.frame = QFrame(self)
-        self.frame_layout = QGridLayout(self.frame)
-        self.frame_layout.setSpacing(0)
-        self.frame_layout.setContentsMargins(0, 0, 0, 0)
-
-        scroll_area.setWidget(self.frame)
-        layout.addWidget(scroll_area)
-
-        self.setLayout(layout)
-
-        self.update_palette()
-
-    def apply_theme(self, theme) -> None:
-        """
-        Apply the theme to the widget.
-
-        Args:
-            theme (str): The theme to apply.
-        """
-        self.update_palette()
-
-    def clear_palette(self) -> None:
-        """
-        Clear the palette colors from the frame.
-        Recursively removes all widgets and layouts in the frame layout.
-        """
-        # Iterate over all items in the layout in reverse to safely remove them
-        for i in reversed(range(self.frame_layout.count())):
-            item = self.frame_layout.itemAt(i)
-
-            # If the item is a layout, clear its contents
-            if isinstance(item, QHBoxLayout):
-                # Recursively remove all widgets from the layout
-                for j in reversed(range(item.count())):
-                    widget = item.itemAt(j).widget()
-                    if widget:
-                        item.removeWidget(widget)
-                        widget.deleteLater()
-                self.frame_layout.removeItem(item)
-
-            # If the item is a widget, remove and delete it
-            elif item.widget():
-                widget = item.widget()
-                self.frame_layout.removeWidget(widget)
-                widget.deleteLater()
-
-    def update_palette(self) -> None:
-        """
-        Update the palette colors in the frame.
-        """
-        self.clear_palette()
-        palette_label = QLabel("Palette Colors (e.g. palette.windowText().color())")
-        palette_label.setStyleSheet("font-weight: bold;")
-        self.frame_layout.addWidget(palette_label, 0, 0)
-
-        palette = get_theme_palette()
-        # Add the palette colors (roles) to the frame
-        palette_roles = [
-            palette.windowText,
-            palette.toolTipText,
-            palette.placeholderText,
-            palette.text,
-            palette.buttonText,
-            palette.highlight,
-            palette.link,
-            palette.light,
-            palette.midlight,
-            palette.mid,
-            palette.shadow,
-            palette.button,
-            palette.brightText,
-            palette.toolTipBase,
-            palette.alternateBase,
-            palette.dark,
-            palette.base,
-            palette.window,
-            palette.highlightedText,
-            palette.linkVisited,
-        ]
-
-        offset = 1
-        for i, pal in enumerate(palette_roles):
-            i += offset
-            color = pal().color()
-            label_layout = QHBoxLayout()
-            color_label = QLabel(f"{pal().color().name()} ({pal.__name__})")
-            background_label = self.background_label_with_clipboard(color)
-            label_layout.addWidget(color_label)
-            label_layout.addWidget(background_label)
-            self.frame_layout.addLayout(label_layout, i, 0)
-
-        # add a horizontal spacer
-        spacer = QLabel()
-        spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Minimum)
-        self.frame_layout.addWidget(spacer, i + 1, 0)
-
-        accent_colors_label = QLabel("Accent Colors (e.g. accent_colors.default)")
-        accent_colors_label.setStyleSheet("font-weight: bold;")
-        self.frame_layout.addWidget(accent_colors_label, i + 2, 0)
-
-        accent_colors = get_accent_colors()
-        items = [
-            (accent_colors.default, "default"),
-            (accent_colors.success, "success"),
-            (accent_colors.warning, "warning"),
-            (accent_colors.emergency, "emergency"),
-            (accent_colors.highlight, "highlight"),
-        ]
-
-        offset = len(palette_roles) + 2
-        for i, (color, name) in enumerate(items):
-            i += offset
-            label_layout = QHBoxLayout()
-            color_label = QLabel(f"{color.name()} ({name})")
-            background_label = self.background_label_with_clipboard(color)
-            label_layout.addWidget(color_label)
-            label_layout.addWidget(background_label)
-            self.frame_layout.addLayout(label_layout, i + 2, 0)
-
-    def background_label_with_clipboard(self, color) -> QLabel:
-        """
-        Create a label with a background color that copies the color to the clipboard when clicked.
-
-        Args:
-            color (QColor): The color to display in the background.
-
-        Returns:
-            QLabel: The label with the background color.
-        """
-        button = QLabel()
-        button.setStyleSheet(f"QLabel {{ background-color: {color.name()}; }}")
-        button.setToolTip("Click to copy color to clipboard")
-        button.setCursor(Qt.PointingHandCursor)
-        button.mousePressEvent = lambda event: QApplication.clipboard().setText(color.name())
-        return button
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    app = QApplication(sys.argv)
-    viewer = PaletteViewer()
-    viewer.show()
-    sys.exit(app.exec_())

bec_widgets/qt_utils/redis_message_waiter.py

@@ -1,47 +0,0 @@
-from bec_lib.serialization import MsgpackSerialization
-from bec_lib.utils import lazy_import_from
-from qtpy.QtCore import QEventLoop, QSocketNotifier, QTimer
-
-MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
-
-
-class QtRedisMessageWaiter:
-    def __init__(self, redis_connector, message_to_wait):
-        self.ev_loop = QEventLoop()
-        self.response = None
-        self.connector = redis_connector
-        self.message_to_wait = message_to_wait
-        self.pubsub = redis_connector._redis_conn.pubsub()
-        self.pubsub.subscribe(self.message_to_wait.endpoint)
-        fd = self.pubsub.connection._sock.fileno()
-        self.notifier = QSocketNotifier(fd, QSocketNotifier.Read)
-        self.notifier.activated.connect(self._pubsub_readable)
-
-    def _msg_received(self, msg_obj):
-        self.response = msg_obj.value
-        self.ev_loop.quit()
-
-    def wait(self, timeout=1):
-        timer = QTimer()
-        timer.singleShot(timeout * 1000, self.ev_loop.quit)
-        self.ev_loop.exec_()
-        timer.stop()
-        self.notifier.setEnabled(False)
-        self.pubsub.close()
-        return self.response
-
-    def _pubsub_readable(self, fd):
-        while True:
-            msg = self.pubsub.get_message()
-            if msg:
-                if msg["type"] == "subscribe":
-                    # get_message buffers, so we may already have the answer
-                    # let's check...
-                    continue
-                else:
-                    break
-            else:
-                return
-        channel = msg["channel"].decode()
-        msg = MessageObject(topic=channel, value=MsgpackSerialization.loads(msg["data"]))
-        self.connector._execute_callback(self._msg_received, msg, {})

bec_widgets/qt_utils/settings_dialog.py

@@ -1,119 +0,0 @@
-from qtpy.QtWidgets import QDialog, QDialogButtonBox, QHBoxLayout, QPushButton, QVBoxLayout, QWidget
-
-from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
-
-
-class SettingWidget(QWidget):
-    """
-    Abstract class for a settings widget to enforce the implementation of the accept_changes and display_current_settings.
-    Can be used for toolbar actions to display the settings of a widget.
-
-    Args:
-        target_widget (QWidget): The widget that the settings will be taken from and applied to.
-    """
-
-    def __init__(self, parent=None, *args, **kwargs):
-        super().__init__(parent, *args, **kwargs)
-
-        self.target_widget = None
-
-    def set_target_widget(self, target_widget: QWidget):
-        self.target_widget = target_widget
-
-    @Slot()
-    def accept_changes(self):
-        """
-        Accepts the changes made in the settings widget and applies them to the target widget.
-        """
-        pass
-
-    @Slot(dict)
-    def display_current_settings(self, config_dict: dict):
-        """
-        Displays the current settings of the target widget in the settings widget.
-
-        Args:
-            config_dict(dict): The current settings of the target widget.
-        """
-        pass
-
-
-class SettingsDialog(QDialog):
-    """
-    Dialog to display and edit the settings of a widget with accept and cancel buttons.
-
-    Args:
-        parent (QWidget): The parent widget of the dialog.
-        target_widget (QWidget): The widget that the settings will be taken from and applied to.
-        settings_widget (SettingWidget): The widget that will display the settings.
-    """
-
-    def __init__(
-        self,
-        parent=None,
-        settings_widget: SettingWidget = None,
-        window_title: str = "Settings",
-        config: dict = None,
-        *args,
-        **kwargs,
-    ):
-        super().__init__(parent, *args, **kwargs)
-
-        self.setModal(False)
-
-        self.setWindowTitle(window_title)
-
-        self.widget = settings_widget
-        self.widget.set_target_widget(parent)
-        if config is None:
-            config = parent.get_config()
-
-        self.widget.display_current_settings(config)
-
-        self.button_box = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
-
-        self.apply_button = QPushButton("Apply")
-
-        button_layout = QHBoxLayout()
-        button_layout.addWidget(self.button_box.button(QDialogButtonBox.Cancel))
-        button_layout.addWidget(self.apply_button)
-        button_layout.addWidget(self.button_box.button(QDialogButtonBox.Ok))
-
-        self.button_box.accepted.connect(self.accept)
-        self.button_box.rejected.connect(self.reject)
-        self.apply_button.clicked.connect(self.apply_changes)
-
-        self.layout = QVBoxLayout(self)
-        self.layout.setContentsMargins(5, 5, 5, 5)
-        self.layout.addWidget(self.widget)
-        self.layout.addLayout(button_layout)
-
-        ok_button = self.button_box.button(QDialogButtonBox.Ok)
-        ok_button.setDefault(True)
-        ok_button.setAutoDefault(True)
-
-    @Slot()
-    def accept(self):
-        """
-        Accept the changes made in the settings widget and close the dialog.
-        """
-        self.widget.accept_changes()
-        super().accept()
-
-    @Slot()
-    def apply_changes(self):
-        """
-        Apply the changes made in the settings widget without closing the dialog.
-        """
-        self.widget.accept_changes()
-
-    def cleanup(self):
-        """
-        Cleanup the dialog.
-        """
-        self.button_box.close()
-        self.button_box.deleteLater()
-
-    def closeEvent(self, event):
-        self.cleanup()
-        super().closeEvent(event)

bec_widgets/qt_utils/toolbar.py

@@ -1,296 +0,0 @@
-# pylint: disable=no-name-in-module
-from __future__ import annotations
-
-import os
-from abc import ABC, abstractmethod
-from collections import defaultdict
-from typing import Literal
-
-from bec_qthemes._icon.material_icons import material_icon
-from qtpy.QtCore import QSize, Qt
-from qtpy.QtGui import QAction, QColor, QIcon
-from qtpy.QtWidgets import (
-    QComboBox,
-    QHBoxLayout,
-    QLabel,
-    QMenu,
-    QSizePolicy,
-    QToolBar,
-    QToolButton,
-    QWidget,
-)
-
-import bec_widgets
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-class ToolBarAction(ABC):
-    """
-    Abstract base class for toolbar actions.
-
-    Args:
-        icon_path (str, optional): The name of the icon file from `assets/toolbar_icons`. Defaults to None.
-        tooltip (bool, optional): The tooltip for the action. Defaults to None.
-        checkable (bool, optional): Whether the action is checkable. Defaults to False.
-    """
-
-    def __init__(self, icon_path: str = None, tooltip: str = None, checkable: bool = False):
-        self.icon_path = (
-            os.path.join(MODULE_PATH, "assets", "toolbar_icons", icon_path) if icon_path else None
-        )
-        self.tooltip = tooltip
-        self.checkable = checkable
-        self.action = None
-
-    @abstractmethod
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        """Adds an action or widget to a toolbar.
-
-        Args:
-            toolbar (QToolBar): The toolbar to add the action or widget to.
-            target (QWidget): The target widget for the action.
-        """
-
-
-class SeparatorAction(ToolBarAction):
-    """Separator action for the toolbar."""
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        toolbar.addSeparator()
-
-
-class IconAction(ToolBarAction):
-    """
-    Action with an icon for the toolbar.
-
-    Args:
-        icon_path (str): The path to the icon file.
-        tooltip (str): The tooltip for the action.
-        checkable (bool, optional): Whether the action is checkable. Defaults to False.
-    """
-
-    def __init__(self, icon_path: str = None, tooltip: str = None, checkable: bool = False):
-        super().__init__(icon_path, tooltip, checkable)
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        icon = QIcon()
-        icon.addFile(self.icon_path, size=QSize(20, 20))
-        self.action = QAction(icon, self.tooltip, target)
-        self.action.setCheckable(self.checkable)
-        toolbar.addAction(self.action)
-
-
-class MaterialIconAction:
-    """
-    Action with a Material icon for the toolbar.
-
-    Args:
-        icon_path (str, optional): The name of the Material icon. Defaults to None.
-        tooltip (bool, optional): The tooltip for the action. Defaults to None.
-        checkable (bool, optional): Whether the action is checkable. Defaults to False.
-        filled (bool, optional): Whether the icon is filled. Defaults to False.
-    """
-
-    def __init__(
-        self,
-        icon_name: str = None,
-        tooltip: str = None,
-        checkable: bool = False,
-        filled: bool = False,
-        color: str | tuple | QColor | dict[Literal["dark", "light"], str] | None = None,
-    ):
-        self.icon_name = icon_name
-        self.tooltip = tooltip
-        self.checkable = checkable
-        self.action = None
-        self.filled = filled
-        self.color = color
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        icon = self.get_icon()
-        self.action = QAction(icon, self.tooltip, target)
-        self.action.setCheckable(self.checkable)
-        toolbar.addAction(self.action)
-
-    def get_icon(self):
-
-        icon = material_icon(
-            self.icon_name,
-            size=(20, 20),
-            convert_to_pixmap=False,
-            filled=self.filled,
-            color=self.color,
-        )
-        return icon
-
-
-class DeviceSelectionAction(ToolBarAction):
-    """
-    Action for selecting a device in a combobox.
-
-    Args:
-        label (str): The label for the combobox.
-        device_combobox (DeviceComboBox): The combobox for selecting the device.
-
-    """
-
-    def __init__(self, label: str, device_combobox):
-        super().__init__()
-        self.label = label
-        self.device_combobox = device_combobox
-        self.device_combobox.currentIndexChanged.connect(lambda: self.set_combobox_style("#ffa700"))
-
-    def add_to_toolbar(self, toolbar, target):
-        widget = QWidget()
-        layout = QHBoxLayout(widget)
-        label = QLabel(f"{self.label}")
-        layout.addWidget(label)
-        layout.addWidget(self.device_combobox)
-        toolbar.addWidget(widget)
-
-    def set_combobox_style(self, color: str):
-        self.device_combobox.setStyleSheet(f"QComboBox {{ background-color: {color}; }}")
-
-
-class WidgetAction(ToolBarAction):
-    """
-    Action for adding any widget to the toolbar.
-
-    Args:
-        label (str|None): The label for the widget.
-        widget (QWidget): The widget to be added to the toolbar.
-
-    """
-
-    def __init__(self, label: str | None = None, widget: QWidget = None, parent=None):
-        super().__init__(parent)
-        self.label = label
-        self.widget = widget
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        container = QWidget()
-        layout = QHBoxLayout(container)
-        layout.setContentsMargins(0, 0, 0, 0)
-        layout.setSpacing(5)
-
-        if self.label is not None:
-            label_widget = QLabel(f"{self.label}")
-            label_widget.setSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
-            label_widget.setAlignment(Qt.AlignVCenter | Qt.AlignRight)
-            layout.addWidget(label_widget)
-
-        if isinstance(self.widget, QComboBox):
-            self.widget.setSizeAdjustPolicy(QComboBox.AdjustToContents)
-
-            size_policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
-            self.widget.setSizePolicy(size_policy)
-
-            self.widget.setMinimumWidth(self.calculate_minimum_width(self.widget))
-
-        else:
-            self.widget.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
-
-        layout.addWidget(self.widget)
-
-        toolbar.addWidget(container)
-
-    @staticmethod
-    def calculate_minimum_width(combo_box: QComboBox) -> int:
-        """
-        Calculate the minimum width required to display the longest item in the combo box.
-
-        Args:
-            combo_box (QComboBox): The combo box to calculate the width for.
-
-        Returns:
-            int: The calculated minimum width in pixels.
-        """
-        font_metrics = combo_box.fontMetrics()
-        max_width = max(font_metrics.width(combo_box.itemText(i)) for i in range(combo_box.count()))
-        return max_width + 60
-
-
-class ExpandableMenuAction(ToolBarAction):
-    """
-    Action for an expandable menu in the toolbar.
-
-    Args:
-        label (str): The label for the menu.
-        actions (dict): A dictionary of actions to populate the menu.
-        icon_path (str, optional): The path to the icon file. Defaults to None.
-
-    """
-
-    def __init__(self, label: str, actions: dict, icon_path: str = None):
-        super().__init__(icon_path, label)
-        self.actions = actions
-        self.widgets = defaultdict(dict)
-
-    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        button = QToolButton(toolbar)
-        if self.icon_path:
-            button.setIcon(QIcon(self.icon_path))
-        button.setText(self.tooltip)
-        button.setPopupMode(QToolButton.InstantPopup)
-        button.setStyleSheet(
-            """
-                   QToolButton {
-                       font-size: 14px;
-                   }
-                   QMenu {
-                       font-size: 14px;
-                   }
-               """
-        )
-        menu = QMenu(button)
-        for action_id, action in self.actions.items():
-            sub_action = QAction(action.tooltip, target)
-            if hasattr(action, "icon_path"):
-                icon = QIcon()
-                icon.addFile(action.icon_path, size=QSize(20, 20))
-                sub_action.setIcon(icon)
-            elif hasattr(action, "get_icon"):
-                sub_action.setIcon(action.get_icon())
-            sub_action.setCheckable(action.checkable)
-            menu.addAction(sub_action)
-            self.widgets[action_id] = sub_action
-        button.setMenu(menu)
-        toolbar.addWidget(button)
-
-
-class ModularToolBar(QToolBar):
-    """Modular toolbar with optional automatic initialization.
-    Args:
-        parent (QWidget, optional): The parent widget of the toolbar. Defaults to None.
-        actions (list[ToolBarAction], optional): A list of action creators to populate the toolbar. Defaults to None.
-        target_widget (QWidget, optional): The widget that the actions will target. Defaults to None.
-    """
-
-    def __init__(self, parent=None, actions: dict | None = None, target_widget=None):
-        super().__init__(parent)
-
-        self.widgets = defaultdict(dict)
-        self.set_background_color()
-
-        if actions is not None and target_widget is not None:
-            self.populate_toolbar(actions, target_widget)
-
-    def populate_toolbar(self, actions: dict, target_widget):
-        """Populates the toolbar with a set of actions.
-
-        Args:
-            actions (list[ToolBarAction]): A list of action creators to populate the toolbar.
-            target_widget (QWidget): The widget that the actions will target.
-        """
-        self.clear()
-        for action_id, action in actions.items():
-            action.add_to_toolbar(self, target_widget)
-            self.widgets[action_id] = action
-
-    def set_background_color(self):
-        self.setIconSize(QSize(20, 20))
-        self.setMovable(False)
-        self.setFloatable(False)
-        self.setContentsMargins(0, 0, 0, 0)
-        self.setStyleSheet("QToolBar { background-color: rgba(0, 0, 0, 0); border: none; }")

bec_widgets/readme.md

@@ -0,0 +1,4 @@
+Add/modify the path in the following variable to make the plugin avaiable in Qt Designer:
+```
+$ export PYQTDESIGNERPATH=/<path to repo>/bec/bec_qtplugin:$PYQTDESIGNERPATH
+```

bec_widgets/scan_plot.py

@@ -0,0 +1,106 @@
+import itertools
+
+import pyqtgraph as pg
+from PyQt5.QtCore import pyqtProperty, pyqtSlot
+
+from bec_lib.core.logger import bec_logger
+
+logger = bec_logger.logger
+
+
+pg.setConfigOptions(background="w", foreground="k", antialias=True)
+COLORS = ["#fd7f6f", "#7eb0d5", "#b2e061", "#bd7ebe", "#ffb55a"]
+
+
+class BECScanPlot(pg.PlotWidget):
+    def __init__(self, parent=None, background="default"):
+        super().__init__(parent, background)
+
+        self._x_channel = ""
+        self._y_channel_list = []
+
+        self.scan_curves = {}
+        self.dap_curves = {}
+
+    def initialize(self):
+        plot_item = self.getPlotItem()
+        plot_item.addLegend()
+        colors = itertools.cycle(COLORS)
+
+        for y_chan in self.y_channel_list:
+            if y_chan.startswith("dap."):
+                y_chan = y_chan.partition("dap.")[-1]
+                curves = self.dap_curves
+            else:
+                curves = self.scan_curves
+
+            curves[y_chan] = plot_item.plot(
+                x=[], y=[], pen=pg.mkPen(color=next(colors), width=2), name=y_chan
+            )
+
+        plot_item.setLabel("bottom", self._x_channel)
+        if len(self.scan_curves) == 1:
+            plot_item.setLabel("left", next(iter(self.scan_curves)))
+
+    @pyqtSlot()
+    def clearData(self):
+        for plot_curve in {**self.scan_curves, **self.dap_curves}.values():
+            plot_curve.setData(x=[], y=[])
+
+    @pyqtSlot(dict)
+    def redraw_scan(self, data):
+        if not self.x_channel:
+            return
+
+        if self.x_channel not in data:
+            logger.warning(f"Unknown channel `{self.x_channel}` for X data in {self.objectName()}")
+            return
+
+        x_new = data[self.x_channel][self.x_channel]["value"]
+        for chan, plot_curve in self.scan_curves.items():
+            if not chan:
+                continue
+
+            if chan not in data:
+                logger.warning(f"Unknown channel `{chan}` for Y data in {self.objectName()}")
+                continue
+
+            y_new = data[chan][chan]["value"]
+            x, y = plot_curve.getData()  # TODO: is it a good approach?
+            if x is None:
+                x = []
+            if y is None:
+                y = []
+
+            plot_curve.setData(x=[*x, x_new], y=[*y, y_new])
+
+    @pyqtSlot(dict)
+    def redraw_dap(self, data):
+        for chan, plot_curve in self.dap_curves.items():
+            if not chan:
+                continue
+
+            if chan not in data:
+                logger.warning(f"Unknown channel `{chan}` for DAP data in {self.objectName()}")
+                continue
+
+            x_new = data[chan]["x"]
+            y_new = data[chan]["y"]
+
+            plot_curve.setData(x=x_new, y=y_new)
+
+    @pyqtProperty("QStringList")
+    def y_channel_list(self):
+        return self._y_channel_list
+
+    @y_channel_list.setter
+    def y_channel_list(self, new_list):
+        self._y_channel_list = new_list
+
+    @pyqtProperty(str)
+    def x_channel(self):
+        return self._x_channel
+
+    @x_channel.setter
+    def x_channel(self, new_val):
+        self._x_channel = new_val

bec_widgets/scan_plot_plugin.py

@@ -0,0 +1,55 @@
+from PyQt5.QtDesigner import QPyDesignerCustomWidgetPlugin
+from PyQt5.QtGui import QIcon
+from scan_plot import BECScanPlot
+
+
+class BECScanPlotPlugin(QPyDesignerCustomWidgetPlugin):
+    def __init__(self, parent=None):
+        super(BECScanPlotPlugin, self).__init__(parent)
+
+        self._initialized = False
+
+    def initialize(self, formEditor):
+        if self._initialized:
+            return
+
+        self._initialized = True
+
+    def isInitialized(self):
+        return self._initialized
+
+    def createWidget(self, parent):
+        return BECScanPlot(parent)
+
+    def name(self):
+        return "BECScanPlot"
+
+    def group(self):
+        return "BEC widgets"
+
+    def icon(self):
+        return QIcon()
+
+    def toolTip(self):
+        return "BEC plot for scans"
+
+    def whatsThis(self):
+        return "BEC plot for scans"
+
+    def isContainer(self):
+        return False
+
+    def domXml(self):
+        return (
+            '<widget class="BECScanPlot" name="BECScanPlot">\n'
+            ' <property name="toolTip" >\n'
+            "  <string>BEC plot for scans</string>\n"
+            " </property>\n"
+            ' <property name="whatsThis" >\n'
+            "  <string>BEC plot for scans in Python using PyQt.</string>\n"
+            " </property>\n"
+            "</widget>\n"
+        )
+
+    def includeFile(self):
+        return "scan_plot"

bec_widgets/tests/utils.py

@@ -1,226 +0,0 @@
-from unittest.mock import MagicMock
-
-from bec_lib.device import Device as BECDevice
-from bec_lib.device import Positioner as BECPositioner
-from bec_lib.device import ReadoutPriority
-from bec_lib.devicemanager import DeviceContainer
-
-
-class FakeDevice(BECDevice):
-    """Fake minimal positioner class for testing."""
-
-    def __init__(self, name, enabled=True, readout_priority=ReadoutPriority.MONITORED):
-        super().__init__(name=name)
-        self._enabled = enabled
-        self.signals = {self.name: {"value": 1.0}}
-        self.description = {self.name: {"source": self.name, "dtype": "number", "shape": []}}
-        self._readout_priority = readout_priority
-        self._config = {
-            "readoutPriority": "baseline",
-            "deviceClass": "ophyd.Device",
-            "deviceConfig": {},
-            "deviceTags": ["user device"],
-            "enabled": enabled,
-            "readOnly": False,
-            "name": self.name,
-        }
-
-    @property
-    def readout_priority(self):
-        return self._readout_priority
-
-    @readout_priority.setter
-    def readout_priority(self, value):
-        self._readout_priority = value
-
-    @property
-    def limits(self) -> tuple[float, float]:
-        return self._limits
-
-    @limits.setter
-    def limits(self, value: tuple[float, float]):
-        self._limits = value
-
-    def __contains__(self, item):
-        return item == self.name
-
-    @property
-    def _hints(self):
-        return [self.name]
-
-    def set_value(self, fake_value: float = 1.0) -> None:
-        """
-        Setup fake value for device readout
-        Args:
-            fake_value(float): Desired fake value
-        """
-        self.signals[self.name]["value"] = fake_value
-
-    def describe(self) -> dict:
-        """
-        Get the description of the device
-        Returns:
-            dict: Description of the device
-        """
-        return self.description
-
-
-class FakePositioner(BECPositioner):
-
-    def __init__(
-        self,
-        name,
-        enabled=True,
-        limits=None,
-        read_value=1.0,
-        readout_priority=ReadoutPriority.MONITORED,
-    ):
-        super().__init__(name=name)
-        # self.limits = limits if limits is not None else [0.0, 0.0]
-        self.read_value = read_value
-        self.setpoint_value = read_value
-        self.motor_is_moving_value = 0
-        self._enabled = enabled
-        self._limits = limits
-        self._readout_priority = readout_priority
-        self.signals = {self.name: {"value": 1.0}}
-        self.description = {self.name: {"source": self.name, "dtype": "number", "shape": []}}
-        self._config = {
-            "readoutPriority": "baseline",
-            "deviceClass": "ophyd_devices.SimPositioner",
-            "deviceConfig": {"delay": 1, "tolerance": 0.01, "update_frequency": 400},
-            "deviceTags": ["user motors"],
-            "enabled": enabled,
-            "readOnly": False,
-            "name": self.name,
-        }
-        self._info = {
-            "signals": {
-                "readback": {"kind_str": "5"},  # hinted
-                "setpoint": {"kind_str": "1"},  # normal
-                "velocity": {"kind_str": "2"},  # config
-            }
-        }
-        self.signals = {
-            self.name: {"value": self.read_value},
-            f"{self.name}_setpoint": {"value": self.setpoint_value},
-            f"{self.name}_motor_is_moving": {"value": self.motor_is_moving_value},
-        }
-
-    @property
-    def readout_priority(self):
-        return self._readout_priority
-
-    @readout_priority.setter
-    def readout_priority(self, value):
-        self._readout_priority = value
-
-    @property
-    def enabled(self) -> bool:
-        return self._enabled
-
-    @enabled.setter
-    def enabled(self, value: bool):
-        self._enabled = value
-
-    @property
-    def limits(self) -> tuple[float, float]:
-        return self._limits
-
-    @limits.setter
-    def limits(self, value: tuple[float, float]):
-        self._limits = value
-
-    def __contains__(self, item):
-        return item == self.name
-
-    @property
-    def _hints(self):
-        return [self.name]
-
-    def set_value(self, fake_value: float = 1.0) -> None:
-        """
-        Setup fake value for device readout
-        Args:
-            fake_value(float): Desired fake value
-        """
-        self.read_value = fake_value
-
-    def describe(self) -> dict:
-        """
-        Get the description of the device
-        Returns:
-            dict: Description of the device
-        """
-        return self.description
-
-    @property
-    def precision(self):
-        return 3
-
-    def set_read_value(self, value):
-        self.read_value = value
-
-    def read(self):
-        return self.signals
-
-    def set_limits(self, limits):
-        self.limits = limits
-
-    def move(self, value, relative=False):
-        """Simulates moving the device to a new position."""
-        if relative:
-            self.read_value += value
-        else:
-            self.read_value = value
-        # Respect the limits
-        self.read_value = max(min(self.read_value, self.limits[1]), self.limits[0])
-
-    @property
-    def readback(self):
-        return MagicMock(get=MagicMock(return_value=self.read_value))
-
-
-class Positioner(FakePositioner):
-    """just placeholder for testing embedded isinstance check in DeviceCombobox"""
-
-    def __init__(self, name="test", limits=None, read_value=1.0):
-        super().__init__(name, limits, read_value)
-
-
-class Device(FakeDevice):
-    """just placeholder for testing embedded isinstance check in DeviceCombobox"""
-
-    def __init__(self, name, enabled=True):
-        super().__init__(name, enabled)
-
-
-class DMMock:
-    def __init__(self):
-        self.devices = DeviceContainer()
-        self.enabled_devices = [device for device in self.devices if device.enabled]
-
-    def add_devives(self, devices: list):
-        for device in devices:
-            self.devices[device.name] = device
-
-
-DEVICES = [
-    FakePositioner("samx", limits=[-10, 10], read_value=2.0),
-    FakePositioner("samy", limits=[-5, 5], read_value=3.0),
-    FakePositioner("samz", limits=[-8, 8], read_value=4.0),
-    FakePositioner("aptrx", limits=None, read_value=4.0),
-    FakePositioner("aptry", limits=None, read_value=5.0),
-    FakeDevice("gauss_bpm"),
-    FakeDevice("gauss_adc1"),
-    FakeDevice("gauss_adc2"),
-    FakeDevice("gauss_adc3"),
-    FakeDevice("bpm4i"),
-    FakeDevice("bpm3a"),
-    FakeDevice("bpm3i"),
-    FakeDevice("eiger", readout_priority=ReadoutPriority.ASYNC),
-    FakeDevice("waveform1d"),
-    FakeDevice("async_device", readout_priority=ReadoutPriority.ASYNC),
-    Positioner("test", limits=[-10, 10], read_value=2.0),
-    Device("test_device"),
-]

bec_widgets/utils/__init__.py

@@ -1,13 +0,0 @@
-from qtpy.QtWebEngineWidgets import QWebEngineView
-
-from .bec_connector import BECConnector, ConnectionConfig
-from .bec_dispatcher import BECDispatcher
-from .bec_table import BECTable
-from .colors import Colors
-from .container_utils import WidgetContainerUtils
-from .crosshair import Crosshair
-from .entry_validator import EntryValidator
-from .layout_manager import GridLayoutManager
-from .rpc_decorator import register_rpc_methods, rpc_public
-from .ui_loader import UILoader
-from .validator_delegate import DoubleValidationDelegate

bec_widgets/utils/bec_connector.py

@@ -1,303 +0,0 @@
-# pylint: disable = no-name-in-module,missing-module-docstring
-from __future__ import annotations
-
-import os
-import time
-import uuid
-from typing import Optional
-
-from bec_lib.logger import bec_logger
-from bec_lib.utils.import_utils import lazy_import_from
-from pydantic import BaseModel, Field, field_validator
-from qtpy.QtCore import QObject, QRunnable, QThreadPool, Signal
-from qtpy.QtWidgets import QApplication
-
-from bec_widgets.cli.rpc_register import RPCRegister
-from bec_widgets.qt_utils.error_popups import ErrorPopupUtility
-from bec_widgets.qt_utils.error_popups import SafeSlot as pyqtSlot
-from bec_widgets.utils.yaml_dialog import load_yaml, load_yaml_gui, save_yaml, save_yaml_gui
-
-logger = bec_logger.logger
-BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
-
-
-class ConnectionConfig(BaseModel):
-    """Configuration for BECConnector mixin class"""
-
-    widget_class: str = Field(default="NonSpecifiedWidget", description="The class of the widget.")
-    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")
-    @classmethod
-    def generate_gui_id(cls, v, values):
-        """Generate a GUI ID if none is provided."""
-        if v is None:
-            widget_class = values.data["widget_class"]
-            v = f"{widget_class}_{str(time.time())}"
-            return v
-        return v
-
-
-class WorkerSignals(QObject):
-    progress = Signal(dict)
-    completed = Signal()
-
-
-class Worker(QRunnable):
-    """
-    Worker class to run a function in a separate thread.
-    """
-
-    def __init__(self, func, *args, **kwargs):
-        super().__init__()
-        self.signals = WorkerSignals()
-        self.func = func
-        self.args = args
-        self.kwargs = kwargs
-
-    def run(self):
-        """
-        Run the specified function in the thread.
-        """
-        self.func(*self.args, **self.kwargs)
-        self.signals.completed.emit()
-
-
-class BECConnector:
-    """Connection mixin class to handle BEC client and device manager"""
-
-    USER_ACCESS = ["_config_dict", "_get_all_rpc", "_rpc_id"]
-    EXIT_HANDLERS = {}
-
-    def __init__(self, client=None, config: ConnectionConfig = None, gui_id: str = None):
-        # BEC related connections
-        self.bec_dispatcher = BECDispatcher(client=client)
-        self.client = self.bec_dispatcher.client if client is None else client
-
-        if not self.client in BECConnector.EXIT_HANDLERS:
-            # register function to clean connections at exit;
-            # the function depends on BECClient, and BECDispatcher
-            @pyqtSlot()
-            def terminate(client=self.client, dispatcher=self.bec_dispatcher):
-                logger.info("Disconnecting", repr(dispatcher))
-                dispatcher.disconnect_all()
-                logger.info("Shutting down BEC Client", repr(client))
-                client.shutdown()
-
-            BECConnector.EXIT_HANDLERS[self.client] = terminate
-            QApplication.instance().aboutToQuit.connect(terminate)
-
-        if config:
-            self.config = config
-            self.config.widget_class = self.__class__.__name__
-        else:
-            logger.debug(
-                f"No initial config found for {self.__class__.__name__}.\n"
-                f"Initializing with default config."
-            )
-            self.config = ConnectionConfig(widget_class=self.__class__.__name__)
-
-        if gui_id:
-            self.config.gui_id = gui_id
-            self.gui_id = gui_id
-        else:
-            self.gui_id = self.config.gui_id
-
-        # register widget to rpc register
-        # be careful: when registering, and the object is not a BECWidget,
-        # cleanup has to called manually since there is no 'closeEvent'
-        self.rpc_register = RPCRegister()
-        self.rpc_register.add_rpc(self)
-
-        # Error popups
-        self.error_utility = ErrorPopupUtility()
-
-        self._thread_pool = QThreadPool.globalInstance()
-
-    def submit_task(self, fn, *args, on_complete: pyqtSlot = None, **kwargs) -> Worker:
-        """
-        Submit a task to run in a separate thread. The task will run the specified
-        function with the provided arguments and emit the completed signal when done.
-
-        Use this method if you want to wait for a task to complete without blocking the
-        main thread.
-
-        Args:
-            fn: Function to run in a separate thread.
-            *args: Arguments for the function.
-            on_complete: Slot to run when the task is complete.
-            **kwargs: Keyword arguments for the function.
-
-        Returns:
-            worker: The worker object that will run the task.
-
-        Examples:
-            >>> def my_function(a, b):
-            >>>     print(a + b)
-            >>> self.submit_task(my_function, 1, 2)
-
-            >>> def my_function(a, b):
-            >>>     print(a + b)
-            >>> def on_complete():
-            >>>     print("Task complete")
-            >>> self.submit_task(my_function, 1, 2, on_complete=on_complete)
-
-        """
-        worker = Worker(fn, *args, **kwargs)
-        if on_complete:
-            worker.signals.completed.connect(on_complete)
-        self._thread_pool.start(worker)
-        return worker
-
-    def _get_all_rpc(self) -> dict:
-        """Get all registered RPC objects."""
-        all_connections = self.rpc_register.list_all_connections()
-        return dict(all_connections)
-
-    @property
-    def _rpc_id(self) -> str:
-        """Get the RPC ID of the widget."""
-        return self.gui_id
-
-    @_rpc_id.setter
-    def _rpc_id(self, rpc_id: str) -> None:
-        """Set the RPC ID of the widget."""
-        self.gui_id = rpc_id
-
-    @property
-    def _config_dict(self) -> dict:
-        """
-        Get the configuration of the widget.
-
-        Returns:
-            dict: The configuration of the widget.
-        """
-        return self.config.model_dump()
-
-    @_config_dict.setter
-    def _config_dict(self, config: BaseModel) -> None:
-        """
-        Get the configuration of the widget.
-
-        Returns:
-            dict: The configuration of the widget.
-        """
-        self.config = config
-
-    def apply_config(self, config: dict, generate_new_id: bool = True) -> None:
-        """
-        Apply the configuration to the widget.
-
-        Args:
-            config(dict): Configuration settings.
-            generate_new_id(bool): If True, generate a new GUI ID for the widget.
-        """
-        self.config = ConnectionConfig(**config)
-        if generate_new_id is True:
-            gui_id = str(uuid.uuid4())
-            self.rpc_register.remove_rpc(self)
-            self.set_gui_id(gui_id)
-            self.rpc_register.add_rpc(self)
-        else:
-            self.gui_id = self.config.gui_id
-
-    def load_config(self, path: str | None = None, gui: bool = False):
-        """
-        Load the configuration of the widget from YAML.
-
-        Args:
-            path(str): Path to the configuration file for non-GUI dialog mode.
-            gui(bool): If True, use the GUI dialog to load the configuration file.
-        """
-        if gui is True:
-            config = load_yaml_gui(self)
-        else:
-            config = load_yaml(path)
-
-        if config is not None:
-            if config.get("widget_class") != self.__class__.__name__:
-                raise ValueError(
-                    f"Configuration file is not for {self.__class__.__name__}. Got configuration for {config.get('widget_class')}."
-                )
-            self.apply_config(config)
-
-    def save_config(self, path: str | None = None, gui: bool = False):
-        """
-        Save the configuration of the widget to YAML.
-
-        Args:
-            path(str): Path to save the configuration file for non-GUI dialog mode.
-            gui(bool): If True, use the GUI dialog to save the configuration file.
-        """
-        if gui is True:
-            save_yaml_gui(self, self._config_dict)
-        else:
-            if path is None:
-                path = os.getcwd()
-            file_path = os.path.join(path, f"{self.__class__.__name__}_config.yaml")
-
-            save_yaml(file_path, self._config_dict)
-
-    @pyqtSlot(str)
-    def set_gui_id(self, gui_id: str) -> None:
-        """
-        Set the GUI ID for the widget.
-
-        Args:
-            gui_id(str): GUI ID
-        """
-        self.config.gui_id = gui_id
-        self.gui_id = gui_id
-
-    def get_obj_by_id(self, obj_id: str):
-        if obj_id == self.gui_id:
-            return self
-
-    def get_bec_shortcuts(self):
-        """Get BEC shortcuts for the widget."""
-        self.dev = self.client.device_manager.devices
-        self.scans = self.client.scans
-        self.queue = self.client.queue
-        self.scan_storage = self.queue.scan_storage
-        self.dap = self.client.dap
-
-    def update_client(self, client) -> None:
-        """Update the client and device manager from BEC and create object for BEC shortcuts.
-
-        Args:
-            client: BEC client
-        """
-        self.client = client
-        self.get_bec_shortcuts()
-
-    @pyqtSlot(ConnectionConfig)  # TODO can be also dict
-    def on_config_update(self, config: ConnectionConfig | dict) -> None:
-        """
-        Update the configuration for the widget.
-
-        Args:
-            config(ConnectionConfig): Configuration settings.
-        """
-        if isinstance(config, dict):
-            config = ConnectionConfig(**config)
-            # TODO add error handler
-
-        self.config = config
-
-    def get_config(self, dict_output: bool = True) -> dict | BaseModel:
-        """
-        Get the configuration of the widget.
-
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
-
-        Returns:
-            dict: The configuration of the plot widget.
-        """
-        if dict_output:
-            return self.config.model_dump()
-        else:
-            return self.config

bec_widgets/utils/bec_designer.py

@@ -1,153 +0,0 @@
-import importlib.metadata
-import json
-import os
-import site
-import sys
-import sysconfig
-from pathlib import Path
-
-from bec_qthemes import material_icon
-from qtpy import PYSIDE6
-from qtpy.QtGui import QIcon
-
-if PYSIDE6:
-    from PySide6.scripts.pyside_tool import (
-        _extend_path_var,
-        init_virtual_env,
-        qt_tool_wrapper,
-        is_pyenv_python,
-        is_virtual_env,
-        ui_tool_binary,
-    )
-
-import bec_widgets
-
-
-def designer_material_icon(icon_name: str) -> QIcon:
-    """
-    Create a QIcon for the BECDesigner with the given material icon name.
-
-    Args:
-        icon_name (str): The name of the material icon.
-
-    Returns:
-        QIcon: The QIcon for the material icon.
-    """
-    return QIcon(material_icon(icon_name, filled=True, convert_to_pixmap=True))
-
-
-def list_editable_packages() -> set[str]:
-    """
-    List all editable packages in the environment.
-
-    Returns:
-        set: A set of paths to editable packages.
-    """
-
-    editable_packages = set()
-
-    # Get site-packages directories
-    site_packages = site.getsitepackages()
-    if hasattr(site, "getusersitepackages"):
-        site_packages.append(site.getusersitepackages())
-
-    for dist in importlib.metadata.distributions():
-        location = dist.locate_file("").resolve()
-        is_editable = all(not str(location).startswith(site_pkg) for site_pkg in site_packages)
-
-        if is_editable:
-            editable_packages.add(str(location))
-
-    for packages in site_packages:
-        # all dist-info directories in site-packages that contain a direct_url.json file
-        dist_info_dirs = Path(packages).rglob("*.dist-info")
-        for dist_info_dir in dist_info_dirs:
-            direct_url = dist_info_dir / "direct_url.json"
-            if not direct_url.exists():
-                continue
-            # load the json file and get the path to the package
-            with open(direct_url, "r", encoding="utf-8") as f:
-                data = json.load(f)
-                path = data.get("url", "")
-                if path.startswith("file://"):
-                    path = path[7:]
-                    editable_packages.add(path)
-
-    return editable_packages
-
-
-def patch_designer():  # pragma: no cover
-    if not PYSIDE6:
-        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
-        return
-
-    init_virtual_env()
-
-    major_version = sys.version_info[0]
-    minor_version = sys.version_info[1]
-    os.environ["PY_MAJOR_VERSION"] = str(major_version)
-    os.environ["PY_MINOR_VERSION"] = str(minor_version)
-
-    if sys.platform == "win32":
-        if is_virtual_env():
-            _extend_path_var("PATH", os.fspath(Path(sys._base_executable).parent), True)
-    else:
-        if sys.platform == "linux":
-            suffix = f"{sys.abiflags}.so"
-            env_var = "LD_PRELOAD"
-        elif sys.platform == "darwin":
-            suffix = ".dylib"
-            env_var = "DYLD_INSERT_LIBRARIES"
-        else:
-            raise RuntimeError(f"Unsupported platform: {sys.platform}")
-        version = f"{major_version}.{minor_version}"
-        library_name = f"libpython{version}{suffix}"
-        lib_path = str(Path(sysconfig.get_config_var("LIBDIR")) / library_name)
-        os.environ[env_var] = lib_path
-
-        if is_pyenv_python() or is_virtual_env():
-            # append all editable packages to the PYTHONPATH
-            editable_packages = list_editable_packages()
-            for pckg in editable_packages:
-                _extend_path_var("PYTHONPATH", pckg, True)
-    qt_tool_wrapper(ui_tool_binary("designer"), sys.argv[1:])
-
-
-def find_plugin_paths(base_path: Path):
-    """
-    Recursively find all directories containing a .pyproject file.
-    """
-    plugin_paths = []
-    for path in base_path.rglob("*.pyproject"):
-        plugin_paths.append(str(path.parent))
-    return plugin_paths
-
-
-def set_plugin_environment_variable(plugin_paths):
-    """
-    Set the PYSIDE_DESIGNER_PLUGINS environment variable with the given plugin paths.
-    """
-    current_paths = os.environ.get("PYSIDE_DESIGNER_PLUGINS", "")
-    if current_paths:
-        current_paths = current_paths.split(os.pathsep)
-    else:
-        current_paths = []
-
-    current_paths.extend(plugin_paths)
-    os.environ["PYSIDE_DESIGNER_PLUGINS"] = os.pathsep.join(current_paths)
-
-
-# Patch the designer function
-def main():  # pragma: no cover
-    if not PYSIDE6:
-        print("PYSIDE6 is not available in the environment. Exiting...")
-        return
-    base_dir = Path(os.path.dirname(bec_widgets.__file__)).resolve()
-    plugin_paths = find_plugin_paths(base_dir)
-    set_plugin_environment_variable(plugin_paths)
-
-    patch_designer()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/utils/bec_dispatcher.py

@@ -1,181 +0,0 @@
-from __future__ import annotations
-
-import collections
-from collections.abc import Callable
-from typing import TYPE_CHECKING, Union
-
-import redis
-from bec_lib.client import BECClient
-from bec_lib.logger import bec_logger
-from bec_lib.redis_connector import MessageObject, RedisConnector
-from bec_lib.service_config import ServiceConfig
-from qtpy.QtCore import QObject
-from qtpy.QtCore import Signal as pyqtSignal
-
-logger = bec_logger.logger
-
-if TYPE_CHECKING:
-    from bec_lib.endpoints import EndpointInfo
-
-
-class QtThreadSafeCallback(QObject):
-    cb_signal = pyqtSignal(dict, dict)
-
-    def __init__(self, cb):
-        super().__init__()
-
-        self.cb = cb
-        self.cb_signal.connect(self.cb)
-
-    def __hash__(self):
-        # make 2 differents QtThreadSafeCallback to look
-        # identical when used as dictionary keys, if the
-        # callback is the same
-        return id(self.cb)
-
-    def __call__(self, msg_content, metadata):
-        self.cb_signal.emit(msg_content, metadata)
-
-
-class QtRedisConnector(RedisConnector):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-
-    def _execute_callback(self, cb, msg, kwargs):
-        if not isinstance(cb, QtThreadSafeCallback):
-            return super()._execute_callback(cb, msg, kwargs)
-        # if msg.msg_type == "bundle_message":
-        #    # big warning: how to handle bundle messages?
-        #    # message with messages inside ; which slot to call?
-        #    # bundle_msg = msg
-        #    # for msg in bundle_msg:
-        #    #    ...
-        #    # for now, only consider the 1st message
-        #    msg = msg[0]
-        #    raise RuntimeError(f"
-        if isinstance(msg, MessageObject):
-            if isinstance(msg.value, list):
-                msg = msg.value[0]
-            else:
-                msg = msg.value
-
-            # we can notice kwargs are lost when passed to Qt slot
-            metadata = msg.metadata
-            cb(msg.content, metadata)
-        else:
-            # from stream
-            msg = msg["data"]
-            cb(msg.content, msg.metadata)
-
-
-class BECDispatcher:
-    """Utility class to keep track of slots connected to a particular redis connector"""
-
-    _instance = None
-    _initialized = False
-
-    def __new__(cls, client=None, config: str = None, *args, **kwargs):
-        if cls._instance is None:
-            cls._instance = super(BECDispatcher, cls).__new__(cls)
-            cls._initialized = False
-        return cls._instance
-
-    def __init__(self, client=None, config: str | ServiceConfig = None):
-        if self._initialized:
-            return
-
-        self._slots = collections.defaultdict(set)
-        self.client = client
-
-        if self.client is None:
-            if config is not None:
-                if not isinstance(config, ServiceConfig):
-                    # config is supposed to be a path
-                    config = ServiceConfig(config)
-            self.client = BECClient(
-                config=config, connector_cls=QtRedisConnector, name="BECWidgets"
-            )
-        else:
-            if self.client.started:
-                # have to reinitialize client to use proper connector
-                logger.info("Shutting down BECClient to switch to QtRedisConnector")
-                self.client.shutdown()
-            self.client._BECClient__init_params["connector_cls"] = QtRedisConnector
-
-        try:
-            self.client.start()
-        except redis.exceptions.ConnectionError:
-            logger.warning("Could not connect to Redis, skipping start of BECClient.")
-
-        logger.success("Initialized BECDispatcher")
-        self._initialized = True
-
-    @classmethod
-    def reset_singleton(cls):
-        cls._instance = None
-        cls._initialized = False
-
-    def connect_slot(
-        self,
-        slot: Callable,
-        topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
-        **kwargs,
-    ) -> None:
-        """Connect widget's qt slot, so that it is called on new pub/sub topic message.
-
-        Args:
-            slot (Callable): A slot method/function that accepts two inputs: content and metadata of
-                the corresponding pub/sub message
-            topics (EndpointInfo | str | list): A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
-        """
-        slot = QtThreadSafeCallback(slot)
-        self.client.connector.register(topics, cb=slot, **kwargs)
-        topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        self._slots[slot].update(set(topics_str))
-
-    def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
-        """
-        Disconnect a slot from a topic.
-
-        Args:
-            slot(Callable): The slot to disconnect
-            topics(Union[str, list]): The topic(s) to disconnect from
-        """
-        # find the right slot to disconnect from ;
-        # slot callbacks are wrapped in QtThreadSafeCallback objects,
-        # but the slot we receive here is the original callable
-        for connected_slot in self._slots:
-            if connected_slot.cb == slot:
-                break
-        else:
-            return
-        self.client.connector.unregister(topics, cb=connected_slot)
-        topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        self._slots[connected_slot].difference_update(set(topics_str))
-        if not self._slots[connected_slot]:
-            del self._slots[connected_slot]
-
-    def disconnect_topics(self, topics: Union[str, list]):
-        """
-        Disconnect all slots from a topic.
-
-        Args:
-            topics(Union[str, list]): The topic(s) to disconnect from
-        """
-        self.client.connector.unregister(topics)
-        topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        for slot in list(self._slots.keys()):
-            slot_topics = self._slots[slot]
-            slot_topics.difference_update(set(topics_str))
-            if not slot_topics:
-                del self._slots[slot]
-
-    def disconnect_all(self, *args, **kwargs):
-        """
-        Disconnect all slots from all topics.
-
-        Args:
-            *args: Arbitrary positional arguments
-            **kwargs: Arbitrary keyword arguments
-        """
-        self.disconnect_topics(self.client.connector._topics_cb)

bec_widgets/utils/bec_signal_proxy.py

@@ -1,54 +0,0 @@
-""" This custom class is a thin wrapper around the SignalProxy class to allow signal calls to be blocked.
-Unblocking the proxy needs to be done through the slot unblock_proxy. The most likely use case for this class is
-when the callback function is potentially initiating a slower progress, i.e. requesting a data analysis routine to 
-analyse data. Requesting a new fit may lead to request piling up and an overall slow done of performance. This proxy
-will allow you to decide by yourself when to unblock and execute the callback again."""
-
-from pyqtgraph import SignalProxy
-from qtpy.QtCore import Signal, Slot
-
-
-class BECSignalProxy(SignalProxy):
-    """Thin wrapper around the SignalProxy class to allow signal calls to be blocked, but args still being stored
-
-    Args:
-        *args: Arguments to pass to the SignalProxy class
-        rateLimit (int): The rateLimit of the proxy
-        **kwargs: Keyword arguments to pass to the SignalProxy class
-
-    Example:
-    >>> proxy = BECSignalProxy(signal, rate_limit=25, slot=callback)"""
-
-    is_blocked = Signal(bool)
-
-    def __init__(self, *args, rateLimit=25, **kwargs):
-        super().__init__(*args, rateLimit=rateLimit, **kwargs)
-        self._blocking = False
-        self.old_args = None
-        self.new_args = None
-
-    @property
-    def blocked(self):
-        """Returns if the proxy is blocked"""
-        return self._blocking
-
-    @blocked.setter
-    def blocked(self, value: bool):
-        self._blocking = value
-        self.is_blocked.emit(value)
-
-    def signalReceived(self, *args):
-        """Receive signal, store the args and call signalReceived from the parent class if not blocked"""
-        self.new_args = args
-        if self.blocked is True:
-            return
-        self.blocked = True
-        self.old_args = args
-        super().signalReceived(*args)
-
-    @Slot()
-    def unblock_proxy(self):
-        """Unblock the proxy, and call the signalReceived method in case there was an update of the args."""
-        self.blocked = False
-        if self.new_args != self.old_args:
-            self.signalReceived(*self.new_args)

bec_widgets/utils/bec_table.py

@@ -1,21 +0,0 @@
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QTableWidget
-
-
-class BECTable(QTableWidget):
-    """Table widget with custom keyPressEvent to delete rows with backspace or delete key"""
-
-    def keyPressEvent(self, event) -> None:
-        """
-        Delete selected rows with backspace or delete key
-
-        Args:
-            event: keyPressEvent
-        """
-        if event.key() in (Qt.Key_Backspace, Qt.Key_Delete):
-            selected_ranges = self.selectedRanges()
-            for selected_range in selected_ranges:
-                for row in range(selected_range.topRow(), selected_range.bottomRow() + 1):
-                    self.removeRow(row)
-        else:
-            super().keyPressEvent(event)

bec_widgets/utils/bec_widget.py

@@ -1,96 +0,0 @@
-from __future__ import annotations
-
-import darkdetect
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import Slot
-from qtpy.QtWidgets import QApplication, QWidget
-
-from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
-from bec_widgets.utils.colors import set_theme
-
-logger = bec_logger.logger
-
-
-class BECWidget(BECConnector):
-    """Mixin class for all BEC widgets, to handle cleanup"""
-
-    # The icon name is the name of the icon in the icon theme, typically a name taken
-    # from fonts.google.com/icons. Override this in subclasses to set the icon name.
-    ICON_NAME = "widgets"
-
-    def __init__(
-        self,
-        client=None,
-        config: ConnectionConfig = None,
-        gui_id: str = None,
-        theme_update: bool = False,
-    ):
-        """
-        Base class for all BEC widgets. This class should be used as a mixin class for all BEC widgets, e.g.:
-
-
-        >>> class MyWidget(BECWidget, QWidget):
-        >>>     def __init__(self, parent=None, client=None, config=None, gui_id=None):
-        >>>         super().__init__(client=client, config=config, gui_id=gui_id)
-        >>>         QWidget.__init__(self, parent=parent)
-
-
-        Args:
-            client(BECClient, optional): The BEC client.
-            config(ConnectionConfig, optional): The connection configuration.
-            gui_id(str, optional): The GUI ID.
-            theme_update(bool, optional): Whether to subscribe to theme updates. Defaults to False. When set to True, the
-                widget's apply_theme method will be called when the theme changes.
-        """
-        if not isinstance(self, QWidget):
-            raise RuntimeError(f"{repr(self)} is not a subclass of QWidget")
-        super().__init__(client=client, config=config, gui_id=gui_id)
-
-        # Set the theme to auto if it is not set yet
-        app = QApplication.instance()
-        if not hasattr(app, "theme"):
-            # DO NOT SET THE THEME TO AUTO! Otherwise, the qwebengineview will segfault
-            # Instead, we will set the theme to the system setting on startup
-            if darkdetect.isDark():
-                set_theme("dark")
-            else:
-                set_theme("light")
-
-        if theme_update:
-            logger.debug(f"Subscribing to theme updates for {self.__class__.__name__}")
-            self._connect_to_theme_change()
-
-    def _connect_to_theme_change(self):
-        """Connect to the theme change signal."""
-        qapp = QApplication.instance()
-        if hasattr(qapp, "theme_signal"):
-            qapp.theme_signal.theme_updated.connect(self._update_theme)
-
-    def _update_theme(self, theme: str):
-        """Update the theme."""
-        if theme is None:
-            qapp = QApplication.instance()
-            if hasattr(qapp, "theme"):
-                theme = qapp.theme.theme
-            else:
-                theme = "dark"
-        self.apply_theme(theme)
-
-    @Slot(str)
-    def apply_theme(self, theme: str):
-        """
-        Apply the theme to the widget.
-
-        Args:
-            theme(str, optional): The theme to be applied.
-        """
-
-    def cleanup(self):
-        """Cleanup the widget."""
-
-    def closeEvent(self, event):
-        self.rpc_register.remove_rpc(self)
-        try:
-            self.cleanup()
-        finally:
-            super().closeEvent(event)

bec_widgets/utils/colors.py

@@ -1,499 +0,0 @@
-from __future__ import annotations
-
-import itertools
-import re
-from typing import TYPE_CHECKING, Literal
-
-import bec_qthemes
-import numpy as np
-import pyqtgraph as pg
-from bec_qthemes._os_appearance.listener import OSThemeSwitchListener
-from pydantic_core import PydanticCustomError
-from qtpy.QtGui import QColor
-from qtpy.QtWidgets import QApplication
-
-if TYPE_CHECKING:
-    from bec_qthemes._main import AccentColors
-
-
-def get_theme_palette():
-    if QApplication.instance() is None or not hasattr(QApplication.instance(), "theme"):
-        theme = "dark"
-    else:
-        theme = QApplication.instance().theme.theme
-    return bec_qthemes.load_palette(theme)
-
-
-def get_accent_colors() -> AccentColors | None:
-    """
-    Get the accent colors for the current theme. These colors are extensions of the color palette
-    and are used to highlight specific elements in the UI.
-    """
-    if QApplication.instance() is None or not hasattr(QApplication.instance(), "theme"):
-        return None
-    return QApplication.instance().theme.accent_colors
-
-
-def _theme_update_callback():
-    """
-    Internal callback function to update the theme based on the system theme.
-    """
-    app = QApplication.instance()
-    # pylint: disable=protected-access
-    app.theme.theme = app.os_listener._theme.lower()
-    app.theme_signal.theme_updated.emit(app.theme.theme)
-    apply_theme(app.os_listener._theme.lower())
-
-
-def set_theme(theme: Literal["dark", "light", "auto"]):
-    """
-    Set the theme for the application.
-
-    Args:
-        theme (Literal["dark", "light", "auto"]): The theme to set. "auto" will automatically switch between dark and light themes based on the system theme.
-    """
-    app = QApplication.instance()
-    bec_qthemes.setup_theme(theme, install_event_filter=False)
-
-    app.theme_signal.theme_updated.emit(theme)
-    apply_theme(theme)
-
-    if theme != "auto":
-        return
-
-    if not hasattr(app, "os_listener") or app.os_listener is None:
-        app.os_listener = OSThemeSwitchListener(_theme_update_callback)
-        app.installEventFilter(app.os_listener)
-
-
-def apply_theme(theme: Literal["dark", "light"]):
-    """
-    Apply the theme to all pyqtgraph widgets. Do not use this function directly. Use set_theme instead.
-    """
-    app = QApplication.instance()
-    # go through all pyqtgraph widgets and set background
-    children = itertools.chain.from_iterable(
-        top.findChildren(pg.GraphicsLayoutWidget) for top in app.topLevelWidgets()
-    )
-    pg.setConfigOptions(
-        foreground="d" if theme == "dark" else "k", background="k" if theme == "dark" else "w"
-    )
-    for pg_widget in children:
-        pg_widget.setBackground("k" if theme == "dark" else "w")
-
-    # now define stylesheet according to theme and apply it
-    style = bec_qthemes.load_stylesheet(theme)
-    app.setStyleSheet(style)
-
-
-class Colors:
-
-    @staticmethod
-    def golden_ratio(num: int) -> list:
-        """Calculate the golden ratio for a given number of angles.
-
-        Args:
-            num (int): Number of angles
-
-        Returns:
-            list: List of angles calculated using the golden ratio.
-        """
-        phi = 2 * np.pi * ((1 + np.sqrt(5)) / 2)
-        angles = []
-        for ii in range(num):
-            x = np.cos(ii * phi)
-            y = np.sin(ii * phi)
-            angle = np.arctan2(y, x)
-            angles.append(angle)
-        return angles
-
-    @staticmethod
-    def set_theme_offset(theme: Literal["light", "dark"] | None = None, offset=0.2) -> tuple:
-        """
-        Set the theme offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
-
-        Args:
-            theme(str): The theme to be applied.
-            offset(float): Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
-
-        Returns:
-            tuple: Tuple of min_pos and max_pos.
-
-        Raises:
-            ValueError: If theme_offset is not between 0 and 1.
-        """
-
-        if offset < 0 or offset > 1:
-            raise ValueError("theme_offset must be between 0 and 1")
-
-        if theme is None:
-            app = QApplication.instance()
-            if hasattr(app, "theme"):
-                theme = app.theme.theme
-
-        if theme == "light":
-            min_pos = 0.0
-            max_pos = 1 - offset
-        else:
-            min_pos = 0.0 + offset
-            max_pos = 1.0
-
-        return min_pos, max_pos
-
-    @staticmethod
-    def evenly_spaced_colors(
-        colormap: str,
-        num: int,
-        format: Literal["QColor", "HEX", "RGB"] = "QColor",
-        theme_offset=0.2,
-        theme: Literal["light", "dark"] | None = None,
-    ) -> list:
-        """
-        Extract `num` colors from the specified colormap, evenly spaced along its range,
-        and return them in the specified format.
-
-        Args:
-            colormap (str): Name of the colormap.
-            num (int): Number of requested colors.
-            format (Literal["QColor","HEX","RGB"]): The format of the returned colors ('RGB', 'HEX', 'QColor').
-            theme_offset (float): Has to be between 0-1. Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
-            theme (Literal['light', 'dark'] | None): The theme to be applied. Overrides the QApplication theme if specified.
-
-        Returns:
-            list: List of colors in the specified format.
-
-        Raises:
-            ValueError: If theme_offset is not between 0 and 1.
-        """
-        if theme_offset < 0 or theme_offset > 1:
-            raise ValueError("theme_offset must be between 0 and 1")
-
-        cmap = pg.colormap.get(colormap)
-        min_pos, max_pos = Colors.set_theme_offset(theme, theme_offset)
-
-        # Generate positions that are evenly spaced within the acceptable range
-        if num == 1:
-            positions = np.array([(min_pos + max_pos) / 2])
-        else:
-            positions = np.linspace(min_pos, max_pos, num)
-
-        # Sample colors from the colormap at the calculated positions
-        colors = cmap.map(positions, mode="float")
-        color_list = []
-
-        for color in colors:
-            if format.upper() == "HEX":
-                color_list.append(QColor.fromRgbF(*color).name())
-            elif format.upper() == "RGB":
-                color_list.append(tuple((np.array(color) * 255).astype(int)))
-            elif format.upper() == "QCOLOR":
-                color_list.append(QColor.fromRgbF(*color))
-            else:
-                raise ValueError("Unsupported format. Please choose 'RGB', 'HEX', or 'QColor'.")
-        return color_list
-
-    @staticmethod
-    def golden_angle_color(
-        colormap: str,
-        num: int,
-        format: Literal["QColor", "HEX", "RGB"] = "QColor",
-        theme_offset=0.2,
-        theme: Literal["dark", "light"] | None = None,
-    ) -> list:
-        """
-        Extract num colors from the specified colormap following golden angle distribution and return them in the specified format.
-
-        Args:
-            colormap (str): Name of the colormap.
-            num (int): Number of requested colors.
-            format (Literal["QColor","HEX","RGB"]): The format of the returned colors ('RGB', 'HEX', 'QColor').
-            theme_offset (float): Has to be between 0-1. Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
-
-        Returns:
-            list: List of colors in the specified format.
-
-        Raises:
-            ValueError: If theme_offset is not between 0 and 1.
-        """
-
-        cmap = pg.colormap.get(colormap)
-        phi = (1 + np.sqrt(5)) / 2  # Golden ratio
-        golden_angle_conjugate = 1 - (1 / phi)  # Approximately 0.38196601125
-
-        min_pos, max_pos = Colors.set_theme_offset(theme, theme_offset)
-
-        # Generate positions within the acceptable range
-        positions = np.mod(np.arange(num) * golden_angle_conjugate, 1)
-        positions = min_pos + positions * (max_pos - min_pos)
-
-        # Sample colors from the colormap at the calculated positions
-        colors = cmap.map(positions, mode="float")
-        color_list = []
-
-        for color in colors:
-            if format.upper() == "HEX":
-                color_list.append(QColor.fromRgbF(*color).name())
-            elif format.upper() == "RGB":
-                color_list.append(tuple((np.array(color) * 255).astype(int)))
-            elif format.upper() == "QCOLOR":
-                color_list.append(QColor.fromRgbF(*color))
-            else:
-                raise ValueError("Unsupported format. Please choose 'RGB', 'HEX', or 'QColor'.")
-        return color_list
-
-    @staticmethod
-    def hex_to_rgba(hex_color: str, alpha=255) -> tuple:
-        """
-        Convert HEX color to RGBA.
-
-        Args:
-            hex_color(str): HEX color string.
-            alpha(int): Alpha value (0-255). Default is 255 (opaque).
-
-        Returns:
-            tuple: RGBA color tuple (r, g, b, a).
-        """
-        hex_color = hex_color.lstrip("#")
-        if len(hex_color) == 6:
-            r, g, b = tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4))
-        elif len(hex_color) == 8:
-            r, g, b, a = tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4, 6))
-            return (r, g, b, a)
-        else:
-            raise ValueError("HEX color must be 6 or 8 characters long.")
-        return (r, g, b, alpha)
-
-    @staticmethod
-    def rgba_to_hex(r: int, g: int, b: int, a: int = 255) -> str:
-        """
-        Convert RGBA color to HEX.
-
-        Args:
-            r(int): Red value (0-255).
-            g(int): Green value (0-255).
-            b(int): Blue value (0-255).
-            a(int): Alpha value (0-255). Default is 255 (opaque).
-
-        Returns:
-            hec_color(str): HEX color string.
-        """
-        return "#{:02X}{:02X}{:02X}{:02X}".format(r, g, b, a)
-
-    @staticmethod
-    def validate_color(color: tuple | str) -> tuple | str:
-        """
-        Validate the color input if it is HEX or RGBA compatible. Can be used in any pydantic model as a field validator.
-
-        Args:
-            color(tuple|str): The color to be validated. Can be a tuple of RGBA values or a HEX string.
-
-        Returns:
-            tuple|str: The validated color.
-        """
-        CSS_COLOR_NAMES = {
-            "aliceblue",
-            "antiquewhite",
-            "aqua",
-            "aquamarine",
-            "azure",
-            "beige",
-            "bisque",
-            "black",
-            "blanchedalmond",
-            "blue",
-            "blueviolet",
-            "brown",
-            "burlywood",
-            "cadetblue",
-            "chartreuse",
-            "chocolate",
-            "coral",
-            "cornflowerblue",
-            "cornsilk",
-            "crimson",
-            "cyan",
-            "darkblue",
-            "darkcyan",
-            "darkgoldenrod",
-            "darkgray",
-            "darkgreen",
-            "darkgrey",
-            "darkkhaki",
-            "darkmagenta",
-            "darkolivegreen",
-            "darkorange",
-            "darkorchid",
-            "darkred",
-            "darksalmon",
-            "darkseagreen",
-            "darkslateblue",
-            "darkslategray",
-            "darkslategrey",
-            "darkturquoise",
-            "darkviolet",
-            "deeppink",
-            "deepskyblue",
-            "dimgray",
-            "dimgrey",
-            "dodgerblue",
-            "firebrick",
-            "floralwhite",
-            "forestgreen",
-            "fuchsia",
-            "gainsboro",
-            "ghostwhite",
-            "gold",
-            "goldenrod",
-            "gray",
-            "green",
-            "greenyellow",
-            "grey",
-            "honeydew",
-            "hotpink",
-            "indianred",
-            "indigo",
-            "ivory",
-            "khaki",
-            "lavender",
-            "lavenderblush",
-            "lawngreen",
-            "lemonchiffon",
-            "lightblue",
-            "lightcoral",
-            "lightcyan",
-            "lightgoldenrodyellow",
-            "lightgray",
-            "lightgreen",
-            "lightgrey",
-            "lightpink",
-            "lightsalmon",
-            "lightseagreen",
-            "lightskyblue",
-            "lightslategray",
-            "lightslategrey",
-            "lightsteelblue",
-            "lightyellow",
-            "lime",
-            "limegreen",
-            "linen",
-            "magenta",
-            "maroon",
-            "mediumaquamarine",
-            "mediumblue",
-            "mediumorchid",
-            "mediumpurple",
-            "mediumseagreen",
-            "mediumslateblue",
-            "mediumspringgreen",
-            "mediumturquoise",
-            "mediumvioletred",
-            "midnightblue",
-            "mintcream",
-            "mistyrose",
-            "moccasin",
-            "navajowhite",
-            "navy",
-            "oldlace",
-            "olive",
-            "olivedrab",
-            "orange",
-            "orangered",
-            "orchid",
-            "palegoldenrod",
-            "palegreen",
-            "paleturquoise",
-            "palevioletred",
-            "papayawhip",
-            "peachpuff",
-            "peru",
-            "pink",
-            "plum",
-            "powderblue",
-            "purple",
-            "red",
-            "rosybrown",
-            "royalblue",
-            "saddlebrown",
-            "salmon",
-            "sandybrown",
-            "seagreen",
-            "seashell",
-            "sienna",
-            "silver",
-            "skyblue",
-            "slateblue",
-            "slategray",
-            "slategrey",
-            "snow",
-            "springgreen",
-            "steelblue",
-            "tan",
-            "teal",
-            "thistle",
-            "tomato",
-            "turquoise",
-            "violet",
-            "wheat",
-            "white",
-            "whitesmoke",
-            "yellow",
-            "yellowgreen",
-        }
-        if isinstance(color, str):
-            hex_pattern = re.compile(r"^#(?:[0-9a-fA-F]{3}){1,2}$")
-            if hex_pattern.match(color):
-                return color
-            elif color.lower() in CSS_COLOR_NAMES:
-                return color
-            else:
-                raise PydanticCustomError(
-                    "unsupported color",
-                    "The color must be a valid HEX string or CSS Color.",
-                    {"wrong_value": color},
-                )
-        elif isinstance(color, tuple):
-            if len(color) != 4:
-                raise PydanticCustomError(
-                    "unsupported color",
-                    "The color must be a tuple of 4 elements (R, G, B, A).",
-                    {"wrong_value": color},
-                )
-            for value in color:
-                if not 0 <= value <= 255:
-                    raise PydanticCustomError(
-                        "unsupported color",
-                        f"The color values must be between 0 and 255 in RGBA format (R,G,B,A)",
-                        {"wrong_value": color},
-                    )
-            return color
-
-    @staticmethod
-    def validate_color_map(color_map: str, return_error: bool = True) -> str | bool:
-        """
-        Validate the colormap input if it is supported by pyqtgraph. Can be used in any pydantic model as a field validator. If validation fails it prints all available colormaps from pyqtgraph instance.
-
-        Args:
-            color_map(str): The colormap to be validated.
-
-        Returns:
-            str: The validated colormap, if colormap is valid.
-            bool: False, if colormap is invalid.
-
-        Raises:
-            PydanticCustomError: If colormap is invalid.
-        """
-        available_pg_maps = pg.colormap.listMaps()
-        available_mpl_maps = pg.colormap.listMaps("matplotlib")
-        available_mpl_colorcet = pg.colormap.listMaps("colorcet")
-
-        available_colormaps = available_pg_maps + available_mpl_maps + available_mpl_colorcet
-        if color_map not in available_colormaps:
-            if return_error:
-                raise PydanticCustomError(
-                    "unsupported colormap",
-                    f"Colormap '{color_map}' not found in the current installation of pyqtgraph. Choose on the following: {available_colormaps}.",
-                    {"wrong_value": color_map},
-                )
-            else:
-                return False
-        return color_map

bec_widgets/utils/container_utils.py

@@ -1,50 +0,0 @@
-from __future__ import annotations
-
-import itertools
-from typing import Type
-
-from qtpy.QtWidgets import QWidget
-
-
-class WidgetContainerUtils:
-
-    @staticmethod
-    def generate_unique_widget_id(container: dict, prefix: str = "widget") -> str:
-        """
-        Generate a unique widget ID.
-
-        Args:
-            container(dict): The container of widgets.
-            prefix(str): The prefix of the widget ID.
-
-        Returns:
-            widget_id(str): The unique widget ID.
-        """
-        existing_ids = set(container.keys())
-        for i in itertools.count(1):
-            widget_id = f"{prefix}_{i}"
-            if widget_id not in existing_ids:
-                return widget_id
-
-    @staticmethod
-    def find_first_widget_by_class(
-        container: dict, widget_class: Type[QWidget], can_fail: bool = True
-    ) -> QWidget | None:
-        """
-        Find the first widget of a given class in the figure.
-
-        Args:
-            container(dict): The container of widgets.
-            widget_class(Type): The class of the widget to find.
-            can_fail(bool): If True, the method will return None if no widget is found. If False, it will raise an error.
-
-        Returns:
-            widget: The widget of the given class.
-        """
-        for widget_id, widget in container.items():
-            if isinstance(widget, widget_class):
-                return widget
-        if can_fail:
-            return None
-        else:
-            raise ValueError(f"No widget of class {widget_class} found.")

bec_widgets/utils/crosshair.py

@@ -1,443 +0,0 @@
-from collections import defaultdict
-
-import numpy as np
-import pyqtgraph as pg
-from qtpy.QtCore import QObject, Qt, Signal, Slot
-from qtpy.QtWidgets import QApplication
-
-
-class CrosshairScatterItem(pg.ScatterPlotItem):
-    def setDownsampling(self, ds=None, auto=None, method=None):
-        pass
-
-    def setClipToView(self, state):
-        pass
-
-    def setAlpha(self, *args, **kwargs):
-        pass
-
-
-class Crosshair(QObject):
-    # QT Position of mouse cursor
-    positionChanged = Signal(tuple)
-    positionClicked = Signal(tuple)
-    # Plain crosshair position signals mapped to real coordinates
-    crosshairChanged = Signal(tuple)
-    crosshairClicked = Signal(tuple)
-    # Signal for 1D plot
-    coordinatesChanged1D = Signal(tuple)
-    coordinatesClicked1D = Signal(tuple)
-    # Signal for 2D plot
-    coordinatesChanged2D = Signal(tuple)
-    coordinatesClicked2D = Signal(tuple)
-
-    def __init__(self, plot_item: pg.PlotItem, precision: int = 3, parent=None):
-        """
-        Crosshair for 1D and 2D plots.
-
-        Args:
-            plot_item (pyqtgraph.PlotItem): The plot item to which the crosshair will be attached.
-            precision (int, optional): Number of decimal places to round the coordinates to. Defaults to None.
-            parent (QObject, optional): Parent object for the QObject. Defaults to None.
-        """
-        super().__init__(parent)
-        self.is_log_y = None
-        self.is_log_x = None
-        self.is_derivative = None
-        self.plot_item = plot_item
-        self.precision = precision
-        self.v_line = pg.InfiniteLine(angle=90, movable=False)
-        self.v_line.skip_auto_range = True
-        self.h_line = pg.InfiniteLine(angle=0, movable=False)
-        self.h_line.skip_auto_range = True
-        # Add custom attribute to identify crosshair lines
-        self.v_line.is_crosshair = True
-        self.h_line.is_crosshair = True
-        self.plot_item.addItem(self.v_line, ignoreBounds=True)
-        self.plot_item.addItem(self.h_line, ignoreBounds=True)
-
-        # Initialize highlighted curve in a case of multiple curves
-        self.highlighted_curve_index = None
-
-        # Add TextItem to display coordinates
-        self.coord_label = pg.TextItem("", anchor=(1, 1), fill=(0, 0, 0, 100))
-        self.coord_label.setVisible(False)  # Hide initially
-        self.coord_label.skip_auto_range = True
-        self.plot_item.addItem(self.coord_label)
-
-        # Signals to connect
-        self.proxy = pg.SignalProxy(
-            self.plot_item.scene().sigMouseMoved, rateLimit=60, slot=self.mouse_moved
-        )
-        self.positionChanged.connect(self.update_coord_label)
-        self.plot_item.scene().sigMouseClicked.connect(self.mouse_clicked)
-
-        # Connect signals from pyqtgraph right click menu
-        self.plot_item.ctrl.derivativeCheck.checkStateChanged.connect(self.check_derivatives)
-        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
-        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
-        self.plot_item.ctrl.downsampleSpin.valueChanged.connect(self.clear_markers)
-
-        # Initialize markers
-        self.items = []
-        self.marker_moved_1d = {}
-        self.marker_clicked_1d = {}
-        self.marker_2d = None
-        self.update_markers()
-        self.check_log()
-        self.check_derivatives()
-
-        self._connect_to_theme_change()
-
-    def _connect_to_theme_change(self):
-        """Connect to the theme change signal."""
-        qapp = QApplication.instance()
-        if hasattr(qapp, "theme_signal"):
-            qapp.theme_signal.theme_updated.connect(self._update_theme)
-            self._update_theme()
-
-    @Slot(str)
-    def _update_theme(self, theme: str | None = None):
-        """Update the theme."""
-        if theme is None:
-            qapp = QApplication.instance()
-            if hasattr(qapp, "theme"):
-                theme = qapp.theme.theme
-            else:
-                theme = "dark"
-        self.apply_theme(theme)
-
-    def apply_theme(self, theme: str):
-        """Apply the theme to the plot."""
-        if theme == "dark":
-            text_color = "w"
-            label_bg_color = (50, 50, 50, 150)
-        elif theme == "light":
-            text_color = "k"
-            label_bg_color = (240, 240, 240, 150)
-        else:
-            text_color = "w"
-            label_bg_color = (50, 50, 50, 150)
-
-        self.coord_label.setColor(text_color)
-        self.coord_label.fill = pg.mkBrush(label_bg_color)
-        self.coord_label.border = pg.mkPen(None)
-
-    @Slot(int)
-    def update_highlighted_curve(self, curve_index: int):
-        """
-        Update the highlighted curve in the case of multiple curves in a plot item.
-
-        Args:
-            curve_index(int): The index of curve to highlight
-        """
-        self.highlighted_curve_index = curve_index
-        self.clear_markers()
-        self.update_markers()
-
-    def update_markers(self):
-        """Update the markers for the crosshair, creating new ones if necessary."""
-
-        if self.highlighted_curve_index is not None and hasattr(self.plot_item, "visible_curves"):
-            # Focus on the highlighted curve only
-            self.items = [self.plot_item.visible_curves[self.highlighted_curve_index]]
-        else:
-            # Handle all curves
-            self.items = self.plot_item.items
-
-        # Create or update markers
-        for item in self.items:
-            if isinstance(item, pg.PlotDataItem):  # 1D plot
-                pen = item.opts["pen"]
-                color = pen.color() if hasattr(pen, "color") else pg.mkColor(pen)
-                name = item.name() or str(id(item))
-                if name in self.marker_moved_1d:
-                    # Update existing markers
-                    marker_moved = self.marker_moved_1d[name]
-                    marker_moved.setPen(pg.mkPen(color))
-                    # Update clicked markers' brushes
-                    for marker_clicked in self.marker_clicked_1d[name]:
-                        alpha = marker_clicked.opts["brush"].color().alpha()
-                        marker_clicked.setBrush(
-                            pg.mkBrush(color.red(), color.green(), color.blue(), alpha)
-                        )
-                    # Update z-values
-                    marker_moved.setZValue(item.zValue() + 1)
-                    for marker_clicked in self.marker_clicked_1d[name]:
-                        marker_clicked.setZValue(item.zValue() + 1)
-                else:
-                    # Create new markers
-                    marker_moved = CrosshairScatterItem(
-                        size=10, pen=pg.mkPen(color), brush=pg.mkBrush(None)
-                    )
-                    marker_moved.skip_auto_range = True
-                    marker_moved.is_crosshair = True
-                    self.marker_moved_1d[name] = marker_moved
-                    self.plot_item.addItem(marker_moved)
-                    # Set marker z-value higher than the curve
-                    marker_moved.setZValue(item.zValue() + 1)
-
-                    # Create glowing effect markers for clicked events
-                    marker_clicked_list = []
-                    for size, alpha in [(18, 64), (14, 128), (10, 255)]:
-                        marker_clicked = CrosshairScatterItem(
-                            size=size,
-                            pen=pg.mkPen(None),
-                            brush=pg.mkBrush(color.red(), color.green(), color.blue(), alpha),
-                        )
-                        marker_clicked.skip_auto_range = True
-                        marker_clicked.is_crosshair = True
-                        self.plot_item.addItem(marker_clicked)
-                        marker_clicked.setZValue(item.zValue() + 1)
-                        marker_clicked_list.append(marker_clicked)
-                    self.marker_clicked_1d[name] = marker_clicked_list
-            elif isinstance(item, pg.ImageItem):  # 2D plot
-                if self.marker_2d is not None:
-                    continue
-                self.marker_2d = pg.ROI(
-                    [0, 0], size=[1, 1], pen=pg.mkPen("r", width=2), movable=False
-                )
-                self.plot_item.addItem(self.marker_2d)
-
-    def snap_to_data(self, x, y) -> tuple[defaultdict[list], defaultdict[list]]:
-        """
-        Finds the nearest data points to the given x and y coordinates.
-
-        Args:
-            x: The x-coordinate of the mouse cursor
-            y: The y-coordinate of the mouse cursor
-
-        Returns:
-            tuple: x and y values snapped to the nearest data
-        """
-        y_values = defaultdict(list)
-        x_values = defaultdict(list)
-
-        # Iterate through items in the plot
-        for item in self.items:
-            if isinstance(item, pg.PlotDataItem):  # 1D plot
-                name = item.name() or str(id(item))
-                plot_data = item._getDisplayDataset()
-                if plot_data is None:
-                    continue
-                x_data, y_data = plot_data.x, plot_data.y
-                if x_data is not None and y_data is not None:
-                    if self.is_log_x:
-                        min_x_data = np.min(x_data[x_data > 0])
-                    else:
-                        min_x_data = np.min(x_data)
-                    max_x_data = np.max(x_data)
-                    if x < min_x_data or x > max_x_data:
-                        y_values[name] = None
-                        x_values[name] = None
-                        continue
-                    closest_x, closest_y = self.closest_x_y_value(x, x_data, y_data)
-                    y_values[name] = closest_y
-                    x_values[name] = closest_x
-            elif isinstance(item, pg.ImageItem):  # 2D plot
-                name = item.config.monitor
-                image_2d = item.image
-                # Clip the x and y values to the image dimensions to avoid out of bounds errors
-                y_values[name] = int(np.clip(y, 0, image_2d.shape[1] - 1))
-                x_values[name] = int(np.clip(x, 0, image_2d.shape[0] - 1))
-
-        if x_values and y_values:
-            if all(v is None for v in x_values.values()) or all(
-                v is None for v in y_values.values()
-            ):
-                return None, None
-            return x_values, y_values
-
-        return None, None
-
-    def closest_x_y_value(self, input_x: float, list_x: list, list_y: list) -> tuple:
-        """
-        Find the closest x and y value to the input value.
-
-        Args:
-            input_x (float): Input value
-            list_x (list): List of x values
-            list_y (list): List of y values
-
-        Returns:
-            tuple: Closest x and y value
-        """
-        # Convert lists to NumPy arrays
-        arr_x = np.asarray(list_x)
-
-        # Get the indices where x is not NaN
-        valid_indices = ~np.isnan(arr_x)
-
-        # Filter x array to exclude NaN values
-        filtered_x = arr_x[valid_indices]
-
-        # Find the index of the closest value in the filtered x array
-        closest_index = np.abs(filtered_x - input_x).argmin()
-
-        # Map back to the original index in the list_x and list_y arrays
-        original_index = np.where(valid_indices)[0][closest_index]
-
-        return list_x[original_index], list_y[original_index]
-
-    def mouse_moved(self, event):
-        """Handles the mouse moved event, updating the crosshair position and emitting signals.
-
-        Args:
-            event: The mouse moved event
-        """
-        pos = event[0]
-        self.update_markers()
-        if self.plot_item.vb.sceneBoundingRect().contains(pos):
-            mouse_point = self.plot_item.vb.mapSceneToView(pos)
-            x, y = mouse_point.x(), mouse_point.y()
-            self.v_line.setPos(x)
-            self.h_line.setPos(y)
-            scaled_x, scaled_y = self.scale_emitted_coordinates(mouse_point.x(), mouse_point.y())
-            self.crosshairChanged.emit((scaled_x, scaled_y))
-            self.positionChanged.emit((x, y))
-
-            x_snap_values, y_snap_values = self.snap_to_data(x, y)
-            if x_snap_values is None or y_snap_values is None:
-                return
-            if all(v is None for v in x_snap_values.values()) or all(
-                v is None for v in y_snap_values.values()
-            ):
-                # not sure how we got here, but just to be safe...
-                return
-
-            for item in self.items:
-                if isinstance(item, pg.PlotDataItem):
-                    name = item.name() or str(id(item))
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    self.marker_moved_1d[name].setData([x], [y])
-                    x_snapped_scaled, y_snapped_scaled = self.scale_emitted_coordinates(x, y)
-                    coordinate_to_emit = (
-                        name,
-                        round(x_snapped_scaled, self.precision),
-                        round(y_snapped_scaled, self.precision),
-                    )
-                    self.coordinatesChanged1D.emit(coordinate_to_emit)
-                elif isinstance(item, pg.ImageItem):
-                    name = item.config.monitor
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    self.marker_2d.setPos([x, y])
-                    coordinate_to_emit = (name, x, y)
-                    self.coordinatesChanged2D.emit(coordinate_to_emit)
-                else:
-                    continue
-
-    def mouse_clicked(self, event):
-        """Handles the mouse clicked event, updating the crosshair position and emitting signals.
-
-        Args:
-            event: The mouse clicked event
-        """
-
-        # we only accept left mouse clicks
-        if event.button() != Qt.MouseButton.LeftButton:
-            return
-        self.update_markers()
-        if self.plot_item.vb.sceneBoundingRect().contains(event._scenePos):
-            mouse_point = self.plot_item.vb.mapSceneToView(event._scenePos)
-            x, y = mouse_point.x(), mouse_point.y()
-            scaled_x, scaled_y = self.scale_emitted_coordinates(mouse_point.x(), mouse_point.y())
-            self.crosshairClicked.emit((scaled_x, scaled_y))
-            self.positionClicked.emit((x, y))
-
-            x_snap_values, y_snap_values = self.snap_to_data(x, y)
-
-            if x_snap_values is None or y_snap_values is None:
-                return
-            if all(v is None for v in x_snap_values.values()) or all(
-                v is None for v in y_snap_values.values()
-            ):
-                # not sure how we got here, but just to be safe...
-                return
-
-            for item in self.items:
-                if isinstance(item, pg.PlotDataItem):
-                    name = item.name() or str(id(item))
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    for marker_clicked in self.marker_clicked_1d[name]:
-                        marker_clicked.setData([x], [y])
-                    x_snapped_scaled, y_snapped_scaled = self.scale_emitted_coordinates(x, y)
-                    coordinate_to_emit = (
-                        name,
-                        round(x_snapped_scaled, self.precision),
-                        round(y_snapped_scaled, self.precision),
-                    )
-                    self.coordinatesClicked1D.emit(coordinate_to_emit)
-                elif isinstance(item, pg.ImageItem):
-                    name = item.config.monitor
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    self.marker_2d.setPos([x, y])
-                    coordinate_to_emit = (name, x, y)
-                    self.coordinatesClicked2D.emit(coordinate_to_emit)
-                else:
-                    continue
-
-    def clear_markers(self):
-        """Clears the markers from the plot."""
-        for marker in self.marker_moved_1d.values():
-            self.plot_item.removeItem(marker)
-        for markers in self.marker_clicked_1d.values():
-            for marker in markers:
-                self.plot_item.removeItem(marker)
-        self.marker_moved_1d.clear()
-        self.marker_clicked_1d.clear()
-
-    def scale_emitted_coordinates(self, x, y):
-        """Scales the emitted coordinates if the axes are in log scale.
-
-        Args:
-            x (float): The x-coordinate
-            y (float): The y-coordinate
-
-        Returns:
-            tuple: The scaled x and y coordinates
-        """
-        if self.is_log_x:
-            x = 10**x
-        if self.is_log_y:
-            y = 10**y
-        return x, y
-
-    def update_coord_label(self, pos: tuple):
-        """Updates the coordinate label based on the crosshair position and axis scales.
-
-        Args:
-            pos (tuple): The (x, y) position of the crosshair.
-        """
-        x, y = pos
-        x_scaled, y_scaled = self.scale_emitted_coordinates(x, y)
-
-        # Update coordinate label
-        self.coord_label.setText(f"({x_scaled:.{self.precision}g}, {y_scaled:.{self.precision}g})")
-        self.coord_label.setPos(x, y)
-        self.coord_label.setVisible(True)
-
-    def check_log(self):
-        """Checks if the x or y axis is in log scale and updates the internal state accordingly."""
-        self.is_log_x = self.plot_item.axes["bottom"]["item"].logMode
-        self.is_log_y = self.plot_item.axes["left"]["item"].logMode
-        self.clear_markers()
-
-    def check_derivatives(self):
-        """Checks if the derivatives are enabled and updates the internal state accordingly."""
-        self.is_derivative = self.plot_item.ctrl.derivativeCheck.isChecked()
-        self.clear_markers()
-
-    def cleanup(self):
-        self.plot_item.removeItem(self.v_line)
-        self.plot_item.removeItem(self.h_line)
-        self.plot_item.removeItem(self.coord_label)
-
-        self.clear_markers()

bec_widgets/utils/entry_validator.py

@@ -1,42 +0,0 @@
-class EntryValidator:
-    def __init__(self, devices):
-        self.devices = devices
-
-    def validate_signal(self, name: str, entry: str = None) -> str:
-        """
-        Validate a signal entry for a given device. If the entry is not provided, the first signal entry will be used from the device hints.
-
-        Args:
-            name(str): Device name
-            entry(str): Signal entry
-
-        Returns:
-            str: Signal entry
-        """
-        if name not in self.devices:
-            raise ValueError(f"Device '{name}' not found in current BEC session")
-
-        device = self.devices[name]
-        description = device.describe()
-
-        if entry is None or entry == "":
-            entry = next(iter(device._hints), name) if hasattr(device, "_hints") else name
-        if entry not in description:
-            raise ValueError(f"Entry '{entry}' not found in device '{name}' signals")
-
-        return entry
-
-    def validate_monitor(self, monitor: str) -> str:
-        """
-        Validate a monitor entry for a given device.
-
-        Args:
-            monitor(str): Monitor entry
-
-        Returns:
-            str: Monitor entry
-        """
-        if monitor not in self.devices:
-            raise ValueError(f"Device '{monitor}' not found in current BEC session")
-
-        return monitor

bec_widgets/utils/filter_io.py

@@ -1,156 +0,0 @@
-"""Module for handling filter I/O operations in BEC Widgets for input fields.
-These operations include filtering device/signal names and/or device types.
-"""
-
-from abc import ABC, abstractmethod
-
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import QStringListModel
-from qtpy.QtWidgets import QComboBox, QCompleter, QLineEdit
-
-logger = bec_logger.logger
-
-
-class WidgetFilterHandler(ABC):
-    """Abstract base class for widget filter handlers"""
-
-    @abstractmethod
-    def set_selection(self, widget, selection: list) -> None:
-        """Set the filtered_selection for the widget
-
-        Args:
-            selection (list): Filtered selection of items
-        """
-
-    @abstractmethod
-    def check_input(self, widget, text: str) -> bool:
-        """Check if the input text is in the filtered selection
-
-        Args:
-            widget: Widget instance
-            text (str): Input text
-
-        Returns:
-            bool: True if the input text is in the filtered selection
-        """
-
-
-class LineEditFilterHandler(WidgetFilterHandler):
-    """Handler for QLineEdit widget"""
-
-    def set_selection(self, widget: QLineEdit, selection: list) -> None:
-        """Set the selection for the widget to the completer model
-
-        Args:
-            widget (QLineEdit): The QLineEdit widget
-            selection (list): Filtered selection of items
-        """
-        if not isinstance(widget.completer, QCompleter):
-            completer = QCompleter(widget)
-            widget.setCompleter(completer)
-        widget.completer.setModel(QStringListModel(selection, widget))
-
-    def check_input(self, widget: QLineEdit, text: str) -> bool:
-        """Check if the input text is in the filtered selection
-
-        Args:
-            widget (QLineEdit): The QLineEdit widget
-            text (str): Input text
-
-        Returns:
-            bool: True if the input text is in the filtered selection
-        """
-        model = widget.completer.model()
-        model_data = [model.data(model.index(i)) for i in range(model.rowCount())]
-        return text in model_data
-
-
-class ComboBoxFilterHandler(WidgetFilterHandler):
-    """Handler for QComboBox widget"""
-
-    def set_selection(self, widget: QComboBox, selection: list) -> None:
-        """Set the selection for the widget to the completer model
-
-        Args:
-            widget (QComboBox): The QComboBox widget
-            selection (list): Filtered selection of items
-        """
-        widget.clear()
-        widget.addItems(selection)
-
-    def check_input(self, widget: QComboBox, text: str) -> bool:
-        """Check if the input text is in the filtered selection
-
-        Args:
-            widget (QComboBox): The QComboBox widget
-            text (str): Input text
-
-        Returns:
-            bool: True if the input text is in the filtered selection
-        """
-        return text in [widget.itemText(i) for i in range(widget.count())]
-
-
-class FilterIO:
-    """Public interface to set filters for input widgets.
-    It supports the list of widgets stored in class attribute _handlers.
-    """
-
-    _handlers = {QLineEdit: LineEditFilterHandler, QComboBox: ComboBoxFilterHandler}
-
-    @staticmethod
-    def set_selection(widget, selection: list, ignore_errors=True):
-        """
-        Retrieve value from the widget instance.
-
-        Args:
-            widget: Widget instance.
-            selection(list): List of filtered selection items.
-            ignore_errors(bool, optional): Whether to ignore if no handler is found.
-        """
-        handler_class = FilterIO._find_handler(widget)
-        if handler_class:
-            return handler_class().set_selection(widget=widget, selection=selection)
-        if not ignore_errors:
-            raise ValueError(
-                f"No matching handler for widget type: {type(widget)} in handler list {FilterIO._handlers}"
-            )
-        return None
-
-    @staticmethod
-    def check_input(widget, text: str, ignore_errors=True):
-        """
-        Check if the input text is in the filtered selection.
-
-        Args:
-            widget: Widget instance.
-            text(str): Input text.
-            ignore_errors(bool, optional): Whether to ignore if no handler is found.
-
-        Returns:
-            bool: True if the input text is in the filtered selection.
-        """
-        handler_class = FilterIO._find_handler(widget)
-        if handler_class:
-            return handler_class().check_input(widget=widget, text=text)
-        if not ignore_errors:
-            raise ValueError(
-                f"No matching handler for widget type: {type(widget)} in handler list {FilterIO._handlers}"
-            )
-        return None
-
-    @staticmethod
-    def _find_handler(widget):
-        """
-        Find the appropriate handler for the widget by checking its base classes.
-
-        Args:
-            widget: Widget instance.
-
-        Returns:
-            handler_class: The handler class if found, otherwise None.
-        """
-        for base in type(widget).__mro__:
-            if base in FilterIO._handlers:
-                return FilterIO._handlers[base]
-        return None

bec_widgets/utils/fps_counter.py

@@ -1,84 +0,0 @@
-"""
-This module provides a utility class for counting and reporting frames per second (FPS) in a PyQtGraph application.
-
-Classes:
-    FPSCounter: A class that monitors the paint events of a `ViewBox` to calculate and emit FPS values.
-
-Usage:
-    The `FPSCounter` class can be used to monitor the rendering performance of a `ViewBox` in a PyQtGraph application.
-    It connects to the `ViewBox`'s paint event and calculates the FPS over a specified interval, emitting the FPS value
-    at regular intervals.
-
-Example:
-    from qtpy import QtWidgets, QtCore
-    import pyqtgraph as pg
-    from fps_counter import FPSCounter
-
-    app = pg.mkQApp("FPS Counter Example")
-    win = pg.GraphicsLayoutWidget()
-    win.show()
-
-    vb = pg.ViewBox()
-    plot_item = pg.PlotItem(viewBox=vb)
-    win.addItem(plot_item)
-
-    fps_counter = FPSCounter(vb)
-    fps_counter.sigFpsUpdate.connect(lambda fps: print(f"FPS: {fps:.2f}"))
-
-    sys.exit(app.exec_())
-"""
-
-from time import perf_counter
-
-import pyqtgraph as pg
-from qtpy import QtCore
-
-
-class FPSCounter(QtCore.QObject):
-    """
-    A utility class for counting and reporting frames per second (FPS).
-
-    This class connects to a `ViewBox`'s paint event to count the number of
-    frames rendered and calculates the FPS over a specified interval. It emits
-    a signal with the FPS value at regular intervals.
-
-    Attributes:
-        sigFpsUpdate (QtCore.Signal): Signal emitted with the FPS value.
-        view_box (pg.ViewBox): The `ViewBox` instance to monitor.
-    """
-
-    sigFpsUpdate = QtCore.Signal(float)
-
-    def __init__(self, view_box):
-        super().__init__()
-        self.view_box = view_box
-        self.view_box.sigPaint.connect(self.increment_count)
-        self.count = 0
-        self.last_update = perf_counter()
-        self.timer = QtCore.QTimer()
-        self.timer.timeout.connect(self.calculate_fps)
-        self.timer.start(1000)
-
-    def increment_count(self):
-        """
-        Increment the frame count when the `ViewBox` is painted.
-        """
-        self.count += 1
-
-    def calculate_fps(self):
-        """
-        Calculate the frames per second (FPS) based on the number of frames
-        """
-        now = perf_counter()
-        elapsed = now - self.last_update
-        fps = self.count / elapsed if elapsed > 0 else 0.0
-        self.last_update = now
-        self.count = 0
-        self.sigFpsUpdate.emit(fps)
-
-    def cleanup(self):
-        """
-        Clean up the FPS counter by stopping the timer and disconnecting the signal.
-        """
-        self.timer.stop()
-        self.timer.timeout.disconnect(self.calculate_fps)

bec_widgets/utils/generate_designer_plugin.py

@@ -1,149 +0,0 @@
-import inspect
-import os
-import re
-
-from qtpy.QtCore import QObject
-
-EXCLUDED_PLUGINS = ["BECConnector", "BECDockArea", "BECDock", "BECFigure"]
-
-
-class DesignerPluginInfo:
-    def __init__(self, plugin_class):
-        self.plugin_class = plugin_class
-        self.plugin_name_pascal = plugin_class.__name__
-        self.plugin_name_snake = self.pascal_to_snake(self.plugin_name_pascal)
-        self.widget_import = f"from {plugin_class.__module__} import {self.plugin_name_pascal}"
-        plugin_module = (
-            ".".join(plugin_class.__module__.split(".")[:-1]) + f".{self.plugin_name_snake}_plugin"
-        )
-        self.plugin_import = f"from {plugin_module} import {self.plugin_name_pascal}Plugin"
-
-        # first sentence / line of the docstring is used as tooltip
-        self.plugin_tooltip = (
-            plugin_class.__doc__.split("\n")[0].strip().replace('"', "'")
-            if plugin_class.__doc__
-            else self.plugin_name_pascal
-        )
-
-        self.base_path = os.path.dirname(inspect.getfile(plugin_class))
-
-    @staticmethod
-    def pascal_to_snake(name: str) -> str:
-        """
-        Convert PascalCase to snake_case.
-
-        Args:
-            name (str): The name to be converted.
-
-        Returns:
-            str: The converted name.
-        """
-        s1 = re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", name)
-        s2 = re.sub(r"([A-Z]+)([A-Z][a-z])", r"\1_\2", s1)
-        return s2.lower()
-
-
-class DesignerPluginGenerator:
-    def __init__(self, widget: type):
-        self._excluded = False
-        self.widget = widget
-        self.info = DesignerPluginInfo(widget)
-        if widget.__name__ in EXCLUDED_PLUGINS:
-
-            self._excluded = True
-            return
-
-        self.templates = {}
-        self.template_path = os.path.join(
-            os.path.dirname(os.path.abspath(__file__)), "plugin_templates"
-        )
-
-    def run(self, validate=True):
-        if self._excluded:
-            print(f"Plugin {self.widget.__name__} is excluded from generation.")
-            return
-        if validate:
-            self._check_class_validity()
-        self._load_templates()
-        self._write_templates()
-
-    def _check_class_validity(self):
-
-        # Check if the widget is a QWidget subclass
-        if not issubclass(self.widget, QObject):
-            return
-
-        # Check if the widget class has parent as the first argument. This is a strict requirement of Qt!
-        signature = list(inspect.signature(self.widget.__init__).parameters.values())
-        if len(signature) == 1 or signature[1].name != "parent":
-            raise ValueError(
-                f"Widget class {self.widget.__name__} must have parent as the first argument."
-            )
-
-        base_cls = [val for val in self.widget.__bases__ if issubclass(val, QObject)]
-        if not base_cls:
-            raise ValueError(
-                f"Widget class {self.widget.__name__} must inherit from a QObject subclass."
-            )
-
-        # Check if the widget class calls the super constructor with parent argument
-        init_source = inspect.getsource(self.widget.__init__)
-        cls_init_found = (
-            bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent=parent") > 0)
-            or bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent)") > 0)
-            or bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent,") > 0)
-        )
-        super_init_found = (
-            bool(
-                init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent=parent") > 0
-            )
-            or bool(init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent,") > 0)
-            or bool(init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent)") > 0)
-        )
-        if issubclass(self.widget.__bases__[0], QObject) and not super_init_found:
-            super_init_found = (
-                bool(init_source.find("super().__init__(parent=parent") > 0)
-                or bool(init_source.find("super().__init__(parent,") > 0)
-                or bool(init_source.find("super().__init__(parent)") > 0)
-            )
-
-        if not cls_init_found and not super_init_found:
-            raise ValueError(
-                f"Widget class {self.widget.__name__} must call the super constructor with parent."
-            )
-
-    def _write_templates(self):
-        self._write_register()
-        self._write_plugin()
-        self._write_pyproject()
-
-    def _write_register(self):
-        file_path = os.path.join(self.info.base_path, f"register_{self.info.plugin_name_snake}.py")
-        with open(file_path, "w", encoding="utf-8") as f:
-            f.write(self.templates["register"].format(**self.info.__dict__))
-
-    def _write_plugin(self):
-        file_path = os.path.join(self.info.base_path, f"{self.info.plugin_name_snake}_plugin.py")
-        with open(file_path, "w", encoding="utf-8") as f:
-            f.write(self.templates["plugin"].format(**self.info.__dict__))
-
-    def _write_pyproject(self):
-        file_path = os.path.join(self.info.base_path, f"{self.info.plugin_name_snake}.pyproject")
-        out = {"files": [f"{self.info.plugin_class.__module__.split('.')[-1]}.py"]}
-        with open(file_path, "w", encoding="utf-8") as f:
-            f.write(str(out))
-
-    def _load_templates(self):
-        for file in os.listdir(self.template_path):
-            if not file.endswith(".template"):
-                continue
-            with open(os.path.join(self.template_path, file), "r", encoding="utf-8") as f:
-                self.templates[file.split(".")[0]] = f.read()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    # from bec_widgets.widgets.bec_queue.bec_queue import BECQueue
-    from bec_widgets.widgets.utility.spinner import SpinnerWidget
-
-    generator = DesignerPluginGenerator(SpinnerWidget)
-    generator.run(validate=False)

bec_widgets/utils/layout_manager.py

@@ -1,121 +0,0 @@
-from collections import OrderedDict
-from typing import Literal
-
-from qtpy.QtWidgets import QGridLayout, QWidget
-
-
-class GridLayoutManager:
-    """
-    GridLayoutManager class is used to manage widgets in a QGridLayout and extend its functionality.
-
-    The GridLayoutManager class provides methods to add, move, and check the position of widgets in a QGridLayout.
-    It also provides a method to get the positions of all widgets in the layout.
-
-    Args:
-        layout(QGridLayout): The layout to manage.
-    """
-
-    def __init__(self, layout: QGridLayout):
-        self.layout = layout
-
-    def is_position_occupied(self, row: int, col: int) -> bool:
-        """
-        Check if the position in the layout is occupied by a widget.
-
-        Args:
-            row(int): The row to check.
-            col(int): The column to check.
-
-        Returns:
-            bool: True if the position is occupied, False otherwise.
-        """
-        for i in range(self.layout.count()):
-            widget_row, widget_col, _, _ = self.layout.getItemPosition(i)
-            if widget_row == row and widget_col == col:
-                return True
-        return False
-
-    def shift_widgets(
-        self,
-        direction: Literal["down", "up", "left", "right"] = "down",
-        start_row: int = 0,
-        start_col: int = 0,
-    ):
-        """
-        Shift widgets in the layout in the specified direction starting from the specified position.
-
-        Args:
-            direction(str): The direction to shift the widgets. Can be "down", "up", "left", or "right".
-            start_row(int): The row to start shifting from. Default is 0.
-            start_col(int): The column to start shifting from. Default is 0.
-        """
-        for i in reversed(range(self.layout.count())):
-            widget_item = self.layout.itemAt(i)
-            widget = widget_item.widget()
-            row, col, rowspan, colspan = self.layout.getItemPosition(i)
-            if direction == "down" and row >= start_row:
-                self.layout.addWidget(widget, row + 1, col, rowspan, colspan)
-            elif direction == "up" and row > start_row:
-                self.layout.addWidget(widget, row - 1, col, rowspan, colspan)
-            elif direction == "right" and col >= start_col:
-                self.layout.addWidget(widget, row, col + 1, rowspan, colspan)
-            elif direction == "left" and col > start_col:
-                self.layout.addWidget(widget, row, col - 1, rowspan, colspan)
-
-    def move_widget(self, widget: QWidget, new_row: int, new_col: int):
-        """
-        Move a widget to a new position in the layout.
-
-        Args:
-            widget(QWidget): The widget to move.
-            new_row(int): The new row to move the widget to.
-            new_col(int): The new column to move the widget to.
-        """
-        self.layout.removeWidget(widget)
-        self.layout.addWidget(widget, new_row, new_col)
-
-    def add_widget(
-        self,
-        widget: QWidget,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
-        shift: Literal["down", "up", "left", "right"] = "down",
-    ):
-        """
-        Add a widget to the layout at the specified position.
-
-        Args:
-            widget(QWidget): The widget to add.
-            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
-            col(int): The column to add the widget to. Default is 0.
-            rowspan(int): The number of rows the widget will span. Default is 1.
-            colspan(int): The number of columns the widget will span. Default is 1.
-            shift(str): The direction to shift the widgets if the position is occupied. Can be "down", "up", "left", or "right".
-        """
-        if row is None:
-            row = self.layout.rowCount()
-        if self.is_position_occupied(row, col):
-            self.shift_widgets(shift, start_row=row)
-        self.layout.addWidget(widget, row, col, rowspan, colspan)
-
-    def get_widgets_positions(self) -> dict:
-        """
-        Get the positions of all widgets in the layout.
-        Returns:
-            dict: A dictionary with the positions of the widgets in the layout.
-
-        """
-        positions = []
-        for i in range(self.layout.count()):
-            widget_item = self.layout.itemAt(i)
-            widget = widget_item.widget()
-            if widget:
-                position = self.layout.getItemPosition(i)
-                positions.append((position, widget))
-        positions.sort(key=lambda x: (x[0][0], x[0][1], x[0][2], x[0][3]))
-        ordered_positions = OrderedDict()
-        for pos, widget in positions:
-            ordered_positions[pos] = widget
-        return ordered_positions

bec_widgets/utils/linear_region_selector.py

@@ -1,84 +0,0 @@
-""" Module for a thin wrapper (LinearRegionWrapper) around the LinearRegionItem in pyqtgraph.
-The class is mainly designed for usage with the BECWaveform and 1D plots. """
-
-import pyqtgraph as pg
-from qtpy.QtCore import QObject, Signal, Slot
-from qtpy.QtGui import QColor
-
-
-class LinearRegionWrapper(QObject):
-    """Wrapper class for the LinearRegionItem in pyqtgraph for 1D plots (BECWaveform)
-
-    Args:
-        plot_item (pg.PlotItem): The plot item to add the region selector to.
-        parent (QObject): The parent object.
-        color (QColor): The color of the region selector.
-        hover_color (QColor): The color of the region selector when the mouse is over it.
-    """
-
-    # Signal with the region tuble (start, end)
-    region_changed = Signal(tuple)
-
-    def __init__(
-        self, plot_item: pg.PlotItem, color: QColor = None, hover_color: QColor = None, parent=None
-    ):
-        super().__init__(parent)
-        self.is_log_x = None
-        self._edge_width = 2
-        self.plot_item = plot_item
-        self.linear_region_selector = pg.LinearRegionItem()
-        self.proxy = None
-        self.change_roi_color((color, hover_color))
-        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
-        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
-
-    # Slot for changing the color of the region selector (edge and fill)
-    @Slot(tuple)
-    def change_roi_color(self, colors: tuple[QColor | str | tuple, QColor | str | tuple]):
-        """Change the color and hover color of the region selector.
-        Hover color means the color when the mouse is over the region.
-
-        Args:
-            colors (tuple): Tuple with the color and hover color
-        """
-        color, hover_color = colors
-        if color is not None:
-            self.linear_region_selector.setBrush(pg.mkBrush(color))
-        if hover_color is not None:
-            self.linear_region_selector.setHoverBrush(pg.mkBrush(hover_color))
-
-    @Slot()
-    def add_region_selector(self):
-        """Add the region selector to the plot item"""
-        self.plot_item.addItem(self.linear_region_selector)
-        # Use proxy to limit the update rate of the region change signal to 10Hz
-        self.proxy = pg.SignalProxy(
-            self.linear_region_selector.sigRegionChanged,
-            rateLimit=10,
-            slot=self._region_change_proxy,
-        )
-
-    @Slot()
-    def remove_region_selector(self):
-        """Remove the region selector from the plot item"""
-        self.proxy.disconnect()
-        self.proxy = None
-        self.plot_item.removeItem(self.linear_region_selector)
-
-    def _region_change_proxy(self):
-        """Emit the region change signal. If the plot is in log mode, convert the region to log."""
-        x_low, x_high = self.linear_region_selector.getRegion()
-        if self.is_log_x:
-            x_low = 10**x_low
-            x_high = 10**x_high
-        self.region_changed.emit((x_low, x_high))
-
-    @Slot()
-    def check_log(self):
-        """Check if the plot is in log mode."""
-        self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
-        self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
-
-    def cleanup(self):
-        """Cleanup the widget."""
-        self.remove_region_selector()

bec_widgets/utils/ophyd_kind_util.py

@@ -1,26 +0,0 @@
-from enum import IntFlag
-
-try:
-
-    from enum import KEEP
-
-    class IFBase(IntFlag, boundary=KEEP): ...
-
-except ImportError:
-
-    IFBase = IntFlag
-
-
-class Kind(IFBase):
-    """
-    This is used in the .kind attribute of all OphydObj (Signals, Devices).
-
-    A Device examines its components' .kind atttribute to decide whether to
-    traverse it in read(), read_configuration(), or neither. Additionally, if
-    decides whether to include its name in `hints['fields']`.
-    """
-
-    omitted = 0b000
-    normal = 0b001
-    config = 0b010
-    hinted = 0b101  # Notice that bool(hinted & normal) is True.

bec_widgets/utils/plot_indicator_items.py

@@ -1,247 +0,0 @@
-"""Module to create an arrow item for a pyqtgraph plot"""
-
-import numpy as np
-import pyqtgraph as pg
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import QObject, QPointF, Signal, Slot
-
-from bec_widgets.utils.colors import get_accent_colors
-
-logger = bec_logger.logger
-
-
-class BECIndicatorItem(QObject):
-
-    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
-        super().__init__(parent=parent)
-        self.accent_colors = get_accent_colors()
-        self.plot_item = plot_item
-        self._item_on_plot = False
-        self._pos = None
-        self.is_log_x = False
-        self.is_log_y = False
-
-    @property
-    def item_on_plot(self) -> bool:
-        """Returns if the item is on the plot"""
-        return self._item_on_plot
-
-    @item_on_plot.setter
-    def item_on_plot(self, value: bool) -> None:
-        self._item_on_plot = value
-
-    def add_to_plot(self) -> None:
-        """Add the item to the plot"""
-        raise NotImplementedError("Method add_to_plot not implemented")
-
-    def remove_from_plot(self) -> None:
-        """Remove the item from the plot"""
-        raise NotImplementedError("Method remove_from_plot not implemented")
-
-    def set_position(self, pos) -> None:
-        """This method should implement the logic to set the position of the
-        item on the plot. Depending on the child class, the position can be
-        a tuple (x,y) or a single value, i.e. x position where y position is fixed.
-        """
-        raise NotImplementedError("Method set_position not implemented")
-
-    def check_log(self):
-        """Checks if the x or y axis is in log scale and updates the internal state accordingly."""
-        self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
-        self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
-        self.set_position(self._pos)
-
-
-class BECTickItem(BECIndicatorItem):
-    """Class to create a tick item which can be added to a pyqtgraph plot.
-    The tick item will be added to the layout of the plot item and can be used to indicate
-    a position"""
-
-    position_changed = Signal(float)
-    position_changed_str = Signal(str)
-
-    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
-        super().__init__(plot_item=plot_item, parent=parent)
-        self.tick_item = pg.TickSliderItem(
-            parent=parent, allowAdd=False, allowRemove=False, orientation="bottom"
-        )
-        self.tick_item.skip_auto_range = True
-        self.tick = None
-        self._pos = 0.0
-        self._range = [0, 1]
-
-    @Slot(float)
-    def set_position(self, pos: float) -> None:
-        """Set the x position of the tick item
-
-        Args:
-            pos (float): The position of the tick item.
-        """
-        if self.is_log_x is True:
-            pos = pos if pos > 0 else 1e-10
-            pos = np.log10(pos)
-        self._pos = pos
-        view_box = self.plot_item.getViewBox()  # Ensure you're accessing the correct view box
-        view_range = view_box.viewRange()[0]
-        self.update_range(self.plot_item.vb, view_range)
-        self.position_changed.emit(pos)
-        self.position_changed_str.emit(str(pos))
-
-    @Slot()
-    def update_range(self, _, view_range: tuple[float, float]) -> None:
-        """Update the range of the tick item
-
-        Args:
-            vb (pg.ViewBox): The view box.
-            viewRange (tuple): The view range.
-        """
-        if self._pos < view_range[0] or self._pos > view_range[1]:
-            self.tick_item.setVisible(False)
-        else:
-            self.tick_item.setVisible(True)
-
-        if self.tick_item.isVisible():
-            origin = self.tick_item.tickSize / 2.0
-            length = self.tick_item.length
-
-            length_with_padding = length + self.tick_item.tickSize + 2
-
-            self._range = view_range
-            tick_with_padding = (self._pos - view_range[0]) / (view_range[1] - view_range[0])
-            tick_value = (tick_with_padding * length_with_padding - origin) / length
-            self.tick_item.setTickValue(self.tick, tick_value)
-
-    def add_to_plot(self):
-        """Add the tick item to the view box or plot item."""
-        if self.plot_item is None:
-            return
-
-        self.plot_item.layout.addItem(self.tick_item, 2, 1)
-        self.tick_item.setOrientation("top")
-        self.tick = self.tick_item.addTick(0, movable=False, color=self.accent_colors.highlight)
-        self.update_tick_pos_y()
-        self.plot_item.vb.sigXRangeChanged.connect(self.update_range)
-        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
-        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
-        self.plot_item.vb.geometryChanged.connect(self.update_tick_pos_y)
-        self.item_on_plot = True
-
-    @Slot()
-    def update_tick_pos_y(self):
-        """Update tick position, while respecting the tick_item coordinates"""
-        pos = self.tick.pos()
-        pos = self.tick_item.mapToParent(pos)
-        new_pos = self.plot_item.vb.geometry().bottom()
-        new_pos = self.tick_item.mapFromParent(QPointF(pos.x(), new_pos))
-        self.tick.setPos(new_pos)
-
-    def remove_from_plot(self):
-        """Remove the tick item from the view box or plot item."""
-        if self.plot_item is not None and self.item_on_plot is True:
-            self.plot_item.vb.sigXRangeChanged.disconnect(self.update_range)
-            self.plot_item.ctrl.logXCheck.checkStateChanged.disconnect(self.check_log)
-            self.plot_item.ctrl.logYCheck.checkStateChanged.disconnect(self.check_log)
-            if self.plot_item.layout is not None:
-                self.plot_item.layout.removeItem(self.tick_item)
-        self.item_on_plot = False
-
-    def cleanup(self) -> None:
-        """Cleanup the item"""
-        self.remove_from_plot()
-        if self.tick_item is not None:
-            self.tick_item.close()
-            self.tick_item.deleteLater()
-            self.tick_item = None
-
-
-class BECArrowItem(BECIndicatorItem):
-    """Class to create an arrow item which can be added to a pyqtgraph plot.
-    It can be either added directly to a view box or a plot item.
-    To add the arrow item to a view box or plot item, use the add_to_plot method.
-
-    Args:
-        view_box (pg.ViewBox | pg.PlotItem): The view box or plot item to which the arrow item should be added.
-        parent (QObject): The parent object.
-
-    Signals:
-        position_changed (tuple[float, float]): Signal emitted when the position of the arrow item has changed.
-        position_changed_str (tuple[str, str]): Signal emitted when the position of the arrow item has changed.
-    """
-
-    # Signal to emit if the position of the arrow item has changed
-    position_changed = Signal(tuple)
-    position_changed_str = Signal(tuple)
-
-    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
-        super().__init__(plot_item=plot_item, parent=parent)
-        self.arrow_item = pg.ArrowItem(parent=parent)
-        self.arrow_item.skip_auto_range = True
-        self._pos = (0, 0)
-        self.arrow_item.setVisible(False)
-
-    @Slot(dict)
-    def set_style(self, style: dict) -> None:
-        """Set the style of the arrow item
-
-        Args:
-            style (dict): The style of the arrow item. Dictionary with key,
-                          value pairs which are accepted from the pg.ArrowItem.setStyle method.
-        """
-        self.arrow_item.setStyle(**style)
-
-    @Slot(tuple)
-    def set_position(self, pos: tuple[float, float]) -> None:
-        """Set the position of the arrow item
-
-        Args:
-            pos (tuple): The position of the arrow item as a tuple (x, y).
-        """
-        self._pos = pos
-        pos_x = pos[0]
-        pos_y = pos[1]
-        if self.is_log_x is True:
-            pos_x = np.log10(pos_x) if pos_x > 0 else 1e-10
-            view_box = self.plot_item.getViewBox()  # Ensure you're accessing the correct view box
-            view_range = view_box.viewRange()[0]
-            # Avoid values outside the view range in the negative direction. Otherwise, there is
-            # a buggy behaviour of the arrow item and it appears at the wrong position.
-            if pos_x < view_range[0]:
-                pos_x = view_range[0]
-        if self.is_log_y is True:
-            pos_y = np.log10(pos_y) if pos_y > 0 else 1e-10
-
-        self.arrow_item.setPos(pos_x, pos_y)
-        self.position_changed.emit(self._pos)
-        self.position_changed_str.emit((str(self._pos[0]), str(self._pos[1])))
-
-    def add_to_plot(self):
-        """Add the arrow item to the view box or plot item."""
-        if not self.arrow_item:
-            logger.warning(f"Arrow item was already destroyed, cannot be created")
-            return
-
-        self.arrow_item.setStyle(
-            angle=-90,
-            pen=pg.mkPen(self.accent_colors.emergency, width=1),
-            brush=pg.mkBrush(self.accent_colors.highlight),
-            headLen=20,
-        )
-        self.arrow_item.setVisible(True)
-        if self.plot_item is not None:
-            self.plot_item.addItem(self.arrow_item)
-            self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
-            self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
-            self.item_on_plot = True
-
-    def remove_from_plot(self):
-        """Remove the arrow item from the view box or plot item."""
-        if self.plot_item is not None and self.item_on_plot is True:
-            self.plot_item.ctrl.logXCheck.checkStateChanged.disconnect(self.check_log)
-            self.plot_item.ctrl.logYCheck.checkStateChanged.disconnect(self.check_log)
-            self.plot_item.removeItem(self.arrow_item)
-        self.item_on_plot = False
-
-    def cleanup(self) -> None:
-        """Cleanup the item"""
-        self.remove_from_plot()
-        self.arrow_item = None

bec_widgets/utils/plugin_templates/plugin.template

@@ -1,54 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-
-from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-
-from bec_widgets.utils.bec_designer import designer_material_icon
-{widget_import}
-
-DOM_XML = """
-<ui language='c++'>
-    <widget class='{plugin_name_pascal}' name='{plugin_name_snake}'>
-    </widget>
-</ui>
-"""
-
-
-class {plugin_name_pascal}Plugin(QDesignerCustomWidgetInterface):  # pragma: no cover
-    def __init__(self):
-        super().__init__()
-        self._form_editor = None
-
-    def createWidget(self, parent):
-        t = {plugin_name_pascal}(parent)
-        return t
-
-    def domXml(self):
-        return DOM_XML
-
-    def group(self):
-        return ""
-
-    def icon(self):
-        return designer_material_icon({plugin_name_pascal}.ICON_NAME)
-
-    def includeFile(self):
-        return "{plugin_name_snake}"
-
-    def initialize(self, form_editor):
-        self._form_editor = form_editor
-
-    def isContainer(self):
-        return False
-
-    def isInitialized(self):
-        return self._form_editor is not None
-
-    def name(self):
-        return "{plugin_name_pascal}"
-
-    def toolTip(self):
-        return "{plugin_tooltip}"
-
-    def whatsThis(self):
-        return self.toolTip()

bec_widgets/utils/plugin_templates/register.template

@@ -1,15 +0,0 @@
-def main():  # pragma: no cover
-    from qtpy import PYSIDE6
-
-    if not PYSIDE6:
-        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
-        return
-    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
-
-    {plugin_import}
-
-    QPyDesignerCustomWidgetCollection.addCustomWidget({plugin_name_pascal}Plugin())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/utils/plugin_utils.py

@@ -1,167 +0,0 @@
-import importlib
-import inspect
-import os
-from dataclasses import dataclass
-
-from bec_lib.plugin_helper import _get_available_plugins
-from qtpy.QtWidgets import QGraphicsWidget, QWidget
-
-from bec_widgets.utils import BECConnector
-from bec_widgets.utils.bec_widget import BECWidget
-
-
-def get_plugin_widgets() -> dict[str, BECConnector]:
-    """
-    Get all available widgets from the plugin directory. Widgets are classes that inherit from BECConnector.
-    The plugins are provided through python plugins and specified in the respective pyproject.toml file using
-    the following key:
-
-        [project.entry-points."bec.widgets.user_widgets"]
-        plugin_widgets = "path.to.plugin.module"
-
-    e.g.
-        [project.entry-points."bec.widgets.user_widgets"]
-        plugin_widgets = "pxiii_bec.bec_widgets.widgets"
-
-        assuming that the widgets module for the package pxiii_bec is located at pxiii_bec/bec_widgets/widgets and
-        contains the widgets to be loaded within the pxiii_bec/bec_widgets/widgets/__init__.py file.
-
-    Returns:
-        dict[str, BECConnector]: A dictionary of widget names and their respective classes.
-    """
-    modules = _get_available_plugins("bec.widgets.user_widgets")
-    loaded_plugins = {}
-    print(modules)
-    for module in modules:
-        mods = inspect.getmembers(module, predicate=_filter_plugins)
-        for name, mod_cls in mods:
-            if name in loaded_plugins:
-                print(f"Duplicated widgets plugin {name}.")
-            loaded_plugins[name] = mod_cls
-    return loaded_plugins
-
-
-def _filter_plugins(obj):
-    return inspect.isclass(obj) and issubclass(obj, BECConnector)
-
-
-@dataclass
-class BECClassInfo:
-    name: str
-    module: str
-    file: str
-    obj: type
-    is_connector: bool = False
-    is_widget: bool = False
-    is_plugin: bool = False
-
-
-class BECClassContainer:
-    def __init__(self):
-        self._collection = []
-
-    def add_class(self, class_info: BECClassInfo):
-        """
-        Add a class to the collection.
-
-        Args:
-            class_info(BECClassInfo): The class information
-        """
-        self.collection.append(class_info)
-
-    @property
-    def collection(self):
-        """
-        Get the collection of classes.
-        """
-        return self._collection
-
-    @property
-    def connector_classes(self):
-        """
-        Get all connector classes.
-        """
-        return [info.obj for info in self.collection if info.is_connector]
-
-    @property
-    def top_level_classes(self):
-        """
-        Get all top-level classes.
-        """
-        return [info.obj for info in self.collection if info.is_plugin]
-
-    @property
-    def plugins(self):
-        """
-        Get all plugins. These are all classes that are on the top level and are widgets.
-        """
-        return [info.obj for info in self.collection if info.is_widget and info.is_plugin]
-
-    @property
-    def widgets(self):
-        """
-        Get all widgets. These are all classes inheriting from BECWidget.
-        """
-        return [info.obj for info in self.collection if info.is_widget]
-
-    @property
-    def rpc_top_level_classes(self):
-        """
-        Get all top-level classes that are RPC-enabled. These are all classes that users can choose from.
-        """
-        return [info.obj for info in self.collection if info.is_plugin and info.is_connector]
-
-    @property
-    def classes(self):
-        """
-        Get all classes.
-        """
-        return [info.obj for info in self.collection]
-
-
-def get_custom_classes(repo_name: str) -> BECClassContainer:
-    """
-    Get all RPC-enabled classes in the specified repository.
-
-    Args:
-        repo_name(str): The name of the repository.
-
-    Returns:
-        dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
-    """
-    collection = BECClassContainer()
-    anchor_module = importlib.import_module(f"{repo_name}.widgets")
-    directory = os.path.dirname(anchor_module.__file__)
-    for root, _, files in sorted(os.walk(directory)):
-        for file in files:
-            if not file.endswith(".py") or file.startswith("__"):
-                continue
-
-            path = os.path.join(root, file)
-            subs = os.path.dirname(os.path.relpath(path, directory)).split("/")
-            if len(subs) == 1 and not subs[0]:
-                module_name = file.split(".")[0]
-            else:
-                module_name = ".".join(subs + [file.split(".")[0]])
-
-            module = importlib.import_module(f"{repo_name}.widgets.{module_name}")
-
-            for name in dir(module):
-                obj = getattr(module, name)
-                if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
-                    continue
-                if isinstance(obj, type):
-                    class_info = BECClassInfo(name=name, module=module_name, file=path, obj=obj)
-                    if issubclass(obj, BECConnector):
-                        class_info.is_connector = True
-                    if issubclass(obj, BECWidget):
-                        class_info.is_widget = True
-                    if len(subs) == 1 and (
-                        issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
-                    ):
-                        class_info.is_top_level = True
-                    if hasattr(obj, "PLUGIN") and obj.PLUGIN:
-                        class_info.is_plugin = True
-                    collection.add_class(class_info)
-
-    return collection

bec_widgets/utils/reference_utils.py

@@ -1,92 +0,0 @@
-import os
-import sys
-
-from PIL import Image, ImageChops
-from qtpy.QtGui import QPixmap
-
-import bec_widgets
-
-REFERENCE_DIR = os.path.join(
-    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/references"
-)
-REFERENCE_DIR_FAILURES = os.path.join(
-    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/reference_failures"
-)
-
-
-def compare_images(image1_path: str, reference_image_path: str):
-    """
-    Load two images and compare them pixel by pixel
-
-    Args:
-        image1_path(str): The path to the first image
-        reference_image_path(str): The path to the reference image
-
-    Raises:
-        ValueError: If the images are different
-    """
-    image1 = Image.open(image1_path)
-    image2 = Image.open(reference_image_path)
-    if image1.size != image2.size:
-        raise ValueError("Image size has changed")
-    diff = ImageChops.difference(image1, image2)
-    if diff.getbbox():
-        # copy image1 to the reference directory to upload as artifact
-        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
-        image_name = os.path.join(REFERENCE_DIR_FAILURES, os.path.basename(image1_path))
-        image1.save(image_name)
-        print(f"Image saved to {image_name}")
-
-        raise ValueError("Images are different")
-
-
-def snap_and_compare(widget: any, output_directory: str, suffix: str = ""):
-    """
-    Save a rendering of a widget and compare it to a reference image
-
-    Args:
-        widget(any): The widget to render
-        output_directory(str): The directory to save the image to
-        suffix(str): A suffix to append to the image name
-
-    Raises:
-        ValueError: If the images are different
-
-    Examples:
-        snap_and_compare(widget, tmpdir, suffix="started")
-
-    """
-
-    if not isinstance(output_directory, str):
-        output_directory = str(output_directory)
-
-    os_suffix = sys.platform
-
-    name = (
-        f"{widget.__class__.__name__}_{suffix}_{os_suffix}.png"
-        if suffix
-        else f"{widget.__class__.__name__}_{os_suffix}.png"
-    )
-
-    # Save the widget to a pixmap
-    test_image_path = os.path.join(output_directory, name)
-    pixmap = QPixmap(widget.size())
-    widget.render(pixmap)
-    pixmap.save(test_image_path)
-
-    try:
-        reference_path = os.path.join(REFERENCE_DIR, f"{widget.__class__.__name__}")
-        reference_image_path = os.path.join(reference_path, name)
-
-        if not os.path.exists(reference_image_path):
-            raise ValueError(f"Reference image not found: {reference_image_path}")
-
-        compare_images(test_image_path, reference_image_path)
-
-    except ValueError:
-        image = Image.open(test_image_path)
-        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
-        image_name = os.path.join(REFERENCE_DIR_FAILURES, name)
-        image.save(image_name)
-        print(f"Image saved to {image_name}")
-        raise

bec_widgets/utils/rpc_decorator.py

@@ -1,15 +0,0 @@
-def rpc_public(func):
-    func.rpc_public = True  # Mark the function for later processing by the class decorator
-    return func
-
-
-def register_rpc_methods(cls):
-    """
-    Class decorator to scan for rpc_public methods and add them to USER_ACCESS.
-    """
-    if not hasattr(cls, "USER_ACCESS"):
-        cls.USER_ACCESS = set()
-    for name, method in cls.__dict__.items():
-        if getattr(method, "rpc_public", False):
-            cls.USER_ACCESS.add(name)
-    return cls

bec_widgets/utils/thread_checker.py

@@ -1,37 +0,0 @@
-import threading
-
-
-class ThreadTracker:
-    def __init__(self, exclude_names=None):
-        self.exclude_names = exclude_names if exclude_names else []
-        self.initial_threads = self._capture_threads()
-
-    def _capture_threads(self):
-        return set(
-            th
-            for th in threading.enumerate()
-            if not any(ex_name in th.name for ex_name in self.exclude_names)
-            and th is not threading.main_thread()
-        )
-
-    def _thread_info(self, threads):
-        return ", \n".join(f"{th.name}(ID: {th.ident})" for th in threads)
-
-    def check_unfinished_threads(self):
-        current_threads = self._capture_threads()
-        additional_threads = current_threads - self.initial_threads
-        closed_threads = self.initial_threads - current_threads
-        if additional_threads:
-            raise Exception(
-                f"###### Initial threads ######:\n {self._thread_info(self.initial_threads)}\n"
-                f"###### Current threads ######:\n {self._thread_info(current_threads)}\n"
-                f"###### Closed threads ######:\n {self._thread_info(closed_threads)}\n"
-                f"###### Unfinished threads ######:\n {self._thread_info(additional_threads)}"
-            )
-        else:
-            print(
-                "All threads properly closed.\n"
-                f"###### Initial threads ######:\n {self._thread_info(self.initial_threads)}\n"
-                f"###### Current threads ######:\n {self._thread_info(current_threads)}\n"
-                f"###### Closed threads ######:\n {self._thread_info(closed_threads)}"
-            )

bec_widgets/utils/ui_loader.py

@@ -1,140 +0,0 @@
-import os
-
-from qtpy import PYQT6, PYSIDE6, QT_VERSION
-from qtpy.QtCore import QFile, QIODevice
-
-from bec_widgets.utils.generate_designer_plugin import DesignerPluginInfo
-from bec_widgets.utils.plugin_utils import get_custom_classes
-
-if PYSIDE6:
-    from PySide6.QtUiTools import QUiLoader
-
-    class CustomUiLoader(QUiLoader):
-        def __init__(self, baseinstance, custom_widgets: dict = None):
-            super().__init__(baseinstance)
-            self.custom_widgets = custom_widgets or {}
-
-            self.baseinstance = baseinstance
-
-        def createWidget(self, class_name, parent=None, name=""):
-            if class_name in self.custom_widgets:
-                widget = self.custom_widgets[class_name](parent)
-                widget.setObjectName(name)
-                return widget
-            return super().createWidget(class_name, parent, name)
-
-
-class UILoader:
-    """Universal UI loader for PyQt6 and PySide6."""
-
-    def __init__(self, parent=None):
-        self.parent = parent
-
-        widgets = get_custom_classes("bec_widgets").classes
-
-        self.custom_widgets = {widget.__name__: widget for widget in widgets}
-
-        if PYSIDE6:
-            self.loader = self.load_ui_pyside6
-        elif PYQT6:
-            self.loader = self.load_ui_pyqt6
-        else:
-            raise ImportError("No compatible Qt bindings found.")
-
-    def load_ui_pyside6(self, ui_file, parent=None):
-        """
-        Specific loader for PySide6 using QUiLoader.
-        Args:
-            ui_file(str): Path to the .ui file.
-            parent(QWidget): Parent widget.
-
-        Returns:
-            QWidget: The loaded widget.
-        """
-
-        loader = CustomUiLoader(parent, self.custom_widgets)
-        file = QFile(ui_file)
-        if not file.open(QIODevice.ReadOnly):
-            raise IOError(f"Cannot open file: {ui_file}")
-        widget = loader.load(file, parent)
-        file.close()
-        return widget
-
-    def load_ui_pyqt6(self, ui_file, parent=None):
-        """
-        Specific loader for PyQt6 using loadUi.
-        Args:
-            ui_file(str): Path to the .ui file.
-            parent(QWidget): Parent widget.
-
-        Returns:
-            QWidget: The loaded widget.
-        """
-        from PyQt6.uic.Loader.loader import DynamicUILoader
-
-        class CustomDynamicUILoader(DynamicUILoader):
-            def __init__(self, package, custom_widgets: dict = None):
-                super().__init__(package)
-                self.custom_widgets = custom_widgets or {}
-
-            def _handle_custom_widgets(self, el):
-                """Handle the <customwidgets> element."""
-
-                def header2module(header):
-                    """header2module(header) -> string
-
-                    Convert paths to C++ header files to according Python modules
-                    >>> header2module("foo/bar/baz.h")
-                    'foo.bar.baz'
-                    """
-
-                    if header.endswith(".h"):
-                        header = header[:-2]
-
-                    mpath = []
-                    for part in header.split("/"):
-                        # Ignore any empty parts or those that refer to the current
-                        # directory.
-                        if part not in ("", "."):
-                            if part == "..":
-                                # We should allow this for Python3.
-                                raise SyntaxError(
-                                    "custom widget header file name may not contain '..'."
-                                )
-
-                            mpath.append(part)
-
-                    return ".".join(mpath)
-
-                for custom_widget in el:
-                    classname = custom_widget.findtext("class")
-                    header = custom_widget.findtext("header")
-                    if header:
-                        header = self._translate_bec_widgets_header(header)
-                    self.factory.addCustomWidget(
-                        classname,
-                        custom_widget.findtext("extends") or "QWidget",
-                        header2module(header),
-                    )
-
-            def _translate_bec_widgets_header(self, header):
-                for name, value in self.custom_widgets.items():
-                    if header == DesignerPluginInfo.pascal_to_snake(name):
-                        return value.__module__
-                return header
-
-        return CustomDynamicUILoader("", self.custom_widgets).loadUi(ui_file, parent)
-
-    def load_ui(self, ui_file, parent=None):
-        """
-        Universal UI loader method.
-        Args:
-            ui_file(str): Path to the .ui file.
-            parent(QWidget): Parent widget.
-
-        Returns:
-            QWidget: The loaded widget.
-        """
-        if parent is None:
-            parent = self.parent
-        return self.loader(ui_file, parent)

bec_widgets/utils/validator_delegate.py

@@ -1,13 +0,0 @@
-# from qtpy.QtGui import QDoubleValidator
-# from qtpy.QtWidgets import QStyledItemDelegate, QLineEdit
-
-from qtpy.QtGui import QDoubleValidator
-from qtpy.QtWidgets import QLineEdit, QStyledItemDelegate
-
-
-class DoubleValidationDelegate(QStyledItemDelegate):
-    def createEditor(self, parent, option, index):
-        editor = QLineEdit(parent)
-        validator = QDoubleValidator()
-        editor.setValidator(validator)
-        return editor

bec_widgets/utils/widget_io.py

@@ -1,367 +0,0 @@
-# pylint: disable=no-name-in-module
-from abc import ABC, abstractmethod
-from typing import Literal
-
-from qtpy.QtWidgets import (
-    QApplication,
-    QCheckBox,
-    QComboBox,
-    QDoubleSpinBox,
-    QLabel,
-    QLineEdit,
-    QSpinBox,
-    QTableWidget,
-    QTableWidgetItem,
-    QVBoxLayout,
-    QWidget,
-)
-
-
-class WidgetHandler(ABC):
-    """Abstract base class for all widget handlers."""
-
-    @abstractmethod
-    def get_value(self, widget: QWidget, **kwargs):
-        """Retrieve value from the widget instance."""
-
-    @abstractmethod
-    def set_value(self, widget: QWidget, value):
-        """Set a value on the widget instance."""
-
-
-class LineEditHandler(WidgetHandler):
-    """Handler for QLineEdit widgets."""
-
-    def get_value(self, widget: QLineEdit, **kwargs) -> str:
-        return widget.text()
-
-    def set_value(self, widget: QLineEdit, value: str) -> None:
-        widget.setText(value)
-
-
-class ComboBoxHandler(WidgetHandler):
-    """Handler for QComboBox widgets."""
-
-    def get_value(self, widget: QComboBox, as_string: bool = False, **kwargs) -> int | str:
-        if as_string is True:
-            return widget.currentText()
-        return widget.currentIndex()
-
-    def set_value(self, widget: QComboBox, value: int | str) -> None:
-        if isinstance(value, str):
-            value = widget.findText(value)
-        if isinstance(value, int):
-            widget.setCurrentIndex(value)
-
-
-class TableWidgetHandler(WidgetHandler):
-    """Handler for QTableWidget widgets."""
-
-    def get_value(self, widget: QTableWidget, **kwargs) -> list:
-        return [
-            [
-                widget.item(row, col).text() if widget.item(row, col) else ""
-                for col in range(widget.columnCount())
-            ]
-            for row in range(widget.rowCount())
-        ]
-
-    def set_value(self, widget: QTableWidget, value) -> None:
-        for row, row_values in enumerate(value):
-            for col, cell_value in enumerate(row_values):
-                item = QTableWidgetItem(str(cell_value))
-                widget.setItem(row, col, item)
-
-
-class SpinBoxHandler(WidgetHandler):
-    """Handler for QSpinBox and QDoubleSpinBox widgets."""
-
-    def get_value(self, widget, **kwargs):
-        return widget.value()
-
-    def set_value(self, widget, value):
-        widget.setValue(value)
-
-
-class CheckBoxHandler(WidgetHandler):
-    """Handler for QCheckBox widgets."""
-
-    def get_value(self, widget, **kwargs):
-        return widget.isChecked()
-
-    def set_value(self, widget, value):
-        widget.setChecked(value)
-
-
-class LabelHandler(WidgetHandler):
-    """Handler for QLabel widgets."""
-
-    def get_value(self, widget, **kwargs):
-        return widget.text()
-
-    def set_value(self, widget, value):
-        widget.setText(value)
-
-
-class WidgetIO:
-    """Public interface for getting and setting values using handler mapping"""
-
-    _handlers = {
-        QLineEdit: LineEditHandler,
-        QComboBox: ComboBoxHandler,
-        QTableWidget: TableWidgetHandler,
-        QSpinBox: SpinBoxHandler,
-        QDoubleSpinBox: SpinBoxHandler,
-        QCheckBox: CheckBoxHandler,
-        QLabel: LabelHandler,
-    }
-
-    @staticmethod
-    def get_value(widget, ignore_errors=False, **kwargs):
-        """
-        Retrieve value from the widget instance.
-
-        Args:
-            widget: Widget instance.
-            ignore_errors(bool, optional): Whether to ignore if no handler is found.
-        """
-        handler_class = WidgetIO._find_handler(widget)
-        if handler_class:
-            return handler_class().get_value(widget, **kwargs)  # Instantiate the handler
-        if not ignore_errors:
-            raise ValueError(f"No handler for widget type: {type(widget)}")
-        return None
-
-    @staticmethod
-    def set_value(widget, value, ignore_errors=False):
-        """
-        Set a value on the widget instance.
-
-        Args:
-            widget: Widget instance.
-            value: Value to set.
-            ignore_errors(bool, optional): Whether to ignore if no handler is found.
-        """
-        handler_class = WidgetIO._find_handler(widget)
-        if handler_class:
-            handler_class().set_value(widget, value)  # Instantiate the handler
-        elif not ignore_errors:
-            raise ValueError(f"No handler for widget type: {type(widget)}")
-
-    @staticmethod
-    def check_and_adjust_limits(spin_box: QDoubleSpinBox, number: float):
-        """
-        Check if the new limits are within the current limits, if not adjust the limits.
-
-        Args:
-            number(float): The new value to check against the limits.
-        """
-
-        min_value = spin_box.minimum()
-        max_value = spin_box.maximum()
-
-        # Calculate the new limits
-        new_limit = number + 5 * number
-
-        if number < min_value:
-            spin_box.setMinimum(new_limit)
-        elif number > max_value:
-            spin_box.setMaximum(new_limit)
-
-    @staticmethod
-    def _find_handler(widget):
-        """
-        Find the appropriate handler for the widget by checking its base classes.
-
-        Args:
-            widget: Widget instance.
-
-        Returns:
-            handler_class: The handler class if found, otherwise None.
-        """
-        for base in type(widget).__mro__:
-            if base in WidgetIO._handlers:
-                return WidgetIO._handlers[base]
-        return None
-
-
-################## for exporting and importing widget hierarchies ##################
-
-
-class WidgetHierarchy:
-    @staticmethod
-    def print_widget_hierarchy(
-        widget,
-        indent: int = 0,
-        grab_values: bool = False,
-        prefix: str = "",
-        exclude_internal_widgets: bool = True,
-    ) -> None:
-        """
-        Print the widget hierarchy to the console.
-
-        Args:
-            widget: Widget to print the hierarchy of
-            indent(int, optional): Level of indentation.
-            grab_values(bool,optional): Whether to grab the values of the widgets.
-            prefix(stc,optional): Custom string prefix for indentation.
-            exclude_internal_widgets(bool,optional): Whether to exclude internal widgets (e.g. QComboBox in PyQt6).
-        """
-        widget_info = f"{widget.__class__.__name__} ({widget.objectName()})"
-        if grab_values:
-            value = WidgetIO.get_value(widget, ignore_errors=True)
-            value_str = f" [value: {value}]" if value is not None else ""
-            widget_info += value_str
-
-        print(prefix + widget_info)
-
-        children = widget.children()
-        for child in children:
-            if (
-                exclude_internal_widgets
-                and isinstance(widget, QComboBox)
-                and child.__class__.__name__ in ["QFrame", "QBoxLayout", "QListView"]
-            ):
-                continue
-            child_prefix = prefix + "  "
-            arrow = "├─ " if child != children[-1] else "└─ "
-            WidgetHierarchy.print_widget_hierarchy(
-                child, indent + 1, grab_values, prefix=child_prefix + arrow
-            )
-
-    @staticmethod
-    def export_config_to_dict(
-        widget: QWidget,
-        config: dict = None,
-        indent: int = 0,
-        grab_values: bool = False,
-        print_hierarchy: bool = False,
-        save_all: bool = True,
-        exclude_internal_widgets: bool = True,
-    ) -> dict:
-        """
-        Export the widget hierarchy to a dictionary.
-
-        Args:
-            widget: Widget to print the hierarchy of.
-            config(dict,optional): Dictionary to export the hierarchy to.
-            indent(int,optional): Level of indentation.
-            grab_values(bool,optional): Whether to grab the values of the widgets.
-            print_hierarchy(bool,optional): Whether to print the hierarchy to the console.
-            save_all(bool,optional): Whether to save all widgets or only those with values.
-            exclude_internal_widgets(bool,optional): Whether to exclude internal widgets (e.g. QComboBox in PyQt6).
-        Returns:
-            config(dict): Dictionary containing the widget hierarchy.
-        """
-        if config is None:
-            config = {}
-        widget_info = f"{widget.__class__.__name__} ({widget.objectName()})"
-
-        # if grab_values and type(widget) in WidgetIO._handlers:
-        if grab_values:
-            value = WidgetIO.get_value(widget, ignore_errors=True)
-            if value is not None or save_all:
-                if widget_info not in config:
-                    config[widget_info] = {}
-                if value is not None:
-                    config[widget_info]["value"] = value
-
-        if print_hierarchy:
-            WidgetHierarchy.print_widget_hierarchy(widget, indent, grab_values)
-
-        for child in widget.children():
-            # Skip internal widgets of QComboBox in PyQt6
-            if (
-                exclude_internal_widgets
-                and isinstance(widget, QComboBox)
-                and child.__class__.__name__ in ["QFrame", "QBoxLayout", "QListView"]
-            ):
-                continue
-            child_config = WidgetHierarchy.export_config_to_dict(
-                child, None, indent + 1, grab_values, print_hierarchy, save_all
-            )
-            if child_config or save_all:
-                if widget_info not in config:
-                    config[widget_info] = {}
-                config[widget_info].update(child_config)
-
-        return config
-
-    @staticmethod
-    def import_config_from_dict(widget, config: dict, set_values: bool = False) -> None:
-        """
-        Import the widget hierarchy from a dictionary.
-
-        Args:
-            widget: Widget to import the hierarchy to.
-            config:
-            set_values:
-        """
-        widget_name = f"{widget.__class__.__name__} ({widget.objectName()})"
-        widget_config = config.get(widget_name, {})
-        for child in widget.children():
-            child_name = f"{child.__class__.__name__} ({child.objectName()})"
-            child_config = widget_config.get(child_name)
-            if child_config is not None:
-                value = child_config.get("value")
-                if set_values and value is not None:
-                    WidgetIO.set_value(child, value)
-                WidgetHierarchy.import_config_from_dict(child, widget_config, set_values)
-
-
-# Example application to demonstrate the usage of the functions
-if __name__ == "__main__":  # pragma: no cover
-    app = QApplication([])
-
-    # Create instance of WidgetHierarchy
-    widget_hierarchy = WidgetHierarchy()
-
-    # Create a simple widget hierarchy for demonstration purposes
-    main_widget = QWidget()
-    layout = QVBoxLayout(main_widget)
-    line_edit = QLineEdit(main_widget)
-    combo_box = QComboBox(main_widget)
-    table_widget = QTableWidget(2, 2, main_widget)
-    spin_box = QSpinBox(main_widget)
-    layout.addWidget(line_edit)
-    layout.addWidget(combo_box)
-    layout.addWidget(table_widget)
-    layout.addWidget(spin_box)
-
-    # Add text items to the combo box
-    combo_box.addItems(["Option 1", "Option 2", "Option 3"])
-
-    main_widget.show()
-
-    # Hierarchy of original widget
-    print(30 * "#")
-    print(f"Widget hierarchy for {main_widget.objectName()}:")
-    print(30 * "#")
-    config_dict = widget_hierarchy.export_config_to_dict(
-        main_widget, grab_values=True, print_hierarchy=True
-    )
-    print(30 * "#")
-    print(f"Config dict: {config_dict}")
-
-    # Hierarchy of new widget and set values
-    new_config_dict = {
-        "QWidget ()": {
-            "QLineEdit ()": {"value": "New Text"},
-            "QComboBox ()": {"value": 1},
-            "QTableWidget ()": {"value": [["a", "b"], ["c", "d"]]},
-            "QSpinBox ()": {"value": 10},
-        }
-    }
-    widget_hierarchy.import_config_from_dict(main_widget, new_config_dict, set_values=True)
-    print(30 * "#")
-    config_dict_new = widget_hierarchy.export_config_to_dict(
-        main_widget, grab_values=True, print_hierarchy=True
-    )
-    config_dict_new_reduced = widget_hierarchy.export_config_to_dict(
-        main_widget, grab_values=True, print_hierarchy=True, save_all=False
-    )
-    print(30 * "#")
-    print(f"Config dict new FULL: {config_dict_new}")
-    print(f"Config dict new REDUCED: {config_dict_new_reduced}")
-
-    app.exec()

bec_widgets/utils/yaml_dialog.py

@@ -1,88 +0,0 @@
-# pylint: disable=no-name-in-module
-
-from typing import Union
-
-import yaml
-from qtpy.QtWidgets import QFileDialog
-
-
-def load_yaml_gui(instance) -> Union[dict, None]:
-    """
-    Load YAML file from disk.
-
-    Args:
-        instance: Instance of the calling widget.
-
-    Returns:
-        dict: Configuration data loaded from the YAML file.
-    """
-    options = QFileDialog.Options()
-    file_path, _ = QFileDialog.getOpenFileName(
-        instance, "Load Settings", "", "YAML Files (*.yaml *.yml);;All Files (*)", options=options
-    )
-    config = load_yaml(file_path)
-    return config
-
-
-def load_yaml(file_path: str) -> Union[dict, None]:
-    """
-    Load YAML file from disk.
-
-    Args:
-        file_path(str): Path to the YAML file.
-
-    Returns:
-        dict: Configuration data loaded from the YAML file.
-    """
-    if not file_path:
-        return None
-    try:
-        with open(file_path, "r") as file:
-            config = yaml.load(file, Loader=yaml.FullLoader)
-        return config
-
-    except FileNotFoundError:
-        print(f"The file {file_path} was not found.")
-    except PermissionError:
-        print(f"Permission denied for file {file_path}.")
-    except yaml.YAMLError as e:
-        print(f"Error parsing YAML file {file_path}: {e}")
-    except Exception as e:
-        print(f"An error occurred while loading the settings from {file_path}: {e}")
-
-
-def save_yaml_gui(instance, config: dict) -> None:
-    """
-    Save YAML file to disk.
-
-    Args:
-        instance: Instance of the calling widget.
-        config: Configuration data to be saved.
-    """
-    options = QFileDialog.Options()
-    file_path, _ = QFileDialog.getSaveFileName(
-        instance, "Save Settings", "", "YAML Files (*.yaml *.yml);;All Files (*)", options=options
-    )
-
-    save_yaml(file_path, config)
-
-
-def save_yaml(file_path: str, config: dict) -> None:
-    """
-    Save YAML file to disk.
-
-    Args:
-        file_path(str): Path to the YAML file.
-        config(dict): Configuration data to be saved.
-    """
-    if not file_path:
-        return
-    try:
-        if not (file_path.endswith(".yaml") or file_path.endswith(".yml")):
-            file_path += ".yaml"
-
-        with open(file_path, "w") as file:
-            yaml.dump(config, file)
-            print(f"Settings saved to {file_path}")
-    except Exception as e:
-        print(f"An error occurred while saving the settings to {file_path}: {e}")

bec_widgets/widgets/__init__.py

@@ -1 +0,0 @@
-

bec_widgets/widgets/containers/dock/__init__.py

@@ -1,2 +0,0 @@
-from .dock import BECDock
-from .dock_area import BECDockArea

bec_widgets/widgets/containers/dock/dock.py

@@ -1,335 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any, Literal, Optional
-
-from pydantic import Field
-from pyqtgraph.dockarea import Dock, DockLabel
-from qtpy import QtCore, QtGui
-
-from bec_widgets.cli.rpc_wigdet_handler import widget_handler
-from bec_widgets.utils import ConnectionConfig, GridLayoutManager
-from bec_widgets.utils.bec_widget import BECWidget
-
-if TYPE_CHECKING:
-    from qtpy.QtWidgets import QWidget
-
-
-class DockConfig(ConnectionConfig):
-    widgets: dict[str, Any] = Field({}, description="The widgets in the dock.")
-    position: Literal["bottom", "top", "left", "right", "above", "below"] = Field(
-        "bottom", description="The position of the dock."
-    )
-    parent_dock_area: Optional[str] = Field(
-        None, description="The GUI ID of parent dock area of the dock."
-    )
-
-
-class CustomDockLabel(DockLabel):
-    def __init__(self, text: str, closable: bool = True):
-        super().__init__(text, closable)
-        if closable:
-            red_icon = QtGui.QIcon()
-            pixmap = QtGui.QPixmap(32, 32)
-            pixmap.fill(QtCore.Qt.GlobalColor.red)
-            painter = QtGui.QPainter(pixmap)
-            pen = QtGui.QPen(QtCore.Qt.GlobalColor.white)
-            pen.setWidth(2)
-            painter.setPen(pen)
-            painter.drawLine(8, 8, 24, 24)
-            painter.drawLine(24, 8, 8, 24)
-            painter.end()
-            red_icon.addPixmap(pixmap)
-
-            self.closeButton.setIcon(red_icon)
-
-    def updateStyle(self):
-        r = "3px"
-        if self.dim:
-            fg = "#aaa"
-            bg = "#44a"
-            border = "#339"
-        else:
-            fg = "#fff"
-            bg = "#3f4042"
-            border = "#3f4042"
-
-        if self.orientation == "vertical":
-            self.vStyle = """DockLabel {
-                background-color : %s;
-                color : %s;
-                border-top-right-radius: 0px;
-                border-top-left-radius: %s;
-                border-bottom-right-radius: 0px;
-                border-bottom-left-radius: %s;
-                border-width: 0px;
-                border-right: 2px solid %s;
-                padding-top: 3px;
-                padding-bottom: 3px;
-                font-size: %s;
-            }""" % (
-                bg,
-                fg,
-                r,
-                r,
-                border,
-                self.fontSize,
-            )
-            self.setStyleSheet(self.vStyle)
-        else:
-            self.hStyle = """DockLabel {
-                background-color : %s;
-                color : %s;
-                border-top-right-radius: %s;
-                border-top-left-radius: %s;
-                border-bottom-right-radius: 0px;
-                border-bottom-left-radius: 0px;
-                border-width: 0px;
-                border-bottom: 2px solid %s;
-                padding-left: 3px;
-                padding-right: 3px;
-                font-size: %s;
-            }""" % (
-                bg,
-                fg,
-                r,
-                r,
-                border,
-                self.fontSize,
-            )
-            self.setStyleSheet(self.hStyle)
-
-
-class BECDock(BECWidget, Dock):
-    ICON_NAME = "widgets"
-    USER_ACCESS = [
-        "_config_dict",
-        "_rpc_id",
-        "widget_list",
-        "show_title_bar",
-        "hide_title_bar",
-        "get_widgets_positions",
-        "set_title",
-        "add_widget",
-        "list_eligible_widgets",
-        "move_widget",
-        "remove_widget",
-        "remove",
-        "attach",
-        "detach",
-    ]
-
-    def __init__(
-        self,
-        parent: QWidget | None = None,
-        parent_dock_area: QWidget | None = None,
-        config: DockConfig | None = None,
-        name: str | None = None,
-        client=None,
-        gui_id: str | None = None,
-        closable: bool = True,
-        **kwargs,
-    ) -> None:
-        if config is None:
-            config = DockConfig(
-                widget_class=self.__class__.__name__, parent_dock_area=parent_dock_area.gui_id
-            )
-        else:
-            if isinstance(config, dict):
-                config = DockConfig(**config)
-            self.config = config
-        super().__init__(client=client, config=config, gui_id=gui_id)
-        label = CustomDockLabel(text=name, closable=closable)
-        Dock.__init__(self, name=name, label=label, **kwargs)
-        # Dock.__init__(self, name=name, **kwargs)
-
-        self.parent_dock_area = parent_dock_area
-
-        # Layout Manager
-        self.layout_manager = GridLayoutManager(self.layout)
-
-    def dropEvent(self, event):
-        source = event.source()
-        old_area = source.area
-        self.setOrientation("horizontal", force=True)
-        super().dropEvent(event)
-        if old_area in self.orig_area.tempAreas and old_area != self.orig_area:
-            self.orig_area.removeTempArea(old_area)
-            old_area.window().deleteLater()
-
-    def float(self):
-        """
-        Float the dock.
-        Overwrites the default pyqtgraph dock float.
-        """
-
-        # need to check if the dock is temporary and if it is the only dock in the area
-        # fixes bug in pyqtgraph detaching
-        if self.area.temporary == True and len(self.area.docks) <= 1:
-            return
-        elif self.area.temporary == True and len(self.area.docks) > 1:
-            self.area.docks.pop(self.name(), None)
-            super().float()
-        else:
-            super().float()
-
-    @property
-    def widget_list(self) -> list[BECWidget]:
-        """
-        Get the widgets in the dock.
-
-        Returns:
-            widgets(list): The widgets in the dock.
-        """
-        return self.widgets
-
-    @widget_list.setter
-    def widget_list(self, value: list[BECWidget]):
-        self.widgets = value
-
-    def hide_title_bar(self):
-        """
-        Hide the title bar of the dock.
-        """
-        # self.hideTitleBar() #TODO pyqtgraph looks bugged ATM, doing my implementation
-        self.label.hide()
-        self.labelHidden = True
-
-    def show_title_bar(self):
-        """
-        Hide the title bar of the dock.
-        """
-        # self.showTitleBar() #TODO pyqtgraph looks bugged ATM, doing my implementation
-        self.label.show()
-        self.labelHidden = False
-
-    def set_title(self, title: str):
-        """
-        Set the title of the dock.
-
-        Args:
-            title(str): The title of the dock.
-        """
-        self.orig_area.docks[title] = self.orig_area.docks.pop(self.name())
-        self.setTitle(title)
-        self._name = title
-
-    def get_widgets_positions(self) -> dict:
-        """
-        Get the positions of the widgets in the dock.
-
-        Returns:
-            dict: The positions of the widgets in the dock as dict -> {(row, col, rowspan, colspan):widget}
-        """
-        return self.layout_manager.get_widgets_positions()
-
-    def list_eligible_widgets(
-        self,
-    ) -> list:  # TODO can be moved to some util mixin like container class for rpc widgets
-        """
-        List all widgets that can be added to the dock.
-
-        Returns:
-            list: The list of eligible widgets.
-        """
-        return list(widget_handler.widget_classes.keys())
-
-    def add_widget(
-        self,
-        widget: BECWidget | str,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
-        shift: Literal["down", "up", "left", "right"] = "down",
-    ) -> BECWidget:
-        """
-        Add a widget to the dock.
-
-        Args:
-            widget(QWidget): The widget to add.
-            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
-            col(int): The column to add the widget to.
-            rowspan(int): The number of rows the widget should span.
-            colspan(int): The number of columns the widget should span.
-            shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
-        """
-        if row is None:
-            row = self.layout.rowCount()
-
-        if self.layout_manager.is_position_occupied(row, col):
-            self.layout_manager.shift_widgets(shift, start_row=row)
-
-        if isinstance(widget, str):
-            widget = widget_handler.create_widget(widget)
-        else:
-            widget = widget
-
-        self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-
-        if hasattr(widget, "config"):
-            self.config.widgets[widget.gui_id] = widget.config
-
-        return widget
-
-    def move_widget(self, widget: QWidget, new_row: int, new_col: int):
-        """
-        Move a widget to a new position in the layout.
-
-        Args:
-            widget(QWidget): The widget to move.
-            new_row(int): The new row to move the widget to.
-            new_col(int): The new column to move the widget to.
-        """
-        self.layout_manager.move_widget(widget, new_row, new_col)
-
-    def attach(self):
-        """
-        Attach the dock to the parent dock area.
-        """
-        self.parent_dock_area.remove_temp_area(self.area)
-
-    def detach(self):
-        """
-        Detach the dock from the parent dock area.
-        """
-        self.float()
-
-    def remove_widget(self, widget_rpc_id: str):
-        """
-        Remove a widget from the dock.
-
-        Args:
-            widget_rpc_id(str): The ID of the widget to remove.
-        """
-        widget = self.rpc_register.get_rpc_by_id(widget_rpc_id)
-        self.layout.removeWidget(widget)
-        self.config.widgets.pop(widget_rpc_id, None)
-        widget.close()
-
-    def remove(self):
-        """
-        Remove the dock from the parent dock area.
-        """
-        # self.cleanup()
-        self.parent_dock_area.remove_dock(self.name())
-
-    def cleanup(self):
-        """
-        Clean up the dock, including all its widgets.
-        """
-        for widget in self.widgets:
-            if hasattr(widget, "cleanup"):
-                widget.cleanup()
-        self.widgets.clear()
-        self.label.close()
-        self.label.deleteLater()
-        super().cleanup()
-
-    def close(self):
-        """
-        Close the dock area and cleanup.
-        Has to be implemented to overwrite pyqtgraph event accept in Container close.
-        """
-        self.cleanup()
-        super().close()
-        self.parent_dock_area.dock_area.docks.pop(self.name(), None)

bec_widgets/widgets/containers/dock/dock_area.py

@@ -1,439 +0,0 @@
-from __future__ import annotations
-
-from typing import Literal, Optional
-from weakref import WeakValueDictionary
-
-from pydantic import Field
-from pyqtgraph.dockarea.DockArea import DockArea
-from qtpy.QtCore import Qt
-from qtpy.QtGui import QPainter, QPaintEvent
-from qtpy.QtWidgets import QSizePolicy, QVBoxLayout, QWidget
-
-from bec_widgets.qt_utils.error_popups import SafeSlot
-from bec_widgets.qt_utils.toolbar import (
-    ExpandableMenuAction,
-    MaterialIconAction,
-    ModularToolBar,
-    SeparatorAction,
-)
-from bec_widgets.utils import ConnectionConfig, WidgetContainerUtils
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.widgets.containers.dock.dock import BECDock, DockConfig
-from bec_widgets.widgets.control.device_control.positioner_box.positioner_box import PositionerBox
-from bec_widgets.widgets.control.scan_control.scan_control import ScanControl
-from bec_widgets.widgets.editors.vscode.vscode import VSCodeEditor
-from bec_widgets.widgets.plots.image.image_widget import BECImageWidget
-from bec_widgets.widgets.plots.motor_map.motor_map_widget import BECMotorMapWidget
-from bec_widgets.widgets.plots.multi_waveform.multi_waveform_widget import BECMultiWaveformWidget
-from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
-from bec_widgets.widgets.progress.ring_progress_bar.ring_progress_bar import RingProgressBar
-from bec_widgets.widgets.services.bec_queue.bec_queue import BECQueue
-from bec_widgets.widgets.services.bec_status_box.bec_status_box import BECStatusBox
-from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
-
-
-class DockAreaConfig(ConnectionConfig):
-    docks: dict[str, DockConfig] = Field({}, description="The docks in the dock area.")
-    docks_state: Optional[dict] = Field(
-        None, description="The state of the docks in the dock area."
-    )
-
-
-class BECDockArea(BECWidget, QWidget):
-    PLUGIN = True
-    USER_ACCESS = [
-        "_config_dict",
-        "panels",
-        "save_state",
-        "remove_dock",
-        "restore_state",
-        "add_dock",
-        "clear_all",
-        "detach_dock",
-        "attach_all",
-        "_get_all_rpc",
-        "temp_areas",
-        "show",
-        "hide",
-    ]
-
-    def __init__(
-        self,
-        parent: QWidget | None = None,
-        config: DockAreaConfig | None = None,
-        client=None,
-        gui_id: str = None,
-    ) -> None:
-        if config is None:
-            config = DockAreaConfig(widget_class=self.__class__.__name__)
-        else:
-            if isinstance(config, dict):
-                config = DockAreaConfig(**config)
-            self.config = config
-        super().__init__(client=client, config=config, gui_id=gui_id)
-        QWidget.__init__(self, parent=parent)
-        self.layout = QVBoxLayout(self)
-        self.layout.setSpacing(5)
-        self.layout.setContentsMargins(0, 0, 0, 0)
-
-        self._instructions_visible = True
-
-        self.dock_area = DockArea()
-        self.toolbar = ModularToolBar(
-            actions={
-                "menu_plots": ExpandableMenuAction(
-                    label="Add Plot ",
-                    actions={
-                        "waveform": MaterialIconAction(
-                            icon_name=BECWaveformWidget.ICON_NAME,
-                            tooltip="Add Waveform",
-                            filled=True,
-                        ),
-                        "multi_waveform": MaterialIconAction(
-                            icon_name=BECMultiWaveformWidget.ICON_NAME,
-                            tooltip="Add Multi Waveform",
-                            filled=True,
-                        ),
-                        "image": MaterialIconAction(
-                            icon_name=BECImageWidget.ICON_NAME, tooltip="Add Image", filled=True
-                        ),
-                        "motor_map": MaterialIconAction(
-                            icon_name=BECMotorMapWidget.ICON_NAME,
-                            tooltip="Add Motor Map",
-                            filled=True,
-                        ),
-                    },
-                ),
-                "separator_0": SeparatorAction(),
-                "menu_devices": ExpandableMenuAction(
-                    label="Add Device Control ",
-                    actions={
-                        "scan_control": MaterialIconAction(
-                            icon_name=ScanControl.ICON_NAME, tooltip="Add Scan Control", filled=True
-                        ),
-                        "positioner_box": MaterialIconAction(
-                            icon_name=PositionerBox.ICON_NAME, tooltip="Add Device Box", filled=True
-                        ),
-                    },
-                ),
-                "separator_1": SeparatorAction(),
-                "menu_utils": ExpandableMenuAction(
-                    label="Add Utils ",
-                    actions={
-                        "queue": MaterialIconAction(
-                            icon_name=BECQueue.ICON_NAME, tooltip="Add Scan Queue", filled=True
-                        ),
-                        "vs_code": MaterialIconAction(
-                            icon_name=VSCodeEditor.ICON_NAME, tooltip="Add VS Code", filled=True
-                        ),
-                        "status": MaterialIconAction(
-                            icon_name=BECStatusBox.ICON_NAME,
-                            tooltip="Add BEC Status Box",
-                            filled=True,
-                        ),
-                        "progress_bar": MaterialIconAction(
-                            icon_name=RingProgressBar.ICON_NAME,
-                            tooltip="Add Circular ProgressBar",
-                            filled=True,
-                        ),
-                    },
-                ),
-                "separator_2": SeparatorAction(),
-                "attach_all": MaterialIconAction(
-                    icon_name="zoom_in_map", tooltip="Attach all floating docks"
-                ),
-                "save_state": MaterialIconAction(icon_name="bookmark", tooltip="Save Dock State"),
-                "restore_state": MaterialIconAction(
-                    icon_name="frame_reload", tooltip="Restore Dock State"
-                ),
-            },
-            target_widget=self,
-        )
-
-        self.layout.addWidget(self.toolbar)
-        self.layout.addWidget(self.dock_area)
-        self.spacer = QWidget()
-        self.spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-        self.toolbar.addWidget(self.spacer)
-        self.toolbar.addWidget(DarkModeButton(toolbar=True))
-        self._hook_toolbar()
-
-    def _hook_toolbar(self):
-        # Menu Plot
-        self.toolbar.widgets["menu_plots"].widgets["waveform"].triggered.connect(
-            lambda: self.add_dock(widget="BECWaveformWidget", prefix="waveform")
-        )
-        self.toolbar.widgets["menu_plots"].widgets["multi_waveform"].triggered.connect(
-            lambda: self.add_dock(widget="BECMultiWaveformWidget", prefix="multi_waveform")
-        )
-        self.toolbar.widgets["menu_plots"].widgets["image"].triggered.connect(
-            lambda: self.add_dock(widget="BECImageWidget", prefix="image")
-        )
-        self.toolbar.widgets["menu_plots"].widgets["motor_map"].triggered.connect(
-            lambda: self.add_dock(widget="BECMotorMapWidget", prefix="motor_map")
-        )
-
-        # Menu Devices
-        self.toolbar.widgets["menu_devices"].widgets["scan_control"].triggered.connect(
-            lambda: self.add_dock(widget="ScanControl", prefix="scan_control")
-        )
-        self.toolbar.widgets["menu_devices"].widgets["positioner_box"].triggered.connect(
-            lambda: self.add_dock(widget="PositionerBox", prefix="positioner_box")
-        )
-
-        # Menu Utils
-        self.toolbar.widgets["menu_utils"].widgets["queue"].triggered.connect(
-            lambda: self.add_dock(widget="BECQueue", prefix="queue")
-        )
-        self.toolbar.widgets["menu_utils"].widgets["status"].triggered.connect(
-            lambda: self.add_dock(widget="BECStatusBox", prefix="status")
-        )
-        self.toolbar.widgets["menu_utils"].widgets["vs_code"].triggered.connect(
-            lambda: self.add_dock(widget="VSCodeEditor", prefix="vs_code")
-        )
-        self.toolbar.widgets["menu_utils"].widgets["progress_bar"].triggered.connect(
-            lambda: self.add_dock(widget="RingProgressBar", prefix="progress_bar")
-        )
-
-        # Icons
-        self.toolbar.widgets["attach_all"].action.triggered.connect(self.attach_all)
-        self.toolbar.widgets["save_state"].action.triggered.connect(self.save_state)
-        self.toolbar.widgets["restore_state"].action.triggered.connect(self.restore_state)
-
-    def paintEvent(self, event: QPaintEvent):  # TODO decide if we want any default instructions
-        super().paintEvent(event)
-        if self._instructions_visible:
-            painter = QPainter(self)
-            painter.drawText(
-                self.rect(),
-                Qt.AlignCenter,
-                "Add docks using 'add_dock' method from CLI\n or \n Add widget docks using the toolbar",
-            )
-
-    @property
-    def panels(self) -> dict[str, BECDock]:
-        """
-        Get the docks in the dock area.
-        Returns:
-            dock_dict(dict): The docks in the dock area.
-        """
-        return dict(self.dock_area.docks)
-
-    @panels.setter
-    def panels(self, value: dict[str, BECDock]):
-        self.dock_area.docks = WeakValueDictionary(value)
-
-    @property
-    def temp_areas(self) -> list:
-        """
-        Get the temporary areas in the dock area.
-
-        Returns:
-            list: The temporary areas in the dock area.
-        """
-        return list(map(str, self.dock_area.tempAreas))
-
-    @temp_areas.setter
-    def temp_areas(self, value: list):
-        self.dock_area.tempAreas = list(map(str, value))
-
-    @SafeSlot()
-    def restore_state(
-        self, state: dict = None, missing: Literal["ignore", "error"] = "ignore", extra="bottom"
-    ):
-        """
-        Restore the state of the dock area. If no state is provided, the last state is restored.
-
-        Args:
-            state(dict): The state to restore.
-            missing(Literal['ignore','error']): What to do if a dock is missing.
-            extra(str): Extra docks that are in the dockarea but that are not mentioned in state will be added to the bottom of the dockarea, unless otherwise specified by the extra argument.
-        """
-        if state is None:
-            state = self.config.docks_state
-        self.dock_area.restoreState(state, missing=missing, extra=extra)
-
-    @SafeSlot()
-    def save_state(self) -> dict:
-        """
-        Save the state of the dock area.
-
-        Returns:
-            dict: The state of the dock area.
-        """
-        last_state = self.dock_area.saveState()
-        self.config.docks_state = last_state
-        return last_state
-
-    def remove_dock(self, name: str):
-        """
-        Remove a dock by name and ensure it is properly closed and cleaned up.
-
-        Args:
-            name(str): The name of the dock to remove.
-        """
-        dock = self.dock_area.docks.pop(name, None)
-        self.config.docks.pop(name, None)
-        if dock:
-            dock.close()
-            dock.deleteLater()
-            if len(self.dock_area.docks) <= 1:
-                for dock in self.dock_area.docks.values():
-                    dock.hide_title_bar()
-
-        else:
-            raise ValueError(f"Dock with name {name} does not exist.")
-
-    @SafeSlot(popup_error=True)
-    def add_dock(
-        self,
-        name: str = None,
-        position: Literal["bottom", "top", "left", "right", "above", "below"] = None,
-        relative_to: BECDock | None = None,
-        closable: bool = True,
-        floating: bool = False,
-        prefix: str = "dock",
-        widget: str | QWidget | None = None,
-        row: int = None,
-        col: int = 0,
-        rowspan: int = 1,
-        colspan: int = 1,
-    ) -> BECDock:
-        """
-        Add a dock to the dock area. Dock has QGridLayout as layout manager by default.
-
-        Args:
-            name(str): The name of the dock to be displayed and for further references. Has to be unique.
-            position(Literal["bottom", "top", "left", "right", "above", "below"]): The position of the dock.
-            relative_to(BECDock): The dock to which the new dock should be added relative to.
-            closable(bool): Whether the dock is closable.
-            floating(bool): Whether the dock is detached after creating.
-            prefix(str): The prefix for the dock name if no name is provided.
-            widget(str|QWidget|None): The widget to be added to the dock. While using RPC, only BEC RPC widgets from RPCWidgetHandler are allowed.
-            row(int): The row of the added widget.
-            col(int): The column of the added widget.
-            rowspan(int): The rowspan of the added widget.
-            colspan(int): The colspan of the added widget.
-
-        Returns:
-            BECDock: The created dock.
-        """
-        if name is None:
-            name = WidgetContainerUtils.generate_unique_widget_id(
-                container=self.dock_area.docks, prefix=prefix
-            )
-
-        if name in set(self.dock_area.docks.keys()):
-            raise ValueError(f"Dock with name {name} already exists.")
-
-        if position is None:
-            position = "bottom"
-
-        dock = BECDock(name=name, parent_dock_area=self, closable=closable)
-        dock.config.position = position
-        self.config.docks[name] = dock.config
-
-        self.dock_area.addDock(dock=dock, position=position, relativeTo=relative_to)
-
-        if len(self.dock_area.docks) <= 1:
-            dock.hide_title_bar()
-        elif len(self.dock_area.docks) > 1:
-            for dock in self.dock_area.docks.values():
-                dock.show_title_bar()
-
-        if widget is not None and isinstance(widget, str):
-            dock.add_widget(widget=widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        elif widget is not None and isinstance(widget, QWidget):
-            dock.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        if (
-            self._instructions_visible
-        ):  # TODO still decide how initial instructions should be handled
-            self._instructions_visible = False
-            self.update()
-        if floating:
-            dock.detach()
-        return dock
-
-    def detach_dock(self, dock_name: str) -> BECDock:
-        """
-        Undock a dock from the dock area.
-
-        Args:
-            dock_name(str): The dock to undock.
-
-        Returns:
-            BECDock: The undocked dock.
-        """
-        dock = self.dock_area.docks[dock_name]
-        dock.detach()
-        return dock
-
-    @SafeSlot()
-    def attach_all(self):
-        """
-        Return all floating docks to the dock area.
-        """
-        while self.dock_area.tempAreas:
-            for temp_area in self.dock_area.tempAreas:
-                self.remove_temp_area(temp_area)
-
-    def remove_temp_area(self, area):
-        """
-        Remove a temporary area from the dock area.
-        This is a patched method of pyqtgraph's removeTempArea
-        """
-        self.dock_area.tempAreas.remove(area)
-        area.window().close()
-        area.window().deleteLater()
-
-    def clear_all(self):
-        """
-        Close all docks and remove all temp areas.
-        """
-        self.attach_all()
-        for dock in dict(self.dock_area.docks).values():
-            dock.remove()
-        self.dock_area.docks.clear()
-
-    def cleanup(self):
-        """
-        Cleanup the dock area.
-        """
-        self.clear_all()
-        self.toolbar.close()
-        self.toolbar.deleteLater()
-        self.dock_area.close()
-        self.dock_area.deleteLater()
-        super().cleanup()
-
-    def close(self):
-        """
-        Close the dock area and cleanup.
-        Has to be implemented to overwrite pyqtgraph event accept in Container close.
-        """
-        self.cleanup()
-        super().close()
-
-    def show(self):
-        """Show all windows including floating docks."""
-        super().show()
-        for docks in self.panels.values():
-            docks.window().show()
-
-    def hide(self):
-        """Hide all windows including floating docks."""
-        super().hide()
-        for docks in self.panels.values():
-            docks.window().hide()
-
-
-if __name__ == "__main__":
-    from qtpy.QtWidgets import QApplication
-
-    from bec_widgets.utils.colors import set_theme
-
-    app = QApplication([])
-    set_theme("auto")
-    dock_area = BECDockArea()
-    dock_area.show()
-    app.exec_()

bec_widgets/widgets/containers/dock/dock_area.pyproject

@@ -1 +0,0 @@
-{'files': ['dock_area.py','dock.py']}

bec_widgets/widgets/containers/dock/dock_area_plugin.py

@@ -1,58 +0,0 @@
-# Copyright (C) 2022 The Qt Company Ltd.
-# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
-import os
-
-from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-
-import bec_widgets
-from bec_widgets.utils.bec_designer import designer_material_icon
-from bec_widgets.widgets.containers.dock import BECDockArea
-
-DOM_XML = """
-<ui language='c++'>
-    <widget class='BECDockArea' name='dock_area'>
-    </widget>
-</ui>
-"""
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-class BECDockAreaPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
-    def __init__(self):
-        super().__init__()
-        self._form_editor = None
-
-    def createWidget(self, parent):
-        t = BECDockArea(parent)
-        return t
-
-    def domXml(self):
-        return DOM_XML
-
-    def group(self):
-        return "BEC Plots"
-
-    def icon(self):
-        return designer_material_icon(BECDockArea.ICON_NAME)
-
-    def includeFile(self):
-        return "dock_area"
-
-    def initialize(self, form_editor):
-        self._form_editor = form_editor
-
-    def isContainer(self):
-        return False
-
-    def isInitialized(self):
-        return self._form_editor is not None
-
-    def name(self):
-        return "BECDockArea"
-
-    def toolTip(self):
-        return "BECDockArea"
-
-    def whatsThis(self):
-        return self.toolTip()

bec_widgets/widgets/containers/dock/register_dock_area.py

@@ -1,15 +0,0 @@
-def main():  # pragma: no cover
-    from qtpy import PYSIDE6
-
-    if not PYSIDE6:
-        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
-        return
-    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
-
-    from bec_widgets.widgets.containers.dock.dock_area_plugin import BECDockAreaPlugin
-
-    QPyDesignerCustomWidgetCollection.addCustomWidget(BECDockAreaPlugin())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/widgets/containers/figure/__init__.py

@@ -1 +0,0 @@
-from .figure import BECFigure, FigureConfig

bec_widgets/widgets/containers/figure/figure.py

@@ -1,797 +0,0 @@
-# pylint: disable = no-name-in-module,missing-module-docstring
-from __future__ import annotations
-
-import uuid
-from collections import defaultdict
-from typing import Literal, Optional
-
-import numpy as np
-import pyqtgraph as pg
-from bec_lib.logger import bec_logger
-from pydantic import Field, ValidationError, field_validator
-from qtpy.QtCore import Signal as pyqtSignal
-from qtpy.QtWidgets import QWidget
-from typeguard import typechecked
-
-from bec_widgets.utils import ConnectionConfig, WidgetContainerUtils
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import apply_theme
-from bec_widgets.widgets.containers.figure.plots.image.image import BECImageShow, ImageConfig
-from bec_widgets.widgets.containers.figure.plots.motor_map.motor_map import (
-    BECMotorMap,
-    MotorMapConfig,
-)
-from bec_widgets.widgets.containers.figure.plots.multi_waveform.multi_waveform import (
-    BECMultiWaveform,
-    BECMultiWaveformConfig,
-)
-from bec_widgets.widgets.containers.figure.plots.plot_base import BECPlotBase, SubplotConfig
-from bec_widgets.widgets.containers.figure.plots.waveform.waveform import (
-    BECWaveform,
-    Waveform1DConfig,
-)
-
-logger = bec_logger.logger
-
-
-class FigureConfig(ConnectionConfig):
-    """Configuration for BECFigure. Inheriting from ConnectionConfig widget_class and gui_id"""
-
-    theme: Literal["dark", "light"] = Field("dark", description="The theme of the figure widget.")
-    num_cols: int = Field(1, description="The number of columns in the figure widget.")
-    num_rows: int = Field(1, description="The number of rows in the figure widget.")
-    widgets: dict[str, Waveform1DConfig | ImageConfig | MotorMapConfig | SubplotConfig] = Field(
-        {}, description="The list of widgets to be added to the figure widget."
-    )
-
-    @field_validator("widgets", mode="before")
-    @classmethod
-    def validate_widgets(cls, v):
-        """Validate the widgets configuration."""
-        widget_class_map = {
-            "BECWaveform": Waveform1DConfig,
-            "BECImageShow": ImageConfig,
-            "BECMotorMap": MotorMapConfig,
-        }
-        validated_widgets = {}
-        for key, widget_config in v.items():
-            if "widget_class" not in widget_config:
-                raise ValueError(f"Widget config for {key} does not contain 'widget_class'.")
-            widget_class = widget_config["widget_class"]
-            if widget_class not in widget_class_map:
-                raise ValueError(f"Unknown widget_class '{widget_class}' for widget '{key}'.")
-            config_class = widget_class_map[widget_class]
-            validated_widgets[key] = config_class(**widget_config)
-        return validated_widgets
-
-
-class WidgetHandler:
-    """Factory for creating and configuring BEC widgets for BECFigure."""
-
-    def __init__(self):
-        self.widget_factory = {
-            "BECPlotBase": (BECPlotBase, SubplotConfig),
-            "BECWaveform": (BECWaveform, Waveform1DConfig),
-            "BECImageShow": (BECImageShow, ImageConfig),
-            "BECMotorMap": (BECMotorMap, MotorMapConfig),
-            "BECMultiWaveform": (BECMultiWaveform, BECMultiWaveformConfig),
-        }
-
-    def create_widget(
-        self,
-        widget_type: str,
-        widget_id: str,
-        parent_figure,
-        parent_id: str,
-        config: dict = None,
-        **axis_kwargs,
-    ) -> BECPlotBase:
-        """
-        Create and configure a widget based on its type.
-
-        Args:
-            widget_type (str): The type of the widget to create.
-            widget_id (str): Unique identifier for the widget.
-            parent_id (str): Identifier of the parent figure.
-            config (dict, optional): Additional configuration for the widget.
-            **axis_kwargs: Additional axis properties to set on the widget after creation.
-
-        Returns:
-            BECPlotBase: The created and configured widget instance.
-        """
-        entry = self.widget_factory.get(widget_type)
-        if not entry:
-            raise ValueError(f"Unsupported widget type: {widget_type}")
-
-        widget_class, config_class = entry
-        if config is not None and isinstance(config, config_class):
-            config = config.model_dump()
-        widget_config_dict = {
-            "widget_class": widget_class.__name__,
-            "parent_id": parent_id,
-            "gui_id": widget_id,
-            **(config if config is not None else {}),
-        }
-        widget_config = config_class(**widget_config_dict)
-        widget = widget_class(
-            config=widget_config, parent_figure=parent_figure, client=parent_figure.client
-        )
-
-        if axis_kwargs:
-            widget.set(**axis_kwargs)
-
-        return widget
-
-
-class BECFigure(BECWidget, pg.GraphicsLayoutWidget):
-    USER_ACCESS = [
-        "_rpc_id",
-        "_config_dict",
-        "_get_all_rpc",
-        "axes",
-        "widgets",
-        "plot",
-        "image",
-        "motor_map",
-        "remove",
-        "change_layout",
-        "change_theme",
-        "export",
-        "clear_all",
-        "widget_list",
-    ]
-    subplot_map = {
-        "PlotBase": BECPlotBase,
-        "BECWaveform": BECWaveform,
-        "BECImageShow": BECImageShow,
-        "BECMotorMap": BECMotorMap,
-        "BECMultiWaveform": BECMultiWaveform,
-    }
-    widget_method_map = {
-        "BECWaveform": "plot",
-        "BECImageShow": "image",
-        "BECMotorMap": "motor_map",
-        "BECMultiWaveform": "multi_waveform",
-    }
-
-    clean_signal = pyqtSignal()
-
-    def __init__(
-        self,
-        parent: Optional[QWidget] = None,
-        config: Optional[FigureConfig] = None,
-        client=None,
-        gui_id: Optional[str] = None,
-    ) -> None:
-        if config is None:
-            config = FigureConfig(widget_class=self.__class__.__name__)
-        else:
-            if isinstance(config, dict):
-                config = FigureConfig(**config)
-        super().__init__(client=client, gui_id=gui_id)
-        pg.GraphicsLayoutWidget.__init__(self, parent)
-
-        self.widget_handler = WidgetHandler()
-
-        # Widget container to reference widgets by 'widget_id'
-        self._widgets = defaultdict(dict)
-
-        # Container to keep track of the grid
-        self.grid = []
-        # Create config and apply it
-        self.apply_config(config)
-
-    def __getitem__(self, key: tuple | str):
-        if isinstance(key, tuple) and len(key) == 2:
-            return self.axes(*key)
-        if isinstance(key, str):
-            widget = self._widgets.get(key)
-            if widget is None:
-                raise KeyError(f"No widget with ID {key}")
-            return self._widgets.get(key)
-        else:
-            raise TypeError(
-                "Key must be a string (widget id) or a tuple of two integers (grid coordinates)"
-            )
-
-    def apply_config(self, config: dict | FigureConfig):  # ,generate_new_id: bool = False):
-        if isinstance(config, dict):
-            try:
-                config = FigureConfig(**config)
-            except ValidationError as e:
-                logger.error(f"Error in applying config: {e}")
-                return
-        self.config = config
-
-        # widget_config has to be reset for not have each widget config twice when added to the figure
-        widget_configs = list(self.config.widgets.values())
-        self.config.widgets = {}
-        for widget_config in widget_configs:
-            getattr(self, self.widget_method_map[widget_config.widget_class])(
-                config=widget_config.model_dump(), row=widget_config.row, col=widget_config.col
-            )
-
-    @property
-    def widget_list(self) -> list[BECPlotBase]:
-        """
-        Access all widget in BECFigure as a list
-        Returns:
-            list[BECPlotBase]: List of all widgets in the figure.
-        """
-        axes = [value for value in self._widgets.values() if isinstance(value, BECPlotBase)]
-        return axes
-
-    @widget_list.setter
-    def widget_list(self, value: list[BECPlotBase]):
-        """
-        Access all widget in BECFigure as a list
-        Returns:
-            list[BECPlotBase]: List of all widgets in the figure.
-        """
-        self._axes = value
-
-    @property
-    def widgets(self) -> dict:
-        """
-        All widgets within the figure with gui ids as keys.
-        Returns:
-            dict: All widgets within the figure.
-        """
-        return self._widgets
-
-    @widgets.setter
-    def widgets(self, value: dict):
-        """
-        All widgets within the figure with gui ids as keys.
-        Returns:
-            dict: All widgets within the figure.
-        """
-        self._widgets = value
-
-    def export(self):
-        """Export the plot widget."""
-        try:
-            plot_item = self.widget_list[0]
-        except Exception as exc:
-            raise ValueError("No plot widget available to export.") from exc
-
-        scene = plot_item.scene()
-        scene.contextMenuItem = plot_item
-        scene.showExportDialog()
-
-    @typechecked
-    def plot(
-        self,
-        arg1: list | np.ndarray | str | None = None,
-        y: list | np.ndarray | None = None,
-        x: list | np.ndarray | None = None,
-        x_name: str | None = None,
-        y_name: str | None = None,
-        z_name: str | None = None,
-        x_entry: str | None = None,
-        y_entry: str | None = None,
-        z_entry: str | None = None,
-        color: str | None = None,
-        color_map_z: str | None = "magma",
-        label: str | None = None,
-        validate: bool = True,
-        new: bool = False,
-        row: int | None = None,
-        col: int | None = None,
-        dap: str | None = None,
-        config: dict | None = None,  # TODO make logic more transparent
-        **axis_kwargs,
-    ) -> BECWaveform:
-        """
-        Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
-
-        Args:
-            arg1(list | np.ndarray | str | None): First argument which can be x data, y data, or y_name.
-            y(list | np.ndarray): Custom y data to plot.
-            x(list | np.ndarray): Custom x data to plot.
-            x_name(str): The name of the device for the x-axis.
-            y_name(str): The name of the device for the y-axis.
-            z_name(str): The name of the device for the z-axis.
-            x_entry(str): The name of the entry for the x-axis.
-            y_entry(str): The name of the entry for the y-axis.
-            z_entry(str): The name of the entry for the z-axis.
-            color(str): The color of the curve.
-            color_map_z(str): The color map to use for the z-axis.
-            label(str): The label of the curve.
-            validate(bool): If True, validate the device names and entries.
-            new(bool): If True, create a new plot instead of using the first plot.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            dap(str): The DAP model to use for the curve.
-            config(dict): Recreates the whole BECWaveform widget from provided configuration.
-            **axis_kwargs: Additional axis properties to set on the widget after creation.
-
-        Returns:
-            BECWaveform: The waveform plot widget.
-        """
-        waveform = self.subplot_factory(
-            widget_type="BECWaveform", config=config, row=row, col=col, new=new, **axis_kwargs
-        )
-        if config is not None:
-            return waveform
-
-        if arg1 is not None or y_name is not None or (y is not None and x is not None):
-            waveform.plot(
-                arg1=arg1,
-                y=y,
-                x=x,
-                x_name=x_name,
-                y_name=y_name,
-                z_name=z_name,
-                x_entry=x_entry,
-                y_entry=y_entry,
-                z_entry=z_entry,
-                color=color,
-                color_map_z=color_map_z,
-                label=label,
-                validate=validate,
-                dap=dap,
-            )
-        return waveform
-
-    def _init_image(
-        self,
-        image,
-        monitor: str = None,
-        monitor_type: Literal["1d", "2d"] = "2d",
-        color_bar: Literal["simple", "full"] = "full",
-        color_map: str = "magma",
-        data: np.ndarray = None,
-        vrange: tuple[float, float] = None,
-    ) -> BECImageShow:
-        """
-        Configure the image based on the provided parameters.
-
-        Args:
-            image (BECImageShow): The image to configure.
-            monitor (str): The name of the monitor to display.
-            color_bar (Literal["simple","full"]): The type of color bar to display.
-            color_map (str): The color map to use for the image.
-            data (np.ndarray): Custom data to display.
-        """
-        if monitor is not None and data is None:
-            image.image(
-                monitor=monitor,
-                monitor_type=monitor_type,
-                color_map=color_map,
-                vrange=vrange,
-                color_bar=color_bar,
-            )
-        elif data is not None and monitor is None:
-            image.add_custom_image(
-                name="custom", data=data, color_map=color_map, vrange=vrange, color_bar=color_bar
-            )
-        elif data is None and monitor is None:
-            # Setting appearance
-            if vrange is not None:
-                image.set_vrange(vmin=vrange[0], vmax=vrange[1])
-            if color_map is not None:
-                image.set_color_map(color_map)
-        else:
-            raise ValueError("Invalid input. Provide either monitor name or custom data.")
-        return image
-
-    def image(
-        self,
-        monitor: str = None,
-        monitor_type: Literal["1d", "2d"] = "2d",
-        color_bar: Literal["simple", "full"] = "full",
-        color_map: str = "magma",
-        data: np.ndarray = None,
-        vrange: tuple[float, float] = None,
-        new: bool = False,
-        row: int | None = None,
-        col: int | None = None,
-        config: dict | None = None,
-        **axis_kwargs,
-    ) -> BECImageShow:
-        """
-        Add an image to the figure. Always access the first image widget in the figure.
-
-        Args:
-            monitor(str): The name of the monitor to display.
-            color_bar(Literal["simple","full"]): The type of color bar to display.
-            color_map(str): The color map to use for the image.
-            data(np.ndarray): Custom data to display.
-            vrange(tuple[float, float]): The range of values to display.
-            new(bool): If True, create a new plot instead of using the first plot.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Recreates the whole BECImageShow widget from provided configuration.
-            **axis_kwargs: Additional axis properties to set on the widget after creation.
-
-        Returns:
-            BECImageShow: The image widget.
-        """
-
-        image = self.subplot_factory(
-            widget_type="BECImageShow", config=config, row=row, col=col, new=new, **axis_kwargs
-        )
-        if config is not None:
-            return image
-
-        image = self._init_image(
-            image=image,
-            monitor=monitor,
-            monitor_type=monitor_type,
-            color_bar=color_bar,
-            color_map=color_map,
-            data=data,
-            vrange=vrange,
-        )
-        return image
-
-    def motor_map(
-        self,
-        motor_x: str = None,
-        motor_y: str = None,
-        new: bool = False,
-        row: int | None = None,
-        col: int | None = None,
-        config: dict | None = None,
-        **axis_kwargs,
-    ) -> BECMotorMap:
-        """
-        Add a motor map to the figure. Always access the first motor map widget in the figure.
-
-        Args:
-            motor_x(str): The name of the motor for the X axis.
-            motor_y(str): The name of the motor for the Y axis.
-            new(bool): If True, create a new plot instead of using the first plot.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Recreates the whole BECImageShow widget from provided configuration.
-            **axis_kwargs: Additional axis properties to set on the widget after creation.
-
-        Returns:
-            BECMotorMap: The motor map widget.
-        """
-        motor_map = self.subplot_factory(
-            widget_type="BECMotorMap", config=config, row=row, col=col, new=new, **axis_kwargs
-        )
-        if config is not None:
-            return motor_map
-
-        if motor_x is not None and motor_y is not None:
-            motor_map.change_motors(motor_x, motor_y)
-
-        return motor_map
-
-    def multi_waveform(
-        self,
-        monitor: str = None,
-        new: bool = False,
-        row: int | None = None,
-        col: int | None = None,
-        config: dict | None = None,
-        **axis_kwargs,
-    ):
-        multi_waveform = self.subplot_factory(
-            widget_type="BECMultiWaveform", config=config, row=row, col=col, new=new, **axis_kwargs
-        )
-        if config is not None:
-            return multi_waveform
-        multi_waveform.set_monitor(monitor)
-        return multi_waveform
-
-    def subplot_factory(
-        self,
-        widget_type: Literal[
-            "BECPlotBase", "BECWaveform", "BECImageShow", "BECMotorMap", "BECMultiWaveform"
-        ] = "BECPlotBase",
-        row: int = None,
-        col: int = None,
-        config=None,
-        new: bool = False,
-        **axis_kwargs,
-    ) -> BECPlotBase:
-        # Case 1 - config provided, new plot, possible to define coordinates
-        if config is not None:
-            widget_cls = config["widget_class"]
-            if widget_cls != widget_type:
-                raise ValueError(
-                    f"Widget type '{widget_type}' does not match the provided configuration ({widget_cls})."
-                )
-            widget = self.add_widget(
-                widget_type=widget_type, config=config, row=row, col=col, **axis_kwargs
-            )
-            return widget
-
-        # Case 2 - find first plot or create first plot if no plot available, no config provided, no coordinates
-        if new is False and (row is None or col is None):
-            widget = WidgetContainerUtils.find_first_widget_by_class(
-                self._widgets, self.subplot_map[widget_type], can_fail=True
-            )
-            if widget is not None:
-                if axis_kwargs:
-                    widget.set(**axis_kwargs)
-            else:
-                widget = self.add_widget(widget_type=widget_type, **axis_kwargs)
-            return widget
-
-        # Case 3 - modifying existing plot wit coordinates provided
-        if new is False and (row is not None and col is not None):
-            try:
-                widget = self.axes(row, col)
-            except ValueError:
-                widget = None
-            if widget is not None:
-                if axis_kwargs:
-                    widget.set(**axis_kwargs)
-            else:
-                widget = self.add_widget(widget_type=widget_type, row=row, col=col, **axis_kwargs)
-            return widget
-
-        # Case 4 - no previous plot or new plot, no config provided, possible to define coordinates
-        widget = self.add_widget(widget_type=widget_type, row=row, col=col, **axis_kwargs)
-        return widget
-
-    def add_widget(
-        self,
-        widget_type: Literal[
-            "BECPlotBase", "BECWaveform", "BECImageShow", "BECMotorMap", "BECMultiWaveform"
-        ] = "BECPlotBase",
-        widget_id: str = None,
-        row: int = None,
-        col: int = None,
-        config=None,
-        **axis_kwargs,
-    ) -> BECPlotBase:
-        """
-        Add a widget to the figure at the specified position.
-
-        Args:
-            widget_type(Literal["PlotBase","Waveform1D"]): The type of the widget to add.
-            widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Additional configuration for the widget.
-            **axis_kwargs(dict): Additional axis properties to set on the widget after creation.
-        """
-        if not widget_id:
-            widget_id = str(uuid.uuid4())
-        if widget_id in self._widgets:
-            raise ValueError(f"Widget with ID '{widget_id}' already exists.")
-
-        # Check if position is occupied
-        if row is not None and col is not None:
-            if self.getItem(row, col):
-                raise ValueError(f"Position at row {row} and column {col} is already occupied.")
-        else:
-            row, col = self._find_next_empty_position()
-
-        widget = self.widget_handler.create_widget(
-            widget_type=widget_type,
-            widget_id=widget_id,
-            parent_figure=self,
-            parent_id=self.gui_id,
-            config=config,
-            **axis_kwargs,
-        )
-        # has to be changed manually to ensure unique id, if config is copied from existing widget, the id could be
-        # used otherwise multiple times
-        widget.set_gui_id(widget_id)
-
-        widget.config.row = row
-        widget.config.col = col
-
-        # Add widget to the figure
-        self.addItem(widget, row=row, col=col)
-
-        # Update num_cols and num_rows based on the added widget
-        self.config.num_rows = max(self.config.num_rows, row + 1)
-        self.config.num_cols = max(self.config.num_cols, col + 1)
-
-        # Saving config for future referencing
-        self.config.widgets[widget_id] = widget.config
-        self._widgets[widget_id] = widget
-
-        # Reflect the grid coordinates
-        self._change_grid(widget_id, row, col)
-
-        return widget
-
-    def remove(
-        self,
-        row: int = None,
-        col: int = None,
-        widget_id: str = None,
-        coordinates: tuple[int, int] = None,
-    ) -> None:
-        """
-        Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
-
-        Args:
-            row(int): The row coordinate of the widget to remove.
-            col(int): The column coordinate of the widget to remove.
-            widget_id(str): The unique identifier of the widget to remove.
-            coordinates(tuple[int, int], optional): The coordinates of the widget to remove.
-        """
-        if widget_id:
-            self._remove_by_id(widget_id)
-        elif row is not None and col is not None:
-            self._remove_by_coordinates(row, col)
-        elif coordinates:
-            self._remove_by_coordinates(*coordinates)
-        else:
-            raise ValueError("Must provide either widget_id or coordinates for removal.")
-
-    def change_theme(self, theme: Literal["dark", "light"]) -> None:
-        """
-        Change the theme of the figure widget.
-
-        Args:
-            theme(Literal["dark","light"]): The theme to set for the figure widget.
-        """
-        self.config.theme = theme
-        apply_theme(theme)
-        for plot in self.widget_list:
-            plot.set_x_label(plot.plot_item.getAxis("bottom").label.toPlainText())
-            plot.set_y_label(plot.plot_item.getAxis("left").label.toPlainText())
-            if plot.plot_item.titleLabel.text:
-                plot.set_title(plot.plot_item.titleLabel.text)
-            plot.set_legend_label_size()
-
-    def _remove_by_coordinates(self, row: int, col: int) -> None:
-        """
-        Remove a widget from the figure by its coordinates.
-
-        Args:
-            row(int): The row coordinate of the widget to remove.
-            col(int): The column coordinate of the widget to remove.
-        """
-        widget = self.axes(row, col)
-        if widget:
-            widget_id = widget.config.gui_id
-            if widget_id in self._widgets:
-                self._remove_by_id(widget_id)
-
-    def _remove_by_id(self, widget_id: str) -> None:
-        """
-        Remove a widget from the figure by its unique identifier.
-
-        Args:
-            widget_id(str): The unique identifier of the widget to remove.
-        """
-        if widget_id in self._widgets:
-            widget = self._widgets.pop(widget_id)
-            widget.cleanup_pyqtgraph()
-            widget.cleanup()
-            self.removeItem(widget)
-            self.grid[widget.config.row][widget.config.col] = None
-            self._reindex_grid()
-            if widget_id in self.config.widgets:
-                self.config.widgets.pop(widget_id)
-            widget.deleteLater()
-        else:
-            raise ValueError(f"Widget with ID '{widget_id}' does not exist.")
-
-    def axes(self, row: int, col: int) -> BECPlotBase:
-        """
-        Get widget by its coordinates in the figure.
-
-        Args:
-            row(int): the row coordinate
-            col(int): the column coordinate
-
-        Returns:
-            BECPlotBase: the widget at the given coordinates
-        """
-        widget = self.getItem(row, col)
-        if widget is None:
-            raise ValueError(f"No widget at coordinates ({row}, {col})")
-        return widget
-
-    def _find_next_empty_position(self):
-        """Find the next empty position (new row) in the figure."""
-        row, col = 0, 0
-        while self.getItem(row, col):
-            row += 1
-        return row, col
-
-    def _change_grid(self, widget_id: str, row: int, col: int):
-        """
-        Change the grid to reflect the new position of the widget.
-
-        Args:
-            widget_id(str): The unique identifier of the widget.
-            row(int): The new row coordinate of the widget in the figure.
-            col(int): The new column coordinate of the widget in the figure.
-        """
-        while len(self.grid) <= row:
-            self.grid.append([])
-        row = self.grid[row]
-        while len(row) <= col:
-            row.append(None)
-        row[col] = widget_id
-
-    def _reindex_grid(self):
-        """Reindex the grid to remove empty rows and columns."""
-        new_grid = []
-        for row in self.grid:
-            new_row = [widget for widget in row if widget is not None]
-            if new_row:
-                new_grid.append(new_row)
-        #
-        # Update the config of each object to reflect its new position
-        for row_idx, row in enumerate(new_grid):
-            for col_idx, widget in enumerate(row):
-                self._widgets[widget].config.row, self._widgets[widget].config.col = (
-                    row_idx,
-                    col_idx,
-                )
-
-        self.grid = new_grid
-        self._replot_layout()
-
-    def _replot_layout(self):
-        """Replot the layout based on the current grid configuration."""
-        self.clear()
-        for row_idx, row in enumerate(self.grid):
-            for col_idx, widget in enumerate(row):
-                self.addItem(self._widgets[widget], row=row_idx, col=col_idx)
-
-    def change_layout(self, max_columns=None, max_rows=None):
-        """
-        Reshuffle the layout of the figure to adjust to a new number of max_columns or max_rows.
-        If both max_columns and max_rows are provided, max_rows is ignored.
-
-        Args:
-            max_columns (Optional[int]): The new maximum number of columns in the figure.
-            max_rows (Optional[int]): The new maximum number of rows in the figure.
-        """
-        # Calculate total number of widgets
-        total_widgets = len(self._widgets)
-
-        if max_columns:
-            # Calculate the required number of rows based on max_columns
-            required_rows = (total_widgets + max_columns - 1) // max_columns
-            new_grid = [[None for _ in range(max_columns)] for _ in range(required_rows)]
-        elif max_rows:
-            # Calculate the required number of columns based on max_rows
-            required_columns = (total_widgets + max_rows - 1) // max_rows
-            new_grid = [[None for _ in range(required_columns)] for _ in range(max_rows)]
-        else:
-            # If neither max_columns nor max_rows is specified, just return without changing the layout
-            return
-
-        # Populate the new grid with widgets' IDs
-        current_idx = 0
-        for widget_id in self._widgets:
-            row = current_idx // len(new_grid[0])
-            col = current_idx % len(new_grid[0])
-            new_grid[row][col] = widget_id
-            current_idx += 1
-
-        self.config.num_rows = row
-        self.config.num_cols = col
-
-        # Update widgets' positions and replot them according to the new grid
-        self.grid = new_grid
-        self._reindex_grid()  # This method should be updated to handle reshuffling correctly
-        self._replot_layout()  # Assumes this method re-adds widgets to the layout based on self.grid
-
-    def clear_all(self):
-        """Clear all widgets from the figure and reset to default state"""
-        for widget in list(self._widgets.values()):
-            widget.remove()
-        self._widgets.clear()
-        self.grid = []
-        theme = self.config.theme
-        self.config = FigureConfig(
-            widget_class=self.__class__.__name__, gui_id=self.gui_id, theme=theme
-        )
-
-    def cleanup_pyqtgraph_all_widgets(self):
-        """Clean up the pyqtgraph widget."""
-        for widget in self.widget_list:
-            widget.cleanup_pyqtgraph()
-
-    def cleanup(self):
-        """Close the figure widget."""
-        self.cleanup_pyqtgraph_all_widgets()

bec_widgets/widgets/containers/figure/plots/axis_settings.py

@@ -1,91 +0,0 @@
-import os
-
-from qtpy.QtWidgets import QVBoxLayout
-
-from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
-from bec_widgets.qt_utils.settings_dialog import SettingWidget
-from bec_widgets.utils import UILoader
-from bec_widgets.utils.widget_io import WidgetIO
-
-
-class AxisSettings(SettingWidget):
-    def __init__(self, parent=None, *args, **kwargs):
-        super().__init__(parent=parent, *args, **kwargs)
-
-        current_path = os.path.dirname(__file__)
-        self.ui = UILoader().load_ui(os.path.join(current_path, "axis_settings.ui"), self)
-
-        self.layout = QVBoxLayout(self)
-        self.layout.addWidget(self.ui)
-
-        # Hardcoded values for best appearance
-        self.setMinimumHeight(280)
-        self.setMaximumHeight(280)
-        self.resize(380, 280)
-
-    @Slot(dict)
-    def display_current_settings(self, axis_config: dict):
-
-        if axis_config == {}:
-            return
-
-        # Top Box
-        WidgetIO.set_value(self.ui.plot_title, axis_config["title"])
-        self.ui.switch_outer_axes.checked = axis_config["outer_axes"]
-
-        # X Axis Box
-        WidgetIO.set_value(self.ui.x_label, axis_config["x_label"])
-        WidgetIO.set_value(self.ui.x_scale, axis_config["x_scale"])
-        WidgetIO.set_value(self.ui.x_grid, axis_config["x_grid"])
-        if axis_config["x_lim"] is not None:
-            WidgetIO.check_and_adjust_limits(self.ui.x_min, axis_config["x_lim"][0])
-            WidgetIO.check_and_adjust_limits(self.ui.x_max, axis_config["x_lim"][1])
-            WidgetIO.set_value(self.ui.x_min, axis_config["x_lim"][0])
-            WidgetIO.set_value(self.ui.x_max, axis_config["x_lim"][1])
-        if axis_config["x_lim"] is None:
-            x_range = self.target_widget.fig.widget_list[0].plot_item.viewRange()[0]
-            WidgetIO.set_value(self.ui.x_min, x_range[0])
-            WidgetIO.set_value(self.ui.x_max, x_range[1])
-
-        # Y Axis Box
-        WidgetIO.set_value(self.ui.y_label, axis_config["y_label"])
-        WidgetIO.set_value(self.ui.y_scale, axis_config["y_scale"])
-        WidgetIO.set_value(self.ui.y_grid, axis_config["y_grid"])
-        if axis_config["y_lim"] is not None:
-            WidgetIO.check_and_adjust_limits(self.ui.y_min, axis_config["y_lim"][0])
-            WidgetIO.check_and_adjust_limits(self.ui.y_max, axis_config["y_lim"][1])
-            WidgetIO.set_value(self.ui.y_min, axis_config["y_lim"][0])
-            WidgetIO.set_value(self.ui.y_max, axis_config["y_lim"][1])
-        if axis_config["y_lim"] is None:
-            y_range = self.target_widget.fig.widget_list[0].plot_item.viewRange()[1]
-            WidgetIO.set_value(self.ui.y_min, y_range[0])
-            WidgetIO.set_value(self.ui.y_max, y_range[1])
-
-    @Slot()
-    def accept_changes(self):
-        title = WidgetIO.get_value(self.ui.plot_title)
-        outer_axes = self.ui.switch_outer_axes.checked
-
-        # X Axis
-        x_label = WidgetIO.get_value(self.ui.x_label)
-        x_scale = self.ui.x_scale.currentText()
-        x_grid = WidgetIO.get_value(self.ui.x_grid)
-        x_lim = (WidgetIO.get_value(self.ui.x_min), WidgetIO.get_value(self.ui.x_max))
-
-        # Y Axis
-        y_label = WidgetIO.get_value(self.ui.y_label)
-        y_scale = self.ui.y_scale.currentText()
-        y_grid = WidgetIO.get_value(self.ui.y_grid)
-        y_lim = (WidgetIO.get_value(self.ui.y_min), WidgetIO.get_value(self.ui.y_max))
-
-        self.target_widget.set(
-            title=title,
-            x_label=x_label,
-            x_scale=x_scale,
-            x_lim=x_lim,
-            y_label=y_label,
-            y_scale=y_scale,
-            y_lim=y_lim,
-        )
-        self.target_widget.set_grid(x_grid, y_grid)
-        self.target_widget.set_outer_axes(outer_axes)

bec_widgets/widgets/containers/figure/plots/axis_settings.ui

@@ -1,256 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
-    <class>Form</class>
-    <widget class="QWidget" name="Form">
-        <property name="geometry">
-            <rect>
-                <x>0</x>
-                <y>0</y>
-                <width>427</width>
-                <height>270</height>
-            </rect>
-        </property>
-        <property name="minimumSize">
-            <size>
-                <width>0</width>
-                <height>250</height>
-            </size>
-        </property>
-        <property name="maximumSize">
-            <size>
-                <width>16777215</width>
-                <height>278</height>
-            </size>
-        </property>
-        <property name="windowTitle">
-            <string>Form</string>
-        </property>
-        <layout class="QGridLayout" name="gridLayout">
-            <item row="0" column="0" colspan="2">
-                <layout class="QHBoxLayout" name="horizontalLayout">
-                    <item>
-                        <widget class="QLabel" name="plot_title_label">
-                            <property name="text">
-                                <string>Plot Title</string>
-                            </property>
-                        </widget>
-                    </item>
-                    <item>
-                        <widget class="QLineEdit" name="plot_title"/>
-                    </item>
-                </layout>
-            </item>
-            <item row="1" column="0">
-                <widget class="QLabel" name="label_outer_axes">
-                    <property name="text">
-                        <string>Outer Axes</string>
-                    </property>
-                </widget>
-            </item>
-            <item row="2" column="1">
-                <widget class="QGroupBox" name="y_axis_box">
-                    <property name="title">
-                        <string>Y Axis</string>
-                    </property>
-                    <layout class="QGridLayout" name="gridLayout_5">
-                        <item row="3" column="2">
-                            <widget class="QComboBox" name="y_scale">
-                                <item>
-                                    <property name="text">
-                                        <string>linear</string>
-                                    </property>
-                                </item>
-                                <item>
-                                    <property name="text">
-                                        <string>log</string>
-                                    </property>
-                                </item>
-                            </widget>
-                        </item>
-                        <item row="2" column="2">
-                            <widget class="QDoubleSpinBox" name="y_max">
-                                <property name="alignment">
-                                    <set>Qt::AlignmentFlag::AlignCenter</set>
-                                </property>
-                                <property name="minimum">
-                                    <double>-9999.000000000000000</double>
-                                </property>
-                                <property name="maximum">
-                                    <double>9999.000000000000000</double>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="1" column="0" colspan="2">
-                            <widget class="QLabel" name="y_min_label">
-                                <property name="text">
-                                    <string>Min</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="1" column="2">
-                            <widget class="QDoubleSpinBox" name="y_min">
-                                <property name="alignment">
-                                    <set>Qt::AlignmentFlag::AlignCenter</set>
-                                </property>
-                                <property name="minimum">
-                                    <double>-9999.000000000000000</double>
-                                </property>
-                                <property name="maximum">
-                                    <double>9999.000000000000000</double>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="0" column="2">
-                            <widget class="QLineEdit" name="y_label"/>
-                        </item>
-                        <item row="3" column="0">
-                            <widget class="QLabel" name="y_scale_label">
-                                <property name="text">
-                                    <string>Scale</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="0" column="0">
-                            <widget class="QLabel" name="y_label_label">
-                                <property name="text">
-                                    <string>Label</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="2" column="0">
-                            <widget class="QLabel" name="y_max_label">
-                                <property name="text">
-                                    <string>Max</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="4" column="2">
-                            <widget class="QCheckBox" name="y_grid">
-                                <property name="text">
-                                    <string/>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="4" column="0">
-                            <widget class="QLabel" name="y_grid_label">
-                                <property name="text">
-                                    <string>Grid</string>
-                                </property>
-                            </widget>
-                        </item>
-                    </layout>
-                </widget>
-            </item>
-            <item row="2" column="0">
-                <widget class="QGroupBox" name="x_axis_box">
-                    <property name="title">
-                        <string>X Axis</string>
-                    </property>
-                    <layout class="QGridLayout" name="gridLayout_4">
-                        <item row="3" column="0">
-                            <widget class="QLabel" name="x_scale_label">
-                                <property name="text">
-                                    <string>Scale</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="1" column="2">
-                            <widget class="QDoubleSpinBox" name="x_min">
-                                <property name="alignment">
-                                    <set>Qt::AlignmentFlag::AlignCenter</set>
-                                </property>
-                                <property name="minimum">
-                                    <double>-9999.000000000000000</double>
-                                </property>
-                                <property name="maximum">
-                                    <double>9999.000000000000000</double>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="1" column="0" colspan="2">
-                            <widget class="QLabel" name="x_min_label">
-                                <property name="text">
-                                    <string>Min</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="2" column="2">
-                            <widget class="QDoubleSpinBox" name="x_max">
-                                <property name="alignment">
-                                    <set>Qt::AlignmentFlag::AlignCenter</set>
-                                </property>
-                                <property name="minimum">
-                                    <double>-9999.000000000000000</double>
-                                </property>
-                                <property name="maximum">
-                                    <double>9999.000000000000000</double>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="3" column="2">
-                            <widget class="QComboBox" name="x_scale">
-                                <item>
-                                    <property name="text">
-                                        <string>linear</string>
-                                    </property>
-                                </item>
-                                <item>
-                                    <property name="text">
-                                        <string>log</string>
-                                    </property>
-                                </item>
-                            </widget>
-                        </item>
-                        <item row="2" column="0">
-                            <widget class="QLabel" name="x_max_label">
-                                <property name="text">
-                                    <string>Max</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="0" column="2">
-                            <widget class="QLineEdit" name="x_label"/>
-                        </item>
-                        <item row="0" column="0">
-                            <widget class="QLabel" name="x_label_label">
-                                <property name="text">
-                                    <string>Label</string>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="4" column="2">
-                            <widget class="QCheckBox" name="x_grid">
-                                <property name="text">
-                                    <string/>
-                                </property>
-                            </widget>
-                        </item>
-                        <item row="4" column="0">
-                            <widget class="QLabel" name="x_grid_label">
-                                <property name="text">
-                                    <string>Grid</string>
-                                </property>
-                            </widget>
-                        </item>
-                    </layout>
-                </widget>
-            </item>
-            <item row="1" column="1">
-                <widget class="ToggleSwitch" name="switch_outer_axes">
-                    <property name="checked" stdset="0">
-                        <bool>false</bool>
-                    </property>
-                </widget>
-            </item>
-        </layout>
-    </widget>
-    <customwidgets>
-        <customwidget>
-            <class>ToggleSwitch</class>
-            <extends>QWidget</extends>
-            <header>toggle_switch</header>
-        </customwidget>
-    </customwidgets>
-    <resources/>
-    <connections/>
-</ui>

bec_widgets/widgets/containers/figure/plots/image/image.py

@@ -1,772 +0,0 @@
-from __future__ import annotations
-
-from collections import defaultdict
-from typing import Any, Literal, Optional
-
-import numpy as np
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.logger import bec_logger
-from pydantic import Field, ValidationError
-from qtpy.QtCore import QThread, Slot
-from qtpy.QtWidgets import QWidget
-
-# from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
-from bec_widgets.utils import EntryValidator
-from bec_widgets.widgets.containers.figure.plots.image.image_item import (
-    BECImageItem,
-    ImageItemConfig,
-)
-from bec_widgets.widgets.containers.figure.plots.image.image_processor import (
-    ImageProcessor,
-    ImageStats,
-    ProcessorWorker,
-)
-from bec_widgets.widgets.containers.figure.plots.plot_base import BECPlotBase, SubplotConfig
-
-logger = bec_logger.logger
-
-
-class ImageConfig(SubplotConfig):
-    images: dict[str, ImageItemConfig] = Field(
-        {},
-        description="The configuration of the images. The key is the name of the image (source).",
-    )
-
-
-class BECImageShow(BECPlotBase):
-    USER_ACCESS = [
-        "_rpc_id",
-        "_config_dict",
-        "add_image_by_config",
-        "image",
-        "add_custom_image",
-        "set_vrange",
-        "set_color_map",
-        "set_autorange",
-        "set_autorange_mode",
-        "set_monitor",
-        "set_processing",
-        "set_image_properties",
-        "set_fft",
-        "set_log",
-        "set_rotation",
-        "set_transpose",
-        "set",
-        "set_title",
-        "set_x_label",
-        "set_y_label",
-        "set_x_scale",
-        "set_y_scale",
-        "set_x_lim",
-        "set_y_lim",
-        "set_grid",
-        "enable_fps_monitor",
-        "lock_aspect_ratio",
-        "export",
-        "remove",
-        "images",
-    ]
-
-    def __init__(
-        self,
-        parent: Optional[QWidget] = None,
-        parent_figure=None,
-        config: Optional[ImageConfig] = None,
-        client=None,
-        gui_id: Optional[str] = None,
-        single_image: bool = True,
-    ):
-        if config is None:
-            config = ImageConfig(widget_class=self.__class__.__name__)
-        super().__init__(
-            parent=parent, parent_figure=parent_figure, config=config, client=client, gui_id=gui_id
-        )
-        # Get bec shortcuts dev, scans, queue, scan_storage, dap
-        self.single_image = single_image
-        self.image_type = "device_monitor_2d"
-        self.scan_id = None
-        self.get_bec_shortcuts()
-        self.entry_validator = EntryValidator(self.dev)
-        self._images = defaultdict(dict)
-        self.apply_config(self.config)
-        self.processor = ImageProcessor()
-        self.use_threading = False  # TODO WILL be moved to the init method and to figure method
-
-    def _create_thread_worker(self, device: str, image: np.ndarray):
-        thread = QThread()
-        worker = ProcessorWorker(self.processor)
-        worker.moveToThread(thread)
-
-        # Connect signals and slots
-        thread.started.connect(lambda: worker.process_image(device, image))
-        worker.processed.connect(self.update_image)
-        worker.stats.connect(self.update_vrange)
-        worker.finished.connect(thread.quit)
-        worker.finished.connect(thread.wait)
-        worker.finished.connect(worker.deleteLater)
-        thread.finished.connect(thread.deleteLater)
-
-        thread.start()
-
-    def find_image_by_monitor(self, item_id: str) -> BECImageItem:
-        """
-        Find the image item by its gui_id.
-
-        Args:
-            item_id(str): The gui_id of the widget.
-
-        Returns:
-            BECImageItem: The widget with the given gui_id.
-        """
-        for source, images in self._images.items():
-            for key, value in images.items():
-                if key == item_id and isinstance(value, BECImageItem):
-                    return value
-                elif isinstance(value, dict):
-                    result = self.find_image_by_monitor(item_id)
-                    if result is not None:
-                        return result
-
-    def apply_config(self, config: dict | SubplotConfig):
-        """
-        Apply the configuration to the 1D waveform widget.
-
-        Args:
-            config(dict|SubplotConfig): Configuration settings.
-            replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
-        """
-        if isinstance(config, dict):
-            try:
-                config = ImageConfig(**config)
-            except ValidationError as e:
-                logger.error(f"Validation error when applying config to BECImageShow: {e}")
-                return
-        self.config = config
-        self.plot_item.clear()
-
-        self.apply_axis_config()
-        self._images = defaultdict(dict)
-
-        for image_id, image_config in config.images.items():
-            self.add_image_by_config(image_config)
-
-    def change_gui_id(self, new_gui_id: str):
-        """
-        Change the GUI ID of the image widget and update the parent_id in all associated curves.
-
-        Args:
-            new_gui_id (str): The new GUI ID to be set for the image widget.
-        """
-        self.gui_id = new_gui_id
-        self.config.gui_id = new_gui_id
-
-        for source, images in self._images.items():
-            for id, image_item in images.items():
-                image_item.config.parent_id = new_gui_id
-
-    def add_image_by_config(self, config: ImageItemConfig | dict) -> BECImageItem:
-        """
-        Add an image to the widget by configuration.
-
-        Args:
-            config(ImageItemConfig|dict): The configuration of the image.
-
-        Returns:
-            BECImageItem: The image object.
-        """
-        if isinstance(config, dict):
-            config = ImageItemConfig(**config)
-            config.parent_id = self.gui_id
-        name = config.monitor if config.monitor is not None else config.gui_id
-        image = self._add_image_object(source=config.source, name=name, config=config)
-        return image
-
-    def get_image_config(self, image_id, dict_output: bool = True) -> ImageItemConfig | dict:
-        """
-        Get the configuration of the image.
-
-        Args:
-            image_id(str): The ID of the image.
-            dict_output(bool): Whether to return the configuration as a dictionary. Defaults to True.
-
-        Returns:
-            ImageItemConfig|dict: The configuration of the image.
-        """
-        for source, images in self._images.items():
-            for id, image in images.items():
-                if id == image_id:
-                    if dict_output:
-                        return image.config.dict()
-                    else:
-                        return image.config  # TODO check if this works
-
-    @property
-    def images(self) -> list[BECImageItem]:
-        """
-        Get the list of images.
-        Returns:
-            list[BECImageItem]: The list of images.
-        """
-        images = []
-        for source, images_dict in self._images.items():
-            for id, image in images_dict.items():
-                images.append(image)
-        return images
-
-    @images.setter
-    def images(self, value: dict[str, dict[str, BECImageItem]]):
-        """
-        Set the images from a dictionary.
-
-        Args:
-            value (dict[str, dict[str, BECImageItem]]): The images to set, organized by source and id.
-        """
-        self._images = value
-
-    def get_image_dict(self) -> dict[str, dict[str, BECImageItem]]:
-        """
-        Get all images.
-
-        Returns:
-            dict[str, dict[str, BECImageItem]]: The dictionary of images.
-        """
-        return self._images
-
-    def image(
-        self,
-        monitor: str,
-        monitor_type: Literal["1d", "2d"] = "2d",
-        color_map: Optional[str] = "magma",
-        color_bar: Optional[Literal["simple", "full"]] = "full",
-        downsample: Optional[bool] = True,
-        opacity: Optional[float] = 1.0,
-        vrange: Optional[tuple[int, int]] = None,
-        # post_processing: Optional[PostProcessingConfig] = None,
-        **kwargs,
-    ) -> BECImageItem:
-        """
-        Add an image to the figure. Always access the first image widget in the figure.
-
-        Args:
-            monitor(str): The name of the monitor to display.
-            monitor_type(Literal["1d","2d"]): The type of monitor to display.
-            color_bar(Literal["simple","full"]): The type of color bar to display.
-            color_map(str): The color map to use for the image.
-            data(np.ndarray): Custom data to display.
-            vrange(tuple[float, float]): The range of values to display.
-
-        Returns:
-            BECImageItem: The image item.
-        """
-        if monitor_type == "1d":
-            image_source = "device_monitor_1d"
-            self.image_type = "device_monitor_1d"
-        elif monitor_type == "2d":
-            image_source = "device_monitor_2d"
-            self.image_type = "device_monitor_2d"
-
-        image_exits = self._check_image_id(monitor, self._images)
-        if image_exits:
-            # raise ValueError(
-            #     f"Monitor with ID '{monitor}' already exists in widget '{self.gui_id}'."
-            # )
-            return
-
-        # monitor = self.entry_validator.validate_monitor(monitor)
-
-        image_config = ImageItemConfig(
-            widget_class="BECImageItem",
-            parent_id=self.gui_id,
-            color_map=color_map,
-            color_bar=color_bar,
-            downsample=downsample,
-            opacity=opacity,
-            vrange=vrange,
-            source=image_source,
-            monitor=monitor,
-            # post_processing=post_processing,
-            **kwargs,
-        )
-
-        image = self._add_image_object(source=image_source, name=monitor, config=image_config)
-        return image
-
-    def add_custom_image(
-        self,
-        name: str,
-        data: Optional[np.ndarray] = None,
-        color_map: Optional[str] = "magma",
-        color_bar: Optional[Literal["simple", "full"]] = "full",
-        downsample: Optional[bool] = True,
-        opacity: Optional[float] = 1.0,
-        vrange: Optional[tuple[int, int]] = None,
-        # post_processing: Optional[PostProcessingConfig] = None,
-        **kwargs,
-    ):
-        image_source = "custom"
-
-        image_exits = self._check_image_id(name, self._images)
-        if image_exits:
-            raise ValueError(f"Monitor with ID '{name}' already exists in widget '{self.gui_id}'.")
-
-        image_config = ImageItemConfig(
-            widget_class="BECImageItem",
-            parent_id=self.gui_id,
-            monitor=name,
-            color_map=color_map,
-            color_bar=color_bar,
-            downsample=downsample,
-            opacity=opacity,
-            vrange=vrange,
-            # post_processing=post_processing,
-            **kwargs,
-        )
-
-        image = self._add_image_object(
-            source=image_source, name=name, config=image_config, data=data
-        )
-        return image
-
-    def apply_setting_to_images(
-        self, setting_method_name: str, args: list, kwargs: dict, image_id: str = None
-    ):
-        """
-        Apply a setting to all images or a specific image by its ID.
-
-        Args:
-            setting_method_name (str): The name of the method to apply (e.g., 'set_color_map').
-            args (list): Positional arguments for the setting method.
-            kwargs (dict): Keyword arguments for the setting method.
-            image_id (str, optional): The ID of the specific image to apply the setting to. If None, applies to all images.
-        """
-        if image_id:
-            image = self.find_image_by_monitor(image_id)
-            if image:
-                getattr(image, setting_method_name)(*args, **kwargs)
-        else:
-            for source, images in self._images.items():
-                for _, image in images.items():
-                    getattr(image, setting_method_name)(*args, **kwargs)
-        self.refresh_image()
-
-    def set_vrange(self, vmin: float, vmax: float, name: str = None):
-        """
-        Set the range of the color bar.
-        If name is not specified, then set vrange for all images.
-
-        Args:
-            vmin(float): Minimum value of the color bar.
-            vmax(float): Maximum value of the color bar.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_vrange", args=[vmin, vmax], kwargs={}, image_id=name)
-
-    def set_color_map(self, cmap: str, name: str = None):
-        """
-        Set the color map of the image.
-        If name is not specified, then set color map for all images.
-
-        Args:
-            cmap(str): The color map of the image.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_color_map", args=[cmap], kwargs={}, image_id=name)
-
-    def set_autorange(self, enable: bool = False, name: str = None):
-        """
-        Set the autoscale of the image.
-
-        Args:
-            enable(bool): Whether to autoscale the color bar.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_autorange", args=[enable], kwargs={}, image_id=name)
-
-    def set_autorange_mode(self, mode: Literal["max", "mean"], name: str = None):
-        """
-        Set the autoscale mode of the image, that decides how the vrange of the color bar is scaled.
-        Choose betwen 'max' -> min/max of the data, 'mean' -> mean +/- fudge_factor*std of the data (fudge_factor~2).
-
-        Args:
-            mode(str): The autoscale mode of the image.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_autorange_mode", args=[mode], kwargs={}, image_id=name)
-
-    def set_monitor(self, monitor: str, name: str = None):
-        """
-        Set the monitor of the image.
-        If name is not specified, then set monitor for all images.
-
-        Args:
-            monitor(str): The name of the monitor.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_monitor", args=[monitor], kwargs={}, image_id=name)
-
-    def set_processing(self, name: str = None, **kwargs):
-        """
-        Set the post processing of the image.
-        If name is not specified, then set post processing for all images.
-
-        Args:
-            name(str): The name of the image. If None, apply to all images.
-            **kwargs: Keyword arguments for the properties to be set.
-        Possible properties:
-            - fft: bool
-            - log: bool
-            - rot: int
-            - transpose: bool
-        """
-        self.apply_setting_to_images("set", args=[], kwargs=kwargs, image_id=name)
-
-    def set_image_properties(self, name: str = None, **kwargs):
-        """
-        Set the properties of the image.
-
-        Args:
-            name(str): The name of the image. If None, apply to all images.
-            **kwargs: Keyword arguments for the properties to be set.
-        Possible properties:
-            - downsample: bool
-            - color_map: str
-            - monitor: str
-            - opacity: float
-            - vrange: tuple[int,int]
-            - fft: bool
-            - log: bool
-            - rot: int
-            - transpose: bool
-        """
-        self.apply_setting_to_images("set", args=[], kwargs=kwargs, image_id=name)
-
-    def set_fft(self, enable: bool = False, name: str = None):
-        """
-        Set the FFT of the image.
-        If name is not specified, then set FFT for all images.
-
-        Args:
-            enable(bool): Whether to perform FFT on the monitor data.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_fft", args=[enable], kwargs={}, image_id=name)
-
-    def set_log(self, enable: bool = False, name: str = None):
-        """
-        Set the log of the image.
-        If name is not specified, then set log for all images.
-
-        Args:
-            enable(bool): Whether to perform log on the monitor data.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_log", args=[enable], kwargs={}, image_id=name)
-
-    def set_rotation(self, deg_90: int = 0, name: str = None):
-        """
-        Set the rotation of the image.
-        If name is not specified, then set rotation for all images.
-
-        Args:
-            deg_90(int): The rotation angle of the monitor data before displaying.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_rotation", args=[deg_90], kwargs={}, image_id=name)
-
-    def set_transpose(self, enable: bool = False, name: str = None):
-        """
-        Set the transpose of the image.
-        If name is not specified, then set transpose for all images.
-
-        Args:
-            enable(bool): Whether to transpose the monitor data before displaying.
-            name(str): The name of the image. If None, apply to all images.
-        """
-        self.apply_setting_to_images("set_transpose", args=[enable], kwargs={}, image_id=name)
-
-    def toggle_threading(self, use_threading: bool):
-        """
-        Toggle threading for the widgets postprocessing and updating.
-
-        Args:
-            use_threading(bool): Whether to use threading.
-        """
-        self.use_threading = use_threading
-        if self.use_threading is False and self.thread.isRunning():
-            self.cleanup()
-
-    def process_image(self, device: str, image: BECImageItem, data: np.ndarray):
-        """
-        Process the image data.
-
-        Args:
-            device(str): The name of the device - image_id of image.
-            image(np.ndarray): The image data to be processed.
-            data(np.ndarray): The image data to be processed.
-
-        Returns:
-            np.ndarray: The processed image data.
-        """
-        processing_config = image.config.processing
-        self.processor.set_config(processing_config)
-        if self.use_threading:
-            self._create_thread_worker(device, data)
-        else:
-            data = self.processor.process_image(data)
-            self.update_image(device, data)
-            self.update_vrange(device, self.processor.config.stats)
-
-    @Slot(dict, dict)
-    def on_image_update(self, msg: dict, metadata: dict):
-        """
-        Update the image of the device monitor from bec.
-
-        Args:
-            msg(dict): The message from bec.
-            metadata(dict): The metadata of the message.
-        """
-        data = msg["data"]
-        device = msg["device"]
-        if self.image_type == "device_monitor_1d":
-            image = self._images["device_monitor_1d"][device]
-            current_scan_id = metadata.get("scan_id", None)
-            if current_scan_id is None:
-                return
-            if current_scan_id != self.scan_id:
-                self.reset()
-                self.scan_id = current_scan_id
-                image.image_buffer_list = []
-                image.max_len = 0
-            image_buffer = self.adjust_image_buffer(image, data)
-            image.raw_data = image_buffer
-            self.process_image(device, image, image_buffer)
-        elif self.image_type == "device_monitor_2d":
-            image = self._images["device_monitor_2d"][device]
-            image.raw_data = data
-            self.process_image(device, image, data)
-
-    def adjust_image_buffer(self, image: BECImageItem, new_data: np.ndarray) -> np.ndarray:
-        """
-        Adjusts the image buffer to accommodate the new data, ensuring that all rows have the same length.
-
-        Args:
-            image: The image object (used to store buffer list and max_len).
-            new_data (np.ndarray): The new incoming 1D waveform data.
-
-        Returns:
-            np.ndarray: The updated image buffer with adjusted shapes.
-        """
-        new_len = new_data.shape[0]
-        if not hasattr(image, "image_buffer_list"):
-            image.image_buffer_list = []
-            image.max_len = 0
-
-        if new_len > image.max_len:
-            image.max_len = new_len
-            for i in range(len(image.image_buffer_list)):
-                wf = image.image_buffer_list[i]
-                pad_width = image.max_len - wf.shape[0]
-                if pad_width > 0:
-                    image.image_buffer_list[i] = np.pad(
-                        wf, (0, pad_width), mode="constant", constant_values=0
-                    )
-            image.image_buffer_list.append(new_data)
-        else:
-            pad_width = image.max_len - new_len
-            if pad_width > 0:
-                new_data = np.pad(new_data, (0, pad_width), mode="constant", constant_values=0)
-            image.image_buffer_list.append(new_data)
-
-        image_buffer = np.array(image.image_buffer_list)
-        return image_buffer
-
-    @Slot(str, np.ndarray)
-    def update_image(self, device: str, data: np.ndarray):
-        """
-        Update the image of the device monitor.
-
-        Args:
-            device(str): The name of the device.
-            data(np.ndarray): The data to be updated.
-        """
-        image_to_update = self._images[self.image_type][device]
-        image_to_update.updateImage(data, autoLevels=image_to_update.config.autorange)
-
-    @Slot(str, ImageStats)
-    def update_vrange(self, device: str, stats: ImageStats):
-        """
-        Update the scaling of the image.
-
-        Args:
-            stats(ImageStats): The statistics of the image.
-        """
-        image_to_update = self._images[self.image_type][device]
-        if image_to_update.config.autorange:
-            image_to_update.auto_update_vrange(stats)
-
-    def refresh_image(self):
-        """
-        Refresh the image.
-        """
-        for source, images in self._images.items():
-            for image_id, image in images.items():
-                data = image.raw_data
-                self.process_image(image_id, image, data)
-
-    def _connect_device_monitor(self, monitor: str):
-        """
-        Connect to the device monitor.
-
-        Args:
-            monitor(str): The name of the monitor.
-        """
-        image_item = self.find_image_by_monitor(monitor)
-        try:
-            previous_monitor = image_item.config.monitor
-        except AttributeError:
-            previous_monitor = None
-        if previous_monitor and image_item.connected is True:
-            self.bec_dispatcher.disconnect_slot(
-                self.on_image_update, MessageEndpoints.device_monitor_1d(previous_monitor)
-            )
-            self.bec_dispatcher.disconnect_slot(
-                self.on_image_update, MessageEndpoints.device_monitor_2d(previous_monitor)
-            )
-            image_item.connected = False
-        if monitor and image_item.connected is False:
-            self.entry_validator.validate_monitor(monitor)
-            if self.image_type == "device_monitor_1d":
-                self.bec_dispatcher.connect_slot(
-                    self.on_image_update, MessageEndpoints.device_monitor_1d(monitor)
-                )
-            elif self.image_type == "device_monitor_2d":
-                self.bec_dispatcher.connect_slot(
-                    self.on_image_update, MessageEndpoints.device_monitor_2d(monitor)
-                )
-            image_item.set_monitor(monitor)
-            image_item.connected = True
-
-    def _add_image_object(
-        self, source: str, name: str, config: ImageItemConfig, data=None
-    ) -> BECImageItem:
-        config.parent_id = self.gui_id
-        if self.single_image is True and len(self.images) > 0:
-            self.remove_image(0)
-        image = BECImageItem(config=config, parent_image=self)
-        self.plot_item.addItem(image)
-        self._images[source][name] = image
-        self._connect_device_monitor(config.monitor)
-        self.config.images[name] = config
-        if data is not None:
-            image.setImage(data)
-        return image
-
-    def _check_image_id(self, val: Any, dict_to_check: dict) -> bool:
-        """
-        Check if val is in the values of the dict_to_check or in the values of the nested dictionaries.
-
-        Args:
-            val(Any): Value to check.
-            dict_to_check(dict): Dictionary to check.
-
-        Returns:
-            bool: True if val is in the values of the dict_to_check or in the values of the nested dictionaries, False otherwise.
-        """
-        if val in dict_to_check.keys():
-            return True
-        for key in dict_to_check:
-            if isinstance(dict_to_check[key], dict):
-                if self._check_image_id(val, dict_to_check[key]):
-                    return True
-        return False
-
-    def remove_image(self, *identifiers):
-        """
-        Remove an image from the plot widget.
-
-        Args:
-            *identifiers: Identifier of the image to be removed. Can be either an integer (index) or a string (image_id).
-        """
-        for identifier in identifiers:
-            if isinstance(identifier, int):
-                self._remove_image_by_order(identifier)
-            elif isinstance(identifier, str):
-                self._remove_image_by_id(identifier)
-            else:
-                raise ValueError(
-                    "Each identifier must be either an integer (index) or a string (image_id)."
-                )
-
-    def _remove_image_by_id(self, image_id):
-        for source, images in self._images.items():
-            if image_id in images:
-                self._disconnect_monitor(image_id)
-                image = images.pop(image_id)
-                self.removeItem(image.color_bar)
-                self.plot_item.removeItem(image)
-                del self.config.images[image_id]
-                if image in self.images:
-                    self.images.remove(image)
-                return
-        raise KeyError(f"Image with ID '{image_id}' not found.")
-
-    def _remove_image_by_order(self, N):
-        """
-        Remove an image by its order from the plot widget.
-
-        Args:
-            N(int): Order of the image to be removed.
-        """
-        if N < len(self.images):
-            image = self.images[N]
-            image_id = image.config.monitor
-            self._disconnect_monitor(image_id)
-            self.removeItem(image.color_bar)
-            self.plot_item.removeItem(image)
-            del self.config.images[image_id]
-            for source, images in self._images.items():
-                if image_id in images:
-                    del images[image_id]
-                    break
-        else:
-            raise IndexError(f"Image order {N} out of range.")
-
-    def _disconnect_monitor(self, image_id):
-        """
-        Disconnect the monitor from the device.
-
-        Args:
-            image_id(str): The ID of the monitor.
-        """
-        image = self.find_image_by_monitor(image_id)
-        if image:
-            self.bec_dispatcher.disconnect_slot(
-                self.on_image_update, MessageEndpoints.device_monitor_1d(image.config.monitor)
-            )
-            self.bec_dispatcher.disconnect_slot(
-                self.on_image_update, MessageEndpoints.device_monitor_2d(image.config.monitor)
-            )
-
-    def cleanup(self):
-        """
-        Clean up the widget.
-        """
-        for monitor in self._images[self.image_type]:
-            self.bec_dispatcher.disconnect_slot(
-                self.on_image_update, MessageEndpoints.device_monitor_1d(monitor)
-            )
-        self.images.clear()
-
-    def cleanup_pyqtgraph(self):
-        """Cleanup pyqtgraph items."""
-        super().cleanup_pyqtgraph()
-        item = self.plot_item
-        if not item.items:
-            return
-        cbar = item.items[0].color_bar
-        cbar.vb.menu.close()
-        cbar.vb.menu.deleteLater()
-        cbar.gradient.menu.close()
-        cbar.gradient.menu.deleteLater()
-        cbar.gradient.colorDialog.close()
-        cbar.gradient.colorDialog.deleteLater()

bec_widgets/widgets/containers/figure/plots/image/image_item.py

@@ -1,337 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Literal, Optional
-
-import numpy as np
-import pyqtgraph as pg
-from bec_lib.logger import bec_logger
-from pydantic import Field
-
-from bec_widgets.utils import BECConnector, ConnectionConfig
-from bec_widgets.widgets.containers.figure.plots.image.image_processor import (
-    ImageStats,
-    ProcessingConfig,
-)
-
-if TYPE_CHECKING:
-    from bec_widgets.widgets.containers.figure.plots.image.image import BECImageShow
-
-logger = bec_logger.logger
-
-
-class ImageItemConfig(ConnectionConfig):
-    parent_id: Optional[str] = Field(None, description="The parent plot of the image.")
-    monitor: Optional[str] = Field(None, description="The name of the monitor.")
-    source: Optional[str] = Field(None, description="The source of the curve.")
-    color_map: Optional[str] = Field("magma", description="The color map of the image.")
-    downsample: Optional[bool] = Field(True, description="Whether to downsample the image.")
-    opacity: Optional[float] = Field(1.0, description="The opacity of the image.")
-    vrange: Optional[tuple[float | int, float | int]] = Field(
-        None, description="The range of the color bar. If None, the range is automatically set."
-    )
-    color_bar: Optional[Literal["simple", "full"]] = Field(
-        "simple", description="The type of the color bar."
-    )
-    autorange: Optional[bool] = Field(True, description="Whether to autorange the color bar.")
-    autorange_mode: Optional[Literal["max", "mean"]] = Field(
-        "mean", description="Whether to use the mean of the image for autoscaling."
-    )
-    processing: ProcessingConfig = Field(
-        default_factory=ProcessingConfig, description="The post processing of the image."
-    )
-
-
-class BECImageItem(BECConnector, pg.ImageItem):
-    USER_ACCESS = [
-        "_rpc_id",
-        "_config_dict",
-        "set",
-        "set_fft",
-        "set_log",
-        "set_rotation",
-        "set_transpose",
-        "set_opacity",
-        "set_autorange",
-        "set_autorange_mode",
-        "set_color_map",
-        "set_auto_downsample",
-        "set_monitor",
-        "set_vrange",
-        "get_data",
-    ]
-
-    def __init__(
-        self,
-        config: Optional[ImageItemConfig] = None,
-        gui_id: Optional[str] = None,
-        parent_image: Optional[BECImageShow] = None,
-        **kwargs,
-    ):
-        if config is None:
-            config = ImageItemConfig(widget_class=self.__class__.__name__)
-            self.config = config
-        else:
-            self.config = config
-        super().__init__(config=config, gui_id=gui_id)
-        pg.ImageItem.__init__(self)
-
-        self.parent_image = parent_image
-        self.colorbar_bar = None
-        self._raw_data = None
-
-        self._add_color_bar(
-            self.config.color_bar, self.config.vrange
-        )  # TODO can also support None to not have any colorbar
-        self.apply_config()
-        if kwargs:
-            self.set(**kwargs)
-        self.connected = False
-
-    @property
-    def raw_data(self) -> np.ndarray:
-        return self._raw_data
-
-    @raw_data.setter
-    def raw_data(self, data: np.ndarray):
-        self._raw_data = data
-
-    def apply_config(self):
-        """
-        Apply current configuration.
-        """
-        self.set_color_map(self.config.color_map)
-        self.set_auto_downsample(self.config.downsample)
-        if self.config.vrange is not None:
-            self.set_vrange(vrange=self.config.vrange)
-
-    def set(self, **kwargs):
-        """
-        Set the properties of the image.
-
-        Args:
-            **kwargs: Keyword arguments for the properties to be set.
-
-        Possible properties:
-            - downsample
-            - color_map
-            - monitor
-            - opacity
-            - vrange
-            - fft
-            - log
-            - rot
-            - transpose
-            - autorange_mode
-        """
-        method_map = {
-            "downsample": self.set_auto_downsample,
-            "color_map": self.set_color_map,
-            "monitor": self.set_monitor,
-            "opacity": self.set_opacity,
-            "vrange": self.set_vrange,
-            "fft": self.set_fft,
-            "log": self.set_log,
-            "rot": self.set_rotation,
-            "transpose": self.set_transpose,
-            "autorange_mode": self.set_autorange_mode,
-        }
-        for key, value in kwargs.items():
-            if key in method_map:
-                method_map[key](value)
-            else:
-                logger.warning(f"Warning: '{key}' is not a recognized property.")
-
-    def set_fft(self, enable: bool = False):
-        """
-        Set the FFT of the image.
-
-        Args:
-            enable(bool): Whether to perform FFT on the monitor data.
-        """
-        self.config.processing.fft = enable
-
-    def set_log(self, enable: bool = False):
-        """
-        Set the log of the image.
-
-        Args:
-            enable(bool): Whether to perform log on the monitor data.
-        """
-        self.config.processing.log = enable
-        if enable and self.color_bar and self.config.color_bar == "full":
-            self.color_bar.autoHistogramRange()
-
-    def set_rotation(self, deg_90: int = 0):
-        """
-        Set the rotation of the image.
-
-        Args:
-            deg_90(int): The rotation angle of the monitor data before displaying.
-        """
-        self.config.processing.rotation = deg_90
-
-    def set_transpose(self, enable: bool = False):
-        """
-        Set the transpose of the image.
-
-        Args:
-            enable(bool): Whether to transpose the image.
-        """
-        self.config.processing.transpose = enable
-
-    def set_opacity(self, opacity: float = 1.0):
-        """
-        Set the opacity of the image.
-
-        Args:
-            opacity(float): The opacity of the image.
-        """
-        self.setOpacity(opacity)
-        self.config.opacity = opacity
-
-    def set_autorange(self, autorange: bool = False):
-        """
-        Set the autorange of the color bar.
-
-        Args:
-            autorange(bool): Whether to autorange the color bar.
-        """
-        self.config.autorange = autorange
-        if self.color_bar and autorange:
-            self.color_bar.autoHistogramRange()
-
-    def set_autorange_mode(self, mode: Literal["max", "mean"] = "mean"):
-        """
-        Set the autorange mode to scale the vrange of the color bar. Choose between min/max or mean +/- std.
-
-        Args:
-            mode(Literal["max","mean"]): Max for min/max or mean for mean +/- std.
-        """
-        self.config.autorange_mode = mode
-
-    def set_color_map(self, cmap: str = "magma"):
-        """
-        Set the color map of the image.
-
-        Args:
-            cmap(str): The color map of the image.
-        """
-        self.setColorMap(cmap)
-        if self.color_bar is not None:
-            if self.config.color_bar == "simple":
-                self.color_bar.setColorMap(cmap)
-            elif self.config.color_bar == "full":
-                self.color_bar.gradient.loadPreset(cmap)
-        self.config.color_map = cmap
-
-    def set_auto_downsample(self, auto: bool = True):
-        """
-        Set the auto downsample of the image.
-
-        Args:
-            auto(bool): Whether to downsample the image.
-        """
-        self.setAutoDownsample(auto)
-        self.config.downsample = auto
-
-    def set_monitor(self, monitor: str):
-        """
-        Set the monitor of the image.
-
-        Args:
-            monitor(str): The name of the monitor.
-        """
-        self.config.monitor = monitor
-
-    def auto_update_vrange(self, stats: ImageStats) -> None:
-        """Auto update of the vrange base on the stats of the image.
-
-        Args:
-            stats(ImageStats): The stats of the image.
-        """
-        fumble_factor = 2
-        if self.config.autorange_mode == "mean":
-            vmin = max(stats.mean - fumble_factor * stats.std, 0)
-            vmax = stats.mean + fumble_factor * stats.std
-            self.set_vrange(vmin, vmax, change_autorange=False)
-            return
-        if self.config.autorange_mode == "max":
-            self.set_vrange(max(stats.minimum, 0), stats.maximum, change_autorange=False)
-            return
-
-    def set_vrange(
-        self,
-        vmin: float = None,
-        vmax: float = None,
-        vrange: tuple[float, float] = None,
-        change_autorange: bool = True,
-    ):
-        """
-        Set the range of the color bar.
-
-        Args:
-            vmin(float): Minimum value of the color bar.
-            vmax(float): Maximum value of the color bar.
-        """
-        if vrange is not None:
-            vmin, vmax = vrange
-        self.setLevels([vmin, vmax])
-        self.config.vrange = (vmin, vmax)
-        if change_autorange:
-            self.config.autorange = False
-        if self.color_bar is not None:
-            if self.config.color_bar == "simple":
-                self.color_bar.setLevels(low=vmin, high=vmax)
-            elif self.config.color_bar == "full":
-                # pylint: disable=unexpected-keyword-arg
-                self.color_bar.setLevels(min=vmin, max=vmax)
-                self.color_bar.setHistogramRange(vmin - 0.1 * vmin, vmax + 0.1 * vmax)
-
-    def get_data(self) -> np.ndarray:
-        """
-        Get the data of the image.
-        Returns:
-            np.ndarray: The data of the image.
-        """
-        return self.image
-
-    def _add_color_bar(
-        self, color_bar_style: str = "simple", vrange: Optional[tuple[int, int]] = None
-    ):
-        """
-        Add color bar to the layout.
-
-        Args:
-            style(Literal["simple,full"]): The style of the color bar.
-            vrange(tuple[int,int]): The range of the color bar.
-        """
-        if color_bar_style == "simple":
-            self.color_bar = pg.ColorBarItem(colorMap=self.config.color_map)
-            if vrange is not None:
-                self.color_bar.setLevels(low=vrange[0], high=vrange[1])
-            self.color_bar.setImageItem(self)
-            self.parent_image.addItem(self.color_bar, row=1, col=1)
-            self.config.color_bar = "simple"
-        elif color_bar_style == "full":
-            # Setting histogram
-            self.color_bar = pg.HistogramLUTItem()
-            self.color_bar.setImageItem(self)
-            self.color_bar.gradient.loadPreset(self.config.color_map)
-            if vrange is not None:
-                self.color_bar.setLevels(min=vrange[0], max=vrange[1])
-                self.color_bar.setHistogramRange(
-                    vrange[0] - 0.1 * vrange[0], vrange[1] + 0.1 * vrange[1]
-                )
-
-            # Adding histogram to the layout
-            self.parent_image.addItem(self.color_bar, row=1, col=1)
-
-            # save settings
-            self.config.color_bar = "full"
-        else:
-            raise ValueError("style should be 'simple' or 'full'")
-
-    def remove(self):
-        """Remove the curve from the plot."""
-        self.parent_image.remove_image(self.config.monitor)
-        self.rpc_register.remove_rpc(self)