Merge branch 'main' into dependabot/pip/coverage-7.5.3

pyvista · Jan 2, 2025 · bc0eab7 · bc0eab7
2 parents e67b679 + 43dfc3f
commit bc0eab7
Show file tree

Hide file tree

Showing 11 changed files with 305 additions and 337 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -1,24 +1,24 @@
 documentation:
-- any:
-  - changed-files:
-    - any-glob-to-any-file: 'doc/**/*'
-    - any-glob-to-any-file: 'examples/**/*'
-    - any-glob-to-any-file: './*.md'
-    - any-glob-to-any-file: './*.rst'
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: "doc/**/*"
+          - any-glob-to-any-file: "examples/**/*"
+          - any-glob-to-any-file: "./*.md"
+          - any-glob-to-any-file: "./*.rst"
 maintenance:
-- any:
-  - changed-files:
-    - any-glob-to-any-file: '.github/**/*'
-    - any-glob-to-any-file: 'codecov.yml'
-    - any-glob-to-any-file: '.flake8'
-    - any-glob-to-any-file: '.coveragerc'
-    - any-glob-to-any-file: '.codecimate.yml'
-    - any-glob-to-any-file: 'ignore_words.txt'
-    - any-glob-to-any-file: 'mypy.ini'
-    - any-glob-to-any-file: 'pyproject.toml'
-    - any-glob-to-any-file: 'setup.py'
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: ".github/**/*"
+          - any-glob-to-any-file: "codecov.yml"
+          - any-glob-to-any-file: ".flake8"
+          - any-glob-to-any-file: ".coveragerc"
+          - any-glob-to-any-file: ".codecimate.yml"
+          - any-glob-to-any-file: "ignore_words.txt"
+          - any-glob-to-any-file: "mypy.ini"
+          - any-glob-to-any-file: "pyproject.toml"
+          - any-glob-to-any-file: "setup.py"
 dependencies:
-- any:
-  - changed-files:
-    - any-glob-to-any-file: 'requirements*'
-    - any-glob-to-any-file: 'environment.yml'
+  - any:
+      - changed-files:
+          - any-glob-to-any-file: "requirements*"
+          - any-glob-to-any-file: "environment.yml"
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -15,7 +15,7 @@ concurrency:
 
 env:
   ALLOW_PLOTTING: true
-  SHELLOPTS: 'errexit:pipefail'
+  SHELLOPTS: "errexit:pipefail"
 
 jobs:
   doc:
@@ -27,16 +27,16 @@ jobs:
       - name: Set up Python 3.11
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-          cache: 'pip'
+          python-version: "3.11"
+          cache: "pip"
           cache-dependency-path: pyproject.toml
 
       - name: Install pytest-pyvista with test dependencies
         run: pip install .[docs] 'pyvista>=0.37'
 
       - uses: awalsh128/[email protected]
         with:
-          packages: libgl1-mesa-glx xvfb
+          packages: libosmesa6-dev libgl1-mesa-dev python3-tk pandoc git-restore-mtime
           version: 3.0
 
       - name: Build Documentation
@@ -59,24 +59,22 @@ jobs:
 
       matrix:
         include:
-          - python-version: '3.8'
-            vtk-version: '9.0.3'
-          - python-version: '3.9'
-            vtk-version: '9.1'
-          - python-version: '3.10'
-            vtk-version: '9.2.2'
-          - python-version: '3.11'
-            vtk-version: 'latest'
-          - python-version: '3.12'
-            vtk-version: 'latest'
+          - python-version: "3.9"
+            vtk-version: "9.1"
+          - python-version: "3.10"
+            vtk-version: "9.2.2"
+          - python-version: "3.11"
+            vtk-version: "latest"
+          - python-version: "3.12"
+            vtk-version: "latest"
     steps:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
+          cache: "pip"
           cache-dependency-path: pyproject.toml
 
       - name: Install pytest-pyvista with test dependencies
@@ -93,7 +91,7 @@ jobs:
 
       - uses: awalsh128/[email protected]
         with:
-          packages: libgl1-mesa-glx xvfb python-tk
+          packages: libosmesa6-dev libgl1-mesa-dev python3-tk pandoc git-restore-mtime
           version: 3.0
 
       - name: Software Report
@@ -106,15 +104,14 @@ jobs:
         run: xvfb-run coverage run -m --source=pytest_pyvista --module pytest --verbose .
       - uses: codecov/codecov-action@v4
         if: matrix.python-version == '3.9'
-        name: 'Upload coverage to CodeCov'
+        name: "Upload coverage to CodeCov"
 
   release:
     name: Release
     if: |
       github.event_name == 'push' &&
       contains(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -149,20 +146,20 @@ jobs:
 
   downstream:
     name: Downstream tests
-    runs-on: ubuntu-20.04  # matching pyvista
+    runs-on: ubuntu-20.04 # matching pyvista
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: "3.11"
 
       - run: git clone --depth=1 https://github.com/pyvista/pyvista.git --branch main --single-branch
-  
+
       - name: Install pyvista
         run: pip install -ve .
         working-directory: pyvista
       - name: Install pyvista test requirements
-        run: pip install -v -r requirements_test.txt
+        run: pip install -v pyvista[test]
         working-directory: pyvista
       - name: Install pytest-pyvista
         run: pip install -ve .
@@ -172,11 +169,11 @@ jobs:
           which python
           pip list
         working-directory: pyvista
-  
+
       - name: Unit Testing
         run: xvfb-run python -m pytest --fail_extra_image_cache -v --generated_image_dir gen_dir tests/plotting/test_plotting.py
         working-directory: pyvista
-        
+
       - name: Upload generated image artifact
         if: ${{ failure() }}
         uses: actions/upload-artifact@v4

diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -7,41 +7,41 @@ jobs:
   triage:
     runs-on: ubuntu-latest
     steps:
-    - name: Label based on changed files
-      uses: actions/labeler@v5
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Label based on changed files
+        uses: actions/labeler@v5
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
 
-    # Label based on branch name
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'doc/') || startsWith(github.event.pull_request.head.ref, 'docs')
-      with:
-        labels: documentation
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'docker')
-      with:
-        labels: docker
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'maint') || startsWith(github.event.pull_request.head.ref, 'no-ci') || startsWith(github.event.pull_request.head.ref, 'ci')
-      with:
-        labels: maintenance
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'junk')
-      with:
-        labels: ignore-for-release
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'feat')
-      with:
-        labels: enhancement
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'fix') || startsWith(github.event.pull_request.head.ref, 'patch')
-      with:
-        labels: bug
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'release')
-      with:
-        labels: release
-    - uses: actions-ecosystem/action-add-labels@v1
-      if: startsWith(github.event.pull_request.head.ref, 'breaking-change')
-      with:
-        labels: breaking-change
+      # Label based on branch name
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'doc/') || startsWith(github.event.pull_request.head.ref, 'docs')
+        with:
+          labels: documentation
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'docker')
+        with:
+          labels: docker
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'maint') || startsWith(github.event.pull_request.head.ref, 'no-ci') || startsWith(github.event.pull_request.head.ref, 'ci')
+        with:
+          labels: maintenance
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'junk')
+        with:
+          labels: ignore-for-release
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'feat')
+        with:
+          labels: enhancement
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'fix') || startsWith(github.event.pull_request.head.ref, 'patch')
+        with:
+          labels: bug
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'release')
+        with:
+          labels: release
+      - uses: actions-ecosystem/action-add-labels@v1
+        if: startsWith(github.event.pull_request.head.ref, 'breaking-change')
+        with:
+          labels: breaking-change
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,63 +3,60 @@ ci:
   autoupdate_schedule: monthly
 
 repos:
-- repo: https://github.com/psf/black
-  rev: 24.4.2
-  hooks:
-  - id: black
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.0.0
-  hooks:
-  - id: flake8
-    additional_dependencies: [
-      "flake8-quotes==3.3.2",
-    ]
-
-- repo: https://github.com/codespell-project/codespell
-  rev: v2.3.0
-  hooks:
-  - id: codespell
-    args: [
-      "doc examples examples_flask pytest-pyvista tests",
-      "*.py *.rst *.md",
-    ]
-
-- repo: https://github.com/pycqa/pydocstyle
-  rev: 6.3.0
-  hooks:
-  - id: pydocstyle
-    additional_dependencies: [toml==0.10.2]
-    files: ^(pytest-pyvista/|other/)
-    exclude: ^pytest-pyvista/ext/
-
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.10.0
-  hooks:
-  - id: mypy
-    exclude: ^(doc/|tests/|examples/|pytest-pyvista/ext/|examples_flask/)
-    additional_dependencies: [
-    "mypy-extensions==1.0.0",
-    "toml==0.10.2",
-    "typing-extensions==4.1.1",
-  ]
-
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
-  hooks:
-  - id: check-merge-conflict
-  - id: debug-statements
-  - id: no-commit-to-branch
-    args: [--branch, main]
-  - id: requirements-txt-fixer
-
-# this validates our github workflow files
-- repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.4
-  hooks:
-    - id: check-github-workflows
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args:
+          [
+            "doc examples examples_flask pytest-pyvista tests",
+            "*.py *.rst *.md",
+          ]
+
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        additional_dependencies: [toml==0.10.2]
+        files: ^(pytest-pyvista/|other/)
+        exclude: ^pytest-pyvista/ext/
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        exclude: ^(doc/|tests/|examples/|pytest-pyvista/ext/|examples_flask/)
+        additional_dependencies:
+          [
+            "mypy-extensions==1.0.0",
+            "toml==0.10.2",
+            "typing-extensions==4.12.2",
+          ]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: no-commit-to-branch
+        args: [--branch, main]
+      - id: requirements-txt-fixer
+
+  # this validates our github workflow files
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.30.0
+    hooks:
+      - id: check-github-workflows
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.1
+    hooks:
+      - id: ruff
+        args: [--fix, --show-fixes]
+      - id: ruff-format
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.4.1
+    hooks:
+      - id: prettier
+        types_or: [yaml, markdown, html, css, scss, javascript, json]
diff --git a/README.rst b/README.rst
@@ -38,7 +38,7 @@ fail.
 
 Requirements
 ------------
-You must have a Python version >= 3.8, as well as PyVista installed
+You must have a Python version >= 3.9, as well as PyVista installed
 in your environment.
 
 pyvista version >=0.37.0 and vtk version >=9.0.0 required.