Merge pull request #687 from jarrodmillman/ruff

Add linter

.coveragerc

@@ -10,4 +10,4 @@ omit =
     */pywt/data/create_dat.py
     *.pxd
     stringsource
-plugins = Cython.Coverage
+plugins = Cython.Coverage

.git-blame-ignore-revs

@@ -1,3 +1,5 @@
 # .git-blame-ignore-revs
 # Applied codespell to the codebase
 5ce73c91800829950474aaa4f4036b2a589a2418
+d531f668d60503d55387d7d0ffae4afd199c5f80
+bb1d1888fd63381ce35805e0cb3623a8bd47163c

.github/workflows/emscripten.yml

@@ -27,7 +27,7 @@ jobs:
         id: setup-python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.11.2'
+          python-version: "3.11.2"
 
       - name: Install prerequisites
         run: |
@@ -43,7 +43,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: '18'
+          node-version: "18"
 
       - name: Build PyWavelets
         run: |

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: style
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install packages
+        run: |
+          pip install --upgrade pip
+          pip install pre-commit
+          pip list
+
+      - name: Lint
+        run: pre-commit run --all-files --show-diff-on-failure --color always

.github/workflows/tests.yml

@@ -11,7 +11,6 @@ on:
       - v1.**
 
 jobs:
-
   test_pywavelets_linux:
     name: linux-cp${{ matrix.python-version }}-${{ matrix.OPTIONS_NAME }}
     runs-on: ubuntu-latest
@@ -27,7 +26,7 @@ jobs:
       # Ensure that a wheel builder finishes even if another fails
       fail-fast: false
       matrix:
-        python-version: [3.9, '3.10', '3.11', '3.12']
+        python-version: [3.9, "3.10", "3.11", "3.12"]
         MINIMUM_REQUIREMENTS: [0]
         USE_SCIPY: [0]
         USE_SDIST: [0]
@@ -48,7 +47,7 @@ jobs:
             USE_SDIST: 1
             OPTIONS_NAME: "install-from-sdist"
           - platform_id: manylinux_x86_64
-            python-version: '3.12'
+            python-version: "3.12"
             PIP_FLAGS: "--pre"
             OPTIONS_NAME: "pre-releases"
 
@@ -64,32 +63,32 @@ jobs:
 
       - name: Build package
         env:
-            VERSION: ${{ matrix.python-version }}
-            MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }}
-            PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
-            USE_SDIST: ${{ matrix.USE_SDIST }}
-            USE_SCIPY: ${{ matrix.USE_SCIPY }}
-            REFGUIDE_CHECK:  ${{ matrix.REFGUIDE_CHECK }}
+          VERSION: ${{ matrix.python-version }}
+          MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }}
+          PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
+          USE_SDIST: ${{ matrix.USE_SDIST }}
+          USE_SCIPY: ${{ matrix.USE_SCIPY }}
+          REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
         run: |
-            uname -a
-            df -h
-            ulimit -a
-            # ccache -s
-            which python
-            python --version
-            # sudo apt-get install libatlas-base-dev
-            pip install --upgrade pip build
-            # Set numpy version first, other packages link against it
-            if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then
-                pip install ${CYTHON_MIN}
-                pip install ${NUMPY_MIN}
-                if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi
-            else
-                pip install ${PIP_FLAGS} cython
-                pip install ${PIP_FLAGS} numpy
-                if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi
-            fi
-            pip install ${PIP_FLAGS} matplotlib pytest
+          uname -a
+          df -h
+          ulimit -a
+          # ccache -s
+          which python
+          python --version
+          # sudo apt-get install libatlas-base-dev
+          pip install --upgrade pip build
+          # Set numpy version first, other packages link against it
+          if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then
+              pip install ${CYTHON_MIN}
+              pip install ${NUMPY_MIN}
+              if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi
+          else
+              pip install ${PIP_FLAGS} cython
+              pip install ${PIP_FLAGS} numpy
+              if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi
+          fi
+          pip install ${PIP_FLAGS} matplotlib pytest
 
             set -o pipefail
             if [ "${USE_SDIST}" == "1" ]; then
@@ -104,22 +103,21 @@ jobs:
 
       - name: Run tests
         env:
-            USE_SDIST: ${{ matrix.USE_SDIST }}
-            REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
+          USE_SDIST: ${{ matrix.USE_SDIST }}
+          REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
         run: |
-            set -o pipefail
-            # Move out of source directory to avoid finding local pywt
-            pushd demo
-            if [ "${USE_SDIST}" == "1" ]; then
-                pytest --pyargs pywt
-                python ../pywt/tests/test_doc.py
-            elif [ "${REFGUIDE_CHECK}" == "1" ]; then
-                python util/refguide_check.py --doctests
-            else
-                pytest --pyargs pywt
-            fi
-            popd
-
+          set -o pipefail
+          # Move out of source directory to avoid finding local pywt
+          pushd demo
+          if [ "${USE_SDIST}" == "1" ]; then
+              pytest --pyargs pywt
+              python ../pywt/tests/test_doc.py
+          elif [ "${REFGUIDE_CHECK}" == "1" ]; then
+              python util/refguide_check.py --doctests
+          else
+              pytest --pyargs pywt
+          fi
+          popd
 
   test_pywavelets_macos:
     name: macos-cp${{ matrix.python-version }}-${{ matrix.OPTIONS_NAME }}
@@ -136,18 +134,18 @@ jobs:
       # Ensure that a wheel builder finishes even if another fails
       fail-fast: false
       matrix:
-        python-version: [3.9, '3.12']
+        python-version: [3.9, "3.12"]
         MINIMUM_REQUIREMENTS: [0]
         USE_SCIPY: [0]
         USE_SDIST: [0]
         REFGUIDE_CHECK: [0]
         PIP_FLAGS: [""]
         OPTIONS_NAME: ["default"]
         include:
-          - python-version: '3.9'
+          - python-version: "3.9"
             MINIMUM_REQUIREMENTS: 1
             OPTIONS_NAME: "osx-minimum-req"
-          - python-version: '3.12'
+          - python-version: "3.12"
             PIP_FLAGS: "--pre"
             OPTIONS_NAME: "pre-releases"
 
@@ -163,30 +161,30 @@ jobs:
 
       - name: Build package
         env:
-            VERSION: ${{ matrix.python-version }}
-            MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }}
-            PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
-            USE_SDIST: ${{ matrix.USE_SDIST }}
-            USE_SCIPY: ${{ matrix.USE_SCIPY }}
-            REFGUIDE_CHECK:  ${{ matrix.REFGUIDE_CHECK }}
-            CC: /usr/bin/clang
-            CXX: /usr/bin/clang++
+          VERSION: ${{ matrix.python-version }}
+          MINIMUM_REQUIREMENTS: ${{ matrix.MINIMUM_REQUIREMENTS }}
+          PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
+          USE_SDIST: ${{ matrix.USE_SDIST }}
+          USE_SCIPY: ${{ matrix.USE_SCIPY }}
+          REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
+          CC: /usr/bin/clang
+          CXX: /usr/bin/clang++
         run: |
-            uname -a
-            df -h
-            ulimit -a
-            which python
-            python --version
-            pip install --upgrade pip build
-            # Set numpy version first, other packages link against it
-            if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then
-                pip install ${CYTHON_MIN} ${NUMPY_MIN}
-                if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi
-            else
-                pip install ${PIP_FLAGS} cython numpy
-                if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi
-            fi
-            pip install ${PIP_FLAGS} matplotlib pytest
+          uname -a
+          df -h
+          ulimit -a
+          which python
+          python --version
+          pip install --upgrade pip build
+          # Set numpy version first, other packages link against it
+          if [ "${MINIMUM_REQUIREMENTS}" == "1" ]; then
+              pip install ${CYTHON_MIN} ${NUMPY_MIN}
+              if [ "${USE_SCIPY}" == "1" ]; then pip install ${SCIPY_MIN}; fi
+          else
+              pip install ${PIP_FLAGS} cython numpy
+              if [ "${USE_SCIPY}" == "1" ]; then pip install ${PIP_FLAGS} scipy; fi
+          fi
+          pip install ${PIP_FLAGS} matplotlib pytest
 
             set -o pipefail
             if [ "${USE_SDIST}" == "1" ]; then
@@ -201,18 +199,18 @@ jobs:
 
       - name: Run tests
         env:
-            PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
-            USE_SDIST: ${{ matrix.USE_SDIST }}
-            REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
+          PIP_FLAGS: ${{ matrix.PIP_FLAGS }}
+          USE_SDIST: ${{ matrix.USE_SDIST }}
+          REFGUIDE_CHECK: ${{ matrix.REFGUIDE_CHECK }}
         run: |
-            # Move out of source directory to avoid finding local pywt
-            pushd demo
-            if [ "${USE_SDIST}" == "1" ]; then
-                pytest --pyargs pywt
-                python ../pywt/tests/test_doc.py
-            elif [ "${REFGUIDE_CHECK}" == "1" ]; then
-                python util/refguide_check.py --doctests
-            else
-                pytest --pyargs pywt
-            fi
-            popd
+          # Move out of source directory to avoid finding local pywt
+          pushd demo
+          if [ "${USE_SDIST}" == "1" ]; then
+              pytest --pyargs pywt
+              python ../pywt/tests/test_doc.py
+          elif [ "${REFGUIDE_CHECK}" == "1" ]; then
+              python util/refguide_check.py --doctests
+          else
+              pytest --pyargs pywt
+          fi
+          popd