lima2.client 4.0.2__tar.gz → 4.0.4__tar.gz

{lima2_client-4.0.2/src/lima2_client.egg-info → lima2_client-4.0.4}/PKG-INFO

@@ -1,20 +1,12 @@
 Metadata-Version: 2.4
 Name: lima2-client
-Version: 4.0.2
+Version: 4.0.4
 Summary: Python client library for Lima2 detector
 Author: BCU (ESRF)
-License: Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Repository, https://gitlab.esrf.fr/limagroup/lima2-client
 Project-URL: Documentation, https://limagroup.gitlab-pages.esrf.fr/lima2-client/
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{lima2_client-4.0.2 → lima2_client-4.0.4}/pyproject.toml

@@ -12,10 +12,10 @@ dynamic = ["version"]
 authors = [{ name = "BCU (ESRF)" }]
 description = "Python client library for Lima2 detector"
 readme = "README.md"
-license = { file = "LICENSE" }
+license = "MIT"
+license-files = ["LICENSE"]
 classifiers = [
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
 ]
 dependencies = [

{lima2_client-4.0.2 → lima2_client-4.0.4}/src/lima2/conductor/acquisition_system.py

@@ -16,6 +16,7 @@ import logging
 import textwrap
 import time
 import traceback
+import weakref
 from typing import Any, Callable, Literal, cast
 from uuid import UUID, uuid1
 
@@ -710,24 +711,32 @@ class AcquisitionSystem:
     def register_receiver_callbacks(self) -> None:
         """Register on_state_change callback on the receiver devices"""
 
+        # NOTE: Using weakref in event handlers is necessary to allow the
+        # garbage collector to destroy the Acquisition object.
+        wself = weakref.ref(self)
+
         async def on_state_change(dev: TangoReceiver, new_state: DeviceState) -> None:
             """Handler for receiver device state changes."""
             logger.info(f"Receiver {dev.name} in new state: {new_state}")
 
+            self_ref = wself()
+            if self_ref is None:
+                return
+
             if new_state == DeviceState.FAULT:
                 payload = await dev.last_error()
 
                 what, info = unpack_exception(payload)
 
                 logger.error(f"⁉️ FAULT state on {dev.name}. Reason: {what} ({info})")
-                await self.update_runstate(event=RunState.ACQ_EXCEPTION)
+                await self_ref.update_runstate(event=RunState.ACQ_EXCEPTION)
 
-            elif new_state == DeviceState.IDLE and self.runstate & RunState.RUNNING:
-                self.finished_receivers.add(dev)
+            elif new_state == DeviceState.IDLE and self_ref.runstate & RunState.RUNNING:
+                self_ref.finished_receivers.add(dev)
 
-                if self.finished_receivers == set(self.receivers):
+                if self_ref.finished_receivers == set(self_ref.receivers):
                     logger.info("✅ All frames received")
-                    await self.update_runstate(event=RunState.ACQ_DONE)
+                    await self_ref.update_runstate(event=RunState.ACQ_DONE)
 
         for receiver in self.receivers:
             receiver.on_state_change(functools.partial(on_state_change, receiver))

{lima2_client-4.0.2 → lima2_client-4.0.4}/src/lima2/conductor/processing/pipeline.py

@@ -16,6 +16,7 @@ import asyncio
 import logging
 import time
 import traceback
+import weakref
 from collections.abc import Callable
 from dataclasses import dataclass
 from typing import Any, AsyncIterator, Awaitable
@@ -243,6 +244,9 @@ class Pipeline:
         self.on_finished_callback = to_async(lambda _: None)
         self.on_error_callback = to_async(lambda _: None)
 
+    def __del__(self) -> None:
+        logger.debug(f"Pipeline instance {self.uuid} destroyed")
+
     async def connect(
         self,
         on_finished: Callable[[list[str]], Awaitable[None]],
@@ -261,6 +265,10 @@ class Pipeline:
         self.on_finished_callback = on_finished
         self.on_error_callback = on_error
 
+        # NOTE: Using weakref in event handlers is necessary to allow the
+        # garbage collector to destroy the Pipeline object.
+        wself = weakref.ref(self)
+
         async def on_device_finished(device_name: str) -> None:
             """Adds a processing device to the finished_devices set.
 
@@ -268,14 +276,19 @@ class Pipeline:
             this pipeline instance (see constructor).
             """
             logger.info(f"Processing device {device_name} is done")
-            self.finished_devices.add(device_name)
 
-            if self.finished_devices == set([dev.name for dev in self.devices]):
+            self_ref = wself()
+            if self_ref is None:
+                return
+
+            self_ref.finished_devices.add(device_name)
+
+            if self_ref.finished_devices == set([dev.name for dev in self_ref.devices]):
                 try:
-                    await self.on_finished_callback(self.errors)
+                    await self_ref.on_finished_callback(self_ref.errors)
                 except Exception:
                     logger.error(
-                        f"Exception raised in pipeline {self.uuid} "
+                        f"Exception raised in pipeline {self_ref.uuid} "
                         "on_finished callback:\n"
                         f"{traceback.format_exc()}"
                     )
@@ -285,7 +298,12 @@ class Pipeline:
             logger.warning(
                 f"Error from processing device {evt.device_name}: {evt.what}."
             )
-            self.errors.append(
+
+            self_ref = wself()
+            if self_ref is None:
+                return
+
+            self_ref.errors.append(
                 format_exception(
                     where=evt.device_name,
                     when="while processing frames",
@@ -295,14 +313,16 @@ class Pipeline:
             )
 
             pipeline_err_evt = PipelineErrorEvent(
-                uuid=self.uuid, error_msg=self.errors[-1], device_name=evt.device_name
+                uuid=self_ref.uuid,
+                error_msg=self_ref.errors[-1],
+                device_name=evt.device_name,
             )
 
             try:
-                await self.on_error_callback(pipeline_err_evt)
+                await self_ref.on_error_callback(pipeline_err_evt)
             except Exception:
                 logger.error(
-                    f"Exception raised in pipeline {self.uuid} "
+                    f"Exception raised in pipeline {self_ref.uuid} "
                     "on_error callback:\n"
                     f"{traceback.format_exc()}"
                 )
@@ -503,6 +523,11 @@ class Pipeline:
     async def close(self) -> None:
         """Wait for the reduced data subtasks to finish."""
 
+        if self.close_event.is_set():
+            logger.warning("Pipeline.close() was already called. Ignoring.")
+            # TODO(mdu) better state handling
+            return
+
         # Signal end to frame index iteration (single, round robin)
         self.close_event.set()
 

{lima2_client-4.0.2 → lima2_client-4.0.4}/src/lima2/conductor/processing/reduced_data.py

@@ -26,12 +26,7 @@ from lima2.conductor.topology import (
     LookupTable,
     ReceiverIdx,
 )
-from lima2.conductor.utils import (
-    Ticker,
-    expand,
-    naturalsize,
-    warn_if_hanging,
-)
+from lima2.conductor.utils import Ticker, expand, naturalsize, warn_if_hanging
 
 logger = logging.getLogger(__name__)
 
@@ -257,6 +252,9 @@ class ReducedDataPipeline:
         self.done_event = asyncio.Event()
         """Event set when the buffer is complete with all fetched chunks."""
 
+    def __del__(self) -> None:
+        logger.debug(f"ReducedDataPipeline instance for {self.name} destroyed")
+
     async def lookup_chunk(
         self, rcv_idx: ReceiverIdx, from_idx: LocalIdx, chunk: npt.NDArray[Any]
     ) -> npt.NDArray[GlobalIdx]:

{lima2_client-4.0.2 → lima2_client-4.0.4/src/lima2_client.egg-info}/PKG-INFO

@@ -1,20 +1,12 @@
 Metadata-Version: 2.4
 Name: lima2-client
-Version: 4.0.2
+Version: 4.0.4
 Summary: Python client library for Lima2 detector
 Author: BCU (ESRF)
-License: Copyright (c) 2020-2024 Beamline Control Unit, ESRF
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Repository, https://gitlab.esrf.fr/limagroup/lima2-client
 Project-URL: Documentation, https://limagroup.gitlab-pages.esrf.fr/lima2-client/
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

lima2_client-4.0.4/src/lima2_client.egg-info/SOURCES.txt

@@ -0,0 +1,57 @@
+LICENSE
+README.md
+pyproject.toml
+src/lima2/client/__init__.py
+src/lima2/client/exceptions.py
+src/lima2/client/py.typed
+src/lima2/client/services.py
+src/lima2/client/session.py
+src/lima2/client/shell.py
+src/lima2/common/__init__.py
+src/lima2/common/exceptions.py
+src/lima2/common/pipelines.py
+src/lima2/common/progress_counter.py
+src/lima2/common/py.typed
+src/lima2/common/state.py
+src/lima2/common/types.py
+src/lima2/common/devencoded/__init__.py
+src/lima2/common/devencoded/dense_frame.py
+src/lima2/common/devencoded/exception.py
+src/lima2/common/devencoded/smx_sparse_frame.py
+src/lima2/common/devencoded/sparse_frame.py
+src/lima2/common/devencoded/structured_array.py
+src/lima2/conductor/__init__.py
+src/lima2/conductor/acquisition_system.py
+src/lima2/conductor/py.typed
+src/lima2/conductor/topology.py
+src/lima2/conductor/utils.py
+src/lima2/conductor/processing/__init__.py
+src/lima2/conductor/processing/failing.py
+src/lima2/conductor/processing/legacy.py
+src/lima2/conductor/processing/master_file.py
+src/lima2/conductor/processing/pipeline.py
+src/lima2/conductor/processing/reduced_data.py
+src/lima2/conductor/processing/smx.py
+src/lima2/conductor/processing/xpcs.py
+src/lima2/conductor/tango/__init__.py
+src/lima2/conductor/tango/control.py
+src/lima2/conductor/tango/processing.py
+src/lima2/conductor/tango/receiver.py
+src/lima2/conductor/tango/utils.py
+src/lima2/conductor/webservice/__init__.py
+src/lima2/conductor/webservice/acquisition.py
+src/lima2/conductor/webservice/benchmark.py
+src/lima2/conductor/webservice/cli.py
+src/lima2/conductor/webservice/detector.py
+src/lima2/conductor/webservice/main.py
+src/lima2/conductor/webservice/pipeline.py
+src/lima2/conductor/webservice/utils.py
+src/lima2/conductor/webservice/webapp.py
+src/lima2/conductor/webservice/benchmark_generators/__init__.py
+src/lima2/conductor/webservice/benchmark_generators/rois.py
+src/lima2_client.egg-info/PKG-INFO
+src/lima2_client.egg-info/SOURCES.txt
+src/lima2_client.egg-info/dependency_links.txt
+src/lima2_client.egg-info/entry_points.txt
+src/lima2_client.egg-info/requires.txt
+src/lima2_client.egg-info/top_level.txt

lima2_client-4.0.2/.gitignore

@@ -1,25 +0,0 @@
-# Byte / compiled / optimized
-*.py[cod]
-__pycache__/
-*.so
-
-# Distribution / packaging
-/dist/
-/build/
-*.egg-info/
-.eggs/
-
-# Unittest / coverage
-*.py,cover
-.coverage.*
-htmlcov/
-.cache/
-.pytest_cache/
-
-# Profiler
-/prof/
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json

lima2_client-4.0.2/.gitlab-ci.yml

@@ -1,142 +0,0 @@
-stages:
-  - style
-  - tests
-  - build
-  - doc
-  - deploy
-
-black-format:
-  stage: style
-  script:
-    - mamba install --yes -c conda-forge black=22.3
-    - LC_ALL=C.UTF-8 black --check .
-  tags:
-    - linux
-
-flake-format:
-  stage: style
-  script:
-    - mamba install --yes -c conda-forge flake8
-    # disable dubious ownership check
-    - git config --global --add safe.directory "*"
-    # choose from where to diff (complete merge request or last commit otherwise)
-    - >
-      if [ $CI_PIPELINE_SOURCE == "merge_request_event" ]; then
-        BASE_SHA="${CI_MERGE_REQUEST_DIFF_BASE_SHA}"
-      else
-        BASE_SHA=$(git rev-parse HEAD^)
-      fi
-    # list Added/Copied/Modified .py files since $BASE_SHA
-    - PY_CHANGES=$(git diff $BASE_SHA --name-only --diff-filter=ACM -- "***.py")
-    # abort if no files
-    - >
-      if [ -z "${PY_CHANGES}" ]; then
-        echo "No changes."
-        exit 0
-      fi
-    - flake8 --config flake8.ini $PY_CHANGES
-    # allow failure without impacting the rest of the CI (will show an orange warning in the UI)
-  allow_failure: true
-  tags:
-    - linux
-
-mypy:
-  stage: style
-  script:
-    - pip install .[dev]
-    - pip install mypy-gitlab-code-quality
-    - mypy --no-error-summary > mypy-out.txt || true
-    - mypy-gitlab-code-quality < mypy-out.txt > codequality.json
-  artifacts:
-    reports:
-      codequality: codequality.json
-  tags:
-    - linux
-    - numpy2.3+
-
-unit-test:
-  stage: tests
-  script:
-    - pip install -e .[dev]
-    - pytest --cov lima2.client --cov lima2.conductor --cov lima2.common --cov-report term --cov-report xml:coverage.xml --junitxml junit-report.xml tests/unit
-  artifacts:
-    paths:
-      - junit-report.xml
-      - coverage.xml
-    reports:
-      junit: junit-report.xml
-      coverage_report:
-        coverage_format: cobertura
-        path: coverage.xml
-  coverage: '/TOTAL.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
-  tags:
-    - linux
-    - numpy2.3+
-
-build-conda:
-  stage: build
-  script:
-    - conda build --output-folder=dist/conda -c esrf-bcu -c conda-forge conda
-  artifacts:
-    paths:
-      - dist/conda/
-  tags:
-    - linux
-
-build-pypi:
-  stage: build
-  script:
-    - mamba install --yes python-build
-    - python -m build --outdir=dist/pypi .
-  artifacts:
-    paths:
-      - dist/pypi/
-  tags:
-    - linux
-
-deploy-conda:
-  stage: deploy
-  environment:
-    name: production/conda
-    url: https://anaconda.org/esrf-bcu/lima2-client
-  dependencies:
-    - build-conda
-  script:
-    - anaconda --token=$ANACONDA_TOKEN upload --user=esrf-bcu dist/conda/**/*.tar.bz2
-  tags:
-    - linux
-  only:
-    - tags
-
-deploy-pypi:
-  stage: deploy
-  environment:
-    name: production/pypi
-    url: https://pypi.org/project/lima2.client/
-  dependencies:
-    - build-pypi
-  script:
-    - pip install twine
-    - pip install -U packaging
-    - twine upload dist/pypi/*
-  tags:
-    - linux
-  only:
-    - tags
-
-pages:
-  stage: doc
-  before_script:
-    - pip install .[docs]
-  script:
-    - mkdocs build
-    - mv site public
-  tags:
-    - linux
-    - numpy2.3+
-  artifacts:
-    paths:
-      - public
-    expire_in: 7 days
-  only:
-    - main

lima2_client-4.0.2/conda/meta.yaml

@@ -1,59 +0,0 @@
-# Strip the 'v' from the version tag
-{% if GIT_DESCRIBE_TAG is defined %}
-{%   set version = GIT_DESCRIBE_TAG[1:] %}
-{% else %}
-{%   set version = "0.0.0" %}
-{% endif %}
-
-package:
-  name: lima2-client
-  version: {{ version }}
-
-source:
-  path: ..
-
-build:
-  number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }}
-  noarch: python
-  script: "{{ PYTHON }} -m pip install . -vv"
-  entry_points:
-    - lima2-conductor = lima2.conductor.webservice.cli:cli
-    - lima2-shell = lima2.client.shell:app
-
-requirements:
-  host:
-    - python>=3.10
-    - setuptools
-  run:
-    - h5py
-    - jsonschema
-    - jsonschema-rs
-    - jsonschema-default
-    - numpy
-    - orjson
-    - pytango
-    - python
-    - pyyaml
-    - requests
-    - starlette
-    - typing-extensions
-    - typer
-    - termcolor
-    - uvicorn[standard]
-
-test:
-  source_files:
-    - tests/
-  requires:
-    - httpx
-    - lima2
-    - pytest
-    - pytest-asyncio
-    - pytest-cov
-    - requests-mock
-
-about:
-  home: https://gitlab.esrf.fr/limagroup/lima2-client
-  license: MIT
-  license_file: LICENSE
-  summary: A library for the unified control of 2D detectors

lima2_client-4.0.2/conda/run_test.sh

@@ -1,10 +0,0 @@
-#!/bin/bash
-#
-# Run lima2-client unit and integration tests
-
-pytest tests/unit
-
-# (Only available from PyPI)
-pip install nosqltangodb
-
-pytest tests/integration