Function to query library features

Author: shahramn

CHANGELOG.rst

@@ -7,6 +7,7 @@ Changelog for eccodes-python
 
 - ECC-1790: Add codes_get_offset
 - ECC-1899: API function to allow setting debug level
+- Function to query library features
 
 
 1.7.1 (2024-06-19)

eccodes/eccodes.py

@@ -10,6 +10,9 @@
 #
 #
 from gribapi import (
+    CODES_FEATURES_ALL,
+    CODES_FEATURES_DISABLED,
+    CODES_FEATURES_ENABLED,
     CODES_PRODUCT_ANY,
     CODES_PRODUCT_BUFR,
     CODES_PRODUCT_GRIB,
@@ -44,6 +47,7 @@
     codes_dump,
     codes_extract_offsets,
     codes_extract_offsets_sizes,
+    codes_get_features,
     codes_get_gaussian_latitudes,
     codes_get_library_path,
     codes_get_version_info,
@@ -249,6 +253,9 @@
     "codes_definition_path",
     "codes_extract_offsets",
     "codes_extract_offsets_sizes",
+    "CODES_FEATURES_ALL",
+    "CODES_FEATURES_ENABLED",
+    "CODES_FEATURES_DISABLED",
     "codes_get_api_version",
     "codes_get_array",
     "codes_get_double_array",
@@ -273,6 +280,7 @@
     "codes_get_values",
     "codes_get_version_info",
     "codes_get",
+    "codes_get_features",
     "codes_grib_find_nearest_multiple",
     "codes_grib_find_nearest",
     "codes_grib_get_data",

gribapi/__init__.py

@@ -14,8 +14,8 @@
 from .gribapi import __version__, lib
 
 # The minimum recommended version for the ecCodes package
-min_recommended_version_str = "2.31.0"
-min_recommended_version_int = 23100
+min_recommended_version_str = "2.37.0"
+min_recommended_version_int = 23700
 
 if lib.grib_get_api_version() < min_recommended_version_int:
     import warnings

gribapi/grib_api.h

@@ -176,6 +176,9 @@ int parse_keyval_string(const char *grib_tool, char *arg, int values_required, i
 int grib_get_data(const grib_handle *h, double *lats, double *lons, double *values);
 int grib_get_gaussian_latitudes(long trunc, double* lats);
 
+int codes_is_feature_enabled(const char* feature);
+int codes_get_features(char* result, size_t* length, int select);
+
 /* EXPERIMENTAL */
 typedef struct codes_bufr_header {
     unsigned long message_offset;

gribapi/gribapi.py

@@ -70,6 +70,12 @@
 GRIB_NEAREST_SAME_DATA = 1 << 1
 GRIB_NEAREST_SAME_POINT = 1 << 2
 
+# Constants for feature selection
+CODES_FEATURES_ALL = 0
+CODES_FEATURES_ENABLED = 1
+CODES_FEATURES_DISABLED = 2
+
+
 # ECC-1029: Disable function-arguments type-checking unless
 # environment variable is defined and equal to 1
 enable_type_checks = os.environ.get("ECCODES_PYTHON_ENABLE_TYPE_CHECKS") == "1"
@@ -2644,6 +2650,23 @@ def codes_extract_offsets_sizes(filepath, product_kind, is_strict=True):
         i += 1
 
 
+@require(select=int)
+def codes_get_features(select=CODES_FEATURES_ALL):
+    """
+    @brief Get the list of library features.
+
+    @param select   One of CODES_FEATURES_ALL, CODES_FEATURES_ENABLED or CODES_FEATURES_DISABLED
+    @return         space-separated string of feature names
+    @exception CodesInternalError
+    """
+    ssize = 1024
+    result = ffi.new("char[]", ssize)
+    size_p = ffi.new("size_t *", ssize)
+    err = lib.codes_get_features(result, size_p, select)
+    GRIB_CHECK(err)
+    return ffi.string(result).decode(ENC)
+
+
 # -------------------------------
 # EXPERIMENTAL FEATURES
 # -------------------------------

tests/test_eccodes.py

@@ -80,6 +80,18 @@ def test_version_info():
     assert len(vinfo) == 2
 
 
+def test_codes_get_features():
+    if eccodes.codes_get_api_version(int) < 23700:
+        pytest.skip("ecCodes version too old")
+
+    features = eccodes.codes_get_features(eccodes.CODES_FEATURES_ALL)
+    print(f"\n\tAll features = {features}")
+    features = eccodes.codes_get_features(eccodes.CODES_FEATURES_DISABLED)
+    print(f"\tDisabled features = {features}")
+    features = eccodes.codes_get_features(eccodes.CODES_FEATURES_ENABLED)
+    print(f"\tEnabled features = {features}")
+
+
 def test_codes_is_defined():
     gid = eccodes.codes_grib_new_from_samples("sh_sfc_grib1")
     assert eccodes.codes_is_defined(gid, "JS")