pymodaq_plugins_owis 5.3.0__tar.gz

pymodaq_plugins_owis-5.3.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

pymodaq_plugins_owis-5.3.0/.github/dependabot.yml

@@ -0,0 +1,7 @@
+# Template repository only: keeps the pinned versions of the GitHub actions up to date (as pull requests).
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly

pymodaq_plugins_owis-5.3.0/.github/scripts/check_template_versions.py

@@ -0,0 +1,112 @@
+"""Warn when the versions written in the template have drifted from PyMoDAQ's.
+
+Run weekly by .github/workflows/check-versions.yml (only in the template repository, not in plugins).
+Single source of truth: the ``pymodaq>=X.Y.Z`` floor of pyproject.toml. Everything else is compared to it and to what
+PyPI says about the latest pymodaq. Standard library only. Exit code 1 if something needs a human.
+
+When a new PyMoDAQ minor (say 5.4.0) is released
+------------------------------------------------
+1. Create the ``5.4.x`` branch from ``5.3.x`` and make it the default branch of the template repository.
+2. On it, raise the floors in pyproject.toml (``pymodaq>=5.4.0``...), the "PyMoDAQ 5.3.x" wording in README.rst and
+   AGENTS.md, requires-python and the matrix of reusable-compatibility.yml if they changed.
+3. Point the three caller workflows (``@5.3.x`` in tests.yml, compatibility.yml, python-publish.yml) to ``@5.4.x``.
+4. Run this script: it must print OK. Keep ``5.3.x`` for hotfixes.
+"""
+import json
+import re
+import sys
+import tomllib
+import urllib.request
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[2]
+PYPI = 'https://pypi.org/pypi/{}/json'
+
+
+def pypi_info(name: str) -> dict:
+    with urllib.request.urlopen(PYPI.format(name), timeout=30) as response:
+        return json.load(response)
+
+
+def minor(version: str) -> tuple:
+    return tuple(int(p) for p in version.split('.')[:2])
+
+
+def is_release(version: str) -> bool:
+    return re.fullmatch(r'\d+\.\d+\.\d+', version) is not None
+
+
+def python_minors(classifiers: list) -> list:
+    found = [re.fullmatch(r'Programming Language :: Python :: 3\.(\d+)', c) for c in classifiers]
+    return sorted(int(m.group(1)) for m in found if m)
+
+
+def main() -> int:
+    problems = []
+    project = tomllib.loads((ROOT / 'pyproject.toml').read_text())['project']
+
+    floors = {}
+    for dep in project['dependencies']:
+        match = re.match(r'(pymodaq(?:_utils|_gui|_data)?)>=(\d+\.\d+\.\d+)', dep)
+        if match:
+            floors[match.group(1)] = match.group(2)
+    if 'pymodaq' not in floors:
+        problems.append('pyproject.toml has no "pymodaq>=X.Y.Z" dependency: nothing to compare to')
+        return report(problems)
+    branch_minor = minor(floors['pymodaq'])
+    branch = '{}.{}'.format(*branch_minor)
+
+    # 1. the floors of the PyMoDAQ packages exist and belong to the branch's minor
+    for name, floor in floors.items():
+        releases = [v for v in pypi_info(name)['releases'] if is_release(v)]
+        if floor not in releases:
+            problems.append(f'{name}>={floor} was never released on PyPI')
+        elif name == 'pymodaq' and minor(floor) != branch_minor:
+            problems.append(f'{name} floor {floor} is not in {branch}')
+        elif minor(floor) > branch_minor:
+            problems.append(f'{name}>={floor} is newer than the branch ({branch}.x)')
+
+    # 2. a new PyMoDAQ minor means a new template branch
+    latest = pypi_info('pymodaq')
+    versions = sorted((v for v in latest['releases'] if is_release(v)), key=lambda v: tuple(map(int, v.split('.'))))
+    newest = versions[-1]
+    if minor(newest) > branch_minor:
+        problems.append(f'PyMoDAQ {newest} is out but this template targets {branch}.x: create the {"{}.{}".format(*minor(newest))}.x '
+                        f'branch (checklist in the docstring of .github/scripts/check_template_versions.py)')
+
+    # 3. supported Python versions: ours vs the latest pymodaq of the branch's minor
+    same_minor = [v for v in versions if minor(v) == branch_minor][-1]
+    with urllib.request.urlopen(f'https://pypi.org/pypi/pymodaq/{same_minor}/json', timeout=30) as response:
+        data = json.load(response)['info']
+    # the Python classifiers of a plugin are computed from requires-python when it is built (dynamic classifiers)
+    ours = theirs = python_minors(data['classifiers'])
+    requires = data.get('requires_python') or ''
+    if requires and requires != project.get('requires-python'):
+        problems.append(f'requires-python is {project.get("requires-python")!r}, pymodaq {same_minor} has {requires!r}')
+
+    # 4. the compatibility matrix covers both Python extremes
+    matrix = (ROOT / '.github/workflows/reusable-compatibility.yml').read_text()
+    used = sorted({int(m) for m in re.findall(r"python-version: '3\.(\d+)'", matrix)})
+    if ours and used and (used[0], used[-1]) != (ours[0], ours[-1]):
+        problems.append(f'compatibility matrix spans Python 3.{used[0]}-3.{used[-1]}, supported is 3.{ours[0]}-3.{ours[-1]}')
+
+    # 5. prose that names the branch
+    for name in ('README.rst', 'AGENTS.md'):
+        for number, line in enumerate((ROOT / name).read_text().splitlines(), 1):
+            for found in re.findall(r'PyMoDAQ\s+(\d+\.\d+)\.x', line):
+                if found != branch:
+                    problems.append(f'{name}:{number} says PyMoDAQ {found}.x, the branch is {branch}.x')
+    return report(problems, branch)
+
+
+def report(problems: list, branch: str = '?') -> int:
+    if not problems:
+        print(f'OK: template versions are consistent with PyMoDAQ {branch}.x')
+        return 0
+    for problem in problems:
+        print(f'::warning::{problem}')
+    return 1
+
+
+if __name__ == '__main__':
+    sys.exit(main())

pymodaq_plugins_owis-5.3.0/.github/workflows/check-versions.yml

@@ -0,0 +1,30 @@
+# Template repository only: warns (failed run, e-mail to the watchers) when the versions written in the template drift
+# from PyMoDAQ's, for instance after a new PyMoDAQ minor release. Plugins copied from the template skip it.
+name: Check template versions
+
+on:
+  schedule:
+    - cron: '0 6 * * 1'
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - pyproject.toml
+      - README.rst
+      - AGENTS.md
+      - .github/workflows/**
+      - .github/scripts/**
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    if: github.repository == 'PyMoDAQ/pymodaq_plugins_template'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v7.0.1
+      - uses: actions/setup-python@v6.2.0
+        with:
+          python-version: '3.12'
+      - run: python .github/scripts/check_template_versions.py

pymodaq_plugins_owis-5.3.0/.github/workflows/compatibility.yml

@@ -0,0 +1,15 @@
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
+name: Compatibility with pymodaq (latest release)
+
+on:
+  pull_request:
+  push:
+    branches: [main, master, '[0-9]*.x']
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  compatibility:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/reusable-compatibility.yml@5.3.x

pymodaq_plugins_owis-5.3.0/.github/workflows/python-publish.yml

@@ -0,0 +1,11 @@
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/reusable-publish.yml@5.3.x
+    secrets: inherit

pymodaq_plugins_owis-5.3.0/.github/workflows/reusable-compatibility.yml

@@ -0,0 +1,57 @@
+# Shared by all plugins: the plugin tests on the latest PyMoDAQ release over Python versions, Qt backends and OS.
+# Called from the small `compatibility.yml` of a plugin, do not copy this file into a plugin.
+name: Reusable compatibility
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: ${{ matrix.os }} / Python ${{ matrix.python-version }} / ${{ matrix.qt-backend }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      # This matrix is a deliberate subset, not every combination of OS x Python x Qt backend (2 x 4 x 3 = 24 jobs).
+      # It follows the usual practice of testing the extremes instead of the full cross product:
+      #  - the oldest (3.10) and the newest (3.13) supported Python versions, on Linux,
+      #  - each Qt backend at least once (pyqt5, pyqt6, pyside6), PySide6 on both Python extremes,
+      #  - Windows once, with an intermediate Python version (3.12).
+      # Not tested on purpose: Python 3.11 and 3.12 on Linux, Windows with pyqt5 or pyside6, PyQt5 with Python 3.13,
+      # PyQt6 with Python 3.10. The plugin tests are fast, so if a plugin needs more coverage, replace `include` by the
+      # three lists `os`, `python-version` and `qt-backend`: GitHub then builds the 24 combinations.
+      # When a Python version is added or dropped (follow pymodaq), update the extremes here.
+      matrix:
+        include:
+          - {os: ubuntu-latest, python-version: '3.10', qt-backend: pyqt5}
+          - {os: ubuntu-latest, python-version: '3.10', qt-backend: pyside6}
+          - {os: ubuntu-latest, python-version: '3.13', qt-backend: pyqt6}
+          - {os: ubuntu-latest, python-version: '3.13', qt-backend: pyside6}
+          - {os: windows-latest, python-version: '3.12', qt-backend: pyqt6}
+    env:
+      QT_DEBUG_PLUGINS: 1
+    steps:
+      - uses: actions/checkout@v7.0.1
+        with:
+          fetch-depth: 0  # history and tags, needed by hatch-vcs: without them the version is 0.1.dev and e.g. pymodaq_plugins_mock cannot satisfy pymodaq's own requirement
+      - uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install system libraries for Qt
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-cursor0 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils libgl1 libegl1
+          sudo mkdir -p /etc/.pymodaq
+          sudo chmod uo+rw /etc/.pymodaq
+      - name: Install the plugin with the latest PyMoDAQ release
+        # PySide6 6.12.0 aborts (garbage collector) after the tests that open PyMoDAQ's Dashboard, see PyMoDAQ issue #1275
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest pytest-qt pytest-xvfb ${{ matrix.qt-backend == 'pyside6' && 'pyside6!=6.12.0' || matrix.qt-backend }}
+          pip install -e .
+      - name: Tests
+        run: pytest -vv tests

pymodaq_plugins_owis-5.3.0/.github/workflows/reusable-publish.yml

@@ -0,0 +1,41 @@
+# Shared by all plugins: build the package and upload it to PyPI.
+# The repository secrets PYPI_USERNAME (`__token__`) and PYPI_PASSWORD (the PyPI API token) are passed by the caller.
+# Called from the small `python-publish.yml` of a plugin, do not copy this file into a plugin.
+name: Reusable publish
+
+on:
+  workflow_call:
+    secrets:
+      PYPI_USERNAME:
+        required: true
+      PYPI_PASSWORD:
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7.0.1
+        with:
+          fetch-depth: 0  # history and tags, needed by hatch-vcs for the version
+      - uses: actions/setup-python@v6.2.0
+        with:
+          python-version: '3.x'
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch hatchling toml twine
+      - name: Show the version
+        run: hatch version
+      - name: Build
+        run: hatch build
+      - name: Check the build
+        run: twine check dist/*
+      - name: Publish
+        env:
+          HATCH_INDEX_USER: ${{ secrets.PYPI_USERNAME }}
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_PASSWORD }}
+        run: hatch publish

pymodaq_plugins_owis-5.3.0/.github/workflows/reusable-tests.yml

@@ -0,0 +1,50 @@
+# Shared by all plugins: flake8 gate and unit tests on one Python version and one Qt backend.
+# Deliberately a single configuration (Linux, Python 3.11, PySide6 by default): this is the fast gate that gives an
+# answer in about a minute. The spread over OS, Python versions and Qt backends is tested by reusable-compatibility.yml
+# (a subset that skips Python 3.11, which is thus covered here).
+# Called from the small `tests.yml` of a plugin, do not copy this file into a plugin.
+name: Reusable tests
+
+on:
+  workflow_call:
+    inputs:
+      python-version:
+        type: string
+        default: '3.11'
+      qt-backend:
+        type: string
+        default: pyside6
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    env:
+      QT_DEBUG_PLUGINS: 1
+    steps:
+      - uses: actions/checkout@v7.0.1
+        with:
+          fetch-depth: 0  # history and tags, needed by hatch-vcs: without them the version is 0.1.dev and e.g. pymodaq_plugins_mock cannot satisfy pymodaq's own requirement
+      - uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ inputs.python-version }}
+      - name: Install system libraries for Qt
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-cursor0 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils libgl1 libegl1
+          sudo mkdir -p /etc/.pymodaq
+          sudo chmod uo+rw /etc/.pymodaq
+      - name: Install the plugin
+        # PySide6 6.12.0 aborts (garbage collector) after the tests that open PyMoDAQ's Dashboard, see PyMoDAQ issue #1275
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-qt pytest-xvfb ${{ inputs.qt-backend == 'pyside6' && 'pyside6!=6.12.0' || inputs.qt-backend }}
+          pip install -e .
+      - name: Lint (syntax errors and undefined names only)
+        run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+      - name: Tests
+        # no xdist: parallel workers race to create the PyMoDAQ config folder on a fresh runner
+        run: pytest tests

pymodaq_plugins_owis-5.3.0/.github/workflows/tests.yml

@@ -0,0 +1,8 @@
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/reusable-tests.yml@5.3.x

pymodaq_plugins_owis-5.3.0/.gitignore

@@ -0,0 +1,117 @@
+# Compiled python modules.
+*.pyc
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+_version.py
+
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# pycharm
+.idea/
+.idea/*
+
+*yacctab.py
+*lextab.py
+STATUS_AI_DEV.md