Skip to content

gh-113329: Catch OSError in doctest finder and document that inspect.getsourcefile/getfile can raise OSError - #113335

Merged
serhiy-storchaka merged 4 commits into
python:mainfrom
stenwessel:gh-113329
Aug 13, 2026
Merged

gh-113329: Catch OSError in doctest finder and document that inspect.getsourcefile/getfile can raise OSError#113335
serhiy-storchaka merged 4 commits into
python:mainfrom
stenwessel:gh-113329

Conversation

@stenwessel

@stenwessel stenwessel commented Dec 20, 2023

Copy link
Copy Markdown
Contributor

Fixes #113329, which occurs when running doctests in a class docstring in a REPL environment. Since Python 3.10, an OSError is raised when the class source code cannot be found.

Just as inspect.getsourcelines, this PR adds documentation for inspect.getsourcefile and inspect.getfile that it can raise an OSError when the source code cannot be found.

Additionally, this PR now also catches OSError in the doctest finder. The source code is only necessary to discover line numbers, and is already ignored when a TypeError occurs. This restores behavior from CPython version < 3.10 where doctests can be found on a class object in the REPL (and, in particular, also in notebook environments).


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

Fixes python#113329, which occurs when running doctests in a class docstring in a REPL environment. Since Python 3.10, an OSError is raised when the class source code cannot be found.
@ghost

ghost commented Dec 20, 2023

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app

bedevere-app Bot commented Dec 20, 2023

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@github-actions

Copy link
Copy Markdown

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

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 15, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34018886 | 📁 Comparing 7a9e7bb against main (3444ef9)

  🔍 Preview build  

2 files changed
± library/inspect.html
± whatsnew/changelog.html

@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Aug 13, 2026

@serhiy-storchaka serhiy-storchaka left a comment

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.

LGTM. 👍

@serhiy-storchaka
serhiy-storchaka enabled auto-merge (squash) August 13, 2026 07:27
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 13, 2026
@serhiy-storchaka
serhiy-storchaka merged commit 025e7d2 into python:main Aug 13, 2026
103 of 105 checks passed
@miss-islington-app

Copy link
Copy Markdown

Thanks @stenwessel for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-app

bedevere-app Bot commented Aug 13, 2026

Copy link
Copy Markdown

GH-155658 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 13, 2026
@bedevere-app

bedevere-app Bot commented Aug 13, 2026

Copy link
Copy Markdown

GH-155659 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 13, 2026
@bedevere-app

bedevere-app Bot commented Aug 13, 2026

Copy link
Copy Markdown

GH-155660 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 13, 2026
serhiy-storchaka pushed a commit that referenced this pull request Aug 13, 2026
…nspect.getsourcefile/getfile can raise OSError (GH-113335) (GH-155659)

Fixes GH-113329, which occurs when running doctests in a class docstring in a REPL environment.
Since Python 3.10, an OSError is raised when the class source code cannot be found.
(cherry picked from commit 025e7d2)

Co-authored-by: Sten Wessel <sten@stenwessel.nl>
serhiy-storchaka pushed a commit that referenced this pull request Aug 13, 2026
…nspect.getsourcefile/getfile can raise OSError (GH-113335) (GH-155660)

Fixes GH-113329, which occurs when running doctests in a class docstring in a REPL environment.
Since Python 3.10, an OSError is raised when the class source code cannot be found.
(cherry picked from commit 025e7d2)

Co-authored-by: Sten Wessel <sten@stenwessel.nl>
hugovk pushed a commit that referenced this pull request Aug 14, 2026
…nspect.getsourcefile/getfile can raise OSError (GH-113335) (#155658)

gh-113329: Catch OSError in doctest finder and document that inspect.getsourcefile/getfile can raise OSError (GH-113335)

Fixes GH-113329, which occurs when running doctests in a class docstring in a REPL environment.
Since Python 3.10, an OSError is raised when the class source code cannot be found.
(cherry picked from commit 025e7d2)

Co-authored-by: Sten Wessel <sten@stenwessel.nl>
mbeijen pushed a commit to mbeijen/cpython that referenced this pull request Aug 14, 2026
…spect.getsourcefile/getfile can raise OSError (pythonGH-113335)

Fixes python#113329, which occurs when running doctests in a class docstring in a REPL environment.
Since Python 3.10, an OSError is raised when the class source code cannot be found.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Running doctest examples on a class results in OSError in REPL

2 participants