Merge pull request #439 from observingClouds/maint/precommit

iainrussell · web-flow · commit a1714e0d29e5 · 2025-12-03T16:01:29.000Z
Setup pre-commit hooks and apply linters
diff --git a/.github/workflows/cd-pypi.yml b/.github/workflows/cd-pypi.yml
@@ -8,4 +8,4 @@ on:
 jobs:
   deploy:
     uses: ecmwf/reusable-workflows/.github/workflows/cd-pypi.yml@v2
-    secrets: inherit
+    secrets: inherit
diff --git a/.github/workflows/label-public-pr.yml b/.github/workflows/label-public-pr.yml
@@ -1,10 +1,10 @@
 # Manage labels of pull requests that originate from forks
 name: label-public-pr
- 
+
 on:
   pull_request_target:
     types: [opened, synchronize]
- 
+
 jobs:
   label:
     uses: ecmwf/reusable-workflows/.github/workflows/label-pr.yml@v2
diff --git a/.gitignore b/.gitignore
@@ -82,4 +82,4 @@ tests/sample-data/cds*.nc
 _dev
 
 # mac
-.DS_Store
+.DS_Store
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,24 @@
+repos:
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: check-json
+      - id: check-yaml
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.2
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - attrs
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 25.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/isort
+    rev: 7.0.0
+    hooks:
+      - id: isort
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,13 @@
 Changelog for cfgrib
 ====================
 
+unreleased
+----------
+
+- Setup and apply linters via pre-commit.
+  See `#439 <https://github.com/ecmwf/cfgrib/pull/439>`_.
+
+
 0.9.15.1 (2025-09-30)
 ---------------------
 
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -8,7 +8,7 @@ Contributing
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
 
-Please note, that we have hooked a CLA assistant to this GitHub Repo. Please accept the contributors license agreement to allow us to keep a legal track of contributions and keep this package open source for the future.  
+Please note, that we have hooked a CLA assistant to this GitHub Repo. Please accept the contributors license agreement to allow us to keep a legal track of contributions and keep this package open source for the future.
 
 You can contribute in many ways:
 
diff --git a/appveyor.yml b/appveyor.yml
@@ -14,4 +14,4 @@ install:
 build: false
 
 test_script:
-  - "echo Pass"
+  - "echo Pass"
diff --git a/cfgrib/abc.py b/cfgrib/abc.py
@@ -1,4 +1,5 @@
 """Abstract Base Classes for GRIB fields and fieldsets"""
+
 import abc
 import typing as T
 
diff --git a/cfgrib/cfmessage.py b/cfgrib/cfmessage.py
@@ -97,7 +97,9 @@ def from_grib_step(message, step_key="endStep:int", step_unit_key="stepUnits:int
     return int(message[step_key]) * to_seconds / 3600.0
 
 
-def to_grib_step(message, step_ns, step_unit=1, step_key="endStep:int", step_unit_key="stepUnits:int"):
+def to_grib_step(
+    message, step_ns, step_unit=1, step_key="endStep:int", step_unit_key="stepUnits:int"
+):
     # type: (abc.MutableField, int, int, str, str) -> None
     step_s = step_ns * 1e-9
     to_seconds = GRIB_STEP_UNITS_TO_SECONDS[step_unit]
@@ -172,8 +174,12 @@ def build_valid_time(time, step):
         functools.partial(to_grib_date_time, date_key="indexingDate", time_key="indexingTime"),
     ),
     "valid_month": (
-        functools.partial(from_grib_date_time, date_key="monthlyVerificationDate", time_key="validityTime"),
-        functools.partial(to_grib_date_time, date_key="monthlyVerificationDate", time_key="validityTime"),
+        functools.partial(
+            from_grib_date_time, date_key="monthlyVerificationDate", time_key="validityTime"
+        ),
+        functools.partial(
+            to_grib_date_time, date_key="monthlyVerificationDate", time_key="validityTime"
+        ),
     ),
 }  # type: messages.ComputedKeysType
 
diff --git a/cfgrib/dataset.py b/cfgrib/dataset.py
@@ -45,7 +45,7 @@
     "stepUnits",
     "stepType",
     "gridType",
-    "uvRelativeToGrid"
+    "uvRelativeToGrid",
 ]
 
 EXTRA_DATA_ATTRIBUTES_KEYS = [
@@ -507,7 +507,9 @@ def build_variable_components(
     extra_attrs = read_data_var_attrs(first, extra_keys)
     data_var_attrs.update(**extra_attrs)
     coords_map = encode_cf_first(
-        data_var_attrs, encode_cf, time_dims,
+        data_var_attrs,
+        encode_cf,
+        time_dims,
     )
     coord_name_key_map = {}
     coord_vars = {}
@@ -689,7 +691,7 @@ def build_dataset_components(
             " be decoded as datetime objects:\n"
             f"{ALL_REF_TIME_KEYS}"
         )
-    
+
     for param_id in index.get("paramId", []):
         var_index = index.subindex(paramId=param_id)
         try:
@@ -825,5 +827,7 @@ def open_file(
     path = os.fspath(path)
     stream = messages.FileStream(path, errors=errors)
     index_keys = compute_index_keys(time_dims, extra_coords)
-    index = open_fileindex(stream, indexpath, index_keys, ignore_keys=ignore_keys, filter_by_keys=filter_by_keys)
+    index = open_fileindex(
+        stream, indexpath, index_keys, ignore_keys=ignore_keys, filter_by_keys=filter_by_keys
+    )
     return open_from_index(index, read_keys, time_dims, extra_coords, errors=errors, **kwargs)
diff --git a/ci/requirements-docs.in b/ci/requirements-docs.in
@@ -1,3 +1,3 @@
 Sphinx
 pytest-runner
-xarray
+xarray
diff --git a/ci/requirements-docs.yml b/ci/requirements-docs.yml
@@ -9,4 +9,3 @@ dependencies:
   - nomkl
   - sphinx
   - xarray
-
diff --git a/ci/requirements-py37.yml b/ci/requirements-py37.yml
@@ -18,4 +18,3 @@ dependencies:
   - typing
   - toolz
   - xarray
-
diff --git a/setup.cfg b/setup.cfg
@@ -2,8 +2,8 @@
 python-file-with-version = cfgrib/__init__.py
 create-wheel = yes
 
-# exclude xarray_plugin for now
 [mypy]
+exclude = cfgrib/xarray_plugin.py
 
 [mypy-cfgrib.xarray_plugin]
 ignore_errors = True
diff --git a/tests/test_30_dataset.py b/tests/test_30_dataset.py
@@ -136,9 +136,12 @@ def test_build_dataset_components_ignore_keys() -> None:
     stream = messages.FileStream(TEST_DATA_UKMO, "warn")
     index = dataset.open_fileindex(stream, messages.DEFAULT_INDEXPATH, dataset.INDEX_KEYS)
     assert "subCentre" in index.index_keys
-    index = dataset.open_fileindex(stream, messages.DEFAULT_INDEXPATH, dataset.INDEX_KEYS, ignore_keys=["subCentre"])
+    index = dataset.open_fileindex(
+        stream, messages.DEFAULT_INDEXPATH, dataset.INDEX_KEYS, ignore_keys=["subCentre"]
+    )
     assert "subCentre" not in index.index_keys
 
+
 def test_Dataset() -> None:
     res = dataset.open_file(TEST_DATA)
     assert "Conventions" in res.attributes
@@ -340,6 +343,7 @@ def test_open_fieldset_ignore_keys() -> None:
     res = dataset.open_fieldset(fieldset, ignore_keys="subCentre")
     assert "GRIB_subCentre" not in res.attributes
 
+
 def test_open_file() -> None:
     res = dataset.open_file(TEST_DATA)
 
diff --git a/tests/test_40_xarray_store.py b/tests/test_40_xarray_store.py
@@ -148,9 +148,9 @@ def test_open_datasets_different_step_types() -> None:
         print("Using the old shortName for Convective precipitation rate")
         cpr0 = res[0]["cprat"]
         cpr1 = res[1]["cprat"]
-    assert cpr0.attrs["GRIB_stepType"]   == "instant"
+    assert cpr0.attrs["GRIB_stepType"] == "instant"
     assert res[0].cfrzr.attrs["GRIB_stepType"] == "instant"
-    assert cpr1.attrs["GRIB_stepType"]   == "avg"
+    assert cpr1.attrs["GRIB_stepType"] == "avg"
     assert res[1].cfrzr.attrs["GRIB_stepType"] == "avg"
 
 
@@ -167,9 +167,9 @@ def test_open_datasets_different_step_types_zeros() -> None:
         print("Using the old shortName for Convective precipitation rate")
         cpr0 = res[0]["cprat"]
         cpr1 = res[1]["cprat"]
-    assert cpr0.attrs["GRIB_stepType"]   == "instant"
+    assert cpr0.attrs["GRIB_stepType"] == "instant"
     assert res[0].cfrzr.attrs["GRIB_stepType"] == "instant"
-    assert cpr1.attrs["GRIB_stepType"]   == "avg"
+    assert cpr1.attrs["GRIB_stepType"] == "avg"
     assert res[1].cfrzr.attrs["GRIB_stepType"] == "avg"
 
 
diff --git a/tests/test_50_sample_data.py b/tests/test_50_sample_data.py
@@ -123,9 +123,8 @@ def test_dataset_missing_field_values() -> None:
 
 
 def test_valid_month_time_dim() -> None:
-    
+
     test_file = os.path.join(SAMPLE_DATA_FOLDER, "cams-egg4-monthly.grib")
     ds = xr.open_dataset(test_file, time_dims=["valid_month"])
 
     assert "valid_month" in ds.dims
-
diff --git a/tests/test_50_xarray_plugin.py b/tests/test_50_xarray_plugin.py
@@ -169,7 +169,9 @@ def test_xr_open_dataset_file_missing_vals() -> None:
 
 def test_xr_open_dataset_coords_to_attributes() -> None:
     ds = xr.open_dataset(
-        TEST_DATA_MULTI_LEVTYPES, engine="cfgrib", coords_as_attributes=["surface", "depthBelowLandLayer"]
+        TEST_DATA_MULTI_LEVTYPES,
+        engine="cfgrib",
+        coords_as_attributes=["surface", "depthBelowLandLayer"],
     )
     assert "surface" not in ds.coords
     assert "depthBelowLandLayer" not in ds.coords

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Abstract Base Classes for GRIB fields and fieldsets"""`
	`2`	`+`
`2`	`3`	`import abc`
`3`	`4`	`import typing as T`
`4`	`5`