bec-testing-plugin 0.3.0__tar.gz → 0.3.2__tar.gz

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/.copier-answers.yml

@@ -2,7 +2,7 @@
 # It is needed to track the repo template version, and editing may break things.
 # This file will be overwritten by copier on template updates.
 
-_commit: v1.2.2
+_commit: v1.4.0
 _src_path: https://github.com/bec-project/plugin_copier_template.git
 make_commit: true
 project_name: bec_testing_plugin

bec_testing_plugin-0.3.2/.gitea/workflows/create_update_pr.yml

@@ -0,0 +1,70 @@
+name: Create template upgrade PR for bec_testing_plugin
+on:
+  workflow_dispatch:
+
+permissions:
+  pull-requests: write
+
+jobs:
+  create_update_branch_and_pr:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Create virtualenv
+	    run: |
+	      python -m virtualenv .venv
+
+      - name: Install tools
+        run: |
+          source .venv/bin/activate
+          pip install copier PySide6 bec_lib
+
+      - name: Perform update
+        run: |
+          source .venv/bin/activate
+          git config --global user.email "bec_ci_staging@psi.ch"
+          git config --global user.name "BEC automated CI"
+
+          branch="chore/update-template-$(python -m uuid)"
+          echo "switching to branch $branch"
+          git checkout -b $branch
+
+          echo "Running copier update..."
+          copier update --trust --defaults --conflict inline 2>&1 | tee copier.log
+          status=${PIPESTATUS[0]}
+          output="$(cat copier.log)"
+          echo $output
+          msg="$(printf '%s\n' "$output" | head -n 1)"
+
+          if ! grep -q "make_commit: true" .copier-answers.yml ; then
+            echo "Autocommit not made, committing..."
+            git add -A
+            git commit -a -m "$msg"
+          fi
+
+          if diff-index --quiet HEAD ; then
+            echo "No changes detected"
+            exit 0
+          fi
+
+          git push -u origin $branch
+          curl -X POST "https://gitea.psi.ch/api/v1/repos/${{ gitea.repository }}/pulls" \
+            -H "Authorization: token ${{ secrets.CI_REPO_WRITE }}" \
+            -H "Content-Type: application/json" \
+            -d "{
+                  \"title\": \"Template: $(echo $msg)\",
+                  \"body\": \"This PR was created by Gitea Actions\",
+                  \"head\": \"$(echo $branch)\",
+                  \"base\": \"main\"
+                }"

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/.github/workflows/ci.yml

@@ -90,8 +90,13 @@ jobs:
           uv pip install --system -e ./bec/bec_ipython_client
           uv pip install --system -e ./bec/bec_server[dev]
           uv pip install --system -e ./bec_widgets[dev]
-          uv pip install --system -e ./bec_testing_plugin
+          uv pip install --system -e "./bec_testing_plugin[dev]"
 
       - name: Run Pytest with Coverage
         id: coverage
-        run: pytest --random-order --cov=./bec_testing_plugin --cov-config=./bec_testing_plugin/pyproject.toml --cov-branch --cov-report=xml --no-cov-on-fail ./bec_testing_plugin/tests/ || test $? -eq 5
+        run: |
+          if coverage run --rcfile=./bec_testing_plugin/pyproject.toml --branch --source=./bec_testing_plugin -m pytest --random-order ./bec_testing_plugin/tests/; then
+            coverage xml --rcfile=./bec_testing_plugin/pyproject.toml
+          else
+            test $? -eq 5
+          fi

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/CHANGELOG.md

@@ -1,6 +1,25 @@
 # CHANGELOG
 
 
+## v0.3.2 (2026-09-27)
+
+### Bug Fixes
+
+- Migrate plugin scans to v4
+  ([`f3c8bac`](https://github.com/bec-project/bec_testing_plugin/commit/f3c8bac246f54987e2e5dedd5030159ff36ff53a))
+
+- Use coverage instead of pytest-cov
+  ([`c0279ee`](https://github.com/bec-project/bec_testing_plugin/commit/c0279eee3539eb4af32e42675da0e78f45a394fc))
+
+
+## v0.3.1 (2026-04-21)
+
+### Bug Fixes
+
+- Update bw client to provide import modules
+  ([`2dfb145`](https://github.com/bec-project/bec_testing_plugin/commit/2dfb145791f4b42b72179c89f09b96a9c2b4c07f))
+
+
 ## v0.3.0 (2025-12-19)
 
 ### Features

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: bec_testing_plugin
-Version: 0.3.0
+Version: 0.3.2
 Summary: A plugin repository for BEC
 License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Provides-Extra: dev
 Requires-Dist: bec-server; extra == 'dev'
 Requires-Dist: black; extra == 'dev'

bec_testing_plugin-0.3.2/bec_testing_plugin/bec_widgets/widgets/client.py

@@ -0,0 +1,61 @@
+# This file was automatically generated by generate_cli.py
+# type: ignore
+
+from __future__ import annotations
+
+from bec_lib.logger import bec_logger
+
+from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call, rpc_timeout
+
+logger = bec_logger.logger
+
+# pylint: skip-file
+
+
+_Widgets = {}
+
+
+class Examplewidgetplugin(RPCBase):
+    _IMPORT_MODULE = (
+        "bec_testing_plugin.bec_widgets.widgets.ExampleWidgetPlugin.ExampleWidgetPlugin"
+    )
+
+    @rpc_call
+    def remove(self):
+        """
+        Cleanup the BECConnector
+        """
+
+    @rpc_call
+    def attach(self):
+        """
+        None
+        """
+
+    @rpc_call
+    def detach(self):
+        """
+        Detach the widget from its parent dock widget (if widget is in the dock), making it a floating widget.
+        """
+
+
+class Nouiwidgetplugin(RPCBase):
+    _IMPORT_MODULE = "bec_testing_plugin.bec_widgets.widgets.NoUiWidgetPlugin.NoUiWidgetPlugin"
+
+    @rpc_call
+    def remove(self):
+        """
+        Cleanup the BECConnector
+        """
+
+    @rpc_call
+    def attach(self):
+        """
+        None
+        """
+
+    @rpc_call
+    def detach(self):
+        """
+        Detach the widget from its parent dock widget (if widget is in the dock), making it a floating widget.
+        """

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/bec_testing_plugin/scans/custom_scan.py

@@ -1,4 +1,4 @@
-from bec_server.scan_server.scans import LineScan
+from bec_server.scan_server.scans.line_scan import LineScan
 
 
 class CustomTestingScan(LineScan):

bec_testing_plugin-0.3.2/bec_testing_plugin/scans/device_progress_scan.py

@@ -0,0 +1,37 @@
+from bec_server.scan_server.scans import position_generators
+from bec_server.scan_server.scans.grid_scan import GridScan, scan_hook
+
+
+class DeviceProgressScan(GridScan):
+    """A scan that simulates device progress updates."""
+
+    scan_name = "device_progress_grid_scan"
+
+    @scan_hook
+    def prepare_scan(self):
+        """
+        Prepare the scan. This can include any steps that need to be executed
+        before the scan is opened, such as preparing the positions (if not done already)
+        or setting up the devices.
+        """
+        self.positions = position_generators.nd_grid_positions(
+            self.motor_input_bundles.values(), snaked=self.snaked
+        )
+
+        if self.relative:
+            self.start_positions = self.components.get_start_positions(self.motors)
+            self.positions += self.start_positions
+
+        self.components.check_limits(self.motors, self.positions)
+
+        self.update_scan_info(
+            positions=self.positions,
+            num_points=len(self.positions),
+            num_monitored_readouts=len(self.positions) * self.burst_at_each_point,
+        )
+
+        self.actions.add_scan_report_instruction_device_progress(device="waveform")
+
+        self._baseline_readout_status = self.actions.read_baseline_devices(wait=False)
+
+        self._premove_motor_status = self.actions.set(self.motors, self.positions[0], wait=False)

bec_testing_plugin-0.3.2/bec_testing_plugin/scans/scan_customization/scan_components.py

@@ -0,0 +1,12 @@
+"""
+Scan components for bec_testing_plugin.
+
+The scan components module allows you to define custom components that can be used in your scans.
+These components can be used to encapsulate reusable logic, interact with devices, or perform specific actions during the scan lifecycle.
+"""
+
+from bec_server.scan_server.scans.scan_components import ScanComponents
+
+
+class BecTestingPluginScanComponents(ScanComponents):
+    """Scan components for bec_testing_plugin."""

bec_testing_plugin-0.3.2/bec_testing_plugin/scans/scan_customization/scan_modifier.py

@@ -0,0 +1,31 @@
+"""
+Scan modifier plugin for bec_testing_plugin.
+
+The scan modifier allows you to modify the scan lifecycle and run custom actions before or after the scan hook or replace the scan hook entirely.
+Note that the scan_modifier module must be registered as a plugin in the pyproject.toml file for it to be recognized by the BEC framework and that
+there can only be one scan_modifier plugin registered at a time. If you need to run multiple scan modifiers, you can create a single scan
+modifier plugin that runs multiple actions in sequence with conditional logic to determine which actions to run based on the scan context.
+"""
+
+from bec_server.scan_server.scans.scan_modifier import ScanModifier, scan_hook_impl
+
+
+class BecTestingPluginScanModifier(ScanModifier):
+    """
+    Scan modifier for bec_testing_plugin.
+
+    By inheriting from the ScanModifier base class, you get access to currently running scan (self.scan), the devices (self.dev), the scan info (self.scan_info),
+    the scan components (self.components) and the scan actions (self.actions).
+    """
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the scan modifier."""
+        super().__init__(*args, **kwargs)
+
+    # Example of running code before the scan stage for a specific scan
+    # @scan_hook_impl("stage", "before")
+    # def before_stage(self):
+    #     """Run before the stage hook."""
+    #     self.actions.send_client_info("Custom stage logic executed by ScanModifier.")
+    #     if self.scan_info.scan_name == "example_scan":
+    #         self.dev.samx.set(20)

{bec_testing_plugin-0.3.0 → bec_testing_plugin-0.3.2}/pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_testing_plugin"
-version = "0.3.0"
+version = "0.3.2"
 description = "A plugin repository for BEC"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",
@@ -39,6 +39,9 @@ plugin_file_writer = "bec_testing_plugin.file_writer"
 [project.entry-points."bec.scans"]
 plugin_scans = "bec_testing_plugin.scans"
 
+[project.entry-points."bec.scans.scan_modifier"]
+plugin_scan_modifier = "bec_testing_plugin.scans.scan_customization.scan_modifier"
+
 [project.entry-points."bec.scans.metadata_schema"]
 plugin_metadata_schema = "bec_testing_plugin.scans.metadata_schema"
 

bec_testing_plugin-0.3.0/.gitlab-ci.yml

@@ -1,7 +0,0 @@
-include:
-- file: /templates/plugin-repo-template.yml
-  inputs:
-    name: bec_testing_plugin
-    target: bec_testing_plugin
-    branch: $CHILD_PIPELINE_BRANCH
-  project: bec/awi_utils

bec_testing_plugin-0.3.0/bec_testing_plugin/bec_widgets/widgets/client.py

@@ -1,31 +0,0 @@
-# This file was automatically generated by generate_cli.py
-# type: ignore
-
-from __future__ import annotations
-
-from bec_lib.logger import bec_logger
-
-from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
-
-logger = bec_logger.logger
-
-# pylint: skip-file
-
-
-_Widgets = {}
-
-
-class Examplewidgetplugin(RPCBase):
-    @rpc_call
-    def remove(self):
-        """
-        Cleanup the BECConnector
-        """
-
-
-class Nouiwidgetplugin(RPCBase):
-    @rpc_call
-    def remove(self):
-        """
-        Cleanup the BECConnector
-        """

bec_testing_plugin-0.3.0/bec_testing_plugin/scans/device_progress_scan.py

@@ -1,10 +0,0 @@
-from bec_server.scan_server.scans import Scan
-
-
-class DeviceProgressScan(Scan):
-    """A scan that simulates device progress updates."""
-
-    scan_name = "device_progress_grid_scan"
-
-    def scan_report_instructions(self):
-        yield from self.stubs.scan_report_instruction({"device_progress": ["waveform"]})