lightfall-utils 0.1.0__tar.gz

lightfall_utils-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,66 @@
+# Release pipeline, triggered by v* tags:
+#   build-dist / publish-pypi: sdist + wheel to PyPI via OIDC trusted
+#   publishing (environment: pypi; publisher registered on pypi.org against
+#   this workflow file). Mirrors lightfall's release.yml minus app packaging.
+
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # hatch-vcs derives the version from git tags
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install build twine
+          python -m build
+          python -m twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-pypi
+          path: dist/
+          if-no-files-found: error
+          retention-days: 7
+
+  publish-pypi:
+    needs: build-dist
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # OIDC trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-pypi
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    needs: build-dist
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-pypi
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          name: lightfall-utils ${{ github.ref_name }}
+          generate_release_notes: true
+          files: dist/**

lightfall_utils-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.pyc
+dist/
+build/
+.pytest_cache/
+.coverage
+src/lightfall_utils/_version.py
+.ruff_cache/

lightfall_utils-0.1.0/LEGAL.md

@@ -0,0 +1,13 @@
+Lightfall Copyright (c) 2026,
+The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
+
+If you have questions about your rights to use or distribute this software,
+please contact Berkeley Lab's Intellectual Property Office at
+IPO@lbl.gov.
+
+NOTICE.  This Software was developed under funding from the U.S. Department
+of Energy and the U.S. Government consequently retains certain rights.  As
+such, the U.S. Government has been granted for itself and others acting on
+its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
+Software to reproduce, distribute copies to the public, prepare derivative 
+works, and perform publicly and display publicly, and to permit others to do so.

lightfall_utils-0.1.0/LICENSE.md

@@ -0,0 +1,33 @@
+Lightfall Copyright (c) 2026,
+The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). 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 University of California, Lawrence Berkeley
+National Laboratory, U.S. Dept. of Energy 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 OWNER 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.
+
+You are under no obligation whatsoever to provide any bug fixes, patches,
+or upgrades to the features, functionality or performance of the source
+code ("Enhancements") to anyone; however, if you choose to make your
+Enhancements available either publicly, or directly to Lawrence Berkeley
+National Laboratory, without imposing a separate written license agreement
+for such Enhancements, then you hereby grant the following license: a
+non-exclusive, royalty-free perpetual license to install, use, modify,
+prepare derivative works, incorporate into other computer software,
+distribute, and sublicense such enhancements or derivative works thereof,
+in binary and source code form.

lightfall_utils-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.5
+Name: lightfall-utils
+Version: 0.1.0
+Summary: Shared Qt/EPICS infrastructure for ALS control applications: managed threading, loguru logging, semantic theming, layered config, and a caproto/Qt bridge
+Author: ALS Controls Team
+License-Expression: BSD-3-Clause
+License-File: LEGAL.md
+License-File: LICENSE.md
+Requires-Python: >=3.11
+Requires-Dist: loguru>=0.7
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyside6>=6.6
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: ca
+Requires-Dist: caproto>=1.1; extra == 'ca'
+Provides-Extra: dev
+Requires-Dist: caproto>=1.1; extra == 'dev'
+Requires-Dist: pyright>=1.1; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-qt>=4.2; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0; extra == 'docs'
+Requires-Dist: sphinx-immaterial>=0.12; extra == 'docs'
+Requires-Dist: sphinx<9.0,>=7.0; extra == 'docs'
+Provides-Extra: multihomed
+Requires-Dist: netifaces>=0.11; (sys_platform != 'darwin') and extra == 'multihomed'
+Description-Content-Type: text/markdown
+
+# lightfall-utils
+
+Shared Qt/EPICS infrastructure for ALS control applications (Lightfall, CAtfish).
+
+Extracted from [Lightfall](https://github.com/als-controls/lightfall). Modules:
+
+- `lightfall_utils.threads` — managed Qt thread pool, `QThreadFuture`, main-thread marshalling
+- `lightfall_utils.logging` / `log_buffer` — loguru configuration, timing, in-process log ring buffer
+- `lightfall_utils.qt_affinity` — GUI-thread assertion helpers (`gui_thread_only`)
+- `lightfall_utils.config` — priority-layered YAML config with pydantic validation
+- `lightfall_utils.theming` — semantic design tokens, theme registry/manager, QSS generation
+- `lightfall_utils.ca` — caproto → Qt signal bridge (`SharedContext`, `PV`); requires the `ca` extra
+- `lightfall_utils.caproto_shutdown` — drains caproto's user-callback thread pools cleanly at application shutdown
+
+Install: `pip install lightfall-utils[ca]`. Add the `multihomed` extra alongside `ca` for caproto multi-homed interface enumeration (`pip install lightfall-utils[ca,multihomed]`).
+
+Development:
+
+```bash
+python -m venv .venv
+.venv\Scripts\activate    # Windows (source .venv/bin/activate on Unix)
+pip install -e ".[dev]"
+pytest
+```

lightfall_utils-0.1.0/README.md

@@ -0,0 +1,24 @@
+# lightfall-utils
+
+Shared Qt/EPICS infrastructure for ALS control applications (Lightfall, CAtfish).
+
+Extracted from [Lightfall](https://github.com/als-controls/lightfall). Modules:
+
+- `lightfall_utils.threads` — managed Qt thread pool, `QThreadFuture`, main-thread marshalling
+- `lightfall_utils.logging` / `log_buffer` — loguru configuration, timing, in-process log ring buffer
+- `lightfall_utils.qt_affinity` — GUI-thread assertion helpers (`gui_thread_only`)
+- `lightfall_utils.config` — priority-layered YAML config with pydantic validation
+- `lightfall_utils.theming` — semantic design tokens, theme registry/manager, QSS generation
+- `lightfall_utils.ca` — caproto → Qt signal bridge (`SharedContext`, `PV`); requires the `ca` extra
+- `lightfall_utils.caproto_shutdown` — drains caproto's user-callback thread pools cleanly at application shutdown
+
+Install: `pip install lightfall-utils[ca]`. Add the `multihomed` extra alongside `ca` for caproto multi-homed interface enumeration (`pip install lightfall-utils[ca,multihomed]`).
+
+Development:
+
+```bash
+python -m venv .venv
+.venv\Scripts\activate    # Windows (source .venv/bin/activate on Unix)
+pip install -e ".[dev]"
+pytest
+```

lightfall_utils-0.1.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lightfall-utils"
+description = "Shared Qt/EPICS infrastructure for ALS control applications: managed threading, loguru logging, semantic theming, layered config, and a caproto/Qt bridge"
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE.md", "LEGAL.md"]
+requires-python = ">=3.11"
+authors = [{ name = "ALS Controls Team" }]
+dynamic = ["version"]
+dependencies = [
+    "PySide6>=6.6",
+    "loguru>=0.7",
+    "pydantic>=2.0",
+    "pyyaml>=6.0",
+]
+
+[project.optional-dependencies]
+ca = ["caproto>=1.1"]
+# netifaces (abandoned upstream, sdist-only) enables caproto multi-homed interface enumeration; caproto degrades gracefully without it
+multihomed = ["netifaces>=0.11; sys_platform != 'darwin'"]
+dev = [
+    "caproto>=1.1",
+    "pytest>=8.0",
+    "pytest-cov>=4.0",
+    "pytest-qt>=4.2",
+    "ruff>=0.1",
+    "pyright>=1.1",
+]
+docs = [
+    "sphinx>=7.0,<9.0",
+    "myst-parser>=2.0",
+    "sphinx-immaterial>=0.12",
+]
+
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.0.0.dev0"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/lightfall_utils/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lightfall_utils"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP"]
+ignore = ["E501"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["lightfall_utils"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra -q"
+qt_api = "pyside6"
+
+[tool.pyright]
+include = ["src"]
+pythonVersion = "3.11"

lightfall_utils-0.1.0/src/lightfall_utils/__init__.py

@@ -0,0 +1,3 @@
+"""Shared Qt/EPICS infrastructure for ALS control applications."""
+
+from lightfall_utils._version import __version__  # noqa: F401

lightfall_utils-0.1.0/src/lightfall_utils/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None

lightfall_utils-0.1.0/src/lightfall_utils/ca/__init__.py

@@ -0,0 +1,9 @@
+"""Channel Access via caproto, bridged to Qt signals.
+
+Requires the ``ca`` extra: ``pip install lightfall-utils[ca]``.
+"""
+
+from lightfall_utils.ca.context import SharedContext
+from lightfall_utils.ca.pv import PV
+
+__all__ = ["SharedContext", "PV"]

lightfall_utils-0.1.0/src/lightfall_utils/ca/context.py

@@ -0,0 +1,100 @@
+"""
+Shared CA context management for the application.
+
+Provides a singleton-like shared context that widgets can use to connect to PVs.
+"""
+
+from __future__ import annotations
+
+import threading
+from typing import TYPE_CHECKING
+
+from caproto.threading.client import Context
+
+if TYPE_CHECKING:
+    from caproto.threading.client import PV as CaprotoPV
+
+
+class SharedContext:
+    """
+    Manages a shared caproto threading context for all widgets.
+
+    This class provides a singleton pattern for the CA context to avoid
+    creating multiple contexts and to share connections efficiently.
+
+    Attributes:
+        context: The underlying caproto threading Context instance.
+
+    Example:
+        >>> ctx = SharedContext.get_instance()
+        >>> pv = ctx.get_pv("MY:PV:NAME")
+    """
+
+    _instance: SharedContext | None = None
+    _lock = threading.Lock()
+
+    def __init__(self) -> None:
+        self._context: Context | None = None
+        self._pvs: dict[str, CaprotoPV] = {}
+
+    @classmethod
+    def get_instance(cls) -> SharedContext:
+        """
+        Get the singleton SharedContext instance.
+
+        Returns:
+            The shared context instance.
+        """
+        if cls._instance is None:
+            with cls._lock:
+                if cls._instance is None:
+                    cls._instance = cls()
+        return cls._instance
+
+    @property
+    def context(self) -> Context:
+        """
+        Get the underlying caproto Context, creating it if necessary.
+
+        Returns:
+            The caproto threading Context.
+        """
+        if self._context is None:
+            self._context = Context()
+        return self._context
+
+    def get_pv(self, pv_name: str) -> CaprotoPV:
+        """
+        Get or create a PV connection.
+
+        Args:
+            pv_name: The name of the PV to connect to.
+
+        Returns:
+            The caproto PV object.
+        """
+        if pv_name not in self._pvs:
+            (pv,) = self.context.get_pvs(pv_name)
+            self._pvs[pv_name] = pv
+        return self._pvs[pv_name]
+
+    def clear(self) -> None:
+        """
+        Clear all cached PVs and reset the context.
+
+        Useful for testing or when reconfiguring the connection.
+        """
+        self._pvs.clear()
+        self._context = None
+
+    @classmethod
+    def reset(cls) -> None:
+        """
+        Reset the singleton instance entirely.
+
+        Primarily used for testing to ensure a clean state.
+        """
+        with cls._lock:
+            if cls._instance is not None:
+                cls._instance.clear()
+            cls._instance = None