Use ruff for linting instead of pycodestyle (#344)

* fix README.rst * Set up ruff * Fix ruff errors * Use ruff instead of pycodestyle in workflow * Update GitHub actions * Use f-string
carnisj · Jan 30, 2024 · 1eb5dfe · 1eb5dfe
1 parent 96e5af7
commit 1eb5dfe
Show file tree

Hide file tree

Showing 151 changed files with 455 additions and 838 deletions.
diff --git a/.github/workflows/pr_lint_test.yml b/.github/workflows/pr_lint_test.yml
@@ -19,9 +19,9 @@ jobs:
         python-version: ['3.9', '3.11']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -34,7 +34,7 @@ jobs:
 
     - name: Cache dependencies
       id: myCache
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{env.LD_LIBRARY_PATH}}/python${{ matrix.python-version }}/site-packages
         key: ${{ runner.os }}-pip-v0-${{ hashFiles('**/requirements.txt') }}
@@ -53,8 +53,8 @@ jobs:
     - name: Check imports with isort
       run: python -m isort --profile black bcdi
 
-    - name: Lint with pycodestyle
-      run: python -m pycodestyle bcdi --max-line-length=88  --ignore=E24,E121,E123,E126,E203,E226,E704,W503
+    - name: Lint with ruff
+      run: python -m ruff check .
 
     - name: Check docstrings with pydocstyle
       run: python -m pydocstyle bcdi --ignore=D102,D107,D212,D203

diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 .. image:: https://readthedocs.org/projects/bcdi/badge/?version=latest
    :target: https://bcdi.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
-.. image:: https://img.shields.io/github/actions/workflow/status/carnisj/bcdi/python-package-3.10.yml?logo=GitHub
+.. image:: https://img.shields.io/github/actions/workflow/status/carnisj/bcdi/pr_lint_test.yml?logo=GitHub
    :alt: GitHub Workflow Status
 .. image:: https://deepsource.io/gh/carnisj/bcdi.svg/?label=active+issues&show_trend=true&token=N3Z0cklmQrG8kzZOVwGJhLd9
 .. image:: https://img.shields.io/pypi/pyversions/bcdi?logo=PyPI&logoColor=%23FFFF00

diff --git a/bcdi/__init__.py b/bcdi/__init__.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE
@@ -10,6 +8,11 @@
 
 from subprocess import PIPE, Popen
 
+try:  # for P10, hdf5plugin should be imported before h5py or PyTables
+    import hdf5plugin  # noqa: F401
+except ModuleNotFoundError:
+    pass
+
 
 def get_git_version() -> str:
     """

diff --git a/bcdi/algorithms/__init__.py b/bcdi/algorithms/__init__.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/algorithms/algorithms_utils.py b/bcdi/algorithms/algorithms_utils.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/constants.py b/bcdi/constants.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/examples/__init__.py b/bcdi/examples/__init__.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/experiment/beamline.py b/bcdi/experiment/beamline.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/experiment/beamline_factory.py b/bcdi/experiment/beamline_factory.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/experiment/detector.py b/bcdi/experiment/detector.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE

diff --git a/bcdi/experiment/diffractometer.py b/bcdi/experiment/diffractometer.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # BCDI: tools for pre(post)-processing Bragg coherent X-ray diffraction imaging data
 #   (c) 07/2017-06/2019 : CNRS UMR 7344 IM2NP
 #   (c) 07/2019-05/2021 : DESY PHOTON SCIENCE