blissdata 1.1.4__tar.gz → 2.0.0__tar.gz

blissdata-2.0.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.2
+Name: blissdata
+Version: 2.0.0
+Summary: Bliss data streaming client
+Maintainer: BCU (ESRF)
+License:                    GNU LESSER GENERAL PUBLIC LICENSE
+                               Version 3, 29 June 2007
+        
+         Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+         Everyone is permitted to copy and distribute verbatim copies
+         of this license document, but changing it is not allowed.
+        
+        
+          This version of the GNU Lesser General Public License incorporates
+        the terms and conditions of version 3 of the GNU General Public
+        License, supplemented by the additional permissions listed below.
+        
+          0. Additional Definitions.
+        
+          As used herein, "this License" refers to version 3 of the GNU Lesser
+        General Public License, and the "GNU GPL" refers to version 3 of the GNU
+        General Public License.
+        
+          "The Library" refers to a covered work governed by this License,
+        other than an Application or a Combined Work as defined below.
+        
+          An "Application" is any work that makes use of an interface provided
+        by the Library, but which is not otherwise based on the Library.
+        Defining a subclass of a class defined by the Library is deemed a mode
+        of using an interface provided by the Library.
+        
+          A "Combined Work" is a work produced by combining or linking an
+        Application with the Library.  The particular version of the Library
+        with which the Combined Work was made is also called the "Linked
+        Version".
+        
+          The "Minimal Corresponding Source" for a Combined Work means the
+        Corresponding Source for the Combined Work, excluding any source code
+        for portions of the Combined Work that, considered in isolation, are
+        based on the Application, and not on the Linked Version.
+        
+          The "Corresponding Application Code" for a Combined Work means the
+        object code and/or source code for the Application, including any data
+        and utility programs needed for reproducing the Combined Work from the
+        Application, but excluding the System Libraries of the Combined Work.
+        
+          1. Exception to Section 3 of the GNU GPL.
+        
+          You may convey a covered work under sections 3 and 4 of this License
+        without being bound by section 3 of the GNU GPL.
+        
+          2. Conveying Modified Versions.
+        
+          If you modify a copy of the Library, and, in your modifications, a
+        facility refers to a function or data to be supplied by an Application
+        that uses the facility (other than as an argument passed when the
+        facility is invoked), then you may convey a copy of the modified
+        version:
+        
+           a) under this License, provided that you make a good faith effort to
+           ensure that, in the event an Application does not supply the
+           function or data, the facility still operates, and performs
+           whatever part of its purpose remains meaningful, or
+        
+           b) under the GNU GPL, with none of the additional permissions of
+           this License applicable to that copy.
+        
+          3. Object Code Incorporating Material from Library Header Files.
+        
+          The object code form of an Application may incorporate material from
+        a header file that is part of the Library.  You may convey such object
+        code under terms of your choice, provided that, if the incorporated
+        material is not limited to numerical parameters, data structure
+        layouts and accessors, or small macros, inline functions and templates
+        (ten or fewer lines in length), you do both of the following:
+        
+           a) Give prominent notice with each copy of the object code that the
+           Library is used in it and that the Library and its use are
+           covered by this License.
+        
+           b) Accompany the object code with a copy of the GNU GPL and this license
+           document.
+        
+          4. Combined Works.
+        
+          You may convey a Combined Work under terms of your choice that,
+        taken together, effectively do not restrict modification of the
+        portions of the Library contained in the Combined Work and reverse
+        engineering for debugging such modifications, if you also do each of
+        the following:
+        
+           a) Give prominent notice with each copy of the Combined Work that
+           the Library is used in it and that the Library and its use are
+           covered by this License.
+        
+           b) Accompany the Combined Work with a copy of the GNU GPL and this license
+           document.
+        
+           c) For a Combined Work that displays copyright notices during
+           execution, include the copyright notice for the Library among
+           these notices, as well as a reference directing the user to the
+           copies of the GNU GPL and this license document.
+        
+           d) Do one of the following:
+        
+               0) Convey the Minimal Corresponding Source under the terms of this
+               License, and the Corresponding Application Code in a form
+               suitable for, and under terms that permit, the user to
+               recombine or relink the Application with a modified version of
+               the Linked Version to produce a modified Combined Work, in the
+               manner specified by section 6 of the GNU GPL for conveying
+               Corresponding Source.
+        
+               1) Use a suitable shared library mechanism for linking with the
+               Library.  A suitable mechanism is one that (a) uses at run time
+               a copy of the Library already present on the user's computer
+               system, and (b) will operate properly with a modified version
+               of the Library that is interface-compatible with the Linked
+               Version.
+        
+           e) Provide Installation Information, but only if you would otherwise
+           be required to provide such information under section 6 of the
+           GNU GPL, and only to the extent that such information is
+           necessary to install and execute a modified version of the
+           Combined Work produced by recombining or relinking the
+           Application with a modified version of the Linked Version. (If
+           you use option 4d0, the Installation Information must accompany
+           the Minimal Corresponding Source and Corresponding Application
+           Code. If you use option 4d1, you must provide the Installation
+           Information in the manner specified by section 6 of the GNU GPL
+           for conveying Corresponding Source.)
+        
+          5. Combined Libraries.
+        
+          You may place library facilities that are a work based on the
+        Library side by side in a single library together with other library
+        facilities that are not Applications and are not covered by this
+        License, and convey such a combined library under terms of your
+        choice, if you do both of the following:
+        
+           a) Accompany the combined library with a copy of the same work based
+           on the Library, uncombined with any other library facilities,
+           conveyed under the terms of this License.
+        
+           b) Give prominent notice with the combined library that part of it
+           is a work based on the Library, and explaining where to find the
+           accompanying uncombined form of the same work.
+        
+          6. Revised Versions of the GNU Lesser General Public License.
+        
+          The Free Software Foundation may publish revised and/or new versions
+        of the GNU Lesser General Public License from time to time. Such new
+        versions will be similar in spirit to the present version, but may
+        differ in detail to address new problems or concerns.
+        
+          Each version is given a distinguishing version number. If the
+        Library as you received it specifies that a certain numbered version
+        of the GNU Lesser General Public License "or any later version"
+        applies to it, you have the option of following the terms and
+        conditions either of that published version or of any later version
+        published by the Free Software Foundation. If the Library as you
+        received it does not specify a version number of the GNU Lesser
+        General Public License, you may choose any version of the GNU Lesser
+        General Public License ever published by the Free Software Foundation.
+        
+          If the Library as you received it specifies that a proxy can decide
+        whether future versions of the GNU Lesser General Public License shall
+        apply, that proxy's public statement of acceptance of any version is
+        permanent authorization for you to choose that version for the
+        Library.
+        
+Project-URL: Repository, https://gitlab.esrf.fr/bliss/blissdata/
+Project-URL: Documentation, https://bliss.gitlab-pages.esrf.fr/blissdata/
+Project-URL: Changes, https://gitlab.esrf.fr/bliss/blissdata/-/blob/master/CHANGELOG.md
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beartype
+Requires-Dist: fabio>=0.12
+Requires-Dist: h5py>=2.9
+Requires-Dist: msgpack
+Requires-Dist: numpy>=1.20
+Requires-Dist: pydantic>=2.3.0
+Requires-Dist: redis>=4.6.0
+Requires-Dist: redis-om>=0.3.1
+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~=2.0; extra == "lima2"
+Provides-Extra: test
+Requires-Dist: gevent>=20.9.0; extra == "test"
+Requires-Dist: pytest>=7; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-redis>=3.1; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Requires-Dist: packaging; extra == "test"
+Provides-Extra: dev
+Requires-Dist: blissdata[test]; extra == "dev"
+Requires-Dist: black==22.3; extra == "dev"
+Requires-Dist: flake8>=4; extra == "dev"
+Requires-Dist: flake8-pep585; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.18; extra == "dev"
+Provides-Extra: beacon
+Requires-Dist: ruamel.yaml; extra == "beacon"
+
+# Blissdata
+
+Documentation [here](https://bliss.gitlab-pages.esrf.fr/blissdata).

{blissdata-1.1.4 → blissdata-2.0.0}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "blissdata"
-version = "1.1.4"
+version = "2.0.0"
 description = "Bliss data streaming client"
 readme = "README.md"
-license = {file = "LICENSE.md"}
+license = {file = "LICENSE"}
 maintainers = [{name = "BCU (ESRF)"}]
 classifiers = [
     "Intended Audience :: Science/Research",
@@ -11,13 +11,13 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
     "beartype",
     "fabio>=0.12",
-    "h5py>=2.9,<3.12", # temporary fix for https://gitlab.esrf.fr/bliss/bliss/-/issues/4512
+    "h5py>=2.9",
     "msgpack",
-    "numpy>=1.13",
+    "numpy>=1.20",
     "pydantic>=2.3.0", # (not a direct dep) redis-om 0.3.2 doesn't support lower versions
     "redis>=4.6.0",
     "redis-om>=0.3.1",
@@ -33,7 +33,7 @@ Changes = "https://gitlab.esrf.fr/bliss/blissdata/-/blob/master/CHANGELOG.md"
 tango = ["pytango>=9.3.1"]
 lima2 = [
     "blissdata[tango]",
-    "lima2-client"
+    "lima2-client~=2.0"
 ]
 test = [
     "gevent>=20.9.0",
@@ -41,17 +41,28 @@ test = [
     "pytest-mock",
     "pytest-redis>=3.1",
     "pytest-timeout",
+    "packaging"
 ]
 dev = [
     "blissdata[test]",
     "black==22.3",
     "flake8>=4",
+    "flake8-pep585",
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings[python]>=0.18",
 ]
 beacon = ["ruamel.yaml"]
 
 [project.scripts]
 memory_tracker = "blissdata.redis_engine.memory_tracker:cli"
 
+[project.entry-points.blissdata]
+hdf5_fallback = "blissdata.streams.hdf5_fallback"
+scan_sequence = "blissdata.streams.scan_sequence"
+lima = "blissdata.streams.lima"
+lima2 = "blissdata.streams.lima2"
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
@@ -59,3 +70,6 @@ build-backend = "setuptools.build_meta"
 [tool.pytest.ini_options]
 addopts = "-v"
 testpaths = ["src/blissdata/tests"]
+
+[tool.setuptools.package-data]
+blissdata = ["py.typed"]

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/beacon/_base.py

@@ -4,7 +4,6 @@ import platform
 import socket
 import struct
 import threading
-from typing import Optional
 from . import config
 
 
@@ -23,8 +22,8 @@ class BeaconClient:
 
     def __init__(
         self,
-        host: Optional[str] = None,
-        port: Optional[int] = None,
+        host: str | None = None,
+        port: int | None = None,
         timeout: float = 3.0,
     ):
         if host is None or port is None:

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/beacon/config.py

@@ -1,24 +1,23 @@
 """Beacon configuration"""
 
 import os
-from typing import Tuple
 
 
-def get_beacon_address() -> Tuple[str, int]:
+def get_beacon_address() -> tuple[str, int]:
     """Beacon address from the environment var `BEACON_HOST`.
 
     For example `('foobar', 25000)`.
 
     Raises:
-        ValueError: If BEACON_HOST is missing or not properly set
+        ValueError: If $BEACON_HOST is missing or not properly set
     """
     beacon_host = os.environ.get("BEACON_HOST")
     if beacon_host is None:
-        raise ValueError("BEACON_HOST is not specified")
+        raise ValueError("$BEACON_HOST is not specified")
     try:
         host, port = beacon_host.split(":")
         return host, int(port)
     except Exception:
         raise ValueError(
-            f"BEACON_HOST variable not properly set. Expected: 'hostname:port'. Found: from '{beacon_host}'."
+            f"$BEACON_HOST variable not properly set. Expected: 'hostname:port'. Found: from '{beacon_host}'."
         )

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/beacon/files.py

@@ -85,6 +85,10 @@ def _read_config_beacon(url: ParseResult) -> Any:
     beacon = BeaconFiles(host=host, port=port)
     try:
         config = beacon.get_file(file_path)
+        if yaml_load is None:
+            raise ImportError(
+                "No yaml parser available. Try to install 'ruamel.yaml' or 'pyyaml'"
+            )
         return yaml_load(config)
     finally:
         beacon.close()

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/h5api/abstract.py

@@ -1,8 +1,7 @@
 """Definition of the h5py-like Bliss Data API"""
 
 from collections import abc
-from abc import abstractmethod, abstractproperty
-from typing import Iterator, Optional, Tuple
+from abc import ABC, abstractmethod, abstractproperty
 from numpy.typing import DTypeLike
 from .utils import types
 
@@ -11,17 +10,13 @@ class Attributes(abc.Mapping):
     """Node attributes."""
 
 
-class Node:
+class Node(ABC):
     """Node in the data tree."""
 
     @abstractproperty
     def name(self) -> str:
         pass
 
-    @abstractproperty
-    def short_name(self) -> str:
-        pass
-
     @abstractproperty
     def attrs(self) -> Attributes:
         pass
@@ -43,7 +38,7 @@ class Group(Node, abc.Mapping):
         pass
 
     @abstractmethod
-    def __iter__(self) -> Iterator[Node]:
+    def __iter__(self) -> abc.Iterator[Node]:
         pass
 
     @abstractmethod
@@ -67,7 +62,7 @@ class Dataset(Node, abc.Sequence):
         pass
 
     @abstractproperty
-    def shape(self) -> Tuple[int]:
+    def shape(self) -> tuple[int]:
         pass
 
     @abstractproperty
@@ -85,17 +80,13 @@ class File(Group):
     def __enter__(self) -> "File":
         return self
 
-    def __exit__(self, exception_type, exception_value, traceback) -> Optional[bool]:
+    def __exit__(self, exception_type, exception_value, traceback) -> bool | None:
         self.close()
 
     @abstractmethod
     def close(self) -> None:
         pass
 
-    @property
-    def parent(self) -> None:
-        return None
-
     @abstractproperty
     def filename(self) -> str:
         pass

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/h5api/dynamic_hdf5.py

@@ -1,6 +1,7 @@
 """Implementation of the h5py-like Bliss Data API with dynamic HDF5 files"""
 
-from typing import Any, Iterator, Tuple, Type
+from collections.abc import Iterator
+from typing import Any
 
 from numpy.typing import DTypeLike
 import h5py
@@ -47,10 +48,6 @@ class Node:
     def name(self) -> str:
         return self.__name
 
-    @property
-    def short_name(self) -> str:
-        return self.name.rpartition(hdf5.SEP)[-1]
-
     @property
     def parent(self) -> "Group":
         if self.__parent is None:
@@ -110,7 +107,7 @@ class Dataset(Node, abstract.Dataset):
         return self._retry_handler.getattr_item(self.name, "dtype")
 
     @property
-    def shape(self) -> Tuple[int]:
+    def shape(self) -> tuple[int]:
         return self._retry_handler.getattr_item(self.name, "shape")
 
     @property
@@ -128,7 +125,7 @@ class File(Group, abstract.File):
     def __init__(
         self,
         file: str,
-        hdf5_retry_handler: Type[
+        hdf5_retry_handler: type[
             hdf5.DynamicHDF5Handler
         ] = bliss.BlissDynamicHDF5Handler,
         **openargs,
@@ -156,7 +153,3 @@ class File(Group, abstract.File):
     @property
     def filename(self) -> str:
         return self._retry_handler.filename
-
-    @property
-    def short_name(self) -> str:
-        return self.name

{blissdata-1.1.4 → blissdata-2.0.0}/src/blissdata/h5api/file_arguments.py

@@ -2,9 +2,6 @@
 arguments which are specific for that context (static HDF5, dynamic HDF5, ...).
 """
 
-from typing import Set
-
-
 _CONTEXT_SPECIFIC_KEYS = {
     "h5py": {"mode"},
     "static_hdf5": set(),
@@ -16,11 +13,12 @@ _CONTEXT_SPECIFIC_KEYS = {
         "instrument_name",
         "lima_url_template",
         "lima_url_template_args",
+        "prioritize_non_native_h5items",
     },
 }
 
 
-def ignore_file_arguments(context: str) -> Set[str]:
+def ignore_file_arguments(context: str) -> set[str]:
     """Returns all keys with that should be ignore when instantiating the `File`
     in a specific context"""
     ignore = set()