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')

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,41 +0,0 @@
-name: Bug report
-description: File a bug report.
-title: "[BUG]: "
-labels: ["bug"]
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Bug report:
-  - type: textarea
-    id: description
-    attributes:
-      label: Provide a brief description of the bug.
-  - type: textarea
-    id: expected
-    attributes:
-      label: Describe what you expected to happen and what actually happened.
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.
-  - type: input
-    id: version
-    attributes:
-      label: bec_widgets version
-      description: which version of BEC widgets was running?
-  - type: input
-    id: bec-version
-    attributes:
-      label: bec core version
-      description: which version of BEC core was running?
-  - type: textarea
-    id: extra
-    attributes:
-      label: Any extra info / data? e.g. log output...
-  - type: input
-    id: issues
-    attributes:
-      label: Related issues
-      description: please tag any related issues

.github/ISSUE_TEMPLATE/documentation_update.md

@@ -1,37 +0,0 @@
----
-name: Documentation update request
-about: Suggest an update to the docs
-title: '[DOCS]: '
-type: documentation
-label: documentation
-assignees: ''
-
----
-
-## 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]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,49 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: '[FEAT]: '
-type: feature
-label: feature
-assignees: ''
-
----
-
-## 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]

.github/actions/bw_install/action.yml

@@ -1,64 +0,0 @@
-name: "BEC Widgets Install"
-description: "Install BEC Widgets and related os dependencies"
-inputs:
-  BEC_WIDGETS_BRANCH: # id of input
-    required: false
-    default: "main"
-    description: "Branch of BEC Widgets to install"
-  BEC_CORE_BRANCH: # id of input
-    required: false
-    default: "main"
-    description: "Branch of BEC Core to install"
-  OPHYD_DEVICES_BRANCH: # id of input
-    required: false
-    default: "main"
-    description: "Branch of Ophyd Devices to install"
-  PYTHON_VERSION: # id of input
-    required: false
-    default: "3.11"
-    description: "Python version to use"
-
-runs:
-  using: "composite"
-  steps:
-    - name: Setup Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ inputs.PYTHON_VERSION }}
-
-    - name: Checkout BEC Core
-      uses: actions/checkout@v4
-      with:
-        repository: bec-project/bec
-        ref: ${{ inputs.BEC_CORE_BRANCH }}
-        path: ./bec
-
-    - name: Checkout Ophyd Devices
-      uses: actions/checkout@v4
-      with:
-        repository: bec-project/ophyd_devices
-        ref: ${{ inputs.OPHYD_DEVICES_BRANCH }}
-        path: ./ophyd_devices
-
-    - name: Checkout BEC Widgets
-      uses: actions/checkout@v4
-      with:
-        repository: bec-project/bec_widgets
-        ref: ${{ inputs.BEC_WIDGETS_BRANCH }}
-        path: ./bec_widgets
-
-    - name: Install dependencies
-      shell: bash
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y libgl1 libegl1 x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb
-        sudo apt-get -y install libnss3 libxdamage1 libasound2t64 libatomic1 libxcursor1
-
-    - name: Install Python dependencies
-      shell: bash
-      run: |
-        pip install uv
-        uv pip install --system -e ./ophyd_devices
-        uv pip install --system -e ./bec/bec_lib[dev]
-        uv pip install --system -e ./bec/bec_ipython_client
-        uv pip install --system -e ./bec_widgets[dev,pyside6]

.github/pull_request_template.md

@@ -1,33 +0,0 @@
-## Description
-
-[Provide a brief description of the changes introduced by this pull request.]
-
-## Related Issues
-
-[Cite any related issues or feature requests that are addressed or resolved by this pull request. Link the associated issue, for example, with `fixes #123` or `closes #123`.]
-
-## Type of Change
-
-- Change 1
-- Change 2
-
-## How to test
-
-- Run unit tests
-- Open [widget] in designer and play around with the properties
-
-## Potential side effects
-
-[Describe any potential side effects or risks of merging this PR.]
-
-## 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.
-

.github/scripts/pr_issue_sync/pr_issue_sync.py

@@ -1,342 +0,0 @@
-import functools
-import os
-from typing import Literal
-
-import requests
-from github import Github
-from pydantic import BaseModel
-
-
-class GHConfig(BaseModel):
-    token: str
-    organization: str
-    repository: str
-    project_number: int
-    graphql_url: str
-    rest_url: str
-    headers: dict
-
-
-class ProjectItemHandler:
-    """
-    A class to handle GitHub project items.
-    """
-
-    def __init__(self, gh_config: GHConfig):
-        self.gh_config = gh_config
-        self.gh = Github(gh_config.token)
-        self.repo = self.gh.get_repo(f"{gh_config.organization}/{gh_config.repository}")
-        self.project_node_id = self.get_project_node_id()
-
-    def set_issue_status(
-        self,
-        status: Literal[
-            "Selected for Development",
-            "Weekly Backlog",
-            "In Development",
-            "Ready For Review",
-            "On Hold",
-            "Done",
-        ],
-        issue_number: int | None = None,
-        issue_node_id: str | None = None,
-    ):
-        """
-        Set the status field of a GitHub issue in the project.
-
-        Args:
-            status (str): The status to set. Must be one of the predefined statuses.
-            issue_number (int, optional): The issue number. If not provided, issue_node_id must be provided.
-            issue_node_id (str, optional): The issue node ID. If not provided, issue_number must be provided.
-        """
-        if not issue_number and not issue_node_id:
-            raise ValueError("Either issue_number or issue_node_id must be provided.")
-        if issue_number and issue_node_id:
-            raise ValueError("Only one of issue_number or issue_node_id must be provided.")
-        if issue_number is not None:
-            issue = self.repo.get_issue(issue_number)
-            issue_id = self.get_issue_info(issue.node_id)[0]["id"]
-        else:
-            issue_id = issue_node_id
-        field_id, option_id = self.get_status_field_id(field_name=status)
-        self.set_field_option(issue_id, field_id, option_id)
-
-    def run_graphql(self, query: str, variables: dict) -> dict:
-        """
-        Execute a GraphQL query against the GitHub API.
-
-        Args:
-            query (str): The GraphQL query to execute.
-            variables (dict): The variables to pass to the query.
-
-        Returns:
-            dict: The response from the GitHub API.
-        """
-        response = requests.post(
-            self.gh_config.graphql_url,
-            json={"query": query, "variables": variables},
-            headers=self.gh_config.headers,
-            timeout=10,
-        )
-        if response.status_code != 200:
-            raise Exception(
-                f"Query failed with status code {response.status_code}: {response.text}"
-            )
-        return response.json()
-
-    def get_project_node_id(self):
-        """
-        Retrieve the project node ID from the GitHub API.
-        """
-        query = """
-      query($owner: String!, $number: Int!) {
-        organization(login: $owner) {
-          projectV2(number: $number) {
-            id
-          }
-        }
-      }
-      """
-        variables = {"owner": self.gh_config.organization, "number": self.gh_config.project_number}
-        resp = self.run_graphql(query, variables)
-        return resp["data"]["organization"]["projectV2"]["id"]
-
-    def get_issue_info(self, issue_node_id: str):
-        """
-        Get the project-related information for a given issue node ID.
-
-        Args:
-            issue_node_id (str): The node ID of the issue. Please note that this is not the issue number and typically starts with "I".
-
-        Returns:
-            list[dict]: A list of project items associated with the issue.
-        """
-        query = """
-        query($issueId: ID!) {
-          node(id: $issueId) {
-            ... on Issue {
-              projectItems(first: 10) {
-                nodes {
-                  project {
-                    id
-                    title
-                  }
-                  id
-                  fieldValues(first: 20) {
-                    nodes {
-                      ... on ProjectV2ItemFieldSingleSelectValue {
-                        name
-                        field {
-                          ... on ProjectV2SingleSelectField {
-                            name
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-        """
-        variables = {"issueId": issue_node_id}
-        resp = self.run_graphql(query, variables)
-        return resp["data"]["node"]["projectItems"]["nodes"]
-
-    def get_status_field_id(
-        self,
-        field_name: Literal[
-            "Selected for Development",
-            "Weekly Backlog",
-            "In Development",
-            "Ready For Review",
-            "On Hold",
-            "Done",
-        ],
-    ) -> tuple[str, str]:
-        """
-        Get the status field ID and option ID for the given field name in the project.
-
-        Args:
-            field_name (str): The name of the field to retrieve.
-                Must be one of the predefined statuses.
-
-        Returns:
-            tuple[str, str]: A tuple containing the field ID and option ID.
-        """
-        field_id = None
-        option_id = None
-        project_fields = self.get_project_fields()
-        for field in project_fields:
-            if field["name"] != "Status":
-                continue
-            field_id = field["id"]
-            for option in field["options"]:
-                if option["name"] == field_name:
-                    option_id = option["id"]
-                    break
-        if not field_id or not option_id:
-            raise ValueError(f"Field '{field_name}' not found in project fields.")
-
-        return field_id, option_id
-
-    def set_field_option(self, item_id, field_id, option_id):
-        """
-        Set the option of a project item for a single-select field.
-
-        Args:
-            item_id (str): The ID of the project item to update.
-            field_id (str): The ID of the field to update.
-            option_id (str): The ID of the option to set.
-        """
-
-        mutation = """
-        mutation($projectId: ID!, $itemId: ID!, $fieldId: ID!, $optionId: String!) {
-          updateProjectV2ItemFieldValue(
-            input: {
-              projectId: $projectId
-              itemId: $itemId
-              fieldId: $fieldId
-              value: { singleSelectOptionId: $optionId }
-            }
-          ) {
-            projectV2Item {
-              id
-            }
-          }
-        }
-        """
-        variables = {
-            "projectId": self.project_node_id,
-            "itemId": item_id,
-            "fieldId": field_id,
-            "optionId": option_id,
-        }
-        return self.run_graphql(mutation, variables)
-
-    @functools.lru_cache(maxsize=1)
-    def get_project_fields(self) -> list[dict]:
-        """
-        Get the available fields in the project.
-        This method caches the result to avoid multiple API calls.
-
-        Returns:
-            list[dict]: A list of fields in the project.
-        """
-
-        query = """
-    query($projectId: ID!) {
-      node(id: $projectId) {
-        ... on ProjectV2 {
-          fields(first: 50) {
-            nodes {
-              ... on ProjectV2SingleSelectField {
-                id
-                name
-                options {
-                  id
-                  name
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-    """
-        variables = {"projectId": self.project_node_id}
-        resp = self.run_graphql(query, variables)
-        return list(filter(bool, resp["data"]["node"]["fields"]["nodes"]))
-
-    def get_pull_request_linked_issues(self, pr_number: int) -> list[dict]:
-        """
-        Get the linked issues of a pull request.
-
-        Args:
-            pr_number (int): The pull request number.
-
-        Returns:
-            list[dict]: A list of linked issues.
-        """
-        query = """
-    query($number: Int!, $owner: String!, $repo: String!) {
-      repository(owner: $owner, name: $repo) {
-        pullRequest(number: $number) {
-          id
-          closingIssuesReferences(first: 50) {
-            edges {
-              node {
-                id
-                body
-                number
-                title
-              }
-            }
-          }
-        }
-      }
-    }
-    """
-        variables = {
-            "number": pr_number,
-            "owner": self.gh_config.organization,
-            "repo": self.gh_config.repository,
-        }
-        resp = self.run_graphql(query, variables)
-        edges = resp["data"]["repository"]["pullRequest"]["closingIssuesReferences"]["edges"]
-        return [edge["node"] for edge in edges if edge.get("node")]
-
-
-def main():
-    # GitHub settings
-    token = os.getenv("TOKEN")
-    org = os.getenv("ORG")
-    repo = os.getenv("REPO")
-    project_number = os.getenv("PROJECT_NUMBER")
-    pr_number = os.getenv("PR_NUMBER")
-
-    if not token:
-        raise ValueError("GitHub token is not set. Please set the TOKEN environment variable.")
-    if not org:
-        raise ValueError("GitHub organization is not set. Please set the ORG environment variable.")
-    if not repo:
-        raise ValueError("GitHub repository is not set. Please set the REPO environment variable.")
-    if not project_number:
-        raise ValueError(
-            "GitHub project number is not set. Please set the PROJECT_NUMBER environment variable."
-        )
-    if not pr_number:
-        raise ValueError(
-            "Pull request number is not set. Please set the PR_NUMBER environment variable."
-        )
-
-    project_number = int(project_number)
-    pr_number = int(pr_number)
-
-    gh_config = GHConfig(
-        token=token,
-        organization=org,
-        repository=repo,
-        project_number=project_number,
-        graphql_url="https://api.github.com/graphql",
-        rest_url=f"https://api.github.com/repos/{org}/{repo}/issues",
-        headers={"Authorization": f"Bearer {token}", "Accept": "application/vnd.github+json"},
-    )
-    project_item_handler = ProjectItemHandler(gh_config=gh_config)
-
-    # Get PR info
-    pr = project_item_handler.repo.get_pull(pr_number)
-
-    # Get the linked issues of the pull request
-    linked_issues = project_item_handler.get_pull_request_linked_issues(pr_number=pr_number)
-    print(f"Linked issues: {linked_issues}")
-
-    target_status = "In Development" if pr.draft else "Ready For Review"
-    print(f"Target status: {target_status}")
-    for issue in linked_issues:
-        project_item_handler.set_issue_status(issue_number=issue["number"], status=target_status)
-
-
-if __name__ == "__main__":
-    main()

.github/scripts/pr_issue_sync/requirements.txt

@@ -1,2 +0,0 @@
-pydantic
-pygithub

.github/workflows/check_pr.yml

@@ -1,28 +0,0 @@
-name: Check PR status for branch
-on:
-  workflow_call:
-    outputs:
-      branch-pr:
-        description: The PR number if the branch is in one
-        value: ${{ jobs.pr.outputs.branch-pr }}
-
-jobs:
-  pr:
-    runs-on: "ubuntu-latest"
-    outputs:
-      branch-pr: ${{ steps.script.outputs.result }}
-    steps:
-      - uses: actions/github-script@v7
-        id: script
-        if: github.event_name == 'push' && github.event.ref_type != 'tag'
-        with:
-          script: |
-            const prs = await github.rest.pulls.list({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              head: context.repo.owner + ':${{ github.ref_name }}'
-            })
-            if (prs.data.length) {
-              console.log(`::notice ::Skipping CI on branch push as it is already run in PR #${prs.data[0]["number"]}`)
-              return prs.data[0]["number"]
-            }

.github/workflows/ci.yml

@@ -1,60 +0,0 @@
-name: Full CI
-on: 
-  push:
-  pull_request:
-  workflow_dispatch:
-    inputs:
-      BEC_WIDGETS_BRANCH:
-        description: 'Branch of BEC Widgets to install'
-        required: false
-        type: string
-      BEC_CORE_BRANCH:
-        description: 'Branch of BEC Core to install'
-        required: false
-        type: string
-      OPHYD_DEVICES_BRANCH:
-        description: 'Branch of Ophyd Devices to install'
-        required: false
-        type: string
-
-permissions:
-  pull-requests: write
-
-jobs:
-  check_pr_status:
-    uses: ./.github/workflows/check_pr.yml
-
-  formatter:
-    needs: check_pr_status
-    if: needs.check_pr_status.outputs.branch-pr == ''
-    uses: ./.github/workflows/formatter.yml
-
-  unit-test:
-    needs: [check_pr_status, formatter]
-    if: needs.check_pr_status.outputs.branch-pr == ''
-    uses: ./.github/workflows/pytest.yml
-    with:
-      BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || github.head_ref }}
-      BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || 'main' }}
-      OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }}
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  unit-test-matrix:
-    needs: [check_pr_status, formatter]
-    if: needs.check_pr_status.outputs.branch-pr == ''
-    uses: ./.github/workflows/pytest-matrix.yml
-    with:
-      BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH || github.head_ref || github.sha}}
-      BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH || 'main' }}
-      OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH || 'main' }}
-
-  generate-cli-test:
-    needs: [check_pr_status, formatter]
-    if: needs.check_pr_status.outputs.branch-pr == ''
-    uses: ./.github/workflows/generate-cli-check.yml
-
-  end2end-test:
-    needs: [check_pr_status, formatter]
-    if: needs.check_pr_status.outputs.branch-pr == ''
-    uses: ./.github/workflows/end2end-conda.yml

.github/workflows/end2end-conda.yml

@@ -1,58 +0,0 @@
-name: Run Pytest with Coverage
-on: [workflow_call]
-
-jobs:
-  pytest:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash -el {0}
-
-    env:
-      CHILD_PIPELINE_BRANCH: main  # Set the branch you want for ophyd_devices
-      BEC_CORE_BRANCH: main        # Set the branch you want for bec
-      OPHYD_DEVICES_BRANCH: main   # Set the branch you want for ophyd_devices
-      PLUGIN_REPO_BRANCH: main     # Set the branch you want for the plugin repo
-      PROJECT_PATH: ${{ github.repository }}
-      QTWEBENGINE_DISABLE_SANDBOX: 1
-      QT_QPA_PLATFORM: "offscreen"
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Conda
-        uses: conda-incubator/setup-miniconda@v3
-        with:
-            auto-update-conda: true
-            auto-activate-base: true
-            python-version: '3.11'
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libgl1 libegl1 x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb
-          sudo apt-get -y install libnss3 libxdamage1 libasound2t64 libatomic1 libxcursor1
-
-      - name: Conda install and run pytest
-        run: |
-          echo -e "\033[35;1m Using branch $BEC_CORE_BRANCH of BEC CORE \033[0;m";
-          git clone --branch $BEC_CORE_BRANCH https://github.com/bec-project/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://github.com/bec-project/ophyd_devices.git
-          export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
-          echo -e "\033[35;1m Using branch $PLUGIN_REPO_BRANCH of bec_testing_plugin \033[0;m";
-          git clone --branch $PLUGIN_REPO_BRANCH https://github.com/bec-project/bec_testing_plugin.git
-          cd ./bec
-          conda create -q -n test-environment python=3.11
-          source ./bin/install_bec_dev.sh -t
-          cd ../
-          pip install -e ./ophyd_devices -e .[dev,pyside6] -e ./bec_testing_plugin
-          pytest -v --files-path ./ --start-servers --random-order  ./tests/end-2-end
-
-      - name: Upload logs if job fails
-        if: failure()
-        uses: actions/upload-artifact@v4
-        with:
-          name: pytest-logs
-          path: ./logs/*.log
-          retention-days: 7

.github/workflows/formatter.yml

@@ -1,61 +0,0 @@
-name: Formatter and Pylint jobs
-on: [workflow_call]
-jobs:
-
-  Formatter:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.13' 
-
-      - name: Run black and isort
-        run: |
-          pip install black isort
-          pip install -e .[dev]
-          black --check --diff --color .
-          isort --check --diff ./
-  Pylint:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.13'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pylint pylint-exit anybadge
-
-      - name: Run Pylint
-        run: |
-          mkdir -p ./pylint
-          set +e
-          pylint ./${{ github.event.repository.name }} --output-format=text > ./pylint/pylint.log
-          pylint-exit $?
-          set -e
-
-      - name: Extract Pylint Score
-        id: score
-        run: |
-          SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log)
-          echo "score=$SCORE" >> $GITHUB_OUTPUT
-
-      - name: Create Badge
-        run: |
-          anybadge --label=Pylint --file=./pylint/pylint.svg --value="${{ steps.score.outputs.score }}" 2=red 4=orange 8=yellow 10=green
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: pylint-artifacts
-          path: |
-            # ./pylint/pylint.log # not sure why this isn't working
-            ./pylint/pylint.svg

.github/workflows/generate-cli-check.yml

@@ -1,49 +0,0 @@
-name: Run bw-generate-cli
-on: [workflow_call]
-
-jobs:
-  pytest:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        shell: bash -el {0}
-
-    env:
-      CHILD_PIPELINE_BRANCH: main  # Set the branch you want for ophyd_devices
-      BEC_CORE_BRANCH: main        # Set the branch you want for bec
-      OPHYD_DEVICES_BRANCH: main   # Set the branch you want for ophyd_devices
-      PROJECT_PATH: ${{ github.repository }}
-      QTWEBENGINE_DISABLE_SANDBOX: 1
-      QT_QPA_PLATFORM: "offscreen"
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.11"
-
-      - name: Install os dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libgl1 libegl1 x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb
-          sudo apt-get -y install libnss3 libxdamage1 libasound2t64 libatomic1 libxcursor1
-
-      - name: Clone and install dependencies
-        run: |
-            echo -e "\033[35;1m Using branch $BEC_CORE_BRANCH of BEC CORE \033[0;m";
-            git clone --branch $BEC_CORE_BRANCH https://github.com/bec-project/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://github.com/bec-project/ophyd_devices.git
-            export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
-            pip install -e ./ophyd_devices
-            pip install -e ./bec/bec_lib[dev]
-            pip install -e ./bec/bec_ipython_client
-            pip install -e .[dev,pyside6]
-
-      - name: Run bw-generate-cli
-        run: |
-            bw-generate-cli --target bec_widgets 
-            git diff --exit-code
-            

.github/workflows/pytest-matrix.yml

@@ -1,59 +0,0 @@
-name: Run Pytest with different Python versions
-on: 
-  workflow_call:
-    inputs:
-      pr_number:
-        description: 'Pull request number'
-        required: false
-        type: number
-      BEC_CORE_BRANCH:
-        description: 'Branch of BEC Core to install'
-        required: false
-        default: 'main'
-        type: string
-      OPHYD_DEVICES_BRANCH:
-        description: 'Branch of Ophyd Devices to install'
-        required: false
-        default: 'main'
-        type: string
-      BEC_WIDGETS_BRANCH:
-        description: 'Branch of BEC Widgets to install'
-        required: false
-        default: 'main'
-        type: string
-
-jobs:
-  pytest-matrix:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
-
-    env:
-      BEC_WIDGETS_BRANCH: main  # Set the branch you want for bec_widgets
-      BEC_CORE_BRANCH: main        # Set the branch you want for bec
-      OPHYD_DEVICES_BRANCH: main   # Set the branch you want for ophyd_devices
-      PROJECT_PATH: ${{ github.repository }}
-      QTWEBENGINE_DISABLE_SANDBOX: 1
-      QT_QPA_PLATFORM: "offscreen"
-
-    steps:
-
-      - name: Checkout BEC Widgets
-        uses: actions/checkout@v4
-        with:
-          repository: bec-project/bec_widgets
-          ref: ${{ inputs.BEC_WIDGETS_BRANCH }}
-
-      - name: Install BEC Widgets and dependencies
-        uses: ./.github/actions/bw_install
-        with:
-          BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH }}
-          BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH }}
-          OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH }}
-          PYTHON_VERSION: ${{ matrix.python-version }}
-
-      - name: Run Pytest
-        run: |
-          pip install pytest pytest-random-order
-          pytest -v --maxfail=2 --junitxml=report.xml --random-order ./tests/unit_tests

.github/workflows/pytest.yml

@@ -1,64 +0,0 @@
-name: Run Pytest with Coverage
-on: 
-  workflow_call:
-    inputs:
-      pr_number:
-        description: 'Pull request number'
-        required: false
-        type: number
-      BEC_CORE_BRANCH:
-        description: 'Branch of BEC Core to install'
-        required: false
-        default: 'main'
-        type: string
-      OPHYD_DEVICES_BRANCH:
-        description: 'Branch of Ophyd Devices to install'
-        required: false
-        default: 'main'
-        type: string
-      BEC_WIDGETS_BRANCH:
-        description: 'Branch of BEC Widgets to install'
-        required: false
-        default: 'main'
-        type: string
-    secrets:
-      CODECOV_TOKEN:
-        required: true
-
-
-
-permissions:
-  pull-requests: write
-
-jobs:
-  pytest:
-    runs-on: ubuntu-latest
-
-    env:
-      QTWEBENGINE_DISABLE_SANDBOX: 1
-      QT_QPA_PLATFORM: "offscreen"
-
-    steps:
-      - name: Checkout BEC Widgets
-        uses: actions/checkout@v4
-        with:
-          repository: bec-project/bec_widgets
-          ref: ${{ inputs.BEC_WIDGETS_BRANCH }}
-
-      - name: Install BEC Widgets and dependencies
-        uses: ./.github/actions/bw_install
-        with:
-          BEC_WIDGETS_BRANCH: ${{ inputs.BEC_WIDGETS_BRANCH }}
-          BEC_CORE_BRANCH: ${{ inputs.BEC_CORE_BRANCH }}
-          OPHYD_DEVICES_BRANCH: ${{ inputs.OPHYD_DEVICES_BRANCH }}
-          PYTHON_VERSION: 3.11
-
-      - name: Run Pytest with Coverage
-        id: coverage
-        run: pytest --random-order --cov=bec_widgets --cov-config=pyproject.toml --cov-branch --cov-report=xml --no-cov-on-fail tests/unit_tests/
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: bec-project/bec_widgets

.github/workflows/semantic_release.yml

@@ -1,103 +0,0 @@
-name: Continuous Delivery
-
-on:
-  push:
-    branches:
-      - main
-
-# default: least privileged permissions across all jobs
-permissions:
-  contents: read
-
-
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    concurrency:
-      group: ${{ github.workflow }}-release-${{ github.ref_name }}
-      cancel-in-progress: false
-
-    env:
-      CHILD_PIPELINE_BRANCH: main  # Set the branch you want for ophyd_devices
-      BEC_CORE_BRANCH: main        # Set the branch you want for bec
-      OPHYD_DEVICES_BRANCH: main   # Set the branch you want for ophyd_devices
-      PROJECT_PATH: ${{ github.repository }}
-      QTWEBENGINE_DISABLE_SANDBOX: 1
-      QT_QPA_PLATFORM: "offscreen"
-
-    permissions:
-      contents: write
-
-    steps:
-      # Note: We checkout the repository at the branch that triggered the workflow
-      # with the entire history to ensure to match PSR's release branch detection
-      # and history evaluation.
-      # However, we forcefully reset the branch to the workflow sha because it is
-      # possible that the branch was updated while the workflow was running. This
-      # prevents accidentally releasing un-evaluated changes.
-      - name: Setup | Checkout Repository on Release Branch
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.ref_name }}
-          fetch-depth: 0
-          ssh-key: ${{ secrets.CI_DEPLOY_SSH_KEY }}
-          ssh-known-hosts: ${{ secrets.CI_DEPLOY_SSH_KNOWN_HOSTS }}
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.11'
-
-      - name: Setup | Force release branch to be at workflow sha
-        run: |
-          git reset --hard ${{ github.sha }}
-      - name: Evaluate | Verify upstream has NOT changed
-        # Last chance to abort before causing an error as another PR/push was applied to
-        # the upstream branch while this workflow was running. This is important
-        # because we are committing a version change (--commit). You may omit this step
-        # if you have 'commit: false' in your configuration.
-        #
-        # You may consider moving this to a repo script and call it from this step instead
-        # of writing it in-line.
-        shell: bash
-        run: |
-          set +o pipefail
-
-          UPSTREAM_BRANCH_NAME="$(git status -sb | head -n 1 | cut -d' ' -f2 | grep -E '\.{3}' | cut -d'.' -f4)"
-          printf '%s\n' "Upstream branch name: $UPSTREAM_BRANCH_NAME"
-
-          set -o pipefail
-
-          if [ -z "$UPSTREAM_BRANCH_NAME" ]; then
-              printf >&2 '%s\n' "::error::Unable to determine upstream branch name!"
-              exit 1
-          fi
-
-          git fetch "${UPSTREAM_BRANCH_NAME%%/*}"
-
-          if ! UPSTREAM_SHA="$(git rev-parse "$UPSTREAM_BRANCH_NAME")"; then
-              printf >&2 '%s\n' "::error::Unable to determine upstream branch sha!"
-              exit 1
-          fi
-
-          HEAD_SHA="$(git rev-parse HEAD)"
-
-          if [ "$HEAD_SHA" != "$UPSTREAM_SHA" ]; then
-              printf >&2 '%s\n' "[HEAD SHA] $HEAD_SHA != $UPSTREAM_SHA [UPSTREAM SHA]"
-              printf >&2 '%s\n' "::error::Upstream has changed, aborting release..."
-              exit 1
-          fi
-
-          printf '%s\n' "Verified upstream branch has not changed, continuing with release..."
-
-      - name: Semantic Version Release
-        id: release
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          pip install python-semantic-release==9.* wheel build twine
-          semantic-release -vv version
-          if [ ! -d dist ]; then echo No release will be made; exit 0; fi
-          twine upload dist/* -u __token__ -p ${{ secrets.CI_PYPI_TOKEN }} --skip-existing
-          semantic-release publish

.github/workflows/sync-issues-pr.yml

@@ -1,40 +0,0 @@
-name: Sync PR to Project
-
-on:
-  pull_request:
-    types: [opened, edited, ready_for_review, converted_to_draft, reopened, synchronize]
-
-jobs:
-  sync-project:
-    runs-on: ubuntu-latest
-
-    permissions:
-      issues: write
-      pull-requests: read
-      contents: read
-
-    env:
-        PROJECT_NUMBER: 3 # BEC Project
-        ORG: 'bec-project'
-        REPO: 'bec_widgets'
-        TOKEN: ${{ secrets.ADD_ISSUE_TO_PROJECT }}
-        PR_NUMBER: ${{ github.event.pull_request.number }}
-
-    steps:
-      - name: Set up python environment
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
-
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          repository: ${{ github.repository }}
-          ref: ${{ github.event.pull_request.head.ref }}
-
-      - name: Install dependencies
-        run: |
-          pip install -r ./.github/scripts/pr_issue_sync/requirements.txt
-      - name: Sync PR to Project
-        run: |
-          python ./.github/scripts/pr_issue_sync/pr_issue_sync.py

.gitignore

@@ -64,9 +64,6 @@ coverage.xml
 .pytest_cache/
 cover/
 
-# Output from end2end testing
-tests/reference_failures/
-
 # Translations
 *.mo
 *.pot

.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"
-      pip_args: ".[dev]"
 
 # 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
-  - pip install -e ./bec/pytest_bec_e2e
-
-.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 -e ./[dev]
-    - isort --check --diff --line-length=100 --profile=black --multi-line=3 --trailing-comma ./
-    - black --check --diff --color --line-length=100 --skip-magic-trailing-comma ./
-  rules:
-    - if: $CI_PROJECT_PATH == "bec/bec_widgets"
-
+    - pip install black
+    - black --check --diff --color --line-length=100 ./
 pylint:
   stage: Formatter
   needs: []
-  before_script:
+  script:
     - pip install pylint pylint-exit anybadge
     - pip install -e .[dev]
-  script:
     - 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,153 +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,pyside6]
-    - 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
 
-generate-client-check:
-  stage: test
-  needs: []
-  variables:
-    QT_QPA_PLATFORM: "offscreen"
-  script:
-    - *clone-repos
-    - *install-os-packages
-    - *install-repos
-    - pip install -e .[dev,pyside6]
-    - bw-generate-cli --target bec_widgets
-    # if there are changes in the generated files, fail the job
-    - git diff --exit-code
-
-test-matrix:
-  parallel:
-    matrix:
-      - PYTHON_VERSION:
-          - "3.10"
-          - "3.11"
-          - "3.12"
-        QT_PCKG:
-          - "pyside6"
-
-  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:25.1.1-2
-  allow_failure: false
-  variables:
-    QT_QPA_PLATFORM: "offscreen"
-  script:
-    - *clone-repos
-    - *install-os-packages
-    - conda config --show-sources
-    - conda config --add channels conda-forge
-    - conda config --system --remove channels https://repo.anaconda.com/pkgs/main
-    - conda config --system --remove channels https://repo.anaconda.com/pkgs/r
-    - conda config --remove channels https://repo.anaconda.com/pkgs/main
-    - conda config --remove channels https://repo.anaconda.com/pkgs/r
-    - conda config --show-sources
-    - 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,pyside6]
-    - pytest -v --files-path ./ --start-servers --random-order  ./tests/end-2-end
-
-  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"'
-    - if: "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^pre_release.*$/"
 
 semver:
   stage: Deploy
@@ -261,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"'

.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,27 +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-22.04
-  tools:
-    python: "3.11"
-
-# 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
-    - method: pip
-      path: .[dev]

LICENSE

@@ -1,29 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2025, Paul Scherrer Institute
-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,81 +1,2 @@
 # BEC Widgets
 
-
-[![CI](https://github.com/bec-project/bec_widgets/actions/workflows/ci.yml/badge.svg)](https://github.com/bec-project/bec_widgets/actions/workflows/ci.yml)
-[![badge](https://img.shields.io/pypi/v/bec-widgets)](https://pypi.org/project/bec-widgets/)
-[![License](https://img.shields.io/github/license/bec-project/bec_widgets)](./LICENSE)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue?logo=python&logoColor=white)](https://www.python.org)
-[![PySide6](https://img.shields.io/badge/PySide6-blue?logo=qt&logoColor=white)](https://doc.qt.io/qtforpython/)
-[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
-[![codecov](https://codecov.io/gh/bec-project/bec_widgets/graph/badge.svg?token=0Z9IQRJKMY)](https://codecov.io/gh/bec-project/bec_widgets)
-
-
-**⚠️ Important Notice:**
-
-🚨 **PyQt6 is no longer supported** due to incompatibilities with Qt Designer. Please use **PySide6** instead. 🚨
-
-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[pyside6]
-```
-
-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,pyside6]
-```
-
-BEC Widgets now **only supports PySide6**. Users must manually install PySide6 as no default Qt distribution is
-specified.
-
-## 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/__init__.py

@@ -1,4 +0,0 @@
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.error_popups import SafeProperty, SafeSlot
-
-__all__ = ["BECWidget", "SafeSlot", "SafeProperty"]

bec_widgets/applications/bw_launch.py

@@ -1,23 +0,0 @@
-from __future__ import annotations
-
-from bec_widgets.widgets.containers.auto_update.auto_updates import AutoUpdates
-from bec_widgets.widgets.containers.dock.dock_area import BECDockArea
-
-
-def dock_area(object_name: str | None = None) -> BECDockArea:
-    _dock_area = BECDockArea(object_name=object_name, root_widget=True)
-    return _dock_area
-
-
-def auto_update_dock_area(object_name: str | None = None) -> AutoUpdates:
-    """
-    Create a dock area with auto update enabled.
-
-    Args:
-        object_name(str): The name of the dock area.
-
-    Returns:
-        BECDockArea: The created dock area.
-    """
-    _auto_update = AutoUpdates(object_name=object_name)
-    return _auto_update

bec_widgets/applications/launch_window.py

@@ -1,583 +0,0 @@
-from __future__ import annotations
-
-import os
-import xml.etree.ElementTree as ET
-from typing import TYPE_CHECKING, Callable
-
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import Qt, Signal  # type: ignore
-from qtpy.QtGui import QFontMetrics, QPainter, QPainterPath, QPixmap
-from qtpy.QtWidgets import (
-    QApplication,
-    QComboBox,
-    QFileDialog,
-    QHBoxLayout,
-    QLabel,
-    QPushButton,
-    QSizePolicy,
-    QSpacerItem,
-    QWidget,
-)
-
-import bec_widgets
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
-from bec_widgets.utils.bec_plugin_helper import get_all_plugin_widgets
-from bec_widgets.utils.container_utils import WidgetContainerUtils
-from bec_widgets.utils.error_popups import SafeSlot
-from bec_widgets.utils.name_utils import pascal_to_snake
-from bec_widgets.utils.plugin_utils import get_plugin_auto_updates
-from bec_widgets.utils.round_frame import RoundedFrame
-from bec_widgets.utils.toolbar import ModularToolBar
-from bec_widgets.utils.ui_loader import UILoader
-from bec_widgets.widgets.containers.auto_update.auto_updates import AutoUpdates
-from bec_widgets.widgets.containers.dock.dock_area import BECDockArea
-from bec_widgets.widgets.containers.main_window.main_window import BECMainWindow, UILaunchWindow
-from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
-
-if TYPE_CHECKING:  # pragma: no cover
-    from qtpy.QtCore import QObject
-
-    from bec_widgets.utils.bec_widget import BECWidget
-
-logger = bec_logger.logger
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-class LaunchTile(RoundedFrame):
-    DEFAULT_SIZE = (250, 300)
-    open_signal = Signal()
-
-    def __init__(
-        self,
-        parent: QObject | None = None,
-        icon_path: str | None = None,
-        top_label: str | None = None,
-        main_label: str | None = None,
-        description: str | None = None,
-        show_selector: bool = False,
-        tile_size: tuple[int, int] | None = None,
-    ):
-        super().__init__(parent=parent, orientation="vertical")
-
-        # Provide a per‑instance TILE_SIZE so the class can compute layout
-        if tile_size is None:
-            tile_size = self.DEFAULT_SIZE
-        self.tile_size = tile_size
-
-        self.icon_label = QLabel(parent=self)
-        self.icon_label.setFixedSize(100, 100)
-        self.icon_label.setScaledContents(True)
-        pixmap = QPixmap(icon_path)
-        if not pixmap.isNull():
-            size = 100
-            circular_pixmap = QPixmap(size, size)
-            circular_pixmap.fill(Qt.transparent)
-
-            painter = QPainter(circular_pixmap)
-            painter.setRenderHints(QPainter.Antialiasing, True)
-            path = QPainterPath()
-            path.addEllipse(0, 0, size, size)
-            painter.setClipPath(path)
-            pixmap = pixmap.scaled(size, size, Qt.KeepAspectRatio, Qt.SmoothTransformation)
-            painter.drawPixmap(0, 0, pixmap)
-            painter.end()
-
-            self.icon_label.setPixmap(circular_pixmap)
-        self.layout.addWidget(self.icon_label, alignment=Qt.AlignCenter)
-
-        # Top label
-        self.top_label = QLabel(top_label.upper())
-        font_top = self.top_label.font()
-        font_top.setPointSize(10)
-        self.top_label.setFont(font_top)
-        self.layout.addWidget(self.top_label, alignment=Qt.AlignCenter)
-
-        # Main label
-        self.main_label = QLabel(main_label)
-
-        # Desired default appearance
-        font_main = self.main_label.font()
-        font_main.setPointSize(14)
-        font_main.setBold(True)
-        self.main_label.setFont(font_main)
-        self.main_label.setAlignment(Qt.AlignCenter)
-
-        # Shrink font if the default would wrap on this platform / DPI
-        content_width = (
-            self.tile_size[0]
-            - self.layout.contentsMargins().left()
-            - self.layout.contentsMargins().right()
-        )
-        self._fit_label_to_width(self.main_label, content_width)
-
-        # Give every tile the same reserved height for the title so the
-        # description labels start at an identical y‑offset.
-        self.main_label.setFixedHeight(QFontMetrics(self.main_label.font()).height() + 2)
-
-        self.layout.addWidget(self.main_label)
-
-        self.spacer_top = QSpacerItem(0, 10, QSizePolicy.Fixed, QSizePolicy.Fixed)
-        self.layout.addItem(self.spacer_top)
-
-        # Description
-        self.description_label = QLabel(description)
-        self.description_label.setWordWrap(True)
-        self.description_label.setAlignment(Qt.AlignCenter)
-        self.layout.addWidget(self.description_label)
-
-        # Selector
-        if show_selector:
-            self.selector = QComboBox(self)
-            self.layout.addWidget(self.selector)
-        else:
-            self.selector = None
-
-        self.spacer_bottom = QSpacerItem(0, 0, QSizePolicy.Fixed, QSizePolicy.Expanding)
-        self.layout.addItem(self.spacer_bottom)
-
-        # Action button
-        self.action_button = QPushButton("Open")
-        self.action_button.setStyleSheet(
-            """
-        QPushButton {
-            background-color: #007AFF;
-            border: none;
-            padding: 8px 16px;
-            color: white;
-            border-radius: 6px;
-            font-weight: bold;
-        }
-        QPushButton:hover {
-            background-color: #005BB5;
-        }
-        """
-        )
-        self.layout.addWidget(self.action_button, alignment=Qt.AlignCenter)
-
-    def _fit_label_to_width(self, label: QLabel, max_width: int, min_pt: int = 10):
-        """
-        Fit the label text to the specified maximum width by adjusting the font size.
-
-        Args:
-            label(QLabel): The label to adjust.
-            max_width(int): The maximum width the label can occupy.
-            min_pt(int): The minimum font point size to use.
-        """
-        font = label.font()
-        for pt in range(font.pointSize(), min_pt - 1, -1):
-            font.setPointSize(pt)
-            metrics = QFontMetrics(font)
-            if metrics.horizontalAdvance(label.text()) <= max_width:
-                label.setFont(font)
-                label.setWordWrap(False)
-                return
-        # If nothing fits, fall back to eliding
-        metrics = QFontMetrics(font)
-        label.setFont(font)
-        label.setWordWrap(False)
-        label.setText(metrics.elidedText(label.text(), Qt.ElideRight, max_width))
-
-
-class LaunchWindow(BECMainWindow):
-    RPC = True
-    TILE_SIZE = (250, 300)
-    USER_ACCESS = ["show_launcher", "hide_launcher"]
-
-    def __init__(
-        self, parent=None, gui_id: str = None, window_title="BEC Launcher", *args, **kwargs
-    ):
-        super().__init__(parent=parent, gui_id=gui_id, window_title=window_title, **kwargs)
-
-        self.app = QApplication.instance()
-        self.tiles: dict[str, LaunchTile] = {}
-        # Track the smallest main‑label font size chosen so far
-        self._min_main_label_pt: int | None = None
-
-        # Toolbar
-        self.dark_mode_button = DarkModeButton(parent=self, toolbar=True)
-        self.toolbar = ModularToolBar(parent=self)
-        self.addToolBar(Qt.TopToolBarArea, self.toolbar)
-        self.spacer = QWidget(self)
-        self.spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-        self.toolbar.addWidget(self.spacer)
-        self.toolbar.addWidget(self.dark_mode_button)
-
-        # Main Widget
-        self.central_widget = QWidget(self)
-        self.central_widget.layout = QHBoxLayout(self.central_widget)
-        self.setCentralWidget(self.central_widget)
-
-        self.register_tile(
-            name="dock_area",
-            icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "bec_widgets_icon.png"),
-            top_label="Get started",
-            main_label="BEC Dock Area",
-            description="Highly flexible and customizable dock area application with modular widgets.",
-            action_button=lambda: self.launch("dock_area"),
-            show_selector=False,
-        )
-
-        self.available_auto_updates: dict[str, type[AutoUpdates]] = (
-            self._update_available_auto_updates()
-        )
-        self.register_tile(
-            name="auto_update",
-            icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "auto_update.png"),
-            top_label="Get automated",
-            main_label="BEC Auto Update Dock Area",
-            description="Dock area with auto update functionality for BEC widgets plotting.",
-            action_button=self._open_auto_update,
-            show_selector=True,
-            selector_items=list(self.available_auto_updates.keys()) + ["Default"],
-        )
-
-        self.register_tile(
-            name="custom_ui_file",
-            icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "ui_loader_tile.png"),
-            top_label="Get customized",
-            main_label="Launch Custom UI File",
-            description="GUI application with custom UI file.",
-            action_button=self._open_custom_ui_file,
-            show_selector=False,
-        )
-
-        # plugin widgets
-        self.available_widgets: dict[str, type[BECWidget]] = get_all_plugin_widgets().as_dict()
-        if self.available_widgets:
-            plugin_repo_name = next(iter(self.available_widgets.values())).__module__.split(".")[0]
-            plugin_repo_name = plugin_repo_name.removesuffix("_bec").upper()
-            self.register_tile(
-                name="widget",
-                icon_path=os.path.join(
-                    MODULE_PATH, "assets", "app_icons", "widget_launch_tile.png"
-                ),
-                top_label="Get quickly started",
-                main_label=f"Launch a {plugin_repo_name} Widget",
-                description=f"GUI application with one widget from the {plugin_repo_name} repository.",
-                action_button=self._open_widget,
-                show_selector=True,
-                selector_items=list(self.available_widgets.keys()),
-            )
-
-        self._update_theme()
-
-        self.register = RPCRegister()
-        self.register.callbacks.append(self._turn_off_the_lights)
-        self.register.broadcast()
-
-    def register_tile(
-        self,
-        name: str,
-        icon_path: str | None = None,
-        top_label: str | None = None,
-        main_label: str | None = None,
-        description: str | None = None,
-        action_button: Callable | None = None,
-        show_selector: bool = False,
-        selector_items: list[str] | None = None,
-    ):
-        """
-        Register a tile in the launcher window.
-
-        Args:
-            name(str): The name of the tile.
-            icon_path(str): The path to the icon.
-            top_label(str): The top label of the tile.
-            main_label(str): The main label of the tile.
-            description(str): The description of the tile.
-            action_button(callable): The action to be performed when the button is clicked.
-            show_selector(bool): Whether to show a selector or not.
-            selector_items(list[str]): The items to be shown in the selector.
-        """
-
-        tile = LaunchTile(
-            icon_path=icon_path,
-            top_label=top_label,
-            main_label=main_label,
-            description=description,
-            show_selector=show_selector,
-            tile_size=self.TILE_SIZE,
-        )
-        tile.setFixedWidth(self.TILE_SIZE[0])
-        tile.setMinimumHeight(self.TILE_SIZE[1])
-        tile.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.MinimumExpanding)
-        if action_button:
-            tile.action_button.clicked.connect(action_button)
-        if show_selector and selector_items:
-            tile.selector.addItems(selector_items)
-        self.central_widget.layout.addWidget(tile)
-
-        # keep all tiles' main labels at a unified point size
-        current_pt = tile.main_label.font().pointSize()
-        if self._min_main_label_pt is None or current_pt < self._min_main_label_pt:
-            # New global minimum – shrink every existing tile to this size
-            self._min_main_label_pt = current_pt
-            for t in self.tiles.values():
-                f = t.main_label.font()
-                f.setPointSize(self._min_main_label_pt)
-                t.main_label.setFont(f)
-                t.main_label.setFixedHeight(QFontMetrics(f).height() + 2)
-        elif current_pt > self._min_main_label_pt:
-            # Tile is larger than global minimum – shrink it to match
-            f = tile.main_label.font()
-            f.setPointSize(self._min_main_label_pt)
-            tile.main_label.setFont(f)
-            tile.main_label.setFixedHeight(QFontMetrics(f).height() + 2)
-
-        self.tiles[name] = tile
-
-    def launch(
-        self,
-        launch_script: str,
-        name: str | None = None,
-        geometry: tuple[int, int, int, int] | None = None,
-        **kwargs,
-    ) -> QWidget | None:
-        """Launch the specified script. If the launch script creates a QWidget, it will be
-        embedded in a BECMainWindow. If the launch script creates a BECMainWindow, it will be shown
-        as a separate window.
-
-        Args:
-            launch_script(str): The name of the script to be launched.
-            name(str): The name of the dock area.
-            geometry(tuple): The geometry parameters to be passed to the dock area.
-        Returns:
-            QWidget: The created dock area.
-        """
-        from bec_widgets.applications import bw_launch
-
-        with RPCRegister.delayed_broadcast() as rpc_register:
-            existing_dock_areas = rpc_register.get_names_of_rpc_by_class_type(BECDockArea)
-            if name is not None:
-                if name in existing_dock_areas:
-                    raise ValueError(
-                        f"Name {name} must be unique for dock areas, but already exists: {existing_dock_areas}."
-                    )
-                WidgetContainerUtils.raise_for_invalid_name(name)
-
-            else:
-                name = "dock_area"
-                name = WidgetContainerUtils.generate_unique_name(name, existing_dock_areas)
-
-            if launch_script is None:
-                launch_script = "dock_area"
-            if not isinstance(launch_script, str):
-                raise ValueError(f"Launch script must be a string, but got {type(launch_script)}.")
-
-            if launch_script == "custom_ui_file":
-                ui_file = kwargs.pop("ui_file", None)
-                if not ui_file:
-                    return None
-                return self._launch_custom_ui_file(ui_file)
-
-            if launch_script == "auto_update":
-                auto_update = kwargs.pop("auto_update", None)
-                return self._launch_auto_update(auto_update)
-
-            if launch_script == "widget":
-                widget = kwargs.pop("widget", None)
-                if widget is None:
-                    raise ValueError("Widget name must be provided.")
-                return self._launch_widget(widget)
-
-            launch = getattr(bw_launch, launch_script, None)
-            if launch is None:
-                raise ValueError(f"Launch script {launch_script} not found.")
-
-            result_widget = launch(name)
-            result_widget.resize(result_widget.minimumSizeHint())
-            # TODO Should we simply use the specified name as title here?
-            result_widget.window().setWindowTitle(f"BEC - {name}")
-            logger.info(f"Created new dock area: {name}")
-
-            if geometry is not None:
-                result_widget.setGeometry(*geometry)
-            if isinstance(result_widget, BECMainWindow):
-                result_widget.show()
-            else:
-                window = BECMainWindow()
-                window.setCentralWidget(result_widget)
-                window.setWindowTitle(f"BEC - {result_widget.objectName()}")
-                window.show()
-            return result_widget
-
-    def _launch_custom_ui_file(self, ui_file: str | None) -> BECMainWindow:
-        # Load the custom UI file
-        if ui_file is None:
-            raise ValueError("UI file must be provided for custom UI file launch.")
-        filename = os.path.basename(ui_file).split(".")[0]
-
-        WidgetContainerUtils.raise_for_invalid_name(filename)
-
-        tree = ET.parse(ui_file)
-        root = tree.getroot()
-        # Check if the top-level widget is a QMainWindow
-        widget = root.find("widget")
-        if widget is None:
-            raise ValueError("No widget found in the UI file.")
-
-        if widget.attrib.get("class") == "QMainWindow":
-            raise ValueError(
-                "Loading a QMainWindow from a UI file is currently not supported. "
-                "If you need this, please contact the BEC team or create a ticket on gitlab.psi.ch/bec/bec_widgets."
-            )
-
-        window = UILaunchWindow(object_name=filename)
-        QApplication.processEvents()
-        result_widget = UILoader(window).loader(ui_file)
-        window.setCentralWidget(result_widget)
-        window.setWindowTitle(f"BEC - {window.object_name}")
-        window.show()
-        logger.info(f"Object name of new instance: {result_widget.objectName()}, {window.gui_id}")
-        return window
-
-    def _launch_auto_update(self, auto_update: str) -> AutoUpdates:
-        if auto_update in self.available_auto_updates:
-            auto_update_cls = self.available_auto_updates[auto_update]
-            window = auto_update_cls()
-        else:
-
-            auto_update = "auto_updates"
-            window = AutoUpdates()
-
-        window.resize(window.minimumSizeHint())
-        QApplication.processEvents()
-        window.setWindowTitle(f"BEC - {window.objectName()}")
-        window.show()
-        return window
-
-    def _launch_widget(self, widget: type[BECWidget]) -> QWidget:
-        name = pascal_to_snake(widget.__name__)
-
-        WidgetContainerUtils.raise_for_invalid_name(name)
-
-        window = BECMainWindow()
-
-        widget_instance = widget(root_widget=True, object_name=name)
-        assert isinstance(widget_instance, QWidget)
-        QApplication.processEvents()
-
-        window.setCentralWidget(widget_instance)
-        window.resize(window.minimumSizeHint())
-        window.setWindowTitle(f"BEC - {widget_instance.objectName()}")
-        window.show()
-        return window
-
-    def apply_theme(self, theme: str):
-        """
-        Change the theme of the application.
-        """
-        for tile in self.tiles.values():
-            tile.apply_theme(theme)
-
-        super().apply_theme(theme)
-
-    def _open_auto_update(self):
-        """
-        Open the auto update window.
-        """
-        if self.tiles["auto_update"].selector is None:
-            auto_update = None
-        else:
-            auto_update = self.tiles["auto_update"].selector.currentText()
-            if auto_update == "Default":
-                auto_update = None
-        return self.launch("auto_update", auto_update=auto_update)
-
-    def _open_widget(self):
-        """
-        Open a widget from the available widgets.
-        """
-        if self.tiles["widget"].selector is None:
-            return
-        widget = self.tiles["widget"].selector.currentText()
-        if widget not in self.available_widgets:
-            raise ValueError(f"Widget {widget} not found in available widgets.")
-        return self.launch("widget", widget=self.available_widgets[widget])
-
-    @SafeSlot(popup_error=True)
-    def _open_custom_ui_file(self):
-        """
-        Open a file dialog to select a custom UI file and launch it.
-        """
-        ui_file, _ = QFileDialog.getOpenFileName(
-            self, "Select UI File", "", "UI Files (*.ui);;All Files (*)"
-        )
-        self.launch("custom_ui_file", ui_file=ui_file)
-
-    @staticmethod
-    def _update_available_auto_updates() -> dict[str, type[AutoUpdates]]:
-        """
-        Load all available auto updates from the plugin repository.
-        """
-        try:
-            auto_updates = get_plugin_auto_updates()
-            logger.info(f"Available auto updates: {auto_updates.keys()}")
-        except Exception as exc:
-            logger.error(f"Failed to load auto updates: {exc}")
-            return {}
-        return auto_updates
-
-    def show_launcher(self):
-        """
-        Show the launcher window.
-        """
-        self.show()
-
-    def hide_launcher(self):
-        """
-        Hide the launcher window.
-        """
-        self.hide()
-
-    def showEvent(self, event):
-        super().showEvent(event)
-        self.setFixedSize(self.size())
-
-    def _launcher_is_last_widget(self, connections: dict) -> bool:
-        """
-        Check if the launcher is the last widget in the application.
-        """
-
-        remaining_connections = [
-            connection for connection in connections.values() if connection.parent_id != self.gui_id
-        ]
-        return len(remaining_connections) <= 1
-
-    def _turn_off_the_lights(self, connections: dict):
-        """
-        If there is only one connection remaining, it is the launcher, so we show it.
-        Once the launcher is closed as the last window, we quit the application.
-        """
-        if self._launcher_is_last_widget(connections):
-            self.show()
-            self.activateWindow()
-            self.raise_()
-            if self.app:
-                self.app.setQuitOnLastWindowClosed(True)  # type: ignore
-            return
-
-        self.hide()
-        if self.app:
-            self.app.setQuitOnLastWindowClosed(False)  # type: ignore
-
-    def closeEvent(self, event):
-        """
-        Close the launcher window.
-        """
-        connections = self.register.list_all_connections()
-        if self._launcher_is_last_widget(connections):
-            event.accept()
-            return
-
-        event.ignore()
-        self.hide()
-
-
-if __name__ == "__main__":
-    import sys
-
-    app = QApplication(sys.argv)
-    launcher = LaunchWindow()
-    launcher.show()
-    sys.exit(app.exec())

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/client_utils.py

@@ -1,531 +0,0 @@
-"""Client utilities for the BEC GUI."""
-
-from __future__ import annotations
-
-import json
-import os
-import select
-import subprocess
-import threading
-import time
-from contextlib import contextmanager
-from threading import Lock
-from typing import TYPE_CHECKING, Literal, TypeAlias, cast
-
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.logger import bec_logger
-from bec_lib.utils.import_utils import lazy_import_from
-from rich.console import Console
-from rich.table import Table
-
-import bec_widgets.cli.client as client
-from bec_widgets.cli.rpc.rpc_base import RPCBase, RPCReference
-from bec_widgets.utils.serialization import register_serializer_extension
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_lib.messages import GUIRegistryStateMessage
-else:
-    GUIRegistryStateMessage = lazy_import_from("bec_lib.messages", "GUIRegistryStateMessage")
-
-logger = bec_logger.logger
-
-IGNORE_WIDGETS = ["LaunchWindow"]
-
-RegistryState: TypeAlias = dict[
-    Literal["gui_id", "name", "widget_class", "config", "__rpc__", "container_proxy"],
-    str | bool | dict,
-]
-
-# pylint: disable=redefined-outer-scope
-
-
-def _filter_output(output: str) -> str:
-    """
-    Filter out the output from the process.
-    """
-    if "IMKClient" in output:
-        # only relevant on macOS
-        # see https://discussions.apple.com/thread/255761734?sortBy=rank
-        return ""
-    return output
-
-
-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")
-                output = _filter_output(output)
-                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_id: str,
-    config: dict | str,
-    gui_class: str = "dock_area",
-    logger=None,  # FIXME change gui_class back to "launcher" later
-) -> tuple[subprocess.Popen[str], threading.Thread | 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,
-        "--gui_class_id",
-        gui_class_id,
-        "--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):
-    """RepeatTimer class."""
-
-    def run(self):
-        while not self.finished.wait(self.interval):
-            self.function(*self.args, **self.kwargs)
-
-
-# pylint: disable=protected-access
-@contextmanager
-def wait_for_server(client: BECGuiClient):
-    """Context manager to wait for the server to start."""
-    timeout = client._startup_timeout
-    if not timeout:
-        if client._gui_is_alive():
-            # there is hope, let's wait a bit
-            timeout = 1
-        else:
-            raise RuntimeError("GUI is not alive")
-    try:
-        if client._gui_started_event.wait(timeout=timeout):
-            client._gui_started_timer.cancel()
-            client._gui_started_timer.join()
-        else:
-            raise TimeoutError("Could not connect to GUI server")
-    finally:
-        # after initial waiting period, do not wait so much any more
-        # (only relevant if GUI didn't start)
-        client._startup_timeout = 0
-    yield
-
-
-class WidgetNameSpace:
-    def __repr__(self):
-        console = Console()
-        table = Table(title="Available widgets for BEC CLI usage")
-        table.add_column("Widget Name", justify="left", style="magenta")
-        table.add_column("Description", justify="left")
-        for attr, value in self.__dict__.items():
-            docs = value.__doc__
-            docs = docs if docs else "No description available"
-            table.add_row(attr, docs)
-        console.print(table)
-        return ""
-
-
-class AvailableWidgetsNamespace:
-    """Namespace for available widgets in the BEC GUI."""
-
-    def __init__(self):
-        for widget in client.Widgets:
-            name = widget.value
-            if name in IGNORE_WIDGETS:
-                continue
-            setattr(self, name, name)
-
-    def __repr__(self):
-        console = Console()
-        table = Table(title="Available widgets for BEC CLI usage")
-        table.add_column("Widget Name", justify="left", style="magenta")
-        table.add_column("Description", justify="left")
-        for attr_name, _ in self.__dict__.items():
-            docs = getattr(client, attr_name).__doc__
-            docs = docs if docs else "No description available"
-            table.add_row(attr_name, docs if len(docs.strip()) > 0 else "No description available")
-        console.print(table)
-        return ""
-
-
-class BECGuiClient(RPCBase):
-    """BEC GUI client class. Container for GUI applications within Python."""
-
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        self._lock = Lock()
-        self._anchor_widget = "launcher"
-        self._killed = False
-        self._top_level: dict[str, RPCReference] = {}
-        self._startup_timeout = 0
-        self._gui_started_timer = None
-        self._gui_started_event = threading.Event()
-        self._process = None
-        self._process_output_processing_thread = None
-        self._server_registry: dict[str, RegistryState] = {}
-        self._ipython_registry: dict[str, RPCReference] = {}
-        self.available_widgets = AvailableWidgetsNamespace()
-        register_serializer_extension()
-
-    ####################
-    #### Client API ####
-    ####################
-
-    @property
-    def launcher(self) -> RPCBase:
-        """The launcher object."""
-        return RPCBase(gui_id=f"{self._gui_id}:launcher", parent=self, object_name="launcher")
-
-    def connect_to_gui_server(self, gui_id: str) -> None:
-        """Connect to a GUI server"""
-        # Unregister the old callback
-        self._client.connector.unregister(
-            MessageEndpoints.gui_registry_state(self._gui_id), cb=self._handle_registry_update
-        )
-        self._gui_id = gui_id
-
-        # reset the namespace
-        self._update_dynamic_namespace({})
-        self._server_registry = {}
-        self._top_level = {}
-        self._ipython_registry = {}
-
-        # Register the new callback
-        self._client.connector.register(
-            MessageEndpoints.gui_registry_state(self._gui_id),
-            cb=self._handle_registry_update,
-            parent=self,
-            from_start=True,
-        )
-
-    @property
-    def windows(self) -> dict:
-        """Dictionary with dock areas in the GUI."""
-        return {widget.object_name: widget for widget in self._top_level.values()}
-
-    @property
-    def window_list(self) -> list:
-        """List with dock areas in the GUI."""
-        return list(self._top_level.values())
-
-    def start(self, wait: bool = False) -> None:
-        """Start the GUI server."""
-        return self._start(wait=wait)
-
-    def show(self):
-        """Show the GUI window."""
-        if self._check_if_server_is_alive():
-            return self._show_all()
-        return self.start(wait=True)
-
-    def hide(self):
-        """Hide the GUI window."""
-        return self._hide_all()
-
-    def new(
-        self,
-        name: str | None = None,
-        wait: bool = True,
-        geometry: tuple[int, int, int, int] | None = None,
-        launch_script: str = "dock_area",
-        **kwargs,
-    ) -> client.BECDockArea:
-        """Create a new top-level dock area.
-
-        Args:
-            name(str, optional): The name of the dock area. Defaults to None.
-            wait(bool, optional): Whether to wait for the server to start. Defaults to True.
-            geometry(tuple[int, int, int, int] | None): The geometry of the dock area (pos_x, pos_y, w, h)
-        Returns:
-            client.BECDockArea: The new dock area.
-        """
-        if not self._check_if_server_is_alive():
-            self.start(wait=True)
-        if wait:
-            with wait_for_server(self):
-                widget = self.launcher._run_rpc(
-                    "launch", launch_script=launch_script, name=name, geometry=geometry, **kwargs
-                )  # pylint: disable=protected-access
-                return widget
-        widget = self.launcher._run_rpc(
-            "launch", launch_script=launch_script, name=name, geometry=geometry, **kwargs
-        )  # pylint: disable=protected-access
-        return widget
-
-    def delete(self, name: str) -> None:
-        """Delete a dock area.
-
-        Args:
-            name(str): The name of the dock area.
-        """
-        widget = self.windows.get(name)
-        if widget is None:
-            raise ValueError(f"Dock area {name} not found.")
-        widget._run_rpc("close")  # pylint: disable=protected-access
-
-    def delete_all(self) -> None:
-        """Delete all dock areas."""
-        for widget_name in self.windows:
-            self.delete(widget_name)
-
-    def kill_server(self) -> None:
-        """Kill the GUI server."""
-        # Unregister the registry state
-        self._killed = True
-
-        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
-
-        # Unregister the registry state
-        self._client.connector.unregister(
-            MessageEndpoints.gui_registry_state(self._gui_id), cb=self._handle_registry_update
-        )
-        # Remove all reference from top level
-        self._top_level.clear()
-        self._server_registry.clear()
-
-    def close(self):
-        """Deprecated. Use kill_server() instead."""
-        # FIXME, deprecated in favor of kill, will be removed in the future
-        self.kill_server()
-
-    #########################
-    #### Private methods ####
-    #########################
-
-    def _check_if_server_is_alive(self):
-        """Checks if the process is alive"""
-        if self._process is None:
-            return False
-        if self._process.poll() is not None:
-            return False
-        return True
-
-    def _gui_post_startup(self):
-        timeout = 60
-        # Wait for 'bec' gui to be registered, this may take some time
-        # After 60s timeout. Should this raise an exception on timeout?
-        while time.time() < time.time() + timeout:
-            if len(list(self._server_registry.keys())) < 2 or not hasattr(
-                self, self._anchor_widget
-            ):
-                time.sleep(0.1)
-            else:
-                break
-
-        self._gui_started_event.set()
-
-    def _start_server(self, wait: bool = 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._startup_timeout = 5
-            self._gui_started_event.clear()
-            self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id,
-                gui_class_id="bec",
-                config=self._client._service_config.config,  # pylint: disable=protected-access
-                logger=logger,
-            )
-
-            def gui_started_callback(callback):
-                try:
-                    if callable(callback):
-                        callback()
-                finally:
-                    threading.current_thread().cancel()  # type: ignore
-
-            self._gui_started_timer = RepeatTimer(
-                0.5, 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 _start(self, wait: bool = False) -> None:
-        self._killed = False
-        self._client.connector.register(
-            MessageEndpoints.gui_registry_state(self._gui_id),
-            cb=self._handle_registry_update,
-            parent=self,
-        )
-        return self._start_server(wait=wait)
-
-    @staticmethod
-    def _handle_registry_update(
-        msg: dict[str, GUIRegistryStateMessage], parent: BECGuiClient
-    ) -> None:
-        # This was causing a deadlock during shutdown, not sure why.
-        # with self._lock:
-        self = parent
-        self._server_registry = cast(dict[str, RegistryState], msg["data"].state)
-        self._update_dynamic_namespace(self._server_registry)
-
-    def _do_show_all(self):
-        rpc_client = RPCBase(gui_id=f"{self._gui_id}:launcher", parent=self)
-        rpc_client._run_rpc("show")  # pylint: disable=protected-access
-        for window in self._top_level.values():
-            window.show()
-
-    def _show_all(self):
-        with wait_for_server(self):
-            return self._do_show_all()
-
-    def _hide_all(self):
-        with wait_for_server(self):
-            rpc_client = RPCBase(gui_id=f"{self._gui_id}:launcher", parent=self)
-            rpc_client._run_rpc("hide")  # pylint: disable=protected-access
-            if not self._killed:
-                for window in self._top_level.values():
-                    window.hide()
-
-    def _update_dynamic_namespace(self, server_registry: dict):
-        """
-        Update the dynamic name space with the given server registry.
-        Setting the server registry to an empty dictionary will remove all widgets from the namespace.
-
-        Args:
-            server_registry (dict): The server registry
-        """
-        top_level_widgets: dict[str, RPCReference] = {}
-        for gui_id, state in server_registry.items():
-            widget = self._add_widget(state, self)
-            if widget is None:
-                # ignore widgets that are not supported
-                continue
-            # get all top-level widgets. These are widgets that have no parent
-            if not state["config"].get("parent_id"):
-                top_level_widgets[gui_id] = widget
-
-        remove_from_registry = []
-        for gui_id, widget in self._ipython_registry.items():
-            if gui_id not in server_registry:
-                remove_from_registry.append(gui_id)
-        for gui_id in remove_from_registry:
-            self._ipython_registry.pop(gui_id)
-
-        removed_widgets = [
-            widget.object_name for widget in self._top_level.values() if widget._is_deleted()
-        ]
-
-        for widget_name in removed_widgets:
-            # the check is not strictly necessary, but better safe
-            # than sorry; who knows what the user has done
-            if hasattr(self, widget_name):
-                delattr(self, widget_name)
-
-        for gui_id, widget_ref in top_level_widgets.items():
-            setattr(self, widget_ref.object_name, widget_ref)
-
-        self._top_level = top_level_widgets
-
-        for widget in self._ipython_registry.values():
-            widget._refresh_references()
-
-    def _add_widget(self, state: dict, parent: object) -> RPCReference | None:
-        """Add a widget to the namespace
-
-        Args:
-            state (dict): The state of the widget from the _server_registry.
-            parent (object): The parent object.
-        """
-        object_name = state["object_name"]
-        gui_id = state["gui_id"]
-        if state["widget_class"] in IGNORE_WIDGETS:
-            return
-        widget_class = getattr(client, state["widget_class"], None)
-        if widget_class is None:
-            return
-        obj = self._ipython_registry.get(gui_id)
-        if obj is None:
-            widget = widget_class(gui_id=gui_id, object_name=object_name, parent=parent)
-            self._ipython_registry[gui_id] = widget
-        else:
-            widget = obj
-        obj = RPCReference(registry=self._ipython_registry, gui_id=gui_id)
-        return obj
-
-
-if __name__ == "__main__":  # pragma: no cover
-    from bec_lib.client import BECClient
-    from bec_lib.service_config import ServiceConfig
-
-    try:
-        config = ServiceConfig()
-        bec_client = BECClient(config)
-        bec_client.start()
-
-        # Test the client_utils.py module
-        gui = BECGuiClient()
-
-        gui.start(wait=True)
-        gui.new().new(widget="Waveform")
-        time.sleep(10)
-    finally:
-        gui.kill_server()

bec_widgets/cli/generate_cli.py

@@ -1,323 +0,0 @@
-# pylint: disable=missing-module-docstring
-from __future__ import annotations
-
-import argparse
-import importlib
-import inspect
-import os
-import sys
-from pathlib import Path
-
-import black
-import isort
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import Property as QtProperty
-
-from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator, plugin_filenames
-from bec_widgets.utils.plugin_utils import BECClassContainer, get_custom_classes
-
-logger = bec_logger.logger
-
-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, base=False):
-        self._base = base
-        base_imports = (
-            """import enum
-import inspect
-import traceback
-from functools import reduce
-from operator import add
-from typing import Literal, Optional
-"""
-            if self._base
-            else "\n"
-        )
-        self.header = f"""# This file was automatically generated by generate_cli.py
-# type: ignore \n
-from __future__ import annotations
-{base_imports}
-from bec_lib.logger import bec_logger
-
-from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
-{"from bec_widgets.utils.bec_plugin_helper import get_all_plugin_widgets, get_plugin_client_module" if self._base else ""}
-
-logger = bec_logger.logger
-
-# pylint: skip-file"""
-
-        self.content = ""
-
-    def generate_client(self, class_container: BECClassContainer):
-        """
-        Generate the client for the published classes, skipping any classes
-        that have `RPC = False`.
-
-        Args:
-            class_container: The class container with the classes to generate the client for.
-        """
-        # Filter out classes that explicitly have RPC=False
-        rpc_top_level_classes = [
-            cls for cls in class_container.rpc_top_level_classes if getattr(cls, "RPC", True)
-        ]
-        rpc_top_level_classes.sort(key=lambda x: x.__name__)
-
-        connector_classes = [
-            cls for cls in class_container.connector_classes if getattr(cls, "RPC", True)
-        ]
-        connector_classes.sort(key=lambda x: x.__name__)
-
-        self.write_client_enum(rpc_top_level_classes)
-        for cls in connector_classes:
-            logger.debug(f"generating RPC client class for {cls.__name__}")
-            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.
-        """
-        if self._base:
-            self.content += """
-class _WidgetsEnumType(str, enum.Enum):
-    \"\"\" Enum for the available widgets, to be generated programatically  \"\"\"
-    ...
-    """
-
-        self.content += """
-
-_Widgets = {
-    """
-        for cls in published_classes:
-            self.content += f'"{cls.__name__}": "{cls.__name__}",\n    '
-
-        self.content += """}
-"""
-        if self._base:
-            self.content += """
-
-try:
-    _plugin_widgets = get_all_plugin_widgets().as_dict()
-    plugin_client = get_plugin_client_module()
-    Widgets = _WidgetsEnumType("Widgets", {name: name for name in _plugin_widgets} | _Widgets)
-
-    if (_overlap := _Widgets.keys() & _plugin_widgets.keys()) != set():
-        for _widget in _overlap:
-            logger.warning(f"Detected duplicate widget {_widget} in plugin repo file: {inspect.getfile(_plugin_widgets[_widget])} !")
-    for plugin_name, plugin_class in inspect.getmembers(plugin_client, inspect.isclass):
-        if issubclass(plugin_class, RPCBase) and plugin_class is not RPCBase:
-            if plugin_name in globals():
-                conflicting_file = (
-                    inspect.getfile(_plugin_widgets[plugin_name])
-                    if plugin_name in _plugin_widgets
-                    else f"{plugin_client}"
-                )
-                logger.warning(
-                    f"Plugin widget {plugin_name} from {conflicting_file} conflicts with a built-in class!"
-                )
-                continue
-            if plugin_name not in _overlap:
-                globals()[plugin_name] = plugin_class
-except ImportError as e:
-    logger.error(f"Failed loading plugins: \\n{reduce(add, traceback.format_exception(e))}")
-"""
-
-    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__
-
-        if class_name == "BECDockArea":
-            self.content += f"""
-class {class_name}(RPCBase):"""
-        else:
-            self.content += f"""
-class {class_name}(RPCBase):"""
-
-        if cls.__doc__:
-            # We only want the first line of the docstring
-            # But skip the first line if it's a blank line
-            first_line = cls.__doc__.split("\n")[0]
-            if first_line:
-                class_docs = first_line
-            else:
-                class_docs = cls.__doc__.split("\n")[1]
-            self.content += f"""
-    \"\"\"{class_docs}\"\"\"
-    """
-        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__}. "
-                    f"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.Mode(line_length=100))
-        except black.NothingChanged:
-            formatted_content = full_content
-
-        config = isort.Config(
-            profile="black",
-            line_length=100,
-            multi_line_output=3,
-            include_trailing_comma=False,
-            known_first_party=["bec_widgets"],
-        )
-        formatted_content = isort.code(formatted_content, config=config)
-
-        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(
-        "--target",
-        action="store",
-        type=str,
-        help="Which package to generate plugin files for. Should be installed in the local environment (example: my_plugin_repo)",
-    )
-
-    args = parser.parse_args()
-    if args.target is None:
-        logger.error(
-            "You must provide a target - for safety, the default of running this on bec_widgets core has been removed. To generate the client for bec_widgets, run `bw-generate-cli --target bec_widgets`"
-        )
-        return
-
-    logger.info(f"BEC Widget code generation tool started with args: {args}")
-
-    client_subdir = "cli" if args.target == "bec_widgets" else "widgets"
-    module_name = "bec_widgets" if args.target == "bec_widgets" else f"{args.target}.bec_widgets"
-
-    try:
-        module = importlib.import_module(module_name)
-        assert module.__file__ is not None
-        module_file = Path(module.__file__)
-        module_dir = module_file.parent if module_file.is_file() else module_file
-    except Exception as e:
-        logger.error(f"Failed to load module {module_name} for code generation: {e}")
-        return
-
-    client_path = module_dir / client_subdir / "client.py"
-
-    rpc_classes = get_custom_classes(module_name)
-    logger.info(f"Obtained classes with RPC objects: {rpc_classes!r}")
-
-    generator = ClientGenerator(base=module_name == "bec_widgets")
-    logger.info(f"Generating client file at {client_path}")
-    generator.generate_client(rpc_classes)
-    generator.write(str(client_path))
-
-    if module_name != "bec_widgets":
-        non_overwrite_classes = list(clsinfo.name for clsinfo in get_custom_classes("bec_widgets"))
-        logger.info(
-            f"Not writing plugins which would conflict with builtin classes: {non_overwrite_classes}"
-        )
-    else:
-        non_overwrite_classes = []
-
-    for cls in rpc_classes.plugins:
-        logger.info(f"Writing bec-designer plugin files for {cls.__name__}...")
-
-        if cls.__name__ in non_overwrite_classes:
-            logger.error(
-                f"Not writing plugin files for {cls.__name__} because a built-in widget with that name exists"
-            )
-
-        plugin = DesignerPluginGenerator(cls)
-        if not hasattr(plugin, "info"):
-            continue
-
-        def _exists(file: str):
-            return os.path.exists(os.path.join(plugin.info.base_path, file))
-
-        if any(_exists(file) for file in plugin_filenames(plugin.info.plugin_name_snake)):
-            logger.debug(
-                f"Skipping generation of extra plugin files for {plugin.info.plugin_name_snake} - at least one file out of 'plugin.py', 'pyproject', and 'register_{plugin.info.plugin_name_snake}.py' already exists."
-            )
-            continue
-
-        plugin.run()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    sys.argv = ["bw-generate-cli", "--target", "bec_widgets"]
-    main()

bec_widgets/cli/rpc/rpc_base.py

@@ -1,308 +0,0 @@
-from __future__ import annotations
-
-import inspect
-import threading
-import uuid
-from functools import wraps
-from typing import TYPE_CHECKING, Any, cast
-
-from bec_lib.client import BECClient
-from bec_lib.endpoints import MessageEndpoints
-from bec_lib.utils.import_utils import lazy_import, lazy_import_from
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_lib import messages
-    from bec_lib.connector import MessageObject
-
-    import bec_widgets.cli.client as client
-    from bec_widgets.cli.client_utils import BECGuiClient
-else:
-    client = lazy_import("bec_widgets.cli.client")  # avoid circular import
-    messages = lazy_import("bec_lib.messages")
-    MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
-
-# pylint: disable=protected-access
-
-
-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...
-        caller_frame = inspect.currentframe().f_back  # type: ignore
-        while caller_frame:
-            if "jedi" in caller_frame.f_globals:
-                # Jedi module is present, likely tab completion
-                # Do not run the RPC call
-                return None  # func(*args, **kwargs)
-            caller_frame = caller_frame.f_back
-
-        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._root._gui_is_alive():
-            raise RuntimeError("GUI is not alive")
-        return self._run_rpc(func.__name__, *args, **kwargs)
-
-    return wrapper
-
-
-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 DeletedWidgetError(Exception): ...
-
-
-def check_for_deleted_widget(func):
-    @wraps(func)
-    def wrapper(self, *args, **kwargs):
-        if self._gui_id not in self._registry:
-            raise DeletedWidgetError(f"Widget with gui_id {self._gui_id} has been deleted")
-        return func(self, *args, **kwargs)
-
-    return wrapper
-
-
-class RPCReference:
-    def __init__(self, registry: dict, gui_id: str) -> None:
-        self._registry = registry
-        self._gui_id = gui_id
-        self.object_name = self._registry[self._gui_id].object_name
-
-    @check_for_deleted_widget
-    def __getattr__(self, name):
-        if name in ["_registry", "_gui_id", "_is_deleted", "object_name"]:
-            return super().__getattribute__(name)
-        return self._registry[self._gui_id].__getattribute__(name)
-
-    def __setattr__(self, name, value):
-        if name in ["_registry", "_gui_id", "_is_deleted", "object_name"]:
-            return super().__setattr__(name, value)
-        if self._gui_id not in self._registry:
-            raise DeletedWidgetError(f"Widget with gui_id {self._gui_id} has been deleted")
-        self._registry[self._gui_id].__setattr__(name, value)
-
-    def __repr__(self):
-        if self._gui_id not in self._registry:
-            return f"<Deleted widget with gui_id {self._gui_id}>"
-        return self._registry[self._gui_id].__repr__()
-
-    def __str__(self):
-        if self._gui_id not in self._registry:
-            return f"<Deleted widget with gui_id {self._gui_id}>"
-        return self._registry[self._gui_id].__str__()
-
-    def __dir__(self):
-        if self._gui_id not in self._registry:
-            return []
-        return self._registry[self._gui_id].__dir__()
-
-    def _is_deleted(self) -> bool:
-        return self._gui_id not in self._registry
-
-
-class RPCBase:
-    def __init__(
-        self,
-        gui_id: str | None = None,
-        config: dict | None = None,
-        object_name: str | None = None,
-        parent=None,
-        **kwargs,
-    ) -> 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.object_name = object_name if object_name is not None else str(uuid.uuid4())[:5]
-        self._parent = parent
-        self._msg_wait_event = threading.Event()
-        self._rpc_response = None
-        super().__init__()
-        self._rpc_references: dict[str, str] = {}
-
-    def __repr__(self):
-        type_ = type(self)
-        qualname = type_.__qualname__
-        return f"<{qualname} with name: {self.object_name}>"
-
-    def remove(self):
-        """
-        Remove the widget.
-        """
-        obj = self._root._server_registry.get(self._gui_id)
-        if obj is None:
-            raise ValueError(f"Widget {self._gui_id} not found.")
-        if proxy := obj.get("container_proxy"):
-            assert isinstance(proxy, str)
-            self._run_rpc("remove", gui_id=proxy)
-            return
-        self._run_rpc("remove")
-
-    @property
-    def _root(self) -> BECGuiClient:
-        """
-        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  # type: ignore
-
-    def _run_rpc(
-        self,
-        method,
-        *args,
-        wait_for_rpc_response=True,
-        timeout=5,
-        gui_id: str | None = None,
-        **kwargs,
-    ) -> Any:
-        """
-        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.
-            timeout: The timeout for the RPC response.
-            gui_id: The GUI ID to use for the RPC call. If None, the default GUI ID is used.
-            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": gui_id or 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(timeout)
-                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
-                )
-
-            # we can assume that the response is a RequestResponseMessage, updated by
-            # the _on_rpc_response method
-            assert isinstance(self._rpc_response, messages.RequestResponseMessage)
-
-            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_obj: MessageObject, parent: RPCBase) -> None:
-        msg = cast(messages.RequestResponseMessage, msg_obj.value)
-        parent._rpc_response = msg
-        parent._msg_wait_event.set()
-
-    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)
-            # The namespace of the object will be updated dynamically on the client side
-            # Therefore it is important to check if the object is already in the registry
-            # If yes, we return the reference to the object, otherwise we create a new object
-            # pylint: disable=protected-access
-            if msg_result["gui_id"] in self._root._ipython_registry:
-                return RPCReference(self._root._ipython_registry, msg_result["gui_id"])
-            ret = cls(parent=self, **msg_result)
-            self._root._ipython_registry[ret._gui_id] = ret
-            self._refresh_references()
-            obj = RPCReference(self._root._ipython_registry, ret._gui_id)
-            return obj
-            # return ret
-        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
-
-    def _refresh_references(self):
-        """
-        Refresh the references.
-        """
-        with self._root._lock:
-            references = {}
-            for key, val in self._root._server_registry.items():
-                parent_id = val["config"].get("parent_id")
-                if parent_id == self._gui_id:
-                    references[key] = {
-                        "gui_id": val["config"]["gui_id"],
-                        "object_name": val["object_name"],
-                    }
-            removed_references = set(self._rpc_references.keys()) - set(references.keys())
-            for key in removed_references:
-                delattr(self, self._rpc_references[key]["object_name"])
-            self._rpc_references = references
-            for key, val in references.items():
-                setattr(
-                    self,
-                    val["object_name"],
-                    RPCReference(self._root._ipython_registry, val["gui_id"]),
-                )

bec_widgets/cli/rpc/rpc_register.py

@@ -1,189 +0,0 @@
-from __future__ import annotations
-
-from functools import wraps
-from threading import RLock
-from typing import TYPE_CHECKING, Callable
-from weakref import WeakValueDictionary
-
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import QObject
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_widgets.utils.bec_connector import BECConnector
-    from bec_widgets.utils.bec_widget import BECWidget
-    from bec_widgets.widgets.containers.dock.dock import BECDock
-    from bec_widgets.widgets.containers.dock.dock_area import BECDockArea
-
-logger = bec_logger.logger
-
-
-def broadcast_update(func):
-    """
-    Decorator to broadcast updates to the RPCRegister whenever a new RPC object is added or removed.
-    If class attribute _skip_broadcast is set to True, the broadcast will be skipped
-    """
-
-    @wraps(func)
-    def wrapper(self, *args, **kwargs):
-        result = func(self, *args, **kwargs)
-        self.broadcast()
-        return result
-
-    return wrapper
-
-
-class RPCRegister:
-    """
-    A singleton class that keeps track of all the RPC objects registered in the system for CLI usage.
-    """
-
-    _instance = None
-    _initialized = False
-
-    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._broadcast_on_hold = RPCRegisterBroadcast(self)
-        self._lock = RLock()
-        self._skip_broadcast = False
-        self._initialized = True
-        self.callbacks = []
-
-    @classmethod
-    def delayed_broadcast(cls):
-        """
-        Delay the broadcast of the update to all the callbacks.
-        """
-        register = cls()
-        return register._broadcast_on_hold
-
-    @broadcast_update
-    def add_rpc(self, rpc: BECConnector):
-        """
-        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
-
-    @broadcast_update
-    def remove_rpc(self, rpc: BECConnector):
-        """
-        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 | None:
-        """
-        Get an RPC object by its ID.
-
-        Args:
-            gui_id(str): The ID of the RPC object to be retrieved.
-
-        Returns:
-            QObject | None: The RPC object with the given ID or None
-        """
-        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
-
-    def get_names_of_rpc_by_class_type(
-        self, cls: type[BECWidget] | type[BECConnector] | type[BECDock] | type[BECDockArea]
-    ) -> list[str]:
-        """Get all the names of the widgets.
-
-        Args:
-            cls(BECWidget | BECConnector): The class of the RPC object to be retrieved.
-        """
-        # This retrieves any rpc objects that are subclass of BECWidget,
-        # i.e. curve and image items are excluded
-        widgets = [rpc for rpc in self._rpc_register.values() if isinstance(rpc, cls)]
-        return [widget.object_name for widget in widgets]
-
-    def broadcast(self):
-        """
-        Broadcast the update to all the callbacks.
-        """
-
-        if self._skip_broadcast:
-            return
-        connections = self.list_all_connections()
-        for callback in self.callbacks:
-            callback(connections)
-
-    def object_is_registered(self, obj: BECConnector) -> bool:
-        """
-        Check if an object is registered in the RPC register.
-
-        Args:
-            obj(QObject): The object to check.
-
-        Returns:
-            bool: True if the object is registered, False otherwise.
-        """
-        return obj.gui_id in self._rpc_register
-
-    def add_callback(self, callback: Callable[[dict], None]):
-        """
-        Add a callback that will be called whenever the registry is updated.
-
-        Args:
-            callback(Callable[[dict], None]): The callback to be added. It should accept a dictionary of all the
-            registered RPC objects as an argument.
-        """
-        self.callbacks.append(callback)
-
-    @classmethod
-    def reset_singleton(cls):
-        """
-        Reset the singleton instance.
-        """
-        cls._instance = None
-        cls._initialized = False
-
-
-class RPCRegisterBroadcast:
-    """Context manager for RPCRegister broadcast."""
-
-    def __init__(self, rpc_register: RPCRegister) -> None:
-        self.rpc_register = rpc_register
-        self._call_depth = 0
-
-    def __enter__(self):
-        """Enter the context manager"""
-        self._call_depth += 1  # Needed for nested calls
-        self.rpc_register._skip_broadcast = True
-        return self.rpc_register
-
-    def __exit__(self, *exc):
-        """Exit the context manager"""
-
-        self._call_depth -= 1  # Remove nested calls
-        if self._call_depth == 0:  # The Last one to exit is responsible for broadcasting
-            self.rpc_register._skip_broadcast = False
-        self.rpc_register.broadcast()

bec_widgets/cli/rpc/rpc_widget_handler.py

@@ -1,56 +0,0 @@
-from __future__ import annotations
-
-from bec_widgets.cli.client_utils import IGNORE_WIDGETS
-from bec_widgets.utils.bec_plugin_helper import get_all_plugin_widgets
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.plugin_utils import get_custom_classes
-
-
-class RPCWidgetHandler:
-    """Handler class for creating widgets from RPC messages."""
-
-    def __init__(self):
-        self._widget_classes = None
-
-    @property
-    def widget_classes(self) -> dict[str, type[BECWidget]]:
-        """
-        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  # type: ignore
-
-    def update_available_widgets(self):
-        """
-        Update the available widgets.
-
-        Returns:
-            None
-        """
-        self._widget_classes = (
-            get_custom_classes("bec_widgets") + get_all_plugin_widgets()
-        ).as_dict(IGNORE_WIDGETS)
-
-    def create_widget(self, widget_type, **kwargs) -> BECWidget:
-        """
-        Create a widget from an RPC message.
-
-        Args:
-            widget_type(str): The type of the widget.
-            name (str): The name of the widget.
-            **kwargs: The keyword arguments for the widget.
-
-        Returns:
-            widget(BECWidget): The created widget.
-        """
-        widget_class = self.widget_classes.get(widget_type)  # type: ignore
-        if widget_class:
-            return widget_class(**kwargs)
-        raise ValueError(f"Unknown widget type: {widget_type}")
-
-
-widget_handler = RPCWidgetHandler()

bec_widgets/cli/server.py

@@ -1,181 +0,0 @@
-from __future__ import annotations
-
-import argparse
-import json
-import os
-import signal
-import sys
-from contextlib import redirect_stderr, redirect_stdout
-
-from bec_lib.logger import bec_logger
-from bec_lib.service_config import ServiceConfig
-from qtpy.QtCore import QSize, Qt
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication
-
-import bec_widgets
-from bec_widgets.applications.launch_window import LaunchWindow
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
-from bec_widgets.utils.bec_dispatcher import BECDispatcher
-
-logger = bec_logger.logger
-
-MODULE_PATH = os.path.dirname(bec_widgets.__file__)
-
-
-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]
-
-    @property
-    def encoding(self):
-        return "utf-8"
-
-    def close(self):
-        return
-
-
-class GUIServer:
-    """
-    This class is used to start the BEC GUI and is the main entry point for launching BEC Widgets in a subprocess.
-    """
-
-    def __init__(self, args):
-        self.config = args.config
-        self.gui_id = args.id
-        self.gui_class = args.gui_class
-        self.gui_class_id = args.gui_class_id
-        self.hide = args.hide
-        self.app: QApplication | None = None
-        self.launcher_window: LaunchWindow | None = None
-        self.dispatcher: BECDispatcher | None = None
-
-    def start(self):
-        """
-        Start the GUI server.
-        """
-        bec_logger.level = bec_logger.LOGLEVEL.INFO
-        if self.hide:
-            # pylint: disable=protected-access
-            bec_logger._stderr_log_level = bec_logger.LOGLEVEL.ERROR
-            bec_logger._update_sinks()
-
-        with redirect_stdout(SimpleFileLikeFromLogOutputFunc(logger.info)):  # type: ignore
-            with redirect_stderr(SimpleFileLikeFromLogOutputFunc(logger.error)):  # type: ignore
-                self._run()
-
-    def _get_service_config(self) -> ServiceConfig:
-        if self.config:
-            try:
-                config = json.loads(self.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()
-        return service_config
-
-    def _run(self):
-        """
-        Run the GUI server.
-        """
-        self.app = QApplication(sys.argv)
-        self.app.setApplicationName("BEC")
-        self.app.gui_id = self.gui_id  # type: ignore
-        self.setup_bec_icon()
-
-        service_config = self._get_service_config()
-        self.dispatcher = BECDispatcher(config=service_config, gui_id=self.gui_id)
-        # self.dispatcher.start_cli_server(gui_id=self.gui_id)
-
-        self.launcher_window = LaunchWindow(gui_id=f"{self.gui_id}:launcher")
-        self.launcher_window.setAttribute(Qt.WA_ShowWithoutActivating)  # type: ignore
-
-        self.app.aboutToQuit.connect(self.shutdown)
-        self.app.setQuitOnLastWindowClosed(False)
-
-        if self.gui_class:
-            # If the server is started with a specific gui class, we launch it.
-            # This will automatically hide the launcher.
-            self.launcher_window.launch(self.gui_class, name=self.gui_class_id)
-
-        def sigint_handler(*args):
-            # display message, for people to let it terminate gracefully
-            print("Caught SIGINT, exiting")
-            # Widgets should be all closed.
-            with RPCRegister.delayed_broadcast():
-                for widget in QApplication.instance().topLevelWidgets():  # type: ignore
-                    widget.close()
-            if self.app:
-                self.app.quit()
-
-        signal.signal(signal.SIGINT, sigint_handler)
-        signal.signal(signal.SIGTERM, sigint_handler)
-
-        sys.exit(self.app.exec())
-
-    def setup_bec_icon(self):
-        """
-        Set the BEC icon for the application
-        """
-        if self.app is None:
-            return
-        icon = QIcon()
-        icon.addFile(
-            os.path.join(MODULE_PATH, "assets", "app_icons", "bec_widgets_icon.png"),
-            size=QSize(48, 48),
-        )
-        self.app.setWindowIcon(icon)
-
-    def shutdown(self):
-        """
-        Shutdown the GUI server.
-        """
-        if self.dispatcher:
-            self.dispatcher.stop_cli_server()
-            self.dispatcher.disconnect_all()
-
-
-def main():
-    """
-    Main entry point for subprocesses that start a GUI server.
-    """
-
-    parser = argparse.ArgumentParser(description="BEC Widgets CLI Server")
-    parser.add_argument("--id", type=str, default="test", 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(
-        "--gui_class_id",
-        type=str,
-        default="bec",
-        help="The id of the gui class that is added to the QApplication",
-    )
-    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()
-
-    server = GUIServer(args)
-    server.start()
-
-
-if __name__ == "__main__":
-    # import sys
-
-    # sys.argv = ["bec_widgets", "--gui_class", "MainWindow"]
-    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,186 +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,
-    QPushButton,
-    QSplitter,
-    QTabWidget,
-    QVBoxLayout,
-    QWidget,
-)
-
-from bec_widgets.utils import BECDispatcher
-from bec_widgets.utils.widget_io import WidgetHierarchy as wh
-from bec_widgets.widgets.containers.dock import BECDockArea
-from bec_widgets.widgets.containers.layout_manager.layout_manager import LayoutManagerWidget
-from bec_widgets.widgets.editors.jupyter_console.jupyter_console import BECJupyterConsole
-from bec_widgets.widgets.plots.image.image import Image
-from bec_widgets.widgets.plots.motor_map.motor_map import MotorMap
-from bec_widgets.widgets.plots.multi_waveform.multi_waveform import MultiWaveform
-from bec_widgets.widgets.plots.plot_base import PlotBase
-from bec_widgets.widgets.plots.scatter_waveform.scatter_waveform import ScatterWaveform
-from bec_widgets.widgets.plots.waveform.waveform import Waveform
-
-
-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,
-                    "wh": wh,
-                    "dock": self.dock,
-                    "im": self.im,
-                    # "mi": self.mi,
-                    # "mm": self.mm,
-                    # "lm": self.lm,
-                    # "btn1": self.btn1,
-                    # "btn2": self.btn2,
-                    # "btn3": self.btn3,
-                    # "btn4": self.btn4,
-                    # "btn5": self.btn5,
-                    # "btn6": self.btn6,
-                    # "pb": self.pb,
-                    # "pi": self.pi,
-                    # "wf": self.wf,
-                    # "scatter": self.scatter,
-                    # "scatter_mi": self.scatter,
-                    # "mwf": self.mwf,
-                }
-            )
-
-    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")
-
-        # third_tab = QWidget()
-        # third_tab_layout = QVBoxLayout(third_tab)
-        # self.lm = LayoutManagerWidget()
-        # third_tab_layout.addWidget(self.lm)
-        # tab_widget.addTab(third_tab, "Layout Manager Widget")
-        #
-        # fourth_tab = QWidget()
-        # fourth_tab_layout = QVBoxLayout(fourth_tab)
-        # self.pb = PlotBase()
-        # self.pi = self.pb.plot_item
-        # fourth_tab_layout.addWidget(self.pb)
-        # tab_widget.addTab(fourth_tab, "PlotBase")
-        #
-        # tab_widget.setCurrentIndex(3)
-        #
-        group_box = QGroupBox("Jupyter Console", splitter)
-        group_box_layout = QVBoxLayout(group_box)
-        self.console = BECJupyterConsole(inprocess=True)
-        group_box_layout.addWidget(self.console)
-        #
-        # # Some buttons for layout testing
-        # self.btn1 = QPushButton("Button 1")
-        # self.btn2 = QPushButton("Button 2")
-        # self.btn3 = QPushButton("Button 3")
-        # self.btn4 = QPushButton("Button 4")
-        # self.btn5 = QPushButton("Button 5")
-        # self.btn6 = QPushButton("Button 6")
-        #
-        # fifth_tab = QWidget()
-        # fifth_tab_layout = QVBoxLayout(fifth_tab)
-        # self.wf = Waveform()
-        # fifth_tab_layout.addWidget(self.wf)
-        # tab_widget.addTab(fifth_tab, "Waveform Next Gen")
-        # tab_widget.setCurrentIndex(4)
-        #
-        sixth_tab = QWidget()
-        sixth_tab_layout = QVBoxLayout(sixth_tab)
-        self.im = Image(popups=True)
-        self.mi = self.im.main_image
-        sixth_tab_layout.addWidget(self.im)
-        tab_widget.addTab(sixth_tab, "Image Next Gen")
-        tab_widget.setCurrentIndex(1)
-        #
-        # seventh_tab = QWidget()
-        # seventh_tab_layout = QVBoxLayout(seventh_tab)
-        # self.scatter = ScatterWaveform()
-        # self.scatter_mi = self.scatter.main_curve
-        # self.scatter.plot("samx", "samy", "bpm4i")
-        # seventh_tab_layout.addWidget(self.scatter)
-        # tab_widget.addTab(seventh_tab, "Scatter Waveform")
-        # tab_widget.setCurrentIndex(6)
-        #
-        # eighth_tab = QWidget()
-        # eighth_tab_layout = QVBoxLayout(eighth_tab)
-        # self.mm = MotorMap()
-        # eighth_tab_layout.addWidget(self.mm)
-        # tab_widget.addTab(eighth_tab, "Motor Map")
-        # tab_widget.setCurrentIndex(7)
-        #
-        # ninth_tab = QWidget()
-        # ninth_tab_layout = QVBoxLayout(ninth_tab)
-        # self.mwf = MultiWaveform()
-        # ninth_tab_layout.addWidget(self.mwf)
-        # tab_widget.addTab(ninth_tab, "MultiWaveform")
-        # tab_widget.setCurrentIndex(8)
-        #
-        # # add stuff to the new Waveform widget
-        # self._init_waveform()
-        #
-        # self.setWindowTitle("Jupyter Console Window")
-
-    def _init_waveform(self):
-        self.wf.plot(y_name="bpm4i", y_entry="bpm4i", dap="GaussianModel")
-        self.wf.plot(y_name="bpm3a", y_entry="bpm3a", dap="GaussianModel")
-
-    def closeEvent(self, event):
-        """Override to handle things when main window is closed."""
-        self.dock.cleanup()
-        self.dock.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")
-    icon = material_icon("terminal", color=(255, 255, 255, 255), filled=True)
-    app.setWindowIcon(icon)
-
-    bec_dispatcher = BECDispatcher(gui_id="jupyter_console")
-    client = bec_dispatcher.client
-    client.start()
-
-    win = JupyterConsoleWindow()
-    win.show()
-    win.resize(1500, 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.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/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,240 +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": "hinted"},  # hinted
-                "setpoint": {"kind_str": "normal"},  # normal
-                "velocity": {"kind_str": "config"},  # 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_devices(self, devices: list):
-        """
-        Add devices to the DeviceContainer.
-
-        Args:
-            devices (list): List of device instances to add.
-        """
-        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"),
-]
-
-
-def check_remote_data_size(widget, plot_name, num_elements):
-    """
-    Check if the remote data has the correct number of elements.
-    Used in the qtbot.waitUntil function.
-    """
-    return len(widget.get_all_data()[plot_name]["x"]) == num_elements

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,521 +0,0 @@
-# pylint: disable = no-name-in-module,missing-module-docstring
-from __future__ import annotations
-
-import os
-import time
-import traceback
-import uuid
-from datetime import datetime
-from typing import TYPE_CHECKING, 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, QTimer, Signal
-from qtpy.QtWidgets import QApplication
-
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
-from bec_widgets.utils.error_popups import ErrorPopupUtility, SafeSlot
-from bec_widgets.utils.widget_io import WidgetHierarchy
-from bec_widgets.utils.yaml_dialog import load_yaml, load_yaml_gui, save_yaml, save_yaml_gui
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_widgets.utils.bec_dispatcher import BECDispatcher
-    from bec_widgets.widgets.containers.dock import BECDock
-else:
-    BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
-
-logger = bec_logger.logger
-
-
-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}_{datetime.now().strftime('%Y_%m_%d_%H_%M_%S_%f')}"
-        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 = None,
-        gui_id: str | None = None,
-        object_name: str | None = None,
-        parent_dock: BECDock | None = None,  # TODO should go away -> issue created #473
-        root_widget: bool = False,
-        **kwargs,
-    ):
-        """
-        BECConnector mixin class to handle BEC client and device manager.
-
-        Args:
-            client(BECClient, optional): The BEC client.
-            config(ConnectionConfig, optional): The connection configuration with specific gui id.
-            gui_id(str, optional): The GUI ID.
-            object_name(str, optional): The object name.
-            parent_dock(BECDock, optional): The parent dock.# TODO should go away -> issue created #473
-            root_widget(bool, optional): If set to True, the parent_id will be always set to None, thus enforcing that the widget is accessible as a root widget of the BECGuiClient object.
-            **kwargs:
-        """
-        # Extract object_name from kwargs to not pass it to Qt class
-        object_name = object_name or kwargs.pop("objectName", None)
-        # Ensure the parent is always the first argument for QObject
-        parent = kwargs.pop("parent", None)
-        # This initializes the QObject or any qt related class BECConnector has to be used from this line down with QObject, otherwise hierarchy logic will not work
-        super().__init__(parent=parent, **kwargs)
-
-        assert isinstance(
-            self, QObject
-        ), "BECConnector must be used with a QObject or any qt related class."
-
-        # flag to check if the object was destroyed and its cleanup was called
-        self._destroyed = False
-
-        # BEC related connections
-        self.bec_dispatcher = BECDispatcher(client=client)
-        self.client = self.bec_dispatcher.client if client is None else client
-        self._parent_dock = parent_dock  # TODO also remove at some point -> issue created #473
-        self.rpc_register = RPCRegister()
-
-        if not self.client in BECConnector.EXIT_HANDLERS:
-            # register function to clean connections at exit;
-            # the function depends on BECClient, and BECDispatcher
-            @SafeSlot()
-            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 the gui_id is passed, it should be respected. However, this should be revisted since
-        # the gui_id has to be unique, and may no longer be.
-        if gui_id:
-            self.config.gui_id = gui_id
-            self.gui_id: str = gui_id  # Keep namespace in sync
-        else:
-            self.gui_id: str = self.config.gui_id  # type: ignore
-
-        if object_name is not None:
-            self.setObjectName(object_name)
-
-        # 1) If no objectName is set, set the initial name
-        if not self.objectName():
-            self.setObjectName(self.__class__.__name__)
-        self.object_name = self.objectName()
-
-        # 2) Enforce unique objectName among siblings with the same BECConnector parent
-        self.setParent(parent)
-        if isinstance(self.parent(), QObject) and hasattr(self, "cleanup"):
-            self.parent().destroyed.connect(self._run_cleanup_on_deleted_parent)
-
-        # Error popups
-        self.error_utility = ErrorPopupUtility()
-
-        self._thread_pool = QThreadPool.globalInstance()
-        # Store references to running workers so they're not garbage collected prematurely.
-        self._workers = []
-
-        # If set to True, the parent_id will be always set to None, thus enforcing that the widget is accessible as a root widget of the BECGuiClient object.
-        self.root_widget = root_widget
-
-        QTimer.singleShot(0, self._update_object_name)
-
-    @property
-    def parent_id(self) -> str | None:
-        try:
-            if self.root_widget:
-                return None
-            connector_parent = WidgetHierarchy._get_becwidget_ancestor(self)
-            return connector_parent.gui_id if connector_parent else None
-        except:
-            logger.error(f"Error getting parent_id for {self.__class__.__name__}")
-
-    @SafeSlot()
-    def _run_cleanup_on_deleted_parent(self) -> None:
-        """
-        Run cleanup on the deleted parent.
-        This method is called when the parent is deleted.
-        """
-        if not hasattr(self, "cleanup"):
-            return
-        try:
-            if not self._destroyed:
-                self.cleanup()
-                self._destroyed = True
-        except Exception:
-            content = traceback.format_exc()
-            logger.info(
-                "Failed to run cleanup on deleted parent. "
-                f"This is not necessarily an error as the parent may be deleted before the child and includes already a cleanup. The following exception was raised:\n{content}"
-            )
-
-    def change_object_name(self, name: str) -> None:
-        """
-        Change the object name of the widget. Unregister old name and register the new one.
-
-        Args:
-            name (str): The new object name.
-        """
-        self.rpc_register.remove_rpc(self)
-        self.setObjectName(name.replace("-", "_").replace(" ", "_"))
-        QTimer.singleShot(0, self._update_object_name)
-
-    def _update_object_name(self) -> None:
-        """
-        Enforce a unique object name among siblings and register the object for RPC.
-        This method is called through a single shot timer kicked off in the constructor.
-        """
-        # 1) Enforce unique objectName among siblings with the same BECConnector parent
-        self._enforce_unique_sibling_name()
-        # 2) Register the object for RPC
-        self.rpc_register.add_rpc(self)
-
-    def _enforce_unique_sibling_name(self):
-        """
-        Enforce that this BECConnector has a unique objectName among its siblings.
-
-        Sibling logic:
-          - If there's a nearest BECConnector parent, only compare with children of that parent.
-          - If parent is None (i.e., top-level object), compare with all other top-level BECConnectors.
-        """
-        QApplication.processEvents()
-        parent_bec = WidgetHierarchy._get_becwidget_ancestor(self)
-
-        if parent_bec:
-            # We have a parent => only compare with siblings under that parent
-            siblings = parent_bec.findChildren(BECConnector)
-        else:
-            # No parent => treat all top-level BECConnectors as siblings
-            # 1) Gather all BECConnectors from QApplication
-            all_widgets = QApplication.allWidgets()
-            all_bec = [w for w in all_widgets if isinstance(w, BECConnector)]
-            # 2) "Top-level" means closest BECConnector parent is None
-            top_level_bec = [
-                w for w in all_bec if WidgetHierarchy._get_becwidget_ancestor(w) is None
-            ]
-            # 3) We are among these top-level siblings
-            siblings = top_level_bec
-
-        # Collect used names among siblings
-        used_names = {sib.objectName() for sib in siblings if sib is not self}
-
-        base_name = self.object_name
-        if base_name not in used_names:
-            # Name is already unique among siblings
-            return
-
-        # Need a suffix to avoid collision
-        counter = 0
-        while True:
-            trial_name = f"{base_name}_{counter}"
-            if trial_name not in used_names:
-                self.setObjectName(trial_name)
-                self.object_name = trial_name
-                break
-            counter += 1
-
-    # pylint: disable=invalid-name
-    def setObjectName(self, name: str) -> None:
-        """
-        Set the object name of the widget.
-
-        Args:
-            name (str): The new object name.
-        """
-        super().setObjectName(name)
-        self.object_name = name
-        if self.rpc_register.object_is_registered(self):
-            self.rpc_register.broadcast()
-
-    def submit_task(self, fn, *args, on_complete: SafeSlot = 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)
-        # Keep a reference to the worker so it is not garbage collected.
-        self._workers.append(worker)
-        # When the worker is done, remove it from our list.
-        worker.signals.completed.connect(lambda: self._workers.remove(worker))
-        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:
-        """
-        Set the configuration of the widget.
-
-        Args:
-            config (BaseModel): The new configuration model.
-        """
-        self.config = config
-
-    # FIXME some thoughts are required to decide how thhis should work with rpc registry
-    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
-
-    # FIXME some thoughts are required to decide how thhis should work with rpc registry
-    def load_config(self, path: str | None = None, gui: bool = False):
-        """
-        Load the configuration of the widget from YAML.
-
-        Args:
-            path (str | None): 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 | None): 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)
-
-    # @SafeSlot(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()
-
-    @SafeSlot(ConnectionConfig)  # TODO can be also dict
-    def on_config_update(self, config: ConnectionConfig | dict) -> None:
-        """
-        Update the configuration for the widget.
-
-        Args:
-            config (ConnectionConfig | dict): Configuration settings.
-        """
-        gui_id = getattr(config, "gui_id", None)
-        if isinstance(config, dict):
-            config = ConnectionConfig(**config)
-        self.config = config
-        if gui_id and config.gui_id != gui_id:  # Recreating config should not overwrite the gui_id
-            self.config.gui_id = gui_id
-
-    def remove(self):
-        """Cleanup the BECConnector"""
-        # If the widget is attached to a dock, remove it from the dock.
-        # TODO this should be handled by dock and dock are not by BECConnector  -> issue created #473
-        if self._parent_dock is not None:
-            self._parent_dock.delete(self.object_name)
-        # If the widget is from Qt, trigger its close method.
-        elif hasattr(self, "close"):
-            self.close()
-        # If the widget is neither from a Dock nor from Qt, remove it from the RPC registry.
-        # i.e. Curve Item from Waveform
-        else:
-            self.rpc_register.remove_rpc(self)
-
-    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 | BaseModel: The configuration of the widget.
-        """
-        if dict_output:
-            return self.config.model_dump()
-        else:
-            return self.config
-
-
-# --- Example usage of BECConnector: running a simple task ---
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    # Create a QApplication instance (required for QThreadPool)
-    app = QApplication(sys.argv)
-
-    connector = BECConnector()
-
-    def print_numbers():
-        """
-        Task function that prints numbers 1 to 10 with a 0.5 second delay between each.
-        """
-        for i in range(1, 11):
-            print(i)
-            time.sleep(0.5)
-
-    def task_complete():
-        """
-        Called when the task is complete.
-        """
-        print("Task complete")
-        # Exit the application after the task completes.
-        app.quit()
-
-    # Submit the task using the connector's submit_task method.
-    connector.submit_task(print_numbers, on_complete=task_complete)
-
-    # Start the Qt event loop.
-    sys.exit(app.exec_())

bec_widgets/utils/bec_designer.py

@@ -1,171 +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
-
-from bec_widgets.utils.bec_plugin_helper import user_widget_plugin
-
-if PYSIDE6:
-    from PySide6.scripts.pyside_tool import (
-        _extend_path_var,
-        init_virtual_env,
-        is_pyenv_python,
-        is_virtual_env,
-        qt_tool_wrapper,
-        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(cmd_args: list[str] = []):  # 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":
-            env_var = "LD_PRELOAD"
-            current_pid = os.getpid()
-            with open(f"/proc/{current_pid}/maps", "rt") as f:
-                for line in f:
-                    if "libpython" in line:
-                        lib_path = line.split()[-1]
-                        os.environ[env_var] = lib_path
-                        break
-
-        elif sys.platform == "darwin":
-            suffix = ".dylib"
-            env_var = "DYLD_INSERT_LIBRARIES"
-            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
-        else:
-            raise RuntimeError(f"Unsupported platform: {sys.platform}")
-
-        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"), cmd_args)
-
-
-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 open_designer(cmd_args: list[str] = []):  # 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)
-    if (plugin_repo := user_widget_plugin()) and isinstance(plugin_repo.__file__, str):
-        plugin_repo_dir = Path(os.path.dirname(plugin_repo.__file__)).resolve()
-        plugin_paths.extend(find_plugin_paths(plugin_repo_dir))
-
-    set_plugin_environment_variable(plugin_paths)
-
-    patch_designer(cmd_args)
-
-
-def main():
-    open_designer(sys.argv[1:])
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/utils/bec_dispatcher.py

@@ -1,283 +0,0 @@
-from __future__ import annotations
-
-import collections
-import random
-import string
-from collections.abc import Callable
-from typing import TYPE_CHECKING, DefaultDict, Hashable, Union
-
-import louie
-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
-
-from bec_widgets.utils.serialization import register_serializer_extension
-
-logger = bec_logger.logger
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_lib.endpoints import EndpointInfo
-
-    from bec_widgets.utils.rpc_server import RPCServer
-
-
-class QtThreadSafeCallback(QObject):
-    """QtThreadSafeCallback is a wrapper around a callback function to make it thread-safe for Qt."""
-
-    cb_signal = pyqtSignal(dict, dict)
-
-    def __init__(self, cb: Callable, cb_info: dict | None = None):
-        """
-        Initialize the QtThreadSafeCallback.
-
-        Args:
-            cb (Callable): The callback function to be wrapped.
-            cb_info (dict, optional): Additional information about the callback. Defaults to None.
-        """
-        super().__init__()
-        self.cb_info = cb_info
-
-        self.cb = cb
-        self.cb_ref = louie.saferef.safe_ref(cb)
-        self.cb_signal.connect(self.cb)
-        self.topics = set()
-
-    def __hash__(self):
-        # make 2 differents QtThreadSafeCallback to look
-        # identical when used as dictionary keys, if the
-        # callback is the same
-        return f"{id(self.cb_ref)}{self.cb_info}".__hash__()
-
-    def __eq__(self, other):
-        if not isinstance(other, QtThreadSafeCallback):
-            return False
-        return self.cb_ref == other.cb_ref and self.cb_info == other.cb_info
-
-    def __call__(self, msg_content, metadata):
-        if self.cb_ref() is None:
-            # callback has been deleted
-            return
-        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
-    client: BECClient
-    cli_server: RPCServer | None = None
-
-    def __new__(
-        cls,
-        client=None,
-        config: str | ServiceConfig | None = None,
-        gui_id: str | None = 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 = None, gui_id: str = None):
-        if self._initialized:
-            return
-
-        self._registered_slots: DefaultDict[Hashable, QtThreadSafeCallback] = (
-            collections.defaultdict()
-        )
-        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.")
-
-        register_serializer_extension()
-
-        logger.success("Initialized BECDispatcher")
-
-        self.start_cli_server(gui_id=gui_id)
-        self._initialized = True
-
-    @classmethod
-    def reset_singleton(cls):
-        """
-        Reset the singleton instance of the BECDispatcher.
-        """
-        cls._instance = None
-        cls._initialized = False
-
-    def connect_slot(
-        self,
-        slot: Callable,
-        topics: EndpointInfo | str | list[EndpointInfo] | list[str],
-        cb_info: dict | None = None,
-        **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[EndpointInfo] | list[str]: A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
-            cb_info (dict | None): A dictionary containing information about the callback. Defaults to None.
-        """
-        qt_slot = QtThreadSafeCallback(cb=slot, cb_info=cb_info)
-        if qt_slot not in self._registered_slots:
-            self._registered_slots[qt_slot] = qt_slot
-        qt_slot = self._registered_slots[qt_slot]
-        self.client.connector.register(topics, cb=qt_slot, **kwargs)
-        topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        qt_slot.topics.update(set(topics_str))
-
-    def disconnect_slot(
-        self, slot: Callable, topics: EndpointInfo | str | list[EndpointInfo] | list[str]
-    ):
-        """
-        Disconnect a slot from a topic.
-
-        Args:
-            slot(Callable): The slot to disconnect
-            topics EndpointInfo | str | list[EndpointInfo] | list[str]: A topic or list of topics to unsub 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._registered_slots.values():
-            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._registered_slots[connected_slot].topics.difference_update(set(topics_str))
-        if not self._registered_slots[connected_slot].topics:
-            del self._registered_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)
-
-        remove_slots = []
-        for connected_slot in self._registered_slots.values():
-            connected_slot.topics.difference_update(set(topics_str))
-
-            if not connected_slot.topics:
-                remove_slots.append(connected_slot)
-
-        for connected_slot in remove_slots:
-            self._registered_slots.pop(connected_slot, None)
-
-    def disconnect_all(self, *args, **kwargs):
-        """
-        Disconnect all slots from all topics.
-
-        Args:
-            *args: Arbitrary positional arguments
-            **kwargs: Arbitrary keyword arguments
-        """
-        # pylint: disable=protected-access
-        self.disconnect_topics(self.client.connector._topics_cb)
-
-    def start_cli_server(self, gui_id: str | None = None):
-        """
-        Start the CLI server.
-
-        Args:
-            gui_id(str, optional): The GUI ID. Defaults to None. If None, a unique identifier will be generated.
-        """
-        # pylint: disable=import-outside-toplevel
-        from bec_widgets.utils.rpc_server import RPCServer
-
-        if gui_id is None:
-            gui_id = self.generate_unique_identifier()
-
-        if not self.client.started:
-            logger.error("Cannot start CLI server without a running client")
-            return
-        self.cli_server = RPCServer(gui_id, dispatcher=self, client=self.client)
-        logger.success(f"Started CLI server with gui_id: {gui_id}")
-
-    def stop_cli_server(self):
-        """
-        Stop the CLI server.
-        """
-        if self.cli_server is None:
-            logger.error("Cannot stop CLI server without starting it first")
-            return
-        self.cli_server.shutdown()
-        self.cli_server = None
-        logger.success("Stopped CLI server")
-
-    @staticmethod
-    def generate_unique_identifier(length: int = 4) -> str:
-        """
-        Generate a unique identifier for the application.
-
-        Args:
-            length: The length of the identifier. Defaults to 4.
-
-        Returns:
-            str: The unique identifier.
-        """
-        allowed_chars = string.ascii_lowercase + string.digits
-        return "".join(random.choices(allowed_chars, k=length))

bec_widgets/utils/bec_plugin_helper.py

@@ -1,102 +0,0 @@
-from __future__ import annotations
-
-import importlib.metadata
-import inspect
-import pkgutil
-import traceback
-from importlib import util as importlib_util
-from importlib.machinery import FileFinder, ModuleSpec, SourceFileLoader
-from types import ModuleType
-from typing import Generator
-
-from bec_lib.logger import bec_logger
-
-from bec_widgets.utils.plugin_utils import BECClassContainer, BECClassInfo
-
-logger = bec_logger.logger
-
-
-def _submodule_specs(module: ModuleType) -> tuple[ModuleSpec | None, ...]:
-    """Return specs for all submodules of the given module."""
-    return tuple(
-        module_info.module_finder.find_spec(module_info.name)
-        for module_info in pkgutil.iter_modules(module.__path__)
-        if isinstance(module_info.module_finder, FileFinder)
-    )
-
-
-def _loaded_submodules_from_specs(
-    submodule_specs: tuple[ModuleSpec | None, ...],
-) -> Generator[ModuleType, None, None]:
-    """Load all submodules from the given specs."""
-    for submodule in (
-        importlib_util.module_from_spec(spec) for spec in submodule_specs if spec is not None
-    ):
-        assert isinstance(
-            submodule.__loader__, SourceFileLoader
-        ), "Module found from FileFinder should have SourceFileLoader!"
-        try:
-            submodule.__loader__.exec_module(submodule)
-        except Exception as e:
-            logger.error(
-                f"Error loading plugin {submodule}: \n{''.join(traceback.format_exception(e))}"
-            )
-        yield submodule
-
-
-def _submodule_by_name(module: ModuleType, name: str):
-    for submod in _loaded_submodules_from_specs(_submodule_specs(module)):
-        if submod.__name__ == name:
-            return submod
-    return None
-
-
-def _get_widgets_from_module(module: ModuleType) -> BECClassContainer:
-    """Find any BECWidget subclasses in the given module and return them with their info."""
-    from bec_widgets.utils.bec_widget import BECWidget  # avoid circular import
-
-    classes = inspect.getmembers(
-        module,
-        predicate=lambda item: inspect.isclass(item)
-        and issubclass(item, BECWidget)
-        and item is not BECWidget,
-    )
-    return BECClassContainer(
-        BECClassInfo(name=k, module=module.__name__, file=module.__loader__.get_filename(), obj=v)
-        for k, v in classes
-    )
-
-
-def _all_widgets_from_all_submods(module) -> BECClassContainer:
-    """Recursively load submodules, find any BECWidgets, and return them all as a flat dict."""
-    widgets = _get_widgets_from_module(module)
-    if not hasattr(module, "__path__"):
-        return widgets
-    for submod in _loaded_submodules_from_specs(_submodule_specs(module)):
-        widgets += _all_widgets_from_all_submods(submod)
-    return widgets
-
-
-def user_widget_plugin() -> ModuleType | None:
-    plugins = importlib.metadata.entry_points(group="bec.widgets.user_widgets")  # type: ignore
-    return None if len(plugins) == 0 else tuple(plugins)[0].load()
-
-
-def get_plugin_client_module() -> ModuleType | None:
-    """If there is a plugin repository installed, return the client module."""
-    return _submodule_by_name(plugin, "client") if (plugin := user_widget_plugin()) else None
-
-
-def get_all_plugin_widgets() -> BECClassContainer:
-    """If there is a plugin repository installed, load all widgets from it."""
-    if plugin := user_widget_plugin():
-        return _all_widgets_from_all_submods(plugin)
-    else:
-        return BECClassContainer()
-
-
-if __name__ == "__main__":  # pragma: no cover
-
-    client = get_plugin_client_module()
-    print(get_all_plugin_widgets())
-    ...

bec_widgets/utils/bec_signal_proxy.py

@@ -1,90 +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 QTimer, Signal
-
-from bec_widgets.utils.error_popups import SafeSlot
-
-
-class BECSignalProxy(SignalProxy):
-    """
-    Thin wrapper around the SignalProxy class to allow signal calls to be blocked,
-    but arguments still being stored.
-
-    Args:
-        *args: Arguments to pass to the SignalProxy class.
-        rateLimit (int): The rateLimit of the proxy.
-        timeout (float): The number of seconds after which the proxy automatically
-                         unblocks if still blocked. Default is 10.0 seconds.
-        **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, timeout=10.0, **kwargs):
-        super().__init__(*args, rateLimit=rateLimit, **kwargs)
-        self._blocking = False
-        self.old_args = None
-        self.new_args = None
-
-        # Store timeout value (in seconds)
-        self._timeout = timeout
-
-        # Create a single-shot timer for auto-unblocking
-        self._timer = QTimer()
-        self._timer.setSingleShot(True)
-        self._timer.timeout.connect(self._timeout_unblock)
-
-    @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)
-
-        self._timer.start(int(self._timeout * 1000))
-
-    @SafeSlot()
-    def unblock_proxy(self):
-        """Unblock the proxy, and call the signalReceived method in case there was an update of the args."""
-        if self.blocked:
-            self._timer.stop()
-            self.blocked = False
-            if self.new_args != self.old_args:
-                self.signalReceived(*self.new_args)
-
-    @SafeSlot()
-    def _timeout_unblock(self):
-        """
-        Internal method called by the QTimer upon timeout. Unblocks the proxy
-        automatically if it is still blocked.
-        """
-        if self.blocked:
-            self.unblock_proxy()
-
-    def cleanup(self):
-        """
-        Cleanup the proxy by stopping the timer and disconnecting the timeout signal.
-        """
-        self._timer.stop()
-        self._timer.timeout.disconnect(self._timeout_unblock)
-        self._timer.deleteLater()

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,113 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-import darkdetect
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import QObject, Slot
-from qtpy.QtWidgets import QApplication
-
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
-from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
-from bec_widgets.utils.colors import set_theme
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_widgets.widgets.containers.dock import BECDock
-
-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"
-    USER_ACCESS = ["remove"]
-
-    # pylint: disable=too-many-arguments
-    def __init__(
-        self,
-        client=None,
-        config: ConnectionConfig = None,
-        gui_id: str | None = None,
-        theme_update: bool = False,
-        parent_dock: BECDock | None = None,  # TODO should go away -> issue created #473
-        **kwargs,
-    ):
-        """
-        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.
-        """
-
-        super().__init__(
-            client=client, config=config, gui_id=gui_id, parent_dock=parent_dock, **kwargs
-        )
-        if not isinstance(self, QObject):
-            raise RuntimeError(f"{repr(self)} is not a subclass of QWidget")
-        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 | 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)
-
-    @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."""
-        with RPCRegister.delayed_broadcast():
-            # All widgets need to call super().cleanup() in their cleanup method
-            logger.info(f"Registry cleanup for widget {self.__class__.__name__}")
-            self.rpc_register.remove_rpc(self)
-
-    def closeEvent(self, event):
-        """Wrap the close even to ensure the rpc_register is cleaned up."""
-        try:
-            if not self._destroyed:
-                self.cleanup()
-                self._destroyed = True
-        finally:
-            super().closeEvent(event)  # pylint: disable=no-member

bec_widgets/utils/collapsible_panel_manager.py

@@ -1,380 +0,0 @@
-from __future__ import annotations
-
-import sys
-from typing import Literal
-
-import pyqtgraph as pg
-from qtpy.QtCore import Property, QEasingCurve, QObject, QPropertyAnimation
-from qtpy.QtWidgets import (
-    QApplication,
-    QHBoxLayout,
-    QMainWindow,
-    QPushButton,
-    QSizePolicy,
-    QVBoxLayout,
-    QWidget,
-)
-from typeguard import typechecked
-
-from bec_widgets.widgets.containers.layout_manager.layout_manager import LayoutManagerWidget
-
-
-class DimensionAnimator(QObject):
-    """
-    Helper class to animate the size of a panel widget.
-    """
-
-    def __init__(self, panel_widget: QWidget, direction: str):
-        super().__init__()
-        self.panel_widget = panel_widget
-        self.direction = direction
-        self._size = 0
-
-    @Property(int)
-    def panel_width(self):
-        """
-        Returns the current width of the panel widget.
-        """
-        return self._size
-
-    @panel_width.setter
-    def panel_width(self, val: int):
-        """
-        Set the width of the panel widget.
-
-        Args:
-            val(int): The width to set.
-        """
-        self._size = val
-        self.panel_widget.setFixedWidth(val)
-
-    @Property(int)
-    def panel_height(self):
-        """
-        Returns the current height of the panel widget.
-        """
-        return self._size
-
-    @panel_height.setter
-    def panel_height(self, val: int):
-        """
-        Set the height of the panel widget.
-
-        Args:
-            val(int): The height to set.
-        """
-        self._size = val
-        self.panel_widget.setFixedHeight(val)
-
-
-class CollapsiblePanelManager(QObject):
-    """
-    Manager class to handle collapsible panels from a main widget using LayoutManagerWidget.
-    """
-
-    def __init__(self, layout_manager: LayoutManagerWidget, reference_widget: QWidget, parent=None):
-        super().__init__(parent)
-        self.layout_manager = layout_manager
-        self.reference_widget = reference_widget
-        self.animations = {}
-        self.panels = {}
-        self.direction_settings = {
-            "left": {"property": b"maximumWidth", "default_size": 200},
-            "right": {"property": b"maximumWidth", "default_size": 200},
-            "top": {"property": b"maximumHeight", "default_size": 150},
-            "bottom": {"property": b"maximumHeight", "default_size": 150},
-        }
-
-    def add_panel(
-        self,
-        direction: Literal["left", "right", "top", "bottom"],
-        panel_widget: QWidget,
-        target_size: int | None = None,
-        duration: int = 300,
-    ):
-        """
-        Add a panel widget to the layout manager.
-
-        Args:
-            direction(Literal["left", "right", "top", "bottom"]): Direction of the panel.
-            panel_widget(QWidget): The panel widget to add.
-            target_size(int, optional): The target size of the panel. Defaults to None.
-            duration(int): The duration of the animation in milliseconds. Defaults to 300.
-        """
-        if direction not in self.direction_settings:
-            raise ValueError("Direction must be one of 'left', 'right', 'top', 'bottom'.")
-
-        if target_size is None:
-            target_size = self.direction_settings[direction]["default_size"]
-
-        self.layout_manager.add_widget_relative(
-            widget=panel_widget, reference_widget=self.reference_widget, position=direction
-        )
-        panel_widget.setVisible(False)
-
-        # Set initial constraints as flexible
-        if direction in ["left", "right"]:
-            panel_widget.setMaximumWidth(0)
-            panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-        else:
-            panel_widget.setMaximumHeight(0)
-            panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-
-        self.panels[direction] = {
-            "widget": panel_widget,
-            "direction": direction,
-            "target_size": target_size,
-            "duration": duration,
-            "animator": None,
-        }
-
-    def toggle_panel(
-        self,
-        direction: Literal["left", "right", "top", "bottom"],
-        target_size: int | None = None,
-        duration: int | None = None,
-        easing_curve: QEasingCurve = QEasingCurve.InOutQuad,
-        ensure_max: bool = False,
-        scale: float | None = None,
-        animation: bool = True,
-    ):
-        """
-        Toggle the specified panel.
-
-        Parameters:
-            direction (Literal["left", "right", "top", "bottom"]): Direction of the panel to toggle.
-            target_size (int, optional): Override target size for this toggle.
-            duration (int, optional): Override the animation duration.
-            easing_curve (QEasingCurve): Animation easing curve.
-            ensure_max (bool): If True, animate as a fixed-size panel.
-            scale (float, optional): If provided, calculate target_size from main widget size.
-            animation (bool): If False, no animation is performed; panel instantly toggles.
-        """
-        if direction not in self.panels:
-            raise ValueError(f"No panel found in direction '{direction}'.")
-
-        panel_info = self.panels[direction]
-        panel_widget = panel_info["widget"]
-        dir_settings = self.direction_settings[direction]
-
-        # Determine final target size
-        if scale is not None:
-            main_rect = self.reference_widget.geometry()
-            if direction in ["left", "right"]:
-                computed_target = int(main_rect.width() * scale)
-            else:
-                computed_target = int(main_rect.height() * scale)
-            final_target_size = computed_target
-        else:
-            if target_size is None:
-                final_target_size = panel_info["target_size"]
-            else:
-                final_target_size = target_size
-
-        if duration is None:
-            duration = panel_info["duration"]
-
-        expanding_property = dir_settings["property"]
-        currently_visible = panel_widget.isVisible()
-
-        if ensure_max:
-            if panel_info["animator"] is None:
-                panel_info["animator"] = DimensionAnimator(panel_widget, direction)
-            animator = panel_info["animator"]
-
-            if direction in ["left", "right"]:
-                prop_name = b"panel_width"
-            else:
-                prop_name = b"panel_height"
-        else:
-            animator = None
-            prop_name = expanding_property
-
-        if currently_visible:
-            # Hide the panel
-            if ensure_max:
-                start_value = final_target_size
-                end_value = 0
-                finish_callback = lambda w=panel_widget, d=direction: self._after_hide_reset(w, d)
-            else:
-                start_value = (
-                    panel_widget.width()
-                    if direction in ["left", "right"]
-                    else panel_widget.height()
-                )
-                end_value = 0
-                finish_callback = lambda w=panel_widget: w.setVisible(False)
-        else:
-            # Show the panel
-            start_value = 0
-            end_value = final_target_size
-            finish_callback = None
-            if ensure_max:
-                # Fix panel exactly
-                if direction in ["left", "right"]:
-                    panel_widget.setMinimumWidth(0)
-                    panel_widget.setMaximumWidth(final_target_size)
-                    panel_widget.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Expanding)
-                else:
-                    panel_widget.setMinimumHeight(0)
-                    panel_widget.setMaximumHeight(final_target_size)
-                    panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
-            else:
-                # Flexible mode
-                if direction in ["left", "right"]:
-                    panel_widget.setMinimumWidth(0)
-                    panel_widget.setMaximumWidth(final_target_size)
-                    panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-                else:
-                    panel_widget.setMinimumHeight(0)
-                    panel_widget.setMaximumHeight(final_target_size)
-                    panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-
-            panel_widget.setVisible(True)
-
-        if not animation:
-            # No animation: instantly set final state
-            if end_value == 0:
-                # Hiding
-                if ensure_max:
-                    # Reset after hide
-                    self._after_hide_reset(panel_widget, direction)
-                else:
-                    panel_widget.setVisible(False)
-            else:
-                # Showing
-                if ensure_max:
-                    # Already set fixed size
-                    if direction in ["left", "right"]:
-                        panel_widget.setFixedWidth(end_value)
-                    else:
-                        panel_widget.setFixedHeight(end_value)
-                else:
-                    # Just set maximum dimension
-                    if direction in ["left", "right"]:
-                        panel_widget.setMaximumWidth(end_value)
-                    else:
-                        panel_widget.setMaximumHeight(end_value)
-            return
-
-        # With animation
-        animation = QPropertyAnimation(animator if ensure_max else panel_widget, prop_name)
-        animation.setDuration(duration)
-        animation.setStartValue(start_value)
-        animation.setEndValue(end_value)
-        animation.setEasingCurve(easing_curve)
-
-        if end_value == 0 and finish_callback:
-            animation.finished.connect(finish_callback)
-        elif end_value == 0 and not finish_callback:
-            animation.finished.connect(lambda w=panel_widget: w.setVisible(False))
-
-        animation.start()
-        self.animations[panel_widget] = animation
-
-    @typechecked
-    def _after_hide_reset(
-        self, panel_widget: QWidget, direction: Literal["left", "right", "top", "bottom"]
-    ):
-        """
-        Reset the panel widget after hiding it in ensure_max mode.
-
-        Args:
-            panel_widget(QWidget): The panel widget to reset.
-            direction(Literal["left", "right", "top", "bottom"]): The direction of the panel.
-        """
-        # Called after hiding a panel in ensure_max mode
-        panel_widget.setVisible(False)
-        if direction in ["left", "right"]:
-            panel_widget.setMinimumWidth(0)
-            panel_widget.setMaximumWidth(0)
-            panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-        else:
-            panel_widget.setMinimumHeight(0)
-            panel_widget.setMaximumHeight(16777215)
-            panel_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
-
-
-####################################################################################################
-# The following code is for the GUI control panel to interact with the CollapsiblePanelManager.
-# It is not covered by any tests as it serves only as an example for the CollapsiblePanelManager class.
-####################################################################################################
-
-
-class MainWindow(QMainWindow):  # pragma: no cover
-    def __init__(self):
-        super().__init__()
-        self.setWindowTitle("Panels with ensure_max, scale, and animation toggle")
-        self.resize(800, 600)
-
-        central_widget = QWidget()
-        self.setCentralWidget(central_widget)
-        main_layout = QVBoxLayout(central_widget)
-        main_layout.setContentsMargins(10, 10, 10, 10)
-        main_layout.setSpacing(10)
-
-        # Buttons
-        buttons_layout = QHBoxLayout()
-        self.btn_left = QPushButton("Toggle Left (ensure_max=True)")
-        self.btn_top = QPushButton("Toggle Top (scale=0.5, no animation)")
-        self.btn_right = QPushButton("Toggle Right (ensure_max=True, scale=0.3)")
-        self.btn_bottom = QPushButton("Toggle Bottom (no animation)")
-
-        buttons_layout.addWidget(self.btn_left)
-        buttons_layout.addWidget(self.btn_top)
-        buttons_layout.addWidget(self.btn_right)
-        buttons_layout.addWidget(self.btn_bottom)
-
-        main_layout.addLayout(buttons_layout)
-
-        self.layout_manager = LayoutManagerWidget()
-        main_layout.addWidget(self.layout_manager)
-
-        # Main widget
-        self.main_plot = pg.PlotWidget()
-        self.main_plot.plot([1, 2, 3, 4], [4, 3, 2, 1])
-        self.layout_manager.add_widget(self.main_plot, 0, 0)
-
-        self.panel_manager = CollapsiblePanelManager(self.layout_manager, self.main_plot)
-
-        # Panels
-        self.left_panel = pg.PlotWidget()
-        self.left_panel.plot([1, 2, 3], [3, 2, 1])
-        self.panel_manager.add_panel("left", self.left_panel, target_size=200)
-
-        self.right_panel = pg.PlotWidget()
-        self.right_panel.plot([10, 20, 30], [1, 10, 1])
-        self.panel_manager.add_panel("right", self.right_panel, target_size=200)
-
-        self.top_panel = pg.PlotWidget()
-        self.top_panel.plot([1, 2, 3], [1, 2, 3])
-        self.panel_manager.add_panel("top", self.top_panel, target_size=150)
-
-        self.bottom_panel = pg.PlotWidget()
-        self.bottom_panel.plot([2, 4, 6], [10, 5, 10])
-        self.panel_manager.add_panel("bottom", self.bottom_panel, target_size=150)
-
-        # Connect buttons
-        # Left with ensure_max
-        self.btn_left.clicked.connect(
-            lambda: self.panel_manager.toggle_panel("left", ensure_max=True)
-        )
-        # Top with scale=0.5 and no animation
-        self.btn_top.clicked.connect(
-            lambda: self.panel_manager.toggle_panel("top", scale=0.5, animation=False)
-        )
-        # Right with ensure_max, scale=0.3
-        self.btn_right.clicked.connect(
-            lambda: self.panel_manager.toggle_panel("right", ensure_max=True, scale=0.3)
-        )
-        # Bottom no animation
-        self.btn_bottom.clicked.connect(
-            lambda: self.panel_manager.toggle_panel("bottom", target_size=100, animation=False)
-        )
-
-
-if __name__ == "__main__":  # pragma: no cover
-    app = QApplication(sys.argv)
-    w = MainWindow()
-    w.show()
-    sys.exit(app.exec())

bec_widgets/utils/colors.py

@@ -1,547 +0,0 @@
-from __future__ import annotations
-
-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:  # pragma: no cover
-    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()
-    graphic_layouts = [
-        child
-        for top in app.topLevelWidgets()
-        for child in top.findChildren(pg.GraphicsLayoutWidget)
-    ]
-
-    plot_items = [
-        item
-        for gl in graphic_layouts
-        for item in gl.ci.items.keys()  # ci is internal pg.GraphicsLayout that hosts all items
-        if isinstance(item, pg.PlotItem)
-    ]
-
-    histograms = [
-        item
-        for gl in graphic_layouts
-        for item in gl.ci.items.keys()  # ci is internal pg.GraphicsLayout that hosts all items
-        if isinstance(item, pg.HistogramLUTItem)
-    ]
-
-    # Update background color based on the theme
-    if theme == "light":
-        background_color = "#e9ecef"  # Subtle contrast for light mode
-        foreground_color = "#141414"
-        label_color = "#000000"
-        axis_color = "#666666"
-    else:
-        background_color = "#141414"  # Dark mode
-        foreground_color = "#e9ecef"
-        label_color = "#FFFFFF"
-        axis_color = "#CCCCCC"
-
-    # update GraphicsLayoutWidget
-    pg.setConfigOptions(foreground=foreground_color, background=background_color)
-    for pg_widget in graphic_layouts:
-        pg_widget.setBackground(background_color)
-
-    # update PlotItems
-    for plot_item in plot_items:
-        for axis in ["left", "right", "top", "bottom"]:
-            plot_item.getAxis(axis).setPen(pg.mkPen(color=axis_color))
-            plot_item.getAxis(axis).setTextPen(pg.mkPen(color=label_color))
-
-        # Change title color
-        plot_item.titleLabel.setText(plot_item.titleLabel.text, color=label_color)
-
-        # Change legend color
-        if hasattr(plot_item, "legend") and plot_item.legend is not None:
-            plot_item.legend.setLabelTextColor(label_color)
-            # if legend is in plot item and theme is changed, has to be like that because of pg opt logic
-            for sample, label in plot_item.legend.items:
-                label_text = label.text
-                label.setText(label_text, color=label_color)
-
-    # update HistogramLUTItem
-    for histogram in histograms:
-        histogram.axis.setPen(pg.mkPen(color=axis_color))
-        histogram.axis.setTextPen(pg.mkPen(color=label_color))
-
-    # 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/compact_popup.py

@@ -1,270 +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()
-
-        super().closeEvent(event)

bec_widgets/utils/container_utils.py

@@ -1,107 +0,0 @@
-from __future__ import annotations
-
-from typing import Any, Type
-
-from qtpy.QtWidgets import QWidget
-
-from bec_widgets.cli.client_utils import BECGuiClient
-
-
-class WidgetContainerUtils:
-
-    # We need one handler that checks if a WIDGET of a given name is already created for that DOCKAREA
-    # 1. If the name exists, then it depends whether the name was auto-generated -> add _1 to the name
-    #    or alternatively raise an error that it can't be added again ( just raise an error)
-    # 2. Dock names in between docks should also be unique
-
-    @staticmethod
-    def has_name_valid_chars(name: str) -> bool:
-        """Check if the name is valid.
-
-        Args:
-            name(str): The name to be checked.
-
-        Returns:
-            bool: True if the name is valid, False otherwise.
-        """
-        if not name or len(name) > 256:
-            return False  # Don't accept empty names or names longer than 256 characters
-        check_value = name.replace("_", "").replace("-", "")
-        if not check_value.isalnum() or not check_value.isascii():
-            return False
-        return True
-
-    @staticmethod
-    def generate_unique_name(name: str, list_of_names: list[str] | None = None) -> str:
-        """Generate a unique ID.
-
-        Args:
-            name(str): The name of the widget.
-        Returns:
-            tuple (str): The unique name
-        """
-        if list_of_names is None:
-            list_of_names = []
-        ii = 0
-        while ii < 1000:  # 1000 is arbritrary!
-            name_candidate = f"{name}_{ii}"
-            if name_candidate not in list_of_names:
-                return name_candidate
-            ii += 1
-        raise ValueError("Could not generate a unique name after within 1000 attempts.")
-
-    @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.")
-
-    @staticmethod
-    def name_is_protected(name: str, container: Any = None) -> bool:
-        """
-        Check if the name is not protected.
-
-        Args:
-            name(str): The name to be checked.
-
-        Returns:
-            bool: True if the name is not protected, False otherwise.
-        """
-        if container is None:
-            container = BECGuiClient
-        gui_client_methods = set(filter(lambda x: not x.startswith("_"), dir(container)))
-        return name in gui_client_methods
-
-    @staticmethod
-    def raise_for_invalid_name(name: str, container: Any = None) -> None:
-        """
-        Check if the name is valid. If not, raise a ValueError.
-
-        Args:
-            name(str): The name to be checked.
-        Raises:
-            ValueError: If the name is not valid.
-        """
-        if not WidgetContainerUtils.has_name_valid_chars(name):
-            raise ValueError(
-                f"Name '{name}' contains invalid characters. Only alphanumeric characters, underscores, and dashes are allowed."
-            )
-        if WidgetContainerUtils.name_is_protected(name, container):
-            raise ValueError(f"Name '{name}' is protected. Please choose another name.")

bec_widgets/utils/crosshair.py

@@ -1,547 +0,0 @@
-from __future__ import annotations
-
-from collections import defaultdict
-from typing import Any
-
-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 | None = None,
-        *,
-        min_precision: int = 2,
-        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 | None, optional): Fixed number of decimal places to display. If *None*, precision is chosen dynamically from the current view range.
-            min_precision (int, optional): The lower bound (in decimal places) used when dynamic precision is enabled. Defaults to 2.
-            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._min_precision = max(0, int(min_precision))  # ensure non‑negative
-
-        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_row = None
-        self.marker_2d_col = None
-        self.update_markers()
-        self.check_log()
-        self.check_derivatives()
-
-        self._connect_to_theme_change()
-
-    @property
-    def precision(self) -> int | None:
-        """Fixed number of decimals; ``None`` enables dynamic mode."""
-        return self._precision
-
-    @precision.setter
-    def precision(self, value: int | None):
-        """
-        Set the fixed number of decimals to display.
-
-        Args:
-            value(int | None): The number of decimals to display. If `None`, dynamic precision is used based on the view range.
-        """
-        self._precision = value
-
-    @property
-    def min_precision(self) -> int:
-        """Lower bound on decimals when dynamic precision is used."""
-        return self._min_precision
-
-    @min_precision.setter
-    def min_precision(self, value: int):
-        """
-        Set the lower bound on decimals when dynamic precision is used.
-
-        Args:
-            value(int): The minimum number of decimals to display. Must be non-negative.
-        """
-        self._min_precision = max(0, int(value))
-
-    def _current_precision(self) -> int:
-        """
-        Get the current precision based on the view range or fixed precision.
-        """
-        if self._precision is not None:
-            return self._precision
-
-        # Dynamically choose precision from the smaller visible span
-        view_range = self.plot_item.vb.viewRange()
-        x_span = abs(view_range[0][1] - view_range[0][0])
-        y_span = abs(view_range[1][1] - view_range[1][0])
-
-        # Ignore zero spans that can appear during initialisation
-        spans = [s for s in (x_span, y_span) if s > 0]
-        span = min(spans) if spans else 1.0
-
-        exponent = np.floor(np.log10(span))  # order of magnitude
-        decimals = max(0, int(-exponent) + 1)
-        return max(self._min_precision, decimals)
-
-    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_row is not None and self.marker_2d_col is not None:
-                    continue
-                # Create horizontal ROI for row highlighting
-                if item.image is None:
-                    continue
-                self.marker_2d_row = pg.ROI(
-                    [0, 0], size=[item.image.shape[0], 1], pen=pg.mkPen("r", width=2), movable=False
-                )
-                self.marker_2d_row.skip_auto_range = True
-                self.plot_item.addItem(self.marker_2d_row)
-
-                # Create vertical ROI for column highlighting
-                self.marker_2d_col = pg.ROI(
-                    [0, 0], size=[1, item.image.shape[1]], pen=pg.mkPen("r", width=2), movable=False
-                )
-                self.marker_2d_col.skip_auto_range = True
-                self.plot_item.addItem(self.marker_2d_col)
-
-    def snap_to_data(
-        self, x: float, y: float
-    ) -> tuple[None, None] | tuple[defaultdict[Any, list], defaultdict[Any, list]]:
-        """
-        Finds the nearest data points to the given x and y coordinates.
-
-        Args:
-            x(float): The x-coordinate of the mouse cursor
-            y(float): 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 or str(id(item))
-                image_2d = item.image
-                if image_2d is None:
-                    continue
-                # 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
-
-            precision = self._current_precision()
-            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, precision),
-                        round(y_snapped_scaled, precision),
-                    )
-                    self.coordinatesChanged1D.emit(coordinate_to_emit)
-                elif isinstance(item, pg.ImageItem):
-                    name = item.config.monitor or str(id(item))
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    # Set position of horizontal ROI (row)
-                    self.marker_2d_row.setPos([0, y])
-                    # Set position of vertical ROI (column)
-                    self.marker_2d_col.setPos([x, 0])
-                    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
-
-            precision = self._current_precision()
-            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, precision),
-                        round(y_snapped_scaled, precision),
-                    )
-                    self.coordinatesClicked1D.emit(coordinate_to_emit)
-                elif isinstance(item, pg.ImageItem):
-                    name = item.config.monitor or str(id(item))
-                    x, y = x_snap_values[name], y_snap_values[name]
-                    if x is None or y is None:
-                        continue
-                    # Set position of horizontal ROI (row)
-                    self.marker_2d_row.setPos([0, y])
-                    # Set position of vertical ROI (column)
-                    self.marker_2d_col.setPos([x, 0])
-                    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)
-        precision = self._current_precision()
-        text = f"({x_scaled:.{precision}f}, {y_scaled:.{precision}f})"
-        for item in self.items:
-            if isinstance(item, pg.ImageItem):
-                image = item.image
-                if image is None:
-                    continue
-                ix = int(np.clip(x, 0, image.shape[0] - 1))
-                iy = int(np.clip(y, 0, image.shape[1] - 1))
-                intensity = image[ix, iy]
-                text += f"\nIntensity: {intensity:.{precision}f}"
-                break
-        # Update coordinate label
-        self.coord_label.setText(text)
-        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):
-        if self.marker_2d_row is not None:
-            self.plot_item.removeItem(self.marker_2d_row)
-            self.marker_2d_row = None
-        if self.marker_2d_col is not None:
-            self.plot_item.removeItem(self.marker_2d_col)
-            self.marker_2d_col = None
-        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,54 +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]
-
-        # Build list of available signal entries from device._info['signals']
-        signals_dict = getattr(device, "_info", {}).get("signals", {})
-        available_entries = [
-            sig.get("obj_name") for sig in signals_dict.values() if sig.get("obj_name")
-        ]
-
-        # If no signals are found, means device is a signal, use the device name as the entry
-        if not available_entries:
-            available_entries = [name]
-
-        if entry is None or entry == "":
-            entry = next(iter(device._hints), name) if hasattr(device, "_hints") else name
-        if entry not in available_entries:
-            raise ValueError(
-                f"Entry '{entry}' not found in device '{name}' signals. "
-                f"Available signals: '{available_entries}'"
-            )
-
-        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/error_popups.py

@@ -1,344 +0,0 @@
-import functools
-import sys
-import traceback
-
-from bec_lib.logger import bec_logger
-from qtpy.QtCore import Property, QObject, Qt, Signal, Slot
-from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget
-
-logger = bec_logger.logger
-
-
-def SafeProperty(prop_type, *prop_args, popup_error: bool = False, default=None, **prop_kwargs):
-    """
-    Decorator to create a Qt Property with safe getter and setter so that
-    Qt Designer won't crash if an exception occurs in either method.
-
-    Args:
-        prop_type: The property type (e.g., str, bool, int, custom classes, etc.)
-        popup_error (bool): If True, show a popup for any error; otherwise, ignore or log silently.
-        default: Any default/fallback value to return if the getter raises an exception.
-        *prop_args, **prop_kwargs: Passed along to the underlying Qt Property constructor.
-
-    Usage:
-        @SafeProperty(int, default=-1)
-        def some_value(self) -> int:
-            # your getter logic
-            return ...   # if an exception is raised, returns -1
-
-        @some_value.setter
-        def some_value(self, val: int):
-            # your setter logic
-            ...
-    """
-
-    def decorator(py_getter):
-        """Decorator for the user's property getter function."""
-
-        @functools.wraps(py_getter)
-        def safe_getter(self_):
-            try:
-                return py_getter(self_)
-            except Exception:
-                # Identify which property function triggered error
-                prop_name = f"{py_getter.__module__}.{py_getter.__qualname__}"
-                error_msg = traceback.format_exc()
-
-                if popup_error:
-                    ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=True)
-                logger.error(f"SafeProperty error in GETTER of '{prop_name}':\n{error_msg}")
-                return default
-
-        class PropertyWrapper:
-            """
-            Intermediate wrapper used so that the user can optionally chain .setter(...).
-            """
-
-            def __init__(self, getter_func):
-                # We store only our safe_getter in the wrapper
-                self.getter_func = safe_getter
-
-            def setter(self, setter_func):
-                """Wraps the user-defined setter to handle errors safely."""
-
-                @functools.wraps(setter_func)
-                def safe_setter(self_, value):
-                    try:
-                        return setter_func(self_, value)
-                    except Exception:
-                        prop_name = f"{setter_func.__module__}.{setter_func.__qualname__}"
-                        error_msg = traceback.format_exc()
-
-                        if popup_error:
-                            ErrorPopupUtility().custom_exception_hook(
-                                *sys.exc_info(), popup_error=True
-                            )
-                        logger.error(f"SafeProperty error in SETTER of '{prop_name}':\n{error_msg}")
-                        return
-
-                # Return the full read/write Property
-                return Property(prop_type, self.getter_func, safe_setter, *prop_args, **prop_kwargs)
-
-            def __call__(self):
-                """
-                If user never calls `.setter(...)`, produce a read-only property.
-                """
-                return Property(prop_type, self.getter_func, None, *prop_args, **prop_kwargs)
-
-        return PropertyWrapper(py_getter)
-
-    return decorator
-
-
-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
-    'verify_sender' keyword argument can be passed with boolean value if the sender should be verified
-    before executing the slot. If True, the slot will only execute if the sender is a QObject. This is
-    useful to prevent function calls from already deleted objects.
-    'raise_error' keyword argument can be passed with boolean value if the error should be raised
-    after the error is displayed. This is useful to propagate the error to the caller but should be used
-    with great care to avoid segfaults.
-
-    The keywords above are stored in a container which can be overridden by passing
-    '_override_slot_params' keyword argument with a dictionary containing the keywords to override.
-    This is useful to override the default behavior of the decorator for a specific function call.
-
-    """
-    _slot_params = {
-        "popup_error": bool(slot_kwargs.pop("popup_error", False)),
-        "verify_sender": bool(slot_kwargs.pop("verify_sender", False)),
-        "raise_error": bool(slot_kwargs.pop("raise_error", False)),
-    }
-
-    def error_managed(method):
-        @Slot(*slot_args, **slot_kwargs)
-        @functools.wraps(method)
-        def wrapper(*args, **kwargs):
-
-            _override_slot_params = kwargs.pop("_override_slot_params", {})
-            _slot_params.update(_override_slot_params)
-            try:
-                if not _slot_params["verify_sender"] or len(args) == 0:
-                    return method(*args, **kwargs)
-
-                _instance = args[0]
-                if not isinstance(_instance, QObject):
-                    return method(*args, **kwargs)
-                sender = _instance.sender()
-                if sender is None:
-                    logger.info(
-                        f"Sender is None for {method.__module__}.{method.__qualname__}, "
-                        "skipping method call."
-                    )
-                    return
-                return method(*args, **kwargs)
-
-            except Exception:
-                slot_name = f"{method.__module__}.{method.__qualname__}"
-                error_msg = traceback.format_exc()
-                if _slot_params["popup_error"]:
-                    ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=True)
-                logger.error(f"SafeSlot error in slot '{slot_name}':\n{error_msg}")
-                if _slot_params["raise_error"]:
-                    raise
-
-        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 show_property_error(self, title, message, widget):
-        """
-        Show a property-specific error message.
-        """
-        self.error_occurred.emit(title, message, widget)
-
-    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 get_error_message(self, exctype, value, tb):
-        return "".join(traceback.format_exception(exctype, value, tb))
-
-    def custom_exception_hook(self, exctype, value, tb, popup_error=False):
-        if popup_error or self.enable_error_popup:
-            self.error_occurred.emit(
-                "Method error" if popup_error else "Application Error",
-                self.get_error_message(exctype, value, tb),
-                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/utils/expandable_frame.py

@@ -1,72 +0,0 @@
-from __future__ import annotations
-
-from bec_qthemes import material_icon
-from qtpy.QtWidgets import (
-    QFrame,
-    QHBoxLayout,
-    QLabel,
-    QLayout,
-    QSizePolicy,
-    QToolButton,
-    QVBoxLayout,
-    QWidget,
-)
-
-from bec_widgets.utils.error_popups import SafeProperty, SafeSlot
-
-
-class ExpandableGroupFrame(QFrame):
-
-    EXPANDED_ICON_NAME: str = "collapse_all"
-    COLLAPSED_ICON_NAME: str = "expand_all"
-
-    def __init__(self, title: str, parent: QWidget | None = None, expanded: bool = True) -> None:
-        super().__init__(parent=parent)
-        self._expanded = expanded
-
-        self.setFrameStyle(QFrame.Shape.StyledPanel | QFrame.Shadow.Plain)
-        self.setSizePolicy(QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum)
-        self._layout = QVBoxLayout()
-        self._layout.setContentsMargins(0, 0, 0, 0)
-        self.setLayout(self._layout)
-        self._title_layout = QHBoxLayout()
-        self._layout.addLayout(self._title_layout)
-        self._expansion_button = QToolButton()
-        self._update_icon()
-        self._title = QLabel(f"<b>{title}</b>")
-        self._title_layout.addWidget(self._expansion_button)
-        self._title_layout.addWidget(self._title)
-
-        self._contents = QWidget(self)
-        self._layout.addWidget(self._contents)
-
-        self._expansion_button.clicked.connect(self.switch_expanded_state)
-        self.expanded = self._expanded  # type: ignore
-
-    def set_layout(self, layout: QLayout) -> None:
-        self._contents.setLayout(layout)
-        self._contents.layout().setContentsMargins(0, 0, 0, 0)  # type: ignore
-
-    @SafeSlot()
-    def switch_expanded_state(self):
-        self.expanded = not self.expanded  # type: ignore
-        self._update_icon()
-
-    @SafeProperty(bool)
-    def expanded(self):  # type: ignore
-        return self._expanded
-
-    @expanded.setter
-    def expanded(self, expanded: bool):
-        self._expanded = expanded
-        self._contents.setVisible(expanded)
-        self.updateGeometry()
-
-    def _update_icon(self):
-        self._expansion_button.setIcon(
-            material_icon(icon_name=self.EXPANDED_ICON_NAME, size=(10, 10), convert_to_pixmap=False)
-            if self.expanded
-            else material_icon(
-                icon_name=self.COLLAPSED_ICON_NAME, size=(10, 10), convert_to_pixmap=False
-            )
-        )

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/forms_from_types/forms.py

@@ -1,182 +0,0 @@
-from __future__ import annotations
-
-from decimal import Decimal
-from types import NoneType
-
-from bec_lib.logger import bec_logger
-from bec_qthemes import material_icon
-from pydantic import BaseModel, ValidationError
-from qtpy.QtCore import Signal  # type: ignore
-from qtpy.QtWidgets import QGridLayout, QLabel, QLayout, QVBoxLayout, QWidget
-
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.compact_popup import CompactPopupWidget
-from bec_widgets.utils.forms_from_types.items import FormItemSpec, widget_from_type
-
-logger = bec_logger.logger
-
-
-class TypedForm(BECWidget, QWidget):
-    PLUGIN = True
-    ICON_NAME = "list_alt"
-
-    value_changed = Signal()
-
-    RPC = False
-
-    def __init__(
-        self,
-        parent=None,
-        items: list[tuple[str, type]] | None = None,
-        form_item_specs: list[FormItemSpec] | None = None,
-        client=None,
-        **kwargs,
-    ):
-        """Widget with a list of form items based on a list of types.
-
-        Args:
-            items (list[tuple[str, type]]): list of tuples of a name for the field and its type.
-                                            Should be a type supported by the logic in items.py
-            form_item_specs (list[FormItemSpec]): list of form item specs, equivalent to items.
-                                                  only one of items or form_item_specs should be
-                                                  supplied.
-
-        """
-        if (items is not None and form_item_specs is not None) or (
-            items is None and form_item_specs is None
-        ):
-            raise ValueError("Must specify one and only one of items and form_item_specs")
-        super().__init__(parent=parent, client=client, **kwargs)
-        self._items = (
-            form_item_specs
-            if form_item_specs is not None
-            else [
-                FormItemSpec(name=name, item_type=item_type)
-                for name, item_type in items  # type: ignore
-            ]
-        )
-        self._layout = QVBoxLayout()
-        self._layout.setContentsMargins(0, 0, 0, 0)
-        self.setLayout(self._layout)
-
-        self._form_grid_container = QWidget(parent=self)
-        self._form_grid = QWidget(parent=self._form_grid_container)
-        self._layout.addWidget(self._form_grid_container)
-        self._form_grid_container.setLayout(QVBoxLayout())
-        self._form_grid.setLayout(self._new_grid_layout())
-
-        self.populate()
-
-    def populate(self):
-        self._clear_grid()
-        for r, item in enumerate(self._items):
-            self._add_griditem(item, r)
-
-    def _add_griditem(self, item: FormItemSpec, row: int):
-        grid = self._form_grid.layout()
-        label = QLabel(item.name)
-        label.setProperty("_model_field_name", item.name)
-        label.setToolTip(item.info.description or item.name)
-        grid.addWidget(label, row, 0)
-        widget = widget_from_type(item.item_type)(parent=self, spec=item)
-        widget.valueChanged.connect(self.value_changed)
-        grid.addWidget(widget, row, 1)
-
-    def _dict_from_grid(self) -> dict[str, str | int | float | Decimal | bool]:
-        grid: QGridLayout = self._form_grid.layout()  # type: ignore
-        return {
-            grid.itemAtPosition(i, 0)
-            .widget()
-            .property("_model_field_name"): grid.itemAtPosition(i, 1)
-            .widget()
-            .getValue()  # type: ignore # we only add 'DynamicFormItem's here
-            for i in range(grid.rowCount())
-        }
-
-    def _clear_grid(self):
-        if (old_layout := self._form_grid.layout()) is not None:
-            while old_layout.count():
-                item = old_layout.takeAt(0)
-                widget = item.widget()
-                if widget is not None:
-                    widget.deleteLater()
-            old_layout.deleteLater()
-            self._form_grid.deleteLater()
-        self._form_grid = QWidget()
-
-        self._form_grid.setLayout(self._new_grid_layout())
-        self._form_grid_container.layout().addWidget(self._form_grid)
-
-        self._form_grid.adjustSize()
-        self._form_grid_container.adjustSize()
-        self.adjustSize()
-
-    def _new_grid_layout(self):
-        new_grid = QGridLayout()
-        new_grid.setContentsMargins(0, 0, 0, 0)
-        new_grid.setSizeConstraint(QLayout.SizeConstraint.SetFixedSize)
-        return new_grid
-
-
-class PydanticModelForm(TypedForm):
-    metadata_updated = Signal(dict)
-    metadata_cleared = Signal(NoneType)
-
-    def __init__(self, parent=None, metadata_model: type[BaseModel] = None, client=None, **kwargs):
-        """
-        A form generated from a pydantic model.
-
-        Args:
-            metadata_model (type[BaseModel]): the model class for which to generate a form.
-        """
-        self._md_schema = metadata_model
-        super().__init__(parent=parent, form_item_specs=self._form_item_specs(), client=client)
-
-        self._validity = CompactPopupWidget()
-        self._validity.compact_view = True  # type: ignore
-        self._validity.label = "Metadata validity"  # type: ignore
-        self._validity.compact_show_popup.setIcon(
-            material_icon(icon_name="info", size=(10, 10), convert_to_pixmap=False)
-        )
-        self._validity_message = QLabel("Not yet validated")
-        self._validity.addWidget(self._validity_message)
-        self._layout.addWidget(self._validity)
-        self.value_changed.connect(self.validate_form)
-
-    def set_schema(self, schema: type[BaseModel]):
-        self._md_schema = schema
-        self.populate()
-
-    def _form_item_specs(self):
-        return [
-            FormItemSpec(name=name, info=info, item_type=info.annotation)
-            for name, info in self._md_schema.model_fields.items()
-        ]
-
-    def update_items_from_schema(self):
-        self._items = self._form_item_specs()
-
-    def populate(self):
-        self.update_items_from_schema()
-        super().populate()
-
-    def get_form_data(self):
-        """Get the entered metadata as a dict."""
-        return self._dict_from_grid()
-
-    def validate_form(self, *_) -> bool:
-        """validate the currently entered metadata against the pydantic schema.
-        If successful, returns on metadata_emitted and returns true.
-        Otherwise, emits on metadata_cleared and returns false."""
-        try:
-            metadata_dict = self.get_form_data()
-            self._md_schema.model_validate(metadata_dict)
-            self._validity.set_global_state("success")
-            self._validity_message.setText("No errors!")
-            self.metadata_updated.emit(metadata_dict)
-            return True
-        except ValidationError as e:
-            self._validity.set_global_state("emergency")
-            self._validity_message.setText(str(e))
-            self.metadata_cleared.emit(None)
-            return False

bec_widgets/utils/forms_from_types/items.py

@@ -1,286 +0,0 @@
-from __future__ import annotations
-
-from abc import abstractmethod
-from decimal import Decimal
-from types import UnionType
-from typing import Callable, Protocol
-
-from bec_lib.logger import bec_logger
-from bec_qthemes import material_icon
-from pydantic import BaseModel, ConfigDict, Field
-from pydantic.fields import FieldInfo
-from qtpy.QtCore import Signal  # type: ignore
-from qtpy.QtWidgets import (
-    QApplication,
-    QButtonGroup,
-    QCheckBox,
-    QDoubleSpinBox,
-    QGridLayout,
-    QHBoxLayout,
-    QLabel,
-    QLayout,
-    QLineEdit,
-    QRadioButton,
-    QSpinBox,
-    QToolButton,
-    QWidget,
-)
-
-from bec_widgets.widgets.editors.scan_metadata._util import (
-    clearable_required,
-    field_default,
-    field_limits,
-    field_maxlen,
-    field_minlen,
-    field_precision,
-)
-
-logger = bec_logger.logger
-
-
-class FormItemSpec(BaseModel):
-    """
-    The specification for an item in a dynamically generated form. Uses a pydantic FieldInfo
-    to store most annotation info, since one of the main purposes is to store data for
-    forms genrated from pydantic models, but can also be composed from other sources or by hand.
-    """
-
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-    item_type: type | UnionType
-    name: str
-    info: FieldInfo = FieldInfo()
-
-
-class ClearableBoolEntry(QWidget):
-    stateChanged = Signal()
-
-    def __init__(self, parent: QWidget | None = None) -> None:
-        super().__init__(parent)
-        self._layout = QHBoxLayout()
-        self._layout.setContentsMargins(0, 0, 0, 0)
-        self.setLayout(self._layout)
-        self._layout.setSizeConstraint(QLayout.SizeConstraint.SetFixedSize)
-        self._entry = QButtonGroup()
-        self._true = QRadioButton("true", parent=self)
-        self._false = QRadioButton("false", parent=self)
-        for button in [self._true, self._false]:
-            self._layout.addWidget(button)
-            self._entry.addButton(button)
-            button.toggled.connect(self.stateChanged)
-
-    def clear(self):
-        self._entry.setExclusive(False)
-        self._true.setChecked(False)
-        self._false.setChecked(False)
-        self._entry.setExclusive(True)
-
-    def isChecked(self) -> bool | None:
-        if not self._true.isChecked() and not self._false.isChecked():
-            return None
-        return self._true.isChecked()
-
-    def setChecked(self, value: bool | None):
-        if value is None:
-            self.clear()
-        elif value:
-            self._true.setChecked(True)
-            self._false.setChecked(False)
-        else:
-            self._true.setChecked(False)
-            self._false.setChecked(True)
-
-    def setToolTip(self, tooltip: str):
-        self._true.setToolTip(tooltip)
-        self._false.setToolTip(tooltip)
-
-
-class DynamicFormItem(QWidget):
-    valueChanged = Signal()
-
-    def __init__(self, parent: QWidget | None = None, *, spec: FormItemSpec) -> None:
-        super().__init__(parent)
-        self._spec = spec
-        self._layout = QHBoxLayout()
-        self._layout.setContentsMargins(0, 0, 0, 0)
-        self._layout.setSizeConstraint(QLayout.SizeConstraint.SetMaximumSize)
-        self._default = field_default(self._spec.info)
-        self._desc = self._spec.info.description
-        self.setLayout(self._layout)
-        self._add_main_widget()
-        if clearable_required(spec.info):
-            self._add_clear_button()
-
-    @abstractmethod
-    def getValue(self): ...
-
-    @abstractmethod
-    def setValue(self, value): ...
-
-    @abstractmethod
-    def _add_main_widget(self) -> None:
-        """Add the main data entry widget to self._main_widget and appply any
-        constraints from the field info"""
-
-    def _describe(self, pad=" "):
-        return pad + (self._desc if self._desc else "")
-
-    def _add_clear_button(self):
-        self._clear_button = QToolButton()
-        self._clear_button.setIcon(
-            material_icon(icon_name="close", size=(10, 10), convert_to_pixmap=False)
-        )
-        self._layout.addWidget(self._clear_button)
-        # the widget added in _add_main_widget must implement .clear() if value is not required
-        self._clear_button.setToolTip("Clear value or reset to default.")
-        self._clear_button.clicked.connect(self._main_widget.clear)  # type: ignore
-
-    def _value_changed(self, *_, **__):
-        self.valueChanged.emit()
-
-
-class StrMetadataField(DynamicFormItem):
-    def __init__(self, parent: QWidget | None = None, *, spec: FormItemSpec) -> None:
-        super().__init__(parent=parent, spec=spec)
-        self._main_widget.textChanged.connect(self._value_changed)
-
-    def _add_main_widget(self) -> None:
-        self._main_widget = QLineEdit()
-        self._layout.addWidget(self._main_widget)
-        min_length, max_length = (field_minlen(self._spec.info), field_maxlen(self._spec.info))
-        if max_length:
-            self._main_widget.setMaxLength(max_length)
-        self._main_widget.setToolTip(
-            f"(length min: {min_length} max: {max_length}){self._describe()}"
-        )
-        if self._default:
-            self._main_widget.setText(self._default)
-            self._add_clear_button()
-
-    def getValue(self):
-        if self._main_widget.text() == "":
-            return self._default
-        return self._main_widget.text()
-
-    def setValue(self, value: str):
-        if value is None:
-            self._main_widget.setText("")
-        self._main_widget.setText(value)
-
-
-class IntMetadataField(DynamicFormItem):
-    def __init__(self, parent: QWidget | None = None, *, spec: FormItemSpec) -> None:
-        super().__init__(parent=parent, spec=spec)
-        self._main_widget.textChanged.connect(self._value_changed)
-
-    def _add_main_widget(self) -> None:
-        self._main_widget = QSpinBox()
-        self._layout.addWidget(self._main_widget)
-        min_, max_ = field_limits(self._spec.info, int)
-        self._main_widget.setMinimum(min_)
-        self._main_widget.setMaximum(max_)
-        self._main_widget.setToolTip(f"(range {min_} to {max_}){self._describe()}")
-        if self._default is not None:
-            self._main_widget.setValue(self._default)
-            self._add_clear_button()
-        else:
-            self._main_widget.clear()
-
-    def getValue(self):
-        if self._main_widget.text() == "":
-            return self._default
-        return self._main_widget.value()
-
-    def setValue(self, value: int):
-        if value is None:
-            self._main_widget.clear()
-        self._main_widget.setValue(value)
-
-
-class FloatDecimalMetadataField(DynamicFormItem):
-    def __init__(self, parent: QWidget | None = None, *, spec: FormItemSpec) -> None:
-        super().__init__(parent=parent, spec=spec)
-        self._main_widget.textChanged.connect(self._value_changed)
-
-    def _add_main_widget(self) -> None:
-        self._main_widget = QDoubleSpinBox()
-        self._layout.addWidget(self._main_widget)
-        min_, max_ = field_limits(self._spec.info, int)
-        self._main_widget.setMinimum(min_)
-        self._main_widget.setMaximum(max_)
-        precision = field_precision(self._spec.info)
-        if precision:
-            self._main_widget.setDecimals(precision)
-        minstr = f"{float(min_):.3f}" if abs(min_) <= 1000 else f"{float(min_):.3e}"
-        maxstr = f"{float(max_):.3f}" if abs(max_) <= 1000 else f"{float(max_):.3e}"
-        self._main_widget.setToolTip(f"(range {minstr} to {maxstr}){self._describe()}")
-        if self._default is not None:
-            self._main_widget.setValue(self._default)
-            self._add_clear_button()
-        else:
-            self._main_widget.clear()
-
-    def getValue(self):
-        if self._main_widget.text() == "":
-            return self._default
-        return self._main_widget.value()
-
-    def setValue(self, value: float):
-        if value is None:
-            self._main_widget.clear()
-        self._main_widget.setValue(value)
-
-
-class BoolMetadataField(DynamicFormItem):
-    def __init__(self, *, parent: QWidget | None = None, spec: FormItemSpec) -> None:
-        super().__init__(parent=parent, spec=spec)
-        self._main_widget.stateChanged.connect(self._value_changed)
-
-    def _add_main_widget(self) -> None:
-        if clearable_required(self._spec.info):
-            self._main_widget = ClearableBoolEntry()
-        else:
-            self._main_widget = QCheckBox()
-        self._layout.addWidget(self._main_widget)
-        self._main_widget.setToolTip(self._describe(""))
-        self._main_widget.setChecked(self._default)  # type: ignore # if there is no default then it will be ClearableBoolEntry and can be set with None
-
-    def getValue(self):
-        return self._main_widget.isChecked()
-
-    def setValue(self, value):
-        self._main_widget.setChecked(value)
-
-
-def widget_from_type(annotation: type | UnionType | None) -> type[DynamicFormItem]:
-    if annotation in [str, str | None]:
-        return StrMetadataField
-    if annotation in [int, int | None]:
-        return IntMetadataField
-    if annotation in [float, float | None, Decimal, Decimal | None]:
-        return FloatDecimalMetadataField
-    if annotation in [bool, bool | None]:
-        return BoolMetadataField
-    else:
-        logger.warning(f"Type {annotation} is not (yet) supported in metadata form creation.")
-        return StrMetadataField
-
-
-if __name__ == "__main__":  # pragma: no cover
-
-    class TestModel(BaseModel):
-        value1: str | None = Field(None)
-        value2: bool | None = Field(None)
-        value3: bool = Field(True)
-        value4: int = Field(123)
-        value5: int | None = Field()
-
-    app = QApplication([])
-    w = QWidget()
-    layout = QGridLayout()
-    w.setLayout(layout)
-    for i, (field_name, info) in enumerate(TestModel.model_fields.items()):
-        layout.addWidget(QLabel(field_name), i, 0)
-        layout.addWidget(widget_from_type(info.annotation)(info), i, 1)
-
-    w.show()
-    app.exec()

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,153 +0,0 @@
-import inspect
-import os
-import re
-from typing import NamedTuple
-
-from qtpy.QtCore import QObject
-
-from bec_widgets.utils.name_utils import pascal_to_snake
-
-EXCLUDED_PLUGINS = ["BECConnector", "BECDockArea", "BECDock", "BECFigure"]
-
-
-class PluginFilenames(NamedTuple):
-    register: str
-    plugin: str
-    pyproj: str
-
-
-def plugin_filenames(name: str) -> PluginFilenames:
-    return PluginFilenames(f"register_{name}.py", f"{name}_plugin.py", f"{name}.pyproject")
-
-
-class DesignerPluginInfo:
-    def __init__(self, plugin_class):
-        self.plugin_class = plugin_class
-        self.plugin_name_pascal = plugin_class.__name__
-        self.plugin_name_snake = 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))
-
-
-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: dict[str, str] = {}
-        self.template_path = os.path.join(
-            os.path.dirname(os.path.abspath(__file__)), "plugin_templates"
-        )
-
-    @property
-    def filenames(self):
-        return plugin_filenames(self.info.plugin_name_snake)
-
-    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)
-            )
-
-        # for the new style classes, we only have one super call. We can therefore check if the
-        # number of __init__ calls is 2 (the class itself and the super class)
-        num_inits = re.findall(r"__init__", init_source)
-        if len(num_inits) == 2 and not super_init_found:
-            super_init_found = bool(
-                init_source.find("super().__init__(parent=parent") > 0
-                or init_source.find("super().__init__(parent,") > 0
-                or 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_file(self, name: str, contents: str):
-        with open(os.path.join(self.info.base_path, name), "w", encoding="utf-8") as f:
-            f.write(contents)
-
-    def _format(self, name: str):
-        return self.templates[name].format(**self.info.__dict__)
-
-    def _write_templates(self):
-        self._write_file(self.filenames.register, self._format("register"))
-        self._write_file(self.filenames.plugin, self._format("plugin"))
-        pyproj = str({"files": [f"{self.info.plugin_class.__module__.split('.')[-1]}.py"]})
-        self._write_file(self.filenames.pyproj, pyproj)
-
-    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,86 +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."""
-
-from __future__ import annotations
-
-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/name_utils.py

@@ -1,16 +0,0 @@
-import re
-
-
-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()

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/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"
-    RPC = False
-
-    def __init__(self, *args, parent=None, **kwargs):
-        super().__init__(parent=parent, theme_update=True, **kwargs)
-        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/utils/plot_indicator_items.py

@@ -1,244 +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()
-        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()
-        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,214 +0,0 @@
-from __future__ import annotations
-
-import importlib
-import inspect
-import os
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, Iterable
-
-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
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_widgets.widgets.containers.auto_update.auto_updates import AutoUpdates
-
-
-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)
-
-
-def get_plugin_auto_updates() -> dict[str, type[AutoUpdates]]:
-    """
-    Get all available auto update classes from the plugin directory. AutoUpdates must inherit from AutoUpdate and be
-    placed in the plugin repository's bec_widgets/auto_updates directory. The entry point for the auto updates is
-    specified in the respective pyproject.toml file using the following key:
-        [project.entry-points."bec.widgets.auto_updates"]
-        plugin_widgets_update = "<beamline_name>.bec_widgets.auto_updates"
-
-    e.g.
-        [project.entry-points."bec.widgets.auto_updates"]
-        plugin_widgets_update = "pxiii_bec.bec_widgets.auto_updates"
-
-    Returns:
-        dict[str, AutoUpdates]: A dictionary of widget names and their respective classes.
-    """
-    modules = _get_available_plugins("bec.widgets.auto_updates")
-    loaded_plugins = {}
-    for module in modules:
-        mods = inspect.getmembers(module, predicate=_filter_auto_updates)
-        for name, mod_cls in mods:
-            if name in loaded_plugins:
-                print(f"Duplicated auto update {name}.")
-            loaded_plugins[name] = mod_cls
-    return loaded_plugins
-
-
-def _filter_auto_updates(obj):
-    from bec_widgets.widgets.containers.auto_update.auto_updates import AutoUpdates
-
-    return (
-        inspect.isclass(obj) and issubclass(obj, AutoUpdates) and not obj.__name__ == "AutoUpdates"
-    )
-
-
-@dataclass
-class BECClassInfo:
-    name: str
-    module: str
-    file: str
-    obj: type[BECWidget]
-    is_connector: bool = False
-    is_widget: bool = False
-    is_plugin: bool = False
-
-
-class BECClassContainer:
-    def __init__(self, initial: Iterable[BECClassInfo] = []):
-        self._collection: list[BECClassInfo] = list(initial)
-
-    def __repr__(self):
-        return str(list(cl.name for cl in self.collection))
-
-    def __iter__(self):
-        return self._collection.__iter__()
-
-    def __add__(self, other: BECClassContainer):
-        return BECClassContainer((*self, *(c for c in other if c.name not in self.names)))
-
-    def as_dict(self, ignores: list[str] = []) -> dict[str, type[BECWidget]]:
-        """get a dict of {name: Type} for all the entries in the collection.
-
-        Args:
-            ignores(list[str]): a list of class names to exclude from the dictionary."""
-        return {c.name: c.obj for c in self if c.name not in ignores}
-
-    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 names(self):
-        """Return a list of class names"""
-        return [c.name for c in self]
-
-    @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/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/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/round_frame.py

@@ -1,157 +0,0 @@
-import pyqtgraph as pg
-from qtpy.QtCore import Property
-from qtpy.QtWidgets import QApplication, QFrame, QHBoxLayout, QVBoxLayout, QWidget
-
-from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
-
-
-class RoundedFrame(QFrame):
-    """
-    A custom QFrame with rounded corners and optional theme updates.
-    The frame can contain any QWidget, however it is mainly designed to wrap PlotWidgets to provide a consistent look and feel with other BEC Widgets.
-    """
-
-    def __init__(
-        self,
-        parent=None,
-        content_widget: QWidget = None,
-        background_color: str = None,
-        orientation: str = "horizontal",
-        radius: int = 10,
-    ):
-        QFrame.__init__(self, parent)
-
-        self.background_color = background_color
-        self._radius = radius
-
-        # Apply rounded frame styling
-        self.setProperty("skip_settings", True)
-        self.setObjectName("roundedFrame")
-
-        # Create a layout for the frame
-        if orientation == "vertical":
-            self.layout = QVBoxLayout(self)
-            self.layout.setContentsMargins(5, 5, 5, 5)
-        else:
-            self.layout = QHBoxLayout(self)
-            self.layout.setContentsMargins(5, 5, 5, 5)  # Set 5px margin
-
-        # Add the content widget to the layout
-        if content_widget:
-            self.layout.addWidget(content_widget)
-
-        # Store reference to the content widget
-        self.content_widget = content_widget
-
-        # Automatically apply initial styles to the GraphicalLayoutWidget if applicable
-        self.apply_plot_widget_style()
-
-    def apply_theme(self, theme: str):
-        """
-        Apply the theme to the frame and its content if theme updates are enabled.
-        """
-        if self.content_widget is not None and isinstance(
-            self.content_widget, pg.GraphicsLayoutWidget
-        ):
-            self.content_widget.setBackground(self.background_color)
-
-        # Update background color based on the theme
-        if theme == "light":
-            self.background_color = "#e9ecef"  # Subtle contrast for light mode
-        else:
-            self.background_color = "#141414"  # Dark mode
-
-        self.update_style()
-
-    @Property(int)
-    def radius(self):
-        """Radius of the rounded corners."""
-        return self._radius
-
-    @radius.setter
-    def radius(self, value: int):
-        self._radius = value
-        self.update_style()
-
-    def update_style(self):
-        """
-        Update the style of the frame based on the background color.
-        """
-        if self.background_color:
-            self.setStyleSheet(
-                f"""
-                QFrame#roundedFrame {{
-                    background-color: {self.background_color}; 
-                    border-radius: {self._radius}; /* Rounded corners */
-                }}
-            """
-            )
-        self.apply_plot_widget_style()
-
-    def apply_plot_widget_style(self, border: str = "none"):
-        """
-        Automatically apply background, border, and axis styles to the PlotWidget.
-
-        Args:
-            border (str): Border style (e.g., 'none', '1px solid red').
-        """
-        if isinstance(self.content_widget, pg.GraphicsLayoutWidget):
-            # Apply border style via stylesheet
-            self.content_widget.setStyleSheet(
-                f"""
-                GraphicsLayoutWidget {{
-                    border: {border}; /* Explicitly set the border */
-                }}
-            """
-            )
-            self.content_widget.setBackground(self.background_color)
-
-
-class ExampleApp(QWidget):  # pragma: no cover
-    def __init__(self):
-        super().__init__()
-        self.setWindowTitle("Rounded Plots Example")
-
-        # Main layout
-        layout = QVBoxLayout(self)
-
-        dark_button = DarkModeButton()
-
-        # Create PlotWidgets
-        plot1 = pg.GraphicsLayoutWidget()
-        plot_item_1 = pg.PlotItem()
-        plot_item_1.plot([1, 3, 2, 4, 6, 5], pen="r")
-        plot1.plot_item = plot_item_1
-
-        plot2 = pg.GraphicsLayoutWidget()
-        plot_item_2 = pg.PlotItem()
-        plot_item_2.plot([1, 2, 4, 8, 16, 32], pen="r")
-        plot2.plot_item = plot_item_2
-
-        # Wrap PlotWidgets in RoundedFrame
-        rounded_plot1 = RoundedFrame(parent=self, content_widget=plot1)
-        rounded_plot2 = RoundedFrame(parent=self, content_widget=plot2)
-
-        # Add to layout
-        layout.addWidget(dark_button)
-        layout.addWidget(rounded_plot1)
-        layout.addWidget(rounded_plot2)
-
-        self.setLayout(layout)
-
-        from qtpy.QtCore import QTimer
-
-        def change_theme():
-            rounded_plot1.apply_theme("light")
-            rounded_plot2.apply_theme("dark")
-
-        QTimer.singleShot(100, change_theme)
-
-
-if __name__ == "__main__":  # pragma: no cover
-    app = QApplication([])
-
-    window = ExampleApp()
-    window.show()
-
-    app.exec()

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/rpc_server.py

@@ -1,277 +0,0 @@
-from __future__ import annotations
-
-import functools
-import traceback
-import types
-from contextlib import contextmanager
-from typing import TYPE_CHECKING, Callable, TypeVar
-
-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 lazy_import
-from qtpy.QtCore import QTimer
-from qtpy.QtWidgets import QApplication
-from redis.exceptions import RedisError
-
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
-from bec_widgets.utils import BECDispatcher
-from bec_widgets.utils.bec_connector import BECConnector
-from bec_widgets.utils.error_popups import ErrorPopupUtility
-from bec_widgets.widgets.containers.main_window.main_window import BECMainWindow
-
-if TYPE_CHECKING:  # pragma: no cover
-    from bec_lib import messages
-    from qtpy.QtCore import QObject
-else:
-    messages = lazy_import("bec_lib.messages")
-logger = bec_logger.logger
-
-
-T = TypeVar("T")
-
-
-@contextmanager
-def rpc_exception_hook(err_func):
-    """This context replaces the popup message box for error display with a specific hook"""
-    # get error popup utility singleton
-    popup = ErrorPopupUtility()
-    # save current setting
-    old_exception_hook = popup.custom_exception_hook
-
-    # install err_func, if it is a callable
-    # IMPORTANT, Keep self here, because this method is overwriting the custom_exception_hook
-    # of the ErrorPopupUtility (popup instance) class.
-    def custom_exception_hook(self, exc_type, value, tb, **kwargs):
-        err_func({"error": popup.get_error_message(exc_type, value, tb)})
-
-    popup.custom_exception_hook = types.MethodType(custom_exception_hook, popup)
-
-    try:
-        yield popup
-    finally:
-        # restore state of error popup utility singleton
-        popup.custom_exception_hook = old_exception_hook
-
-
-class RPCServer:
-
-    client: BECClient
-
-    def __init__(
-        self,
-        gui_id: str,
-        dispatcher: BECDispatcher | None = None,
-        client: BECClient | None = None,
-        config=None,
-        gui_class_id: str = "bec",
-    ) -> 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
-        # register broadcast callback
-        self.rpc_register = RPCRegister()
-        self.rpc_register.add_callback(self.broadcast_registry_update)
-
-        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._registry_update_callbacks = []
-        self._broadcasted_data = {}
-
-        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")
-        if request_id is None:
-            logger.error("Received RPC instruction without request_id")
-            return
-        logger.debug(f"Received RPC instruction: {msg}, metadata: {metadata}")
-        with rpc_exception_hook(functools.partial(self.send_response, request_id, False)):
-            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:
-                content = traceback.format_exc()
-                logger.error(f"Error while executing RPC instruction: {content}")
-                self.send_response(request_id, False, {"error": content})
-            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):
-        # Run with rpc registry broadcast, but only once
-        with RPCRegister.delayed_broadcast():
-            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: T) -> None | dict | T:
-        """
-        Serialize all BECConnector objects.
-
-        Args:
-            obj: The object to be serialized.
-
-        Returns:
-            None | dict | T: The serialized object or None if the object is not a BECConnector.
-        """
-        if not isinstance(obj, BECConnector):
-            return obj
-        # Respect RPC = False
-        if getattr(obj, "RPC", True) is False:
-            return None
-        return self._serialize_bec_connector(obj, wait=True)
-
-    def emit_heartbeat(self) -> None:
-        """
-        Emit a heartbeat message to the GUI server.
-        This method is called periodically to indicate that the server is still running.
-        """
-        logger.trace(f"Emitting heartbeat for {self.gui_id}")
-        try:
-            self.client.connector.set(
-                MessageEndpoints.gui_heartbeat(self.gui_id),
-                messages.StatusMessage(name=self.gui_id, status=self.status, info={}),
-                expire=10,
-            )
-        except RedisError as exc:
-            logger.error(f"Error while emitting heartbeat: {exc}")
-
-    def broadcast_registry_update(self, connections: dict) -> None:
-        """
-        Broadcast the registry update to all the callbacks.
-        This method is called whenever the registry is updated.
-        """
-        data = {}
-        for key, val in connections.items():
-            if not isinstance(val, BECConnector):
-                continue
-            if not getattr(val, "RPC", True):
-                continue
-            data[key] = self._serialize_bec_connector(val)
-        if self._broadcasted_data == data:
-            return
-        self._broadcasted_data = data
-
-        logger.debug(f"Broadcasting registry update: {data} for {self.gui_id}")
-        self.client.connector.xadd(
-            MessageEndpoints.gui_registry_state(self.gui_id),
-            msg_dict={"data": messages.GUIRegistryStateMessage(state=data)},
-            max_size=1,
-        )
-
-    def _serialize_bec_connector(self, connector: BECConnector, wait=False) -> dict:
-        """
-        Create the serialization dict for a single BECConnector.
-
-        Args:
-            connector (BECConnector): The BECConnector to serialize.
-            wait (bool): If True, wait until the object is registered in the RPC register.
-
-        Returns:
-            dict: The serialized BECConnector object.
-        """
-
-        config_dict = connector.config.model_dump()
-        config_dict["parent_id"] = getattr(connector, "parent_id", None)
-
-        try:
-            parent = connector.parent()
-            if isinstance(parent, BECMainWindow):
-                container_proxy = parent.gui_id
-            else:
-                container_proxy = None
-        except Exception:
-            container_proxy = None
-
-        if wait:
-            while not self.rpc_register.object_is_registered(connector):
-                QApplication.processEvents()
-
-        widget_class = getattr(connector, "rpc_widget_class", None)
-        if not widget_class:
-            widget_class = connector.__class__.__name__
-
-        return {
-            "gui_id": connector.gui_id,
-            "object_name": connector.object_name or connector.__class__.__name__,
-            "widget_class": widget_class,
-            "config": config_dict,
-            "container_proxy": container_proxy,
-            "__rpc__": True,
-        }
-
-    @staticmethod
-    def _get_becwidget_ancestor(widget: QObject) -> BECConnector | None:
-        """
-        Traverse up the parent chain to find the nearest BECConnector.
-        Returns None if none is found.
-        """
-
-        parent = widget.parent()
-        while parent is not None:
-            if isinstance(parent, BECConnector):
-                return parent
-            parent = parent.parent()
-        return None
-
-    # Suppose clients register callbacks to receive updates
-    def add_registry_update_callback(self, cb: Callable) -> None:
-        """
-        Add a callback to be called whenever the registry is updated.
-        The specified callback is called whenever the registry is updated.
-
-        Args:
-            cb (Callable): The callback to be added. It should accept a dictionary of all the
-            registered RPC objects as an argument.
-        """
-        self._registry_update_callbacks.append(cb)
-
-    def shutdown(self):  # TODO not sure if needed when cleanup is done at level of BECConnector
-        self.status = messages.BECStatus.IDLE
-        self._heartbeat_timer.stop()
-        self.emit_heartbeat()
-        logger.info("Succeded in shutting down CLI server")
-        self.client.shutdown()