FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-111704: Add `stdtypes.rst` to doctests by sobolevn · Pull Request #136501 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-111704: Add stdtypes.rst to doctests - #136501

Closed
sobolevn wants to merge 3 commits into
python:mainfrom
sobolevn:issue-111704-stdtypes
ConversationCommits (3)ChecksFiles changed
Closed

gh-111704: Add stdtypes.rst to doctests#136501
sobolevn wants to merge 3 commits into
python:mainfrom
sobolevn:issue-111704-stdtypes

Conversation

sobolevn commented Jul 10, 2025 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Please, help me with this one :)

This stdtypes.rst PR:

  • Enables more >>> to be tested with doctest in test cases. Because regular doctest runs all >>> examples, not just ones that are explicitly marked as doctests. Which is benefitial, when we already have lots of code samples
  • Refactors .. doctest:: to be a regular code, because we don't need to test it twice with sphinx doctest and doctest

📚 Documentation preview 📚: https://cpython-previews--136501.org.readthedocs.build/

sobolevn requested review from AA-Turner and hugovk July 10, 2025 10:49
bedevere-app Bot added awaiting core review tests Tests in the Lib/test dir labels Jul 10, 2025
bedevere-app Bot mentioned this pull request Jul 10, 2025
Open

sobolevn commented Jul 10, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

This is a very interesting case: tests fail on WASI https://github.com/python/cpython/actions/runs/16193074826/job/45713120305?pr=136501

hugovk commented Aug 8, 2025

Copy link
Copy Markdown
Member

Can we skip them on WASI?

sobolevn commented Sep 10, 2025

Copy link
Copy Markdown
Member Author

Done!

AA-Turner reviewed Sep 10, 2025
View reviewed changes
Comment thread Doc/library/stdtypes.rst
and are converted into regular :class:`str` objects.
For example:

.. doctest::

AA-Turner Sep 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Why are all the doctest:: directive removed?

sobolevn Sep 10, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Because we now run doctests from test_builtins.py

AA-Turner Sep 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Why run from test_builtins instead of make doctest? All the other doctests in documnentation run via Sphinx.

sobolevn Sep 10, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Couple of reasons: make doctest is not executed in all environments (which call help us find bugs), it is harder to run locally (slower and requires extra setup), not all >>> are recognized as doctests by make doctest

AA-Turner Sep 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think though we should maintain the property that documentation doctests are all run via the same mechanism.

not all >>> are recognized as doctests by make doctest

Do you have examples? We likely need to add more .. doctest::, rather than removing them.

sobolevn Sep 10, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yes, right in this file. Check out int.bit_length(). It is checked now. Also, check out my AttributeError: 'method' object has no attribute 'whoami' change, it was not caught before :(

github-actions Bot commented Apr 27, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 27, 2026

skirpichev commented May 31, 2026

Copy link
Copy Markdown
Member

This has merge conflicts now.

sobolevn closed this May 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AA-Turner AA-Turner left review comments
hugovk Awaiting requested review from hugovk

Assignees

No one assigned

Labels

awaiting core review skip news stale Stale PR or inactive for long period of time. tests Tests in the Lib/test dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL