Replace isort with ruff (SciTools#5633)

* Replace isort with ruff * ruff isort changes * add whatsnew entry * remove tool.isort configuration
stephenworsley · Dec 13, 2023 · 2b764a3 · 2b764a3
1 parent 0cdead6
commit 2b764a3
Show file tree

Hide file tree

Showing 13 changed files with 17 additions and 34 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -55,13 +55,6 @@ repos:
     -   id: flake8
         types: [file, python]
 
--   repo: https://github.com/pycqa/isort
-    rev: 5.13.0
-    hooks:
-    -   id: isort
-        types: [file, python]
-        args: [--filter-files]
-
 -   repo: https://github.com/asottile/blacken-docs
     rev: 1.16.0
     hooks:

diff --git a/.ruff.toml b/.ruff.toml
@@ -17,10 +17,6 @@ lint.ignore = [
     # https://docs.astral.sh/ruff/rules/#mccabe-c90
     "C90",
 
-    # isort (I)
-    # https://docs.astral.sh/ruff/rules/#isort-i
-    "I",
-
     # pep8-naming (N)
     # https://docs.astral.sh/ruff/rules/#pep8-naming-n
     "N",

diff --git a/benchmarks/benchmarks/cperf/equality.py b/benchmarks/benchmarks/cperf/equality.py
@@ -5,8 +5,8 @@
 """
 Equality benchmarks for the CPerf scheme of the UK Met Office's NG-VAT project.
 """
-from . import SingleDiagnosticMixin
 from .. import on_demand_benchmark
+from . import SingleDiagnosticMixin
 
 
 class EqualityMixin(SingleDiagnosticMixin):

diff --git a/benchmarks/benchmarks/cperf/load.py b/benchmarks/benchmarks/cperf/load.py
@@ -5,8 +5,8 @@
 """
 File loading benchmarks for the CPerf scheme of the UK Met Office's NG-VAT project.
 """
-from . import SingleDiagnosticMixin
 from .. import on_demand_benchmark
+from . import SingleDiagnosticMixin
 
 
 @on_demand_benchmark

diff --git a/benchmarks/benchmarks/cperf/save.py b/benchmarks/benchmarks/cperf/save.py
@@ -8,9 +8,9 @@
 
 from iris import save
 
-from . import _N_CUBESPHERE_UM_EQUIVALENT, _UM_DIMS_YX
 from .. import TrackAddedMemoryAllocation, on_demand_benchmark
 from ..generate_data.ugrid import make_cube_like_2d_cubesphere, make_cube_like_umfield
+from . import _N_CUBESPHERE_UM_EQUIVALENT, _UM_DIMS_YX
 
 
 @on_demand_benchmark

diff --git a/benchmarks/benchmarks/sperf/equality.py b/benchmarks/benchmarks/sperf/equality.py
@@ -5,8 +5,8 @@
 """
 Equality benchmarks for the SPerf scheme of the UK Met Office's NG-VAT project.
 """
-from . import FileMixin
 from .. import on_demand_benchmark
+from . import FileMixin
 
 
 @on_demand_benchmark

diff --git a/benchmarks/benchmarks/sperf/load.py b/benchmarks/benchmarks/sperf/load.py
@@ -5,8 +5,8 @@
 """
 File loading benchmarks for the SPerf scheme of the UK Met Office's NG-VAT project.
 """
-from . import FileMixin
 from .. import on_demand_benchmark
+from . import FileMixin
 
 
 @on_demand_benchmark

diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc
@@ -32,6 +32,7 @@
 .. _pull requests: https://github.com/SciTools/iris/pulls
 .. _Read the Docs: https://scitools-iris.readthedocs.io/en/latest/
 .. _readthedocs.yml: https://github.com/SciTools/iris/blob/main/requirements/readthedocs.yml
+.. _ruff: https://github.com/astral-sh/ruff
 .. _SciTools: https://github.com/SciTools
 .. _scitools-iris: https://pypi.org/project/scitools-iris/
 .. _sphinx: https://www.sphinx-doc.org/en/master/

diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
@@ -96,6 +96,7 @@ This document explains the changes made to Iris for this release
    lazy data from file. This will also speed up coordinate comparison.
    (:pull:`5610`)
 
+
 🔥 Deprecations
 ===============
 
@@ -134,6 +135,7 @@ This document explains the changes made to Iris for this release
 
 #. `@bouweandela`_ updated all hyperlinks to https. (:pull:`5621`)
 
+
 💼 Internal
 ===========
 
@@ -175,6 +177,8 @@ This document explains the changes made to Iris for this release
 #. `@bjlittle`_ configured the ``line-length = 88`` for `black`_, `isort`_
    and `ruff`_. (:pull:`5632`)
 
+#. `@bjlittle`_ replaced `isort`_ with `ruff`_. (:pull:`5633`)
+
 
 .. comment
     Whatsnew author names (@github name) in alphabetical order. Note that,
@@ -190,5 +194,4 @@ This document explains the changes made to Iris for this release
 
 .. _NEP29 Drop Schedule: https://numpy.org/neps/nep-0029-deprecation_policy.html#drop-schedule
 .. _codespell: https://github.com/codespell-project/codespell
-.. _ruff: https://github.com/astral-sh/ruff
 .. _split attributes project: https://github.com/orgs/SciTools/projects/5?pane=info
diff --git a/lib/iris/common/resolve.py b/lib/iris/common/resolve.py
@@ -19,8 +19,8 @@
 from dask.array.core import broadcast_shapes
 import numpy as np
 
-from . import LENIENT
 from ..config import get_logger
+from . import LENIENT
 
 __all__ = ["Resolve"]
 

diff --git a/lib/iris/tests/experimental/test_raster.py b/lib/iris/tests/experimental/test_raster.py
@@ -4,8 +4,8 @@
 # See LICENSE in the root of the repository for full licensing details.
 
 import iris.tests as tests  # isort:skip
-import PIL.Image
 import numpy as np
+import PIL.Image
 
 import iris
 

diff --git a/lib/iris/tests/graphics/__init__.py b/lib/iris/tests/graphics/__init__.py
@@ -129,8 +129,8 @@ def repos_equal(repo1: Dict[str, str], repo2: Dict[str, str]) -> bool:
 
 
 def get_phash(input: Path) -> str:
-    from PIL import Image
     import imagehash
+    from PIL import Image
 
     return imagehash.phash(Image.open(input), hash_size=HASH_SIZE)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -89,6 +89,10 @@ ignore = [
         "ALL",
     ]
 
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["iris"]
+
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"
 
@@ -125,20 +129,6 @@ extend-exclude = '''
 )
 '''
 
-[tool.isort]
-force_sort_within_sections = "True"
-known_first_party = "iris"
-line_length = 88
-profile = "black"
-extend_skip = [
-  "_build",
-  "generated",
-  "sphinxext",
-  "tools",
-]
-skip_gitignore = "True"
-verbose = "False"
-
 [tool.pytest.ini_options]
 addopts = "-ra"
 testpaths = "lib/iris"