Skip to content

[BUG] add raise of softdep not working when we install all extras #3409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
baraline wants to merge 5 commits into from
+53 −2
Closed

[BUG] add raise of softdep not working when we install all extras #3409

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b697fd3
add raise of softdep not working when we install all extras
baraline May 20, 2026
d58cdec
run the flag for a specific ubuntu matrix
baraline May 20, 2026
e576a39
Update pytest command for Python 3.11 on Ubuntu
baraline May 22, 2026
2fcfbb1
Update pytest command for Python 3.11
baraline May 22, 2026
ffbe6e0
Add comments
baraline May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/periodic_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,9 @@ jobs:
run: python -m pip list

- name: Run tests
run: python -m pytest -n logical
run: >
python -m pytest -n logical
${{ matrix.os == 'ubuntu-24.04' && matrix.python-version == '3.12' && '--fail-soft-dependency-skips' || '' }}

- name: Save new cache
uses: actions/cache/save@v5
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/pr_pytest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,10 @@ jobs:

- name: Run tests
# run the full test suit if a PR has the 'full pytest actions' label
run: python -m pytest -n logical --prtesting ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'full pytest actions') }}
run: >
python -m pytest -n logical
${{ matrix.os == 'ubuntu-24.04' && matrix.python-version == '3.12' && '--fail-soft-dependency-skips' || '' }}
--prtesting ${{ github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'full pytest actions') }}

doctests:
runs-on: ubuntu-24.04
Expand Down
40 changes: 40 additions & 0 deletions conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@

__maintainer__ = ["MatthewMiddlehurst"]

import pytest


def _is_soft_dependency_skip(report):
if not report.skipped:
return False

skip_reason = (
report.longrepr[2]
if isinstance(report.longrepr, tuple)
else str(report.longrepr)
)
Comment on lines +25 to +29
Copy link
Copy Markdown
Member

@MatthewMiddlehurst MatthewMiddlehurst May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pretty evident what the function is doing as a whole but coud you leave a comment on why this is needed if possible

Copy link
Copy Markdown
Member Author

@baraline baraline May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments/docs any better ?

Copy link
Copy Markdown
Member

@MatthewMiddlehurst MatthewMiddlehurst May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

specifically meant that bit of code, im not really sure what in a test could cause the output type the change! other bits seem reasonable to understand just reading through

Copy link
Copy Markdown
Member

@MatthewMiddlehurst MatthewMiddlehurst May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

either way is minor

return "soft dependency" in skip_reason.lower()


def pytest_addoption(parser):
"""Pytest command line parser options adder."""
Expand All @@ -35,6 +49,32 @@ def pytest_addoption(parser):
"version."
),
)
parser.addoption(
"--fail-soft-dependency-skips",
action="store_true",
default=False,
help=(
"Fail tests skipped by soft dependency checks. Use only in environments "
"where soft dependencies are installed."
),
)


@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
"""Turn soft dependency skips into failures when requested."""
outcome = yield
report = outcome.get_result()

if item.config.getoption(
"--fail-soft-dependency-skips"
) and _is_soft_dependency_skip(report):
report.outcome = "failed"
report.longrepr = (
"Test skipped because a soft dependency check failed while "
"--fail-soft-dependency-skips is enabled. "
f"Original skip reason: {report.longrepr}"
)


def pytest_configure(config):
Expand Down
Loading