Skip to content

gh-137070: Clarify Traversable.open text parameters #157294

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

Open
lpyu001 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

gh-137070: Clarify Traversable.open text parameters #157294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions Doc/library/importlib.resources.abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@
*mode* may be 'r' or 'rb' to open as text or binary. Return a handle
suitable for reading (same as :attr:`pathlib.Path.open`).

When opening as text, accepts encoding parameters such as those
accepted by :class:`io.TextIOWrapper`.
When opening as text, accepts the *encoding*, *errors*, and *newline*
keyword arguments with the same meanings as in :class:`io.TextIOWrapper`.

.. method:: read_bytes()

Expand Down
4 changes: 2 additions & 2 deletions Lib/importlib/resources/abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ def open(self, mode: str = 'r', *args: Any, **kwargs: Any) -> TextIO | BinaryIO:
mode may be 'r' or 'rb' to open as text or binary. Return a handle
suitable for reading (same as pathlib.Path.open).

When opening as text, accepts encoding parameters such as those
accepted by io.TextIOWrapper.
When opening as text, accepts the encoding, errors, and newline
keyword arguments with the same meanings as in io.TextIOWrapper.
"""

@property
Expand Down
Loading