Skip to content

gh-98239: Document that inspect.getsource() can raise TypeError #101689

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

Merged
AlexWaygood merged 2 commits into from
Mar 23, 2023
Merged

gh-98239: Document that inspect.getsource() can raise TypeError #101689

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52b3481
gh-98239: Document that `inspect.getsource()` can raise `TypeError`
sobolevn Feb 8, 2023
d08f2d8
Apply suggestions from code review
sobolevn Mar 23, 2023
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
8 changes: 6 additions & 2 deletions Doc/library/inspect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,9 @@ Retrieving source code
object. The source code is returned as a list of the lines corresponding to the
object and the line number indicates where in the original source file the first
line of code was found. An :exc:`OSError` is raised if the source code cannot
be retrieved.
be retrieved. This
will fail with a :exc:`TypeError` if the object is a built-in module, class, or
function.

.. versionchanged:: 3.3
:exc:`OSError` is raised instead of :exc:`IOError`, now an alias of the
Expand All @@ -585,7 +587,9 @@ Retrieving source code
Return the text of the source code for an object. The argument may be a module,
class, method, function, traceback, frame, or code object. The source code is
returned as a single string. An :exc:`OSError` is raised if the source code
cannot be retrieved.
cannot be retrieved. This
will fail with a :exc:`TypeError` if the object is a built-in module, class, or
function.

.. versionchanged:: 3.3
:exc:`OSError` is raised instead of :exc:`IOError`, now an alias of the
Expand Down