Improve pytest default options (#794)

Author: NicolasHug

.github/workflows/linux_cuda_wheel.yaml

@@ -140,7 +140,7 @@ jobs:
           ls
       - name: Run Python tests
         run: |
-          ${CONDA_RUN} FAIL_WITHOUT_CUDA=1 pytest test -v --tb=short
+          ${CONDA_RUN} FAIL_WITHOUT_CUDA=1 pytest --override-ini="addopts=-v" test --tb=short
       - name: Run Python benchmark
         run: |
           ${CONDA_RUN} time python benchmarks/decoders/gpu_benchmark.py --devices=cuda:0,cpu --resize_devices=none

.github/workflows/linux_wheel.yaml

@@ -123,4 +123,4 @@ jobs:
           ls
       - name: Run Python tests
         run: |
-          pytest test -vvv
+          pytest --override-ini="addopts=-v" test

.github/workflows/macos_wheel.yaml

@@ -122,4 +122,4 @@ jobs:
 
       - name: Run Python tests
         run: |
-          pytest test -vvv
+          pytest --override-ini="addopts=-v" test

CONTRIBUTING.md

@@ -55,10 +55,11 @@ pip install -e ".[dev]" --no-build-isolation -vv
 To run python tests run:
 
 ```bash
-pytest test -vvv
+pytest
 ```
 
-Tip: use the `-k "not slow"` flag to skip slow tests.
+Some tests are marked as 'slow' and aren't run by default. You can use `pytest
+-m slow` to run those, or `pytest -m ""` to run all tests, slow or not.
 
 To run the C++ tests run:
 

pyproject.toml

@@ -39,3 +39,15 @@ target-version = ["py38"]
 excludes = [
     "examples",
 ]
+
+[tool.pytest.ini_options]
+markers = [
+    # defines a 'slow' mark to mark slow tests with `@pytest.mark.slow`
+    "slow: mark test as slow"
+]
+
+# We don't want to run the slow tests by default. These options are ignored in
+# the CI, where we definitely want the 'slow' tests to run.
+addopts = "-v -m 'not slow'"
+
+testpaths = ["test"]

test/test_decoders.py

@@ -422,6 +422,7 @@ def test_iteration(self, device, seek_mode):
             elif i == 389:
                 assert_frames_equal(ref_frame_last, frame)
 
+    @pytest.mark.slow
     def test_iteration_slow(self):
         decoder = VideoDecoder(NASA_VIDEO.path)
         ref_frame_last = NASA_VIDEO.get_frame_data_by_index(389)