Release 2.41.0

shahramn · shahramn · commit b55eb1bc4c5a · 2025-04-10T11:02:33.000+01:00
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -29,6 +29,6 @@ jobs:
     secrets: inherit
   pypi:
     needs: [wheel-linux, wheel-macos, wheel-windows]
-    uses: ecmwf-actions/reusable-workflows/.github/workflows/cd-pypi.yml@v2
+    uses: ecmwf/reusable-workflows/.github/workflows/cd-pypi.yml@v2
     secrets: inherit
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -28,7 +28,7 @@ jobs:
   downstream-ci:
     name: downstream-ci
     if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
-    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci.yml@main
+    uses: ecmwf/downstream-ci/.github/workflows/downstream-ci.yml@main
     with:
       eccodes-python: ecmwf/eccodes-python@${{ github.event.pull_request.head.sha || github.sha }}
       codecov_upload: true
@@ -39,7 +39,7 @@ jobs:
   downstream-ci-hpc:
     name: downstream-ci-hpc
     if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
-    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci-hpc.yml@main
+    uses: ecmwf/downstream-ci/.github/workflows/downstream-ci-hpc.yml@main
     with:
       eccodes-python: ecmwf/eccodes-python@${{ github.event.pull_request.head.sha || github.sha }}
     secrets: inherit
diff --git a/.github/workflows/label-public-pr.yml b/.github/workflows/label-public-pr.yml
@@ -7,4 +7,4 @@ on:
 
 jobs:
   label:
-    uses: ecmwf-actions/reusable-workflows/.github/workflows/label-pr.yml@v2
+    uses: ecmwf/reusable-workflows/.github/workflows/label-pr.yml@v2
diff --git a/.github/workflows/reusable-ci-hpc.yml b/.github/workflows/reusable-ci-hpc.yml
@@ -13,7 +13,7 @@ on:
 jobs:
   ci-hpc:
     name: ci-hpc
-    uses: ecmwf-actions/reusable-workflows/.github/workflows/ci-hpc.yml@v2
+    uses: ecmwf/reusable-workflows/.github/workflows/ci-hpc.yml@v2
     with:
       name-prefix: eccodes-python-
       build-inputs: |
diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml
@@ -17,7 +17,7 @@ jobs:
   #   It will correctly handle addition of any new and removal of existing Git objects.
   sync:
     name: sync
-    uses: ecmwf-actions/reusable-workflows/.github/workflows/sync.yml@v2
+    uses: ecmwf/reusable-workflows/.github/workflows/sync.yml@v2
     secrets:
       target_repository: eccodes/eccodes-python
       target_username: ClonedDuck
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,13 @@
 Changelog for eccodes-python
 ============================
 
+2.41.0 (2025-04-10)
+--------------------
+
+- ECC-2034: GRIB encoding: Data quality checks via the API
+- GitHub pull request #124: Add basic BUFR support (high-level interface)
+
+
 2.40.1 (2025-03-17)
 --------------------
 
diff --git a/ci/requirements-docs.txt b/ci/requirements-docs.txt
@@ -18,7 +18,7 @@ idna==3.7
     # via requests
 imagesize==1.1.0
     # via sphinx
-jinja2==3.1.5
+jinja2==3.1.6
     # via sphinx
 markupsafe==2.1.5
     # via jinja2
diff --git a/eccodes/eccodes.py b/eccodes/eccodes.py
@@ -132,6 +132,7 @@
 from gribapi import grib_release as codes_release
 from gribapi import grib_set as codes_set
 from gribapi import grib_set_array as codes_set_array
+from gribapi import grib_set_data_quality_checks as codes_set_data_quality_checks
 from gribapi import grib_set_debug as codes_set_debug
 from gribapi import grib_set_definitions_path as codes_set_definitions_path
 from gribapi import grib_set_double as codes_set_double
@@ -348,6 +349,7 @@
     "codes_samples_path",
     "codes_dump",
     "codes_set_array",
+    "codes_set_data_quality_checks",
     "codes_set_debug",
     "codes_set_definitions_path",
     "codes_set_double_array",
diff --git a/eccodes/highlevel/__init__.py b/eccodes/highlevel/__init__.py
@@ -1,2 +1,2 @@
-from .message import GRIBMessage, Message  # noqa
+from .message import BUFRMessage, GRIBMessage, Message  # noqa
 from .reader import FileReader, MemoryReader, StreamReader  # noqa
diff --git a/eccodes/highlevel/message.py b/eccodes/highlevel/message.py
@@ -33,7 +33,7 @@ def __del__(self):
 
     def copy(self):
         """Create a copy of the current message"""
-        return Message(eccodes.codes_clone(self._handle))
+        return self.__class__(eccodes.codes_clone(self._handle))
 
     def __copy__(self):
         return self.copy()
@@ -242,6 +242,24 @@ def get_buffer(self):
         return eccodes.codes_get_message(self._handle)
 
 
+class BUFRMessage(Message):
+    def __init__(self, handle):
+        super().__init__(handle)
+
+    def pack(self):
+        """Pack the underlying data"""
+        self.set("pack", 1, check_values=False)
+
+    def unpack(self):
+        """Unpack the underlying data"""
+        self.set("unpack", 1, check_values=False)
+
+    @classmethod
+    def from_samples(cls, name):
+        """Create a message from a sample"""
+        return cls(eccodes.codes_bufr_new_from_samples(name))
+
+
 class GRIBMessage(Message):
     def __init__(self, handle):
         super().__init__(handle)
diff --git a/eccodes/highlevel/reader.py b/eccodes/highlevel/reader.py
@@ -2,12 +2,22 @@
 import gribapi
 from gribapi import ffi
 
-from .message import GRIBMessage
+from .message import BUFRMessage, GRIBMessage
+
+_MSG_CLASSES = {
+    eccodes.CODES_PRODUCT_GRIB: GRIBMessage,
+    eccodes.CODES_PRODUCT_BUFR: BUFRMessage,
+}
 
 
 class ReaderBase:
-    def __init__(self):
+    def __init__(self, kind=eccodes.CODES_PRODUCT_GRIB):
         self._peeked = None
+        self._kind = kind
+        cls = _MSG_CLASSES.get(kind)
+        if cls is None:
+            raise ValueError(f"Unsupported product type {kind}")
+        self._msg_class = cls
 
     def __iter__(self):
         return self
@@ -20,7 +30,7 @@ def __next__(self):
         handle = self._next_handle()
         if handle is None:
             raise StopIteration
-        return GRIBMessage(handle)
+        return self._msg_class(handle)
 
     def _next_handle(self):
         raise NotImplementedError
@@ -36,19 +46,19 @@ def peek(self):
         if self._peeked is None:
             handle = self._next_handle()
             if handle is not None:
-                self._peeked = GRIBMessage(handle)
+                self._peeked = self._msg_class(handle)
         return self._peeked
 
 
 class FileReader(ReaderBase):
     """Read messages from a file"""
 
-    def __init__(self, path):
-        super().__init__()
+    def __init__(self, path, kind=eccodes.CODES_PRODUCT_GRIB):
+        super().__init__(kind=kind)
         self.file = open(path, "rb")
 
     def _next_handle(self):
-        return eccodes.codes_new_from_file(self.file, eccodes.CODES_PRODUCT_GRIB)
+        return eccodes.codes_new_from_file(self.file, self._kind)
 
     def __enter__(self):
         self.file.__enter__()
@@ -61,8 +71,8 @@ def __exit__(self, exc_type, exc_value, traceback):
 class MemoryReader(ReaderBase):
     """Read messages from memory"""
 
-    def __init__(self, buf):
-        super().__init__()
+    def __init__(self, buf, kind=eccodes.CODES_PRODUCT_GRIB):
+        super().__init__(kind=kind)
         self.buf = buf
 
     def _next_handle(self):
@@ -128,14 +138,14 @@ def codes_new_from_stream(stream):
 class StreamReader(ReaderBase):
     """Read messages from a stream (an object with a ``read`` method)"""
 
-    def __init__(self, stream):
+    def __init__(self, stream, kind=eccodes.CODES_PRODUCT_GRIB):
         if cstd is None:
             raise OSError("This feature is not supported on Windows")
         if pyread_callback is None:
             raise OSError(
                 "This feature cannot be used because the OS prevents allocating write+execute memory"
             )
-        super().__init__()
+        super().__init__(kind=kind)
         self.stream = stream
 
     def _next_handle(self):
diff --git a/gribapi/bindings.py b/gribapi/bindings.py
@@ -23,7 +23,7 @@
 
 import cffi
 
-__version__ = "2.40.1"
+__version__ = "2.41.0"
 
 LOG = logging.getLogger(__name__)
 
diff --git a/gribapi/grib_api.h b/gribapi/grib_api.h
@@ -133,6 +133,7 @@ void grib_gribex_mode_on(grib_context* c);
 void grib_gribex_mode_off(grib_context* c);
 void grib_context_set_definitions_path(grib_context* c, const char* path);
 void grib_context_set_debug(grib_context* c, int mode);
+void grib_context_set_data_quality_checks(grib_context* c, int val);
 void grib_context_set_samples_path(grib_context* c, const char* path);
 void grib_multi_support_on(grib_context* c);
 void grib_multi_support_off(grib_context* c);
diff --git a/gribapi/gribapi.py b/gribapi/gribapi.py
@@ -2438,6 +2438,21 @@ def grib_set_debug(dmode):
     lib.grib_context_set_debug(context, dmode)
 
 
+@require(val=int)
+def grib_set_data_quality_checks(val):
+    """
+    @brief Enable/Disable GRIB data quality checks
+
+    @param val  0, 1 or 2
+                0 -> disable data quality checks
+                1 -> failure results in an error
+                2 -> failure results in a warning
+    """
+    assert val == 0 or val == 1 or val == 2
+    context = lib.grib_context_get_default()
+    lib.grib_context_set_data_quality_checks(context, val)
+
+
 @require(defs_path=str)
 def grib_set_definitions_path(defs_path):
     """
diff --git a/scripts/common.sh b/scripts/common.sh
@@ -14,7 +14,7 @@ GIT_ECBUILD=https://github.com/ecmwf/ecbuild.git
 ECBUILD_VERSION=master
 
 GIT_ECCODES=https://github.com/ecmwf/eccodes.git
-ECCODES_VERSION=2.40.1
+ECCODES_VERSION=2.41.0
 ECCODES_COMMON_CMAKE_OPTIONS="-DENABLE_PNG=1 -DENABLE_JPG=1 -DENABLE_NETCDF=0 -DENABLE_EXAMPLES=0"
 
 GIT_AEC=https://github.com/MathisRosenhauer/libaec.git
diff --git a/tests/test_eccodes.py b/tests/test_eccodes.py
@@ -55,6 +55,14 @@ def test_codes_set_debug():
     eccodes.codes_set_debug(0)
 
 
+def test_codes_set_data_quality_checks():
+    if eccodes.codes_get_api_version(int) < 24100:
+        pytest.skip("ecCodes version too old")
+    eccodes.codes_set_data_quality_checks(2)
+    eccodes.codes_set_data_quality_checks(1)
+    eccodes.codes_set_data_quality_checks(0)
+
+
 def test_codes_set_definitions_path():
     eccodes.codes_set_definitions_path(eccodes.codes_definition_path())
 
diff --git a/tests/test_highlevel.py b/tests/test_highlevel.py
@@ -166,8 +166,13 @@ def test_write_message(tmp_path):
             assert np.all(message1.data == message2.data)
 
 
-def test_message_from_samples():
+def test_grib_message_from_samples():
     message = eccodes.GRIBMessage.from_samples("regular_ll_sfc_grib2")
     assert message["edition"] == 2
     assert message["gridType"] == "regular_ll"
     assert message["levtype"] == "sfc"
+
+
+def test_bufr_message_from_samples():
+    message = eccodes.BUFRMessage.from_samples("BUFR4")
+    assert message["edition"] == 4

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-from .message import GRIBMessage, Message # noqa`
	`1`	`+from .message import BUFRMessage, GRIBMessage, Message # noqa`
`2`	`2`	`from .reader import FileReader, MemoryReader, StreamReader # noqa`