blissdata 2.2.0__tar.gz → 2.3.0__tar.gz

{blissdata-2.2.0/src/blissdata.egg-info → blissdata-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blissdata
-Version: 2.2.0
+Version: 2.3.0
 Summary: Bliss data streaming client
 Maintainer: BCU (ESRF)
 License-Expression: LGPL-3.0-or-later
@@ -26,8 +26,7 @@ Requires-Dist: silx>=1.1.0
 Provides-Extra: tango
 Requires-Dist: pytango>=9.3.1; extra == "tango"
 Provides-Extra: lima2
-Requires-Dist: blissdata[tango]; extra == "lima2"
-Requires-Dist: lima2-client~=4.0; extra == "lima2"
+Requires-Dist: blissdata-lima2>=2.0; extra == "lima2"
 Provides-Extra: test
 Requires-Dist: gevent>=20.9.0; extra == "test"
 Requires-Dist: pytest>=7; extra == "test"

{blissdata-2.2.0 → blissdata-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blissdata"
-version = "2.2.0"
+version = "2.3.0"
 description = "Bliss data streaming client"
 readme = "README.md"
 license = "LGPL-3.0-or-later"
@@ -32,10 +32,7 @@ Changes = "https://gitlab.esrf.fr/bliss/blissdata/-/blob/master/CHANGELOG.md"
 
 [project.optional-dependencies]
 tango = ["pytango>=9.3.1"]
-lima2 = [
-    "blissdata[tango]",
-    "lima2-client~=4.0"
-]
+lima2 = ["blissdata-lima2>=2.0"]
 test = [
     "gevent>=20.9.0",
     "pytest>=7",
@@ -62,7 +59,6 @@ memory_tracker = "blissdata.redis_engine.memory_tracker:cli"
 hdf5_fallback = "blissdata.streams.hdf5_fallback"
 scan_sequence = "blissdata.streams.scan_sequence"
 lima = "blissdata.streams.lima"
-lima2 = "blissdata.streams.lima2"
 
 [build-system]
 requires = ["setuptools"]

blissdata-2.3.0/src/blissdata/__init__.py

@@ -0,0 +1,4 @@
+from .redis_engine.store import DataStore  # noqa F401
+from .redis_engine.scan import Scan, ScanState  # noqa F401
+
+__all__ = ["DataStore", "Scan", "ScanState"]

blissdata-2.3.0/src/blissdata/deprecation.py

@@ -0,0 +1,12 @@
+from warnings import warn
+
+
+def warn_deprecated(old_name, new_name, removal_version=None):
+    msg = f"'{old_name}' is deprecated, use '{new_name}' instead."
+    if removal_version:
+        msg += f" It will be removed in version {removal_version}."
+    warn(
+        msg,
+        FutureWarning,
+        stacklevel=3,
+    )

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/h5api/h5_scan_map.py

@@ -2,7 +2,7 @@ import time
 import logging
 from collections.abc import Mapping
 from pathlib import PurePosixPath as Path
-from blissdata.redis_engine.scan import ScanState
+from blissdata import ScanState
 from blissdata.h5map import HDF5ItemType, Group
 
 _logger = logging.getLogger(__name__)

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/h5api/redis_hdf5.py

@@ -7,9 +7,9 @@ from abc import ABC, abstractmethod
 from pathlib import PurePosixPath as Path
 
 import blissdata.h5map as h5m
+from blissdata import DataStore
 from blissdata.beacon.data import BeaconData
-from blissdata.redis_engine.store import DataStore
-from blissdata.redis_engine.exceptions import EndOfStream, IndexNotYetThereError
+from blissdata.exceptions import EndOfStream, IndexNotYetThereError
 from blissdata.h5api import abstract
 from blissdata.h5api.h5_scan_map import H5ScanMap
 

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/lima/client.py

@@ -5,16 +5,13 @@
 # Copyright (c) Beamline Control Unit, ESRF
 # Distributed under the GNU LGPLv3. See LICENSE for more info.
 import math
+import logging
 import numpy as np
 from packaging.version import Version
 from functools import cached_property
-import logging
 from dataclasses import dataclass
 
-from blissdata.redis_engine.exceptions import (
-    IndexNoMoreThereError,
-    IndexNotYetThereError,
-)
+from blissdata.exceptions import IndexNoMoreThereError, IndexNotYetThereError
 from . import image_utils
 
 try:

blissdata-2.3.0/src/blissdata/redis_engine/encoding/json.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+from blissdata.deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata.streams.encoding.json", "3")
+
+from blissdata.streams.encoding.json import JsonStreamEncoder  # noqa F401, E402

blissdata-2.3.0/src/blissdata/redis_engine/encoding/numeric.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+from blissdata.deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata.streams.encoding.numeric", "3")
+
+from blissdata.streams.encoding.numeric import NumericStreamEncoder  # noqa F401, E402

blissdata-2.3.0/src/blissdata/redis_engine/event_stream.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+from blissdata.deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata.streams.event_stream", "3")
+
+from blissdata.streams.event_stream import EventStream  # noqa F401, E402

blissdata-2.3.0/src/blissdata/redis_engine/exceptions.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+
+from blissdata.deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata.exceptions", "3")
+
+from blissdata.exceptions import *  # noqa F401, E402

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/redis_engine/memory_tracker.py

@@ -13,10 +13,8 @@ import redis
 from datetime import timedelta
 from dataclasses import dataclass
 
-from .store import DataStore
-from .scan import Scan
-from .scan import ScanState
-from .exceptions import NoScanAvailable, ScanNotFoundError, ScanLoadError
+from blissdata import DataStore, Scan, ScanState
+from blissdata.exceptions import NoScanAvailable, ScanNotFoundError, ScanLoadError
 
 
 memory_tracking_stream = "_MEMORY_TRACKING_"

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/redis_engine/scan.py

@@ -11,21 +11,19 @@ import math
 import logging
 import numpy as np
 from functools import wraps
-
 from pydantic import ValidationError
 from importlib.metadata import entry_points
 
-from .event_stream import EventStream
-from .exceptions import (
+from blissdata.streams.event_stream import EventStream
+from blissdata.exceptions import (
     UnauthorizeStateTransition,
     ScanNotFoundError,
     ScanValidationError,
     NoWritePermission,
 )
-from blissdata.streams.base import (
-    BaseStream,
+from blissdata.streams import BaseStream, StreamDefinition
+from blissdata.streams.default import (
     Stream,
-    StreamDefinition,
     BrokenStream,
     BrokenPluginStream,
     MissingPluginStream,

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/redis_engine/store.py

@@ -13,8 +13,8 @@ from redis.commands.search.query import Query
 from redis.commands.search.querystring import querystring, tags
 from redis_om import HashModel, JsonModel, Migrator
 
+from blissdata.exceptions import NoScanAvailable, ScanNotFoundError
 from .scan import Scan, scan_creation_stream, ScanState
-from .exceptions import NoScanAvailable, ScanNotFoundError
 from .identities import ESRFIdentityModel
 
 _PROTOCOL_KEY = "_PROTOCOL_VERSION_"

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/scan.py

@@ -4,4 +4,8 @@
 #
 # Copyright (c) Beamline Control Unit, ESRF
 # Distributed under the GNU LGPLv3. See LICENSE for more info.
-from .redis_engine.scan import Scan  # noqa: F401
+from .deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata", "3")
+
+from . import Scan  # noqa: F401, E402

blissdata-2.2.0/src/blissdata/streams/base.py → blissdata-2.3.0/src/blissdata/streams/__init__.py

@@ -4,21 +4,21 @@
 #
 # Copyright (c) Beamline Control Unit, ESRF
 # Distributed under the GNU LGPLv3. See LICENSE for more info.
-import numpy as np
 from abc import ABC, abstractmethod
 from collections.abc import Mapping, Sequence
 from dataclasses import dataclass
-from blissdata.redis_engine.event_stream import EventStream
-from blissdata.redis_engine.exceptions import (
-    EndOfStream,
-    IndexNoMoreThereError,
-    UnknownEncodingError,
-    MissingPluginException,
-    EmptyViewException,
-)
-from blissdata.redis_engine.encoding import StreamEncoder
-from blissdata.redis_engine.encoding.numeric import NumericStreamEncoder
-from blissdata.redis_engine.encoding.json import JsonStreamEncoder
+from blissdata.exceptions import EndOfStream, EmptyViewException
+from .encoding import StreamEncoder
+from .event_stream import EventStream
+
+__all__ = [
+    "BaseStream",
+    "BaseView",
+    "Cursor",
+    "CursorGroup",
+    "EventRange",
+    "StreamDefinition",
+]
 
 
 @dataclass(slots=True)
@@ -174,151 +174,6 @@ class BaseView(ABC):
         pass
 
 
-class View(BaseView):
-    def __init__(self, event_range: EventRange):
-        self._events = event_range
-
-    @property
-    def index(self) -> int:
-        return self._events.index
-
-    def __len__(self) -> int:
-        return len(self._events)
-
-    def __iter__(self):
-        yield from self.get_data()
-
-    def get_data(self, start=None, stop=None):
-        trimmed_range = range(len(self))[start:stop]
-        offset = self._events.nb_expired
-        data_start = trimmed_range.start - offset
-        data_stop = trimmed_range.stop - offset
-        if data_start < 0:
-            raise IndexNoMoreThereError
-        else:
-            return self._events.data[data_start:data_stop]
-
-
-class Stream(BaseStream):
-    def __init__(self, event_stream):
-        super().__init__(event_stream)
-        if event_stream.encoding["type"] == "numeric":
-            self._kind = "array"
-        elif event_stream.encoding["type"] == "json":
-            self._kind = "json"
-        else:
-            raise UnknownEncodingError(
-                f"Unknow stream encoding {event_stream.encoding}"
-            )
-
-    @staticmethod
-    def make_definition(name, dtype, shape=None, info={}) -> StreamDefinition:
-        if dtype == "json":
-            if shape is None:
-                return StreamDefinition(name, info, JsonStreamEncoder())
-            else:
-                raise ValueError("JSON stream cannot have shape")
-        else:
-            if shape is None:
-                shape = ()
-            info = info.copy()
-            info["dtype"] = np.dtype(dtype).name
-            info["shape"] = shape
-            return StreamDefinition(name, info, NumericStreamEncoder(dtype, shape))
-
-    @property
-    def kind(self):
-        return self._kind
-
-    @property
-    def plugin(self):
-        None
-
-    @property
-    def dtype(self):
-        return self.event_stream.dtype
-
-    @property
-    def shape(self):
-        return self.event_stream.shape
-
-    def __len__(self):
-        return len(self._event_stream)
-
-    def __getitem__(self, key):
-        return self._event_stream[key]
-
-    def _need_last_only(self, last_only):
-        return last_only
-
-    def _build_view_from_events(self, index, events: EventRange, last_only):
-        # NOTE event_range is never empty
-        return View(events)
-
-
-class BrokenStream(BaseStream):
-    def __init__(self, event_stream, plugin_name, exception, kind):
-        self._event_stream = event_stream
-        self._plugin_name = plugin_name
-        self._exception = exception
-        self._kind = kind
-
-    @property
-    def kind(self):
-        self._kind
-
-    @staticmethod
-    def make_definition(*args, **kwargs) -> StreamDefinition:
-        raise NotImplementedError
-
-    @property
-    def plugin(self):
-        return self._plugin_name
-
-    @property
-    def dtype(self):
-        raise self._exception
-
-    @property
-    def shape(self):
-        raise self._exception
-
-    def __len__(self):
-        raise self._exception
-
-    def __getitem__(self, key):
-        raise self._exception
-
-    def _need_last_only(self, last_only):
-        raise self._exception
-
-    def _build_view_from_events(
-        self, hl_index: int, events: EventRange, last_only: bool
-    ):
-        raise self._exception
-
-
-class BrokenPluginStream(BrokenStream):
-    """A stream class instanciated in place of a plugin, if it can't be
-    instantiated. A warning is issued, but the scan object is not affected,
-    ensuring memory tracker robustness against plugins."""
-
-    def __init__(self, event_stream, plugin_name, exception):
-        super().__init__(event_stream, plugin_name, exception, "broken_plugin")
-
-
-class MissingPluginStream(BrokenStream):
-    """A stream class instanciated in place of a plugin if not installed."""
-
-    def __init__(self, event_stream, plugin_name):
-        super().__init__(
-            event_stream,
-            plugin_name,
-            MissingPluginException(event_stream.name, plugin_name),
-            "missing_plugin",
-        )
-
-
 class Cursor:
     def __init__(self, stream):
         # low level stream (multiplexable events from redis)

blissdata-2.3.0/src/blissdata/streams/base.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+from . import (
+    BaseStream,
+    BaseView,
+    Cursor,
+    CursorGroup,
+    EventRange,
+    StreamDefinition,
+)
+from .default import (
+    View,
+    Stream,
+    BrokenStream,
+    BrokenPluginStream,
+    MissingPluginStream,
+)
+
+from blissdata.deprecation import warn_deprecated
+
+warn_deprecated(__name__, "blissdata.streams' and 'blissdata.streams.default", "3")
+
+__all__ = [
+    "BaseStream",
+    "BaseView",
+    "Cursor",
+    "CursorGroup",
+    "EventRange",
+    "StreamDefinition",
+    "View",
+    "Stream",
+    "BrokenStream",
+    "BrokenPluginStream",
+    "MissingPluginStream",
+]

blissdata-2.3.0/src/blissdata/streams/default.py

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of the bliss project
+#
+# Copyright (c) Beamline Control Unit, ESRF
+# Distributed under the GNU LGPLv3. See LICENSE for more info.
+import numpy as np
+from blissdata.exceptions import (
+    IndexNoMoreThereError,
+    UnknownEncodingError,
+    MissingPluginException,
+)
+from . import EventRange, StreamDefinition, BaseStream, BaseView
+from .encoding.numeric import NumericStreamEncoder
+from .encoding.json import JsonStreamEncoder
+
+
+class View(BaseView):
+    def __init__(self, event_range: EventRange):
+        self._events = event_range
+
+    @property
+    def index(self) -> int:
+        return self._events.index
+
+    def __len__(self) -> int:
+        return len(self._events)
+
+    def __iter__(self):
+        yield from self.get_data()
+
+    def get_data(self, start=None, stop=None):
+        trimmed_range = range(len(self))[start:stop]
+        offset = self._events.nb_expired
+        data_start = trimmed_range.start - offset
+        data_stop = trimmed_range.stop - offset
+        if data_start < 0:
+            raise IndexNoMoreThereError
+        else:
+            return self._events.data[data_start:data_stop]
+
+
+class Stream(BaseStream):
+    def __init__(self, event_stream):
+        super().__init__(event_stream)
+        if event_stream.encoding["type"] == "numeric":
+            self._kind = "array"
+        elif event_stream.encoding["type"] == "json":
+            self._kind = "json"
+        else:
+            raise UnknownEncodingError(
+                f"Unknow stream encoding {event_stream.encoding}"
+            )
+
+    @staticmethod
+    def make_definition(name, dtype, shape=None, info={}) -> StreamDefinition:
+        if dtype == "json":
+            if shape is None:
+                return StreamDefinition(name, info, JsonStreamEncoder())
+            else:
+                raise ValueError("JSON stream cannot have shape")
+        else:
+            if shape is None:
+                shape = ()
+            info = info.copy()
+            info["dtype"] = np.dtype(dtype).name
+            info["shape"] = shape
+            return StreamDefinition(name, info, NumericStreamEncoder(dtype, shape))
+
+    @property
+    def kind(self):
+        return self._kind
+
+    @property
+    def plugin(self):
+        None
+
+    @property
+    def dtype(self):
+        return self.event_stream.dtype
+
+    @property
+    def shape(self):
+        return self.event_stream.shape
+
+    def __len__(self):
+        return len(self._event_stream)
+
+    def __getitem__(self, key):
+        return self._event_stream[key]
+
+    def _need_last_only(self, last_only):
+        return last_only
+
+    def _build_view_from_events(self, index, events: EventRange, last_only):
+        # NOTE event_range is never empty
+        return View(events)
+
+
+class BrokenStream(BaseStream):
+    def __init__(self, event_stream, plugin_name, exception, kind):
+        self._event_stream = event_stream
+        self._plugin_name = plugin_name
+        self._exception = exception
+        self._kind = kind
+
+    @property
+    def kind(self):
+        self._kind
+
+    @staticmethod
+    def make_definition(*args, **kwargs) -> StreamDefinition:
+        raise NotImplementedError
+
+    @property
+    def plugin(self):
+        return self._plugin_name
+
+    @property
+    def dtype(self):
+        raise self._exception
+
+    @property
+    def shape(self):
+        raise self._exception
+
+    def __len__(self):
+        raise self._exception
+
+    def __getitem__(self, key):
+        raise self._exception
+
+    def _need_last_only(self, last_only):
+        raise self._exception
+
+    def _build_view_from_events(
+        self, hl_index: int, events: EventRange, last_only: bool
+    ):
+        raise self._exception
+
+
+class BrokenPluginStream(BrokenStream):
+    """A stream class instanciated in place of a plugin, if it can't be
+    instantiated. A warning is issued, but the scan object is not affected,
+    ensuring memory tracker robustness against plugins."""
+
+    def __init__(self, event_stream, plugin_name, exception):
+        super().__init__(event_stream, plugin_name, exception, "broken_plugin")
+
+
+class MissingPluginStream(BrokenStream):
+    """A stream class instanciated in place of a plugin if not installed."""
+
+    def __init__(self, event_stream, plugin_name):
+        super().__init__(
+            event_stream,
+            plugin_name,
+            MissingPluginException(event_stream.name, plugin_name),
+            "missing_plugin",
+        )

{blissdata-2.2.0/src/blissdata/redis_engine → blissdata-2.3.0/src/blissdata/streams}/event_stream.py

@@ -12,7 +12,7 @@ from dataclasses import dataclass
 from .encoding import EncodedBatch
 from .encoding.json import JsonStreamEncoder
 from .encoding.numeric import NumericStreamEncoder
-from .exceptions import (
+from blissdata.exceptions import (
     IndexNoMoreThereError,
     IndexNotYetThereError,
     IndexWontBeThereError,

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/streams/hdf5_fallback/stream.py

@@ -7,8 +7,9 @@
 import numpy as np
 
 from blissdata.h5api import dynamic_hdf5
-from blissdata.redis_engine.exceptions import IndexNoMoreThereError
-from blissdata.streams.base import Stream, StreamDefinition, BaseView, EventRange
+from blissdata.exceptions import IndexNoMoreThereError
+from blissdata.streams import BaseView, EventRange, StreamDefinition
+from blissdata.streams.default import Stream
 
 
 class Hdf5BackedView(BaseView):

{blissdata-2.2.0 → blissdata-2.3.0}/src/blissdata/streams/lima/stream.py

@@ -4,25 +4,27 @@
 #
 # Copyright (c) Beamline Control Unit, ESRF
 # Distributed under the GNU LGPLv3. See LICENSE for more info.
+from abc import ABC, abstractmethod
 import numpy as np
 from numpy.typing import DTypeLike
 from collections.abc import Sequence
-from blissdata.streams.base import (
-    Stream,
+from blissdata.streams import (
     BaseStream,
     BaseView,
     StreamDefinition,
     EventRange,
 )
+from blissdata.streams.default import Stream
+from blissdata.streams.encoding.json import JsonStreamEncoder
 from blissdata.lima.client import LimaClient, ImageReference
-from blissdata.redis_engine.encoding.json import JsonStreamEncoder
-from blissdata.redis_engine.exceptions import (
+from blissdata.exceptions import (
     EndOfStream,
     IndexWontBeThereError,
     IndexNotYetThereError,
     IndexNoMoreThereError,
     EmptyViewException,
 )
+from blissdata.lima.image_utils import ImageData
 
 
 class LimaView(BaseView):
@@ -50,7 +52,15 @@ class LimaView(BaseView):
         )
 
 
-class LimaStream(BaseStream):
+class LimaDirectAccess(ABC):
+    """Provides access to images directly from the backend (bypassing the blissdata stream)."""
+
+    @abstractmethod
+    def get_last_live_image(self) -> ImageData:
+        """Access the most up to date frame directly from the backend."""
+
+
+class LimaStream(BaseStream, LimaDirectAccess):
     """Same API as a Stream but with a lima client inside to dereference events into images.
     Will support any Lima version as long as there is a client for it."""
 
@@ -218,5 +228,5 @@ class LimaStream(BaseStream):
             else:
                 raise IndexNoMoreThereError
 
-    def get_last_live_image(self):
+    def get_last_live_image(self) -> ImageData:
         return self._client.get_last_live_image()