chore: switch to ruff, misc linting fixes (#145)

* switch to Ruff from black, isort, pylint, flake8 * apply some fixes recommended by ruff's linter * reformat python files with ruff's default ruleset * add ruff lint rule npy201
MODFLOW-USGS · Mar 11, 2024 · 70cce0e · 70cce0e
1 parent 5c0ee37
commit 70cce0e
Show file tree

Hide file tree

Showing 15 changed files with 120 additions and 202 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,21 +30,10 @@ jobs:
           cache-dependency-path: pyproject.toml
 
       - name: Install Python packages
-        run: |
-          pip install .
-          pip install ".[lint]"
-
-      - name: Run isort
-        run: isort --verbose --check --diff modflow_devtools
-
-      - name: Run black
-        run: black --check --diff modflow_devtools
+        run: pip install ".[lint]"
 
-      - name: Run flake8
-        run: flake8 --count --show-source --exit-zero modflow_devtools
-
-      - name: Run pylint
-        run: pylint --jobs=0 --errors-only --exit-zero modflow_devtools
+      - name: Run ruff
+        run: ruff check .
 
   build:
     name: Build
@@ -139,28 +128,29 @@ jobs:
 
       - name: Install Python packages
         working-directory: modflow-devtools
-        run: |
-          pip install .
-          pip install ".[test]"
+        run: pip install ".[test]"
 
       - name: Cache modflow6 examples
+        if: matrix.python != 3.8
         id: cache-examples
         uses: actions/cache@v3
         with:
           path: modflow6-examples/examples
           key: modflow6-examples-${{ hashFiles('modflow6-examples/data/**') }}
 
       - name: Install extra Python packages
+        if: matrix.python != 3.8
         working-directory: modflow6-examples/etc
         run: |
           pip install -r requirements.pip.txt
           pip install -r requirements.usgs.txt
 
       - name: Update FloPy packages
+        if: matrix.python != 3.8
         run: python -m flopy.mf6.utils.generate_classes --ref develop --no-backup
 
       - name: Build modflow6 example models
-        if: steps.cache-examples.outputs.cache-hit != 'true'
+        if: matrix.python != 3.8 && steps.cache-examples.outputs.cache-hit != 'true'
         working-directory: modflow6-examples/autotest
         run: pytest -v -n auto test_scripts.py --init
 

diff --git a/autotest/test_build.py b/autotest/test_build.py
@@ -16,9 +16,7 @@
 _system = platform.system()
 _exe_ext = ".exe" if _system == "Windows" else ""
 _lib_ext = (
-    ".so"
-    if _system == "Linux"
-    else (".dylib" if _system == "Darwin" else ".dll")
+    ".so" if _system == "Linux" else (".dylib" if _system == "Darwin" else ".dll")
 )
 
 

diff --git a/autotest/test_download.py b/autotest/test_download.py
@@ -21,9 +21,7 @@
 @pytest.mark.parametrize("retries", [-1, 0, 1.5])
 def test_get_releases_bad_params(per_page, retries):
     with pytest.raises(ValueError):
-        get_releases(
-            "executables", per_page=per_page, retries=retries, verbose=True
-        )
+        get_releases("executables", per_page=per_page, retries=retries, verbose=True)
 
 
 @flaky
@@ -109,9 +107,7 @@ def test_download_and_unzip(function_tmpdir, delete_zip):
     zip_name = "mf6.3.0_linux.zip"
     dir_name = zip_name.replace(".zip", "")
     url = f"https://github.com/MODFLOW-USGS/modflow6/releases/download/6.3.0/{zip_name}"
-    download_and_unzip(
-        url, function_tmpdir, delete_zip=delete_zip, verbose=True
-    )
+    download_and_unzip(url, function_tmpdir, delete_zip=delete_zip, verbose=True)
 
     assert (function_tmpdir / zip_name).is_file() != delete_zip
 

diff --git a/autotest/test_fixtures.py b/autotest/test_fixtures.py
@@ -39,8 +39,7 @@ def test_function_scoped_tmpdir_slash_in_name(function_tmpdir, name):
     replaced1 = name.replace("/", "_").replace("\\", "_").replace(":", "_")
     replaced2 = name.replace("/", "_").replace("\\", "__").replace(":", "_")
     assert (
-        f"{inspect.currentframe().f_code.co_name}[{replaced1}]"
-        in function_tmpdir.stem
+        f"{inspect.currentframe().f_code.co_name}[{replaced1}]" in function_tmpdir.stem
         or f"{inspect.currentframe().f_code.co_name}[{replaced2}]"
         in function_tmpdir.stem
     )
@@ -144,9 +143,7 @@ def test_keep_class_scoped_tmpdir(tmp_path, arg):
     ]
     assert pytest.main(args) == ExitCode.OK
     assert Path(
-        tmp_path
-        / f"{TestKeepClassScopedTmpdirInner.__name__}0"
-        / test_keep_fname
+        tmp_path / f"{TestKeepClassScopedTmpdirInner.__name__}0" / test_keep_fname
     ).is_file()
 
 
@@ -165,9 +162,7 @@ def test_keep_module_scoped_tmpdir(tmp_path, arg):
     ]
     assert pytest.main(args) == ExitCode.OK
     this_path = Path(__file__)
-    keep_path = (
-        tmp_path / f"{str(this_path.parent.name)}.{str(this_path.stem)}0"
-    )
+    keep_path = tmp_path / f"{str(this_path.parent.name)}.{str(this_path.stem)}0"
     assert test_keep_fname in [f.name for f in keep_path.glob("*")]
 
 
@@ -206,9 +201,7 @@ def test_keep_failed_function_scoped_tmpdir(function_tmpdir, keep):
         args += ["--keep-failed", function_tmpdir]
     assert pytest.main(args) == ExitCode.TESTS_FAILED
 
-    kept_file = Path(
-        function_tmpdir / f"{inner_fn}0" / test_keep_fname
-    ).is_file()
+    kept_file = Path(function_tmpdir / f"{inner_fn}0" / test_keep_fname).is_file()
     assert kept_file if keep else not kept_file
 
 

diff --git a/autotest/test_markers.py b/autotest/test_markers.py
@@ -3,17 +3,32 @@
 from shutil import which
 
 from packaging.version import Version
-
-from modflow_devtools.markers import *
+import pytest
+
+from modflow_devtools.markers import (
+    requires_exe,
+    require_exe,
+    requires_program,
+    require_program,
+    requires_pkg,
+    require_package,
+    requires_platform,
+    require_platform,
+    excludes_platform,
+    requires_python,
+    require_python,
+)
 
 exe = "pytest"
+pkg = exe
 
 
 @requires_exe(exe)
 def test_require_exe():
     assert which(exe)
     require_exe(exe)
     require_program(exe)
+    requires_program(exe)
 
 
 exes = [exe, "python"]
@@ -24,14 +39,15 @@ def test_require_exe_multiple():
     assert all(which(exe) for exe in exes)
 
 
-@requires_pkg("pytest")
+@requires_pkg(pkg)
 def test_requires_pkg():
     import numpy
 
     assert numpy is not None
+    require_package(pkg)
 
 
-@requires_pkg("pytest", "pluggy")
+@requires_pkg(pkg, "pluggy")
 def test_requires_pkg_multiple():
     import pluggy
     import pytest
@@ -42,6 +58,7 @@ def test_requires_pkg_multiple():
 @requires_platform("Windows")
 def test_requires_platform():
     assert system() == "Windows"
+    require_platform("Windows")
 
 
 @excludes_platform("Darwin", ci_only=True)
@@ -57,3 +74,4 @@ def test_requires_platform_ci_only():
 def test_requires_python(version):
     if Version(py_ver) >= Version(version):
         assert requires_python(version)
+        assert require_python(version)
diff --git a/autotest/test_misc.py b/autotest/test_misc.py
@@ -49,9 +49,7 @@ def test_set_env():
     _repos_path = Path(__file__).parent.parent.parent.parent
 _repos_path = Path(_repos_path).expanduser().absolute()
 _testmodels_repo_path = _repos_path / "modflow6-testmodels"
-_testmodels_repo_paths_mf6 = sorted(
-    list((_testmodels_repo_path / "mf6").glob("test*"))
-)
+_testmodels_repo_paths_mf6 = sorted(list((_testmodels_repo_path / "mf6").glob("test*")))
 _testmodels_repo_paths_mf5to6 = sorted(
     list((_testmodels_repo_path / "mf5to6").glob("test*"))
 )
@@ -60,9 +58,7 @@ def test_set_env():
 _examples_repo_path = _repos_path / "modflow6-examples"
 _examples_path = _examples_repo_path / "examples"
 _example_paths = (
-    sorted(list(_examples_path.glob("ex-*")))
-    if _examples_path.is_dir()
-    else []
+    sorted(list(_examples_path.glob("ex-*"))) if _examples_path.is_dir() else []
 )
 
 
@@ -150,9 +146,7 @@ def get_expected_namefiles(path, pattern="mfsim.nam") -> List[Path]:
     return sorted(list(set(folders)))
 
 
-@pytest.mark.skipif(
-    not any(_example_paths), reason="modflow6-examples repo not found"
-)
+@pytest.mark.skipif(not any(_example_paths), reason="modflow6-examples repo not found")
 def test_get_model_paths_examples():
     expected_paths = get_expected_model_dirs(_examples_path)
     paths = get_model_paths(_examples_path)
@@ -193,9 +187,7 @@ def test_get_model_paths_exclude_patterns(models):
     assert len(paths) >= expected_count
 
 
-@pytest.mark.skipif(
-    not any(_example_paths), reason="modflow6-examples repo not found"
-)
+@pytest.mark.skipif(not any(_example_paths), reason="modflow6-examples repo not found")
 def test_get_namefile_paths_examples():
     expected_paths = get_expected_namefiles(_examples_path)
     paths = get_namefile_paths(_examples_path)
@@ -287,9 +279,9 @@ def test_get_env():
     assert get_env("NO_VALUE") is None
 
     with set_env(TEST_VALUE=str(True)):
-        assert get_env("NO_VALUE", True) == True
-        assert get_env("TEST_VALUE") == True
-        assert get_env("TEST_VALUE", default=False) == True
+        assert get_env("NO_VALUE", True)
+        assert get_env("TEST_VALUE")
+        assert get_env("TEST_VALUE", default=False)
         assert get_env("TEST_VALUE", default=1) == 1
 
     with set_env(TEST_VALUE=str(1)):
@@ -302,4 +294,4 @@ def test_get_env():
         assert get_env("NO_VALUE", 1.1) == 1.1
         assert get_env("TEST_VALUE") == 1.1
         assert get_env("TEST_VALUE", default=2.1) == 1.1
-        assert get_env("TEST_VALUE", default=False) == False
+        assert not get_env("TEST_VALUE", default=False)