Merge pull request #52 from bsc-dom/4.1

4.1

PUBLISH.md

@@ -4,10 +4,9 @@
 
 **Prerequisite**: Have a dataClay's pypi and testpypi account with owner access.
 
-1. Run `tox` to format and check tests.
+1. Run `nox` to format and check tests.
 2. Push a new commit `release version <VERSION>` where you:
    - Update `dataclay.__version__` from `dataclay.__init__` to `<VERSION>`
-   - Add `Released YYYY-MM-DD` to `CHANGES.rst`
 
 3. Create and push a new tag:
 

docs/reference/dataclay.exceptions.rst

@@ -0,0 +1,16 @@
+Exceptions
+==========
+
+General dataClay exceptions
+---------------------------
+
+.. automodule:: dataclay.exceptions
+    :members:
+    :show-inheritance:
+
+Proxy exceptions
+----------------
+
+.. automodule:: dataclay.proxy.exceptions
+    :members:
+    :show-inheritance:

docs/reference/index.rst

@@ -7,5 +7,6 @@ API Reference
    dataclay.client
    dataclay.backend
    dataclay.metadata
+   dataclay.exceptions
    aliendco
    annotations

docs/releasenotes/4-x.rst

@@ -36,3 +36,23 @@ Other changes
 - Offering a new :doc:`Zenoh bridging mechanism </contrib/zenoh>` (similar to the :doc:`MQTT </contrib/mqtt>` one).
 - Removed the session and password authentication. This feature will be handled by the proxy going forward.
 - Added healthcheck mechanisms (at the gRPC level) to monitor the status of the dataClay services.
+
+4.1 (November 2024)
+-------------------
+
+This minor release brings some bug fixes to the features introduced in 4.0, and also some new features.
+
+Highlights
+~~~~~~~~~~
+
+- Official support for Python 3.13.
+- Improved granularity and semantic of raised exceptions. The list and description of all the current
+  exceptions can be found in the :doc:`/reference/dataclay.exceptions` reference page.
+- Fixed behavior of the proxy. Now the code works properly in an async configuration.
+- More detailed examples and utility functions to support JWT tokens in the proxy side.
+- Better defaults for the logging system.
+- Improved and expanded documentation for Telemetry.
+- Build system is now using `nox <https://nox.thea.codes>`_.
+- Support for PyCOMPSs 
+  `constraints <https://compss-doc.readthedocs.io/en/stable/Sections/09_PyCOMPSs_Notebooks/syntax/5_UsingConstraints.html>`_.
+  Should work out of the box with dataClay 4.1 and the upcoming COMPSs version.

src/dataclay/__init__.py

@@ -9,5 +9,5 @@
 
 StorageObject = DataClayObject
 
-__version__ = "4.0.1.dev"
+__version__ = "4.1.0"
 __all__ = ["Client", "DataClayObject", "AlienDataClayObject", "activemethod", "StorageObject"]

src/dataclay/exceptions.py

@@ -1,17 +1,11 @@
-""" All dataClay exceptions are colected in this file. """
+"""In general, dataClay will prefer to raise the exceptions defined below."""
 
 
 class DataClayException(Exception):
     """Base class for exceptions in this module."""
-
     pass
 
 
-##################
-# NEW EXCEPTIONS #
-##################
-
-
 ##############
 # KV Generic #
 ##############

src/dataclay/proxy/exceptions.py

@@ -1,2 +1,5 @@
+"""The middleware can throw the exceptions defined below."""
+
 class MiddlewareException(Exception):
+    """Exception raised for errors in the middleware."""
     status_code = None