Skip to content

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

Open
stenwessel wants to merge 4 commits into
python:mainfrom
stenwessel:gh-113329
Open

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

Conversation

@stenwessel

@stenwessel stenwessel commented Dec 20, 2023

Copy link
Copy Markdown

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review stale Stale PR or inactive for long period of time.

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