Skip to content

Replace doctest runner by pytest in ci #36981

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

Jump to bottom
Draft
tobiasdiez wants to merge 92 commits into
base: develop
Choose a base branch
from
Draft

Replace doctest runner by pytest in ci #36981

tobiasdiez wants to merge 92 commits into from

Conversation

@tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Dec 29, 2023 •
edited
Loading

Replace sage's custom doctest runner by pytest in ci.

TODO:

  • Require pytest >= 8.1 (because consider_namespace_packages was added there)

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@tobiasdiez
Run pytest in conda ci
5fc47b2
@tobiasdiez
Fix missing feature import errors in SageDoctestModule
a1f88a4
@tobiasdiez
Skip when module not found error is raised during collection
af6959c
@tobiasdiez
Fix pytest command in build and ci-conda workflows
36eea75
@tobiasdiez
Update pytest options in build and ci-conda workflows to show summary…
bdfe4d8 
… of errors and failures
@tobiasdiez
Add rich output backend for doctest
fd809d9
@tobiasdiez
Replace _get_runner with SageDocTestRunner in conftest.py
86defa1
@tobiasdiez
Update pytest command to include verbose output
8a6995e
@tobiasdiez
Add pytest-github-actions-annotate-failures to test dependencies
bf6ac0d
@tobiasdiez
Only use sage spoofer if output file is specified
6c6582f
@tobiasdiez
Always run pytest
96f9e58
@tobiasdiez
Fix start_spoofing and stop_spoofing calls in SageDocTestRunner
038695a
@tobiasdiez
Refactor exception printing to use short names instead of Sage's hack…
490146f 
…y DoctestRunner
@tobiasdiez
add missing imports
a94a678
@tobiasdiez
Add imports to conftest.py
1c6fa26
@tobiasdiez
revert changes to forker
ad7a14b
@tobiasdiez
Fix a few display errors
6a77fd7
@tobiasdiez
Merge branch 'develop' into pytest_replace_doctest
4d3f882
@tobiasdiez
Merge branch 'develop' into pytest_replace_doctest
2666c6b
@github-actions
Copy link

github-actions bot commented Feb 25, 2024 •
edited
Loading

Documentation preview for this PR (built with commit eabca64; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

tobiasdiez and others added 26 commits June 4, 2025 18:38
@tobiasdiez
Merge branch 'develop' into pytest_replace_doctest
73c63bc
@tobiasdiez
Merge branch 'develop' into pytest_replace_doctest
42490cb
@tobiasdiez
Don't try to import src/sage_docbuild/build_options.py
892670d
@tobiasdiez
Ignore builders.py in addition to build_options.py for Meson comp…
9967f48 
…atibility
@tobiasdiez
Ignore more fatal python errors
a5dacb9
@tobiasdiez
Ignore atexit.pyx in cpython directory to prevent fatal Python er…
dc37fa6 
…rors
@tobiasdiez
Conditional pytest-isolate installation not on Windows
dd13d79
@tobiasdiez
Rename more test_ to check_
19295a0
@tobiasdiez
Improve error message for skipped doctests on import failure
f549d82
@tobiasdiez
Fix condition for installing pytest-isolate based on matrix OS
0af1a89
@tobiasdiez
Enhance pytest command with full trace option for better error visibi…
c1da4b3 
…lity
@tobiasdiez
Ignore specific files in pytest collection to prevent output stream i…
6faf68b 
…ssues
@tobiasdiez
Remove incompatible test
1eb59cb
@tobiasdiez
Fix docstring formatting to raw string literals
47f56b1
@tobiasdiez
Add ignore condition for calculus_method.py in pytest collection
79f434f
@tobiasdiez
Prevent fatal errors in specific test files
a6e05f9
@tobiasdiez
Add more to pytest ignore logic to prevent fatal errors
cbd89a9
@tobiasdiez
Exclude a few more files
ddf825f
@tobiasdiez
Merge branch 'pytest_rename_check' into pytest_replace_doctest
e0eca45
@tobiasdiez
Merge branch 'maxima-bin-remove' into pytest_replace_doctest
5388732
@tobiasdiez
Merge remote-tracking branch 'upstream/develop' into pytest_replace_d…
e3040a2 
…octest
@tobiasdiez
Merge branch 'maxima-bin-remove' into pytest_replace_doctest
faa2bdf
@tobiasdiez
Merge remote-tracking branch 'upstream/develop' into pytest_replace_d…
46ffe33 
…octest
@tobiasdiez
Merge remote-tracking branch 'upstream/develop' into pytest_replace_d…
5a7aea3 
…octest
@tobiasdiez
Merge branch 'develop' into pytest_replace_doctest
09db99a
@tobiasdiez
Merge remote-tracking branch 'origin/develop' into pytest_replace_doc…
eabca64 
…test
This was referenced Jan 16, 2026
Merged
Merged
vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 19, 2026
9cde032 
sagemathgh-41459: Fix docstring formatting to raw string literals
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fix a few missing `r-strings` for docs, found by running pytest and
those changes here are extracted from sagemath#36981.

Also includes a few other minor linter fixes in the touched files.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [ ] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#41459
Reported by: Tobias Diez
Reviewer(s): Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this pull request Jan 24, 2026
e7b803b 
sagemathgh-41459: Fix docstring formatting to raw string literals
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fix a few missing `r-strings` for docs, found by running pytest and
those changes here are extracted from sagemath#36981.

Also includes a few other minor linter fixes in the touched files.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [ ] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#41459
Reported by: Tobias Diez
Reviewer(s): Frédéric Chapoton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

c: scripts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tobiasdiez @mkoeppe @user202729