Mailman 3 December 2023 - Python-checkins

gh-103092: Make `_elementtree` module importable in sub-interpreters (#113434)
by kumaraditya303 28 Dec '23

28 Dec '23

https://github.com/python/cpython/commit/f1676867b52f8b6c7f70bf32e2a53f7edd… commit: f1676867b52f8b6c7f70bf32e2a53f7edd6700a7 branch: main author: Kirill Podoprigora <kirill.bast9(a)mail.ru> committer: kumaraditya303 <kumaraditya(a)python.org> date: 2023-12-28T14:42:21+05:30 summary: gh-103092: Make `_elementtree` module importable in sub-interpreters (#113434) Enable imports of _elementtree module in sub-interpreters files: M Modules/_elementtree.c diff --git a/Modules/_elementtree.c b/Modules/_elementtree.c index 5bf67870767698..b574c96d3f9625 100644 --- a/Modules/_elementtree.c +++ b/Modules/_elementtree.c @@ -4430,9 +4430,7 @@ module_exec(PyObject *m) static struct PyModuleDef_Slot elementtree_slots[] = { {Py_mod_exec, module_exec}, - // XXX gh-103092: fix isolation. - {Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED}, - //{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED}, + {Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED}, {0, NULL}, };

1 0

gh-110459: Make sure --with-openssl-rpath works on macOS (#113441)
by ronaldoussoren 28 Dec '23

28 Dec '23

https://github.com/python/cpython/commit/cc13eabc7ce08accf49656e258ba500f74… commit: cc13eabc7ce08accf49656e258ba500f74a1dae8 branch: main author: Ronald Oussoren <ronaldoussoren(a)mac.com> committer: ronaldoussoren <ronaldoussoren(a)mac.com> date: 2023-12-28T09:42:05+01:00 summary: gh-110459: Make sure --with-openssl-rpath works on macOS (#113441) * gh-110459: Make sure --with-openssl-rpath works on macOS On macOS the `-rpath` linker flag is spelled differently than on on platforms. files: A Misc/NEWS.d/next/macOS/2023-12-23-22-41-07.gh-issue-110459.NaMBJy.rst M configure M configure.ac diff --git a/Misc/NEWS.d/next/macOS/2023-12-23-22-41-07.gh-issue-110459.NaMBJy.rst b/Misc/NEWS.d/next/macOS/2023-12-23-22-41-07.gh-issue-110459.NaMBJy.rst new file mode 100644 index 00000000000000..44ffd857785f0d --- /dev/null +++ b/Misc/NEWS.d/next/macOS/2023-12-23-22-41-07.gh-issue-110459.NaMBJy.rst @@ -0,0 +1,2 @@ +Running ``configure ... --with-openssl-rpath=X/Y/Z`` no longer fails to detect +OpenSSL on macOS. diff --git a/configure b/configure index 7e50abc29d0c1a..6d65d3abc1811b 100755 --- a/configure +++ b/configure @@ -27478,7 +27478,12 @@ then : else $as_nop - rpath_arg="-Wl,-rpath=" + if test "$ac_sys_system" = "Darwin" + then + rpath_arg="-Wl,-rpath," + else + rpath_arg="-Wl,-rpath=" + fi fi diff --git a/configure.ac b/configure.ac index e064848af9ed1b..bfdabc4474e5eb 100644 --- a/configure.ac +++ b/configure.ac @@ -6808,7 +6808,12 @@ AX_CHECK_OPENSSL([have_openssl=yes],[have_openssl=no]) AS_VAR_IF([GNULD], [yes], [ rpath_arg="-Wl,--enable-new-dtags,-rpath=" ], [ - rpath_arg="-Wl,-rpath=" + if test "$ac_sys_system" = "Darwin" + then + rpath_arg="-Wl,-rpath," + else + rpath_arg="-Wl,-rpath=" + fi ]) AC_MSG_CHECKING([for --with-openssl-rpath])

1 0

gh-73427: deprecate `_enablelegacywindowsfsencoding` (#107729)
by methane 28 Dec '23

28 Dec '23

https://github.com/python/cpython/commit/bfee2f77e16f01a718c1044564ee624f1f… commit: bfee2f77e16f01a718c1044564ee624f1f2bc328 branch: main author: Inada Naoki <songofacandy(a)gmail.com> committer: methane <songofacandy(a)gmail.com> date: 2023-12-28T17:31:19+09:00 summary: gh-73427: deprecate `_enablelegacywindowsfsencoding` (#107729) files: A Misc/NEWS.d/next/Windows/2023-08-08-01-42-14.gh-issue-73427.WOpiNt.rst M Doc/library/sys.rst M Doc/whatsnew/3.13.rst M Python/sysmodule.c diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index aaf79205d44282..2426c37ccb1e0f 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -1744,9 +1744,17 @@ always available. .. availability:: Windows. + .. note:: + Changing the filesystem encoding after Python startup is risky because + the old fsencoding or paths encoded by the old fsencoding may be cached + somewhere. Use :envvar:`PYTHONLEGACYWINDOWSFSENCODING` instead. + .. versionadded:: 3.6 See :pep:`529` for more details. + .. deprecated-removed:: 3.13 3.16 + Use :envvar:`PYTHONLEGACYWINDOWSFSENCODING` instead. + .. data:: stdin stdout stderr diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst index 4b02ecddd63b27..888ebd0402d0e7 100644 --- a/Doc/whatsnew/3.13.rst +++ b/Doc/whatsnew/3.13.rst @@ -474,6 +474,10 @@ Deprecated security and functionality bugs. This includes removal of the ``--cgi`` flag to the ``python -m http.server`` command line in 3.15. +* :mod:`sys`: :func:`sys._enablelegacywindowsfsencoding` function. + Replace it with :envvar:`PYTHONLEGACYWINDOWSFSENCODING` environment variable. + (Contributed by Inada Naoki in :gh:`73427`.) + * :mod:`traceback`: * The field *exc_type* of :class:`traceback.TracebackException` is diff --git a/Misc/NEWS.d/next/Windows/2023-08-08-01-42-14.gh-issue-73427.WOpiNt.rst b/Misc/NEWS.d/next/Windows/2023-08-08-01-42-14.gh-issue-73427.WOpiNt.rst new file mode 100644 index 00000000000000..830c4c54838e80 --- /dev/null +++ b/Misc/NEWS.d/next/Windows/2023-08-08-01-42-14.gh-issue-73427.WOpiNt.rst @@ -0,0 +1,2 @@ +Deprecate :func:`sys._enablelegacywindowsfsencoding`. Use +:envvar:`PYTHONLEGACYWINDOWSFSENCODING` instead. Patch by Inada Naoki. diff --git a/Python/sysmodule.c b/Python/sysmodule.c index 57dc4a1226ce75..c2de4ecdc8ce0f 100644 --- a/Python/sysmodule.c +++ b/Python/sysmodule.c @@ -1715,6 +1715,13 @@ static PyObject * sys__enablelegacywindowsfsencoding_impl(PyObject *module) /*[clinic end generated code: output=f5c3855b45e24fe9 input=2bfa931a20704492]*/ { + if (PyErr_WarnEx(PyExc_DeprecationWarning, + "sys._enablelegacywindowsfsencoding() is deprecated and will be " + "removed in Python 3.16. Use PYTHONLEGACYWINDOWSFSENCODING " + "instead.", 1)) + { + return NULL; + } if (_PyUnicode_EnableLegacyWindowsFSEncoding() < 0) { return NULL; }

1 0

gh-113299: Move cpp.py into libclinic (#113526)
by erlend-aasland 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/7ab9efdd6a2fb21cddca1ccd70175f1ac6… commit: 7ab9efdd6a2fb21cddca1ccd70175f1ac6bd9168 branch: main author: Erlend E. Aasland <erlend(a)python.org> committer: erlend-aasland <erlend.aasland(a)protonmail.com> date: 2023-12-28T00:20:57+01:00 summary: gh-113299: Move cpp.py into libclinic (#113526) files: A Tools/clinic/libclinic/cpp.py D Tools/clinic/cpp.py M Lib/test/test_clinic.py M Tools/clinic/clinic.py diff --git a/Lib/test/test_clinic.py b/Lib/test/test_clinic.py index 3d6816d73d45bc..7323bdd801f4be 100644 --- a/Lib/test/test_clinic.py +++ b/Lib/test/test_clinic.py @@ -3920,7 +3920,7 @@ def test_Function_and_Parameter_reprs(self): self.assertEqual(repr(parameter), "<clinic.Parameter 'bar'>") def test_Monitor_repr(self): - monitor = clinic.cpp.Monitor("test.c") + monitor = libclinic.cpp.Monitor("test.c") self.assertRegex(repr(monitor), r"<clinic.Monitor \d+ line=0 condition=''>") monitor.line_number = 42 diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py index 82efff56eda756..f6f95580f1a177 100755 --- a/Tools/clinic/clinic.py +++ b/Tools/clinic/clinic.py @@ -13,7 +13,6 @@ import collections import contextlib import copy -import cpp import dataclasses as dc import enum import functools @@ -53,6 +52,7 @@ # Local imports. import libclinic +import libclinic.cpp from libclinic import ClinicError @@ -648,7 +648,7 @@ class CLanguage(Language): def __init__(self, filename: str) -> None: super().__init__(filename) - self.cpp = cpp.Monitor(filename) + self.cpp = libclinic.cpp.Monitor(filename) def parse_line(self, line: str) -> None: self.cpp.writeline(line) diff --git a/Tools/clinic/cpp.py b/Tools/clinic/libclinic/cpp.py similarity index 99% rename from Tools/clinic/cpp.py rename to Tools/clinic/libclinic/cpp.py index 659099056cd46c..e115d65a88e1b6 100644 --- a/Tools/clinic/cpp.py +++ b/Tools/clinic/libclinic/cpp.py @@ -3,7 +3,10 @@ import sys from typing import NoReturn -from libclinic.errors import ParseError +from .errors import ParseError + + +__all__ = ["Monitor"] TokenAndCondition = tuple[str, str]

1 0

gh-113317: Rework Argument Clinic cpp.py error handling (#113525)
by erlend-aasland 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/87295b4068762f9cbdfcae5fed5ff54aad… commit: 87295b4068762f9cbdfcae5fed5ff54aadd3cb62 branch: main author: Erlend E. Aasland <erlend(a)python.org> committer: erlend-aasland <erlend.aasland(a)protonmail.com> date: 2023-12-27T21:43:19Z summary: gh-113317: Rework Argument Clinic cpp.py error handling (#113525) Rework error handling in the C preprocessor helper. Instead of monkey- patching the cpp.Monitor.fail() method from within clinic.py, rewrite cpp.py to use a subclass of the ClinicError exception. As a side-effect, ClinicError is moved into Tools/clinic/libclinic/errors.py. Yak-shaving in preparation for putting cpp.py into libclinic. files: A Tools/clinic/libclinic/errors.py M Lib/test/test_clinic.py M Tools/clinic/clinic.py M Tools/clinic/cpp.py M Tools/clinic/libclinic/__init__.py diff --git a/Lib/test/test_clinic.py b/Lib/test/test_clinic.py index 21f56fe0195e69..3d6816d73d45bc 100644 --- a/Lib/test/test_clinic.py +++ b/Lib/test/test_clinic.py @@ -22,7 +22,7 @@ def _make_clinic(*, filename='clinic_tests'): - clang = clinic.CLanguage(None) + clang = clinic.CLanguage(filename) c = clinic.Clinic(clang, filename=filename, limited_capi=False) c.block_parser = clinic.BlockParser('', clang) return c @@ -3920,7 +3920,7 @@ def test_Function_and_Parameter_reprs(self): self.assertEqual(repr(parameter), "<clinic.Parameter 'bar'>") def test_Monitor_repr(self): - monitor = clinic.cpp.Monitor() + monitor = clinic.cpp.Monitor("test.c") self.assertRegex(repr(monitor), r"<clinic.Monitor \d+ line=0 condition=''>") monitor.line_number = 42 diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py index f004bec3cce8f6..82efff56eda756 100755 --- a/Tools/clinic/clinic.py +++ b/Tools/clinic/clinic.py @@ -53,6 +53,7 @@ # Local imports. import libclinic +from libclinic import ClinicError # TODO: @@ -94,27 +95,6 @@ def __repr__(self) -> str: TemplateDict = dict[str, str] -(a)dc.dataclass -class ClinicError(Exception): - message: str - _: dc.KW_ONLY - lineno: int | None = None - filename: str | None = None - - def __post_init__(self) -> None: - super().__init__(self.message) - - def report(self, *, warn_only: bool = False) -> str: - msg = "Warning" if warn_only else "Error" - if self.filename is not None: - msg += f" in file {self.filename!r}" - if self.lineno is not None: - msg += f" on line {self.lineno}" - msg += ":\n" - msg += f"{self.message}\n" - return msg - - @overload def warn_or_fail( *args: object, @@ -669,7 +649,6 @@ class CLanguage(Language): def __init__(self, filename: str) -> None: super().__init__(filename) self.cpp = cpp.Monitor(filename) - self.cpp.fail = fail # type: ignore[method-assign] def parse_line(self, line: str) -> None: self.cpp.writeline(line) diff --git a/Tools/clinic/cpp.py b/Tools/clinic/cpp.py index 16eee6fc399491..659099056cd46c 100644 --- a/Tools/clinic/cpp.py +++ b/Tools/clinic/cpp.py @@ -3,6 +3,8 @@ import sys from typing import NoReturn +from libclinic.errors import ParseError + TokenAndCondition = tuple[str, str] TokenStack = list[TokenAndCondition] @@ -32,7 +34,7 @@ class Monitor: Anyway this implementation seems to work well enough for the CPython sources. """ - filename: str | None = None + filename: str _: dc.KW_ONLY verbose: bool = False @@ -59,14 +61,8 @@ def condition(self) -> str: """ return " && ".join(condition for token, condition in self.stack) - def fail(self, *a: object) -> NoReturn: - if self.filename: - filename = " " + self.filename - else: - filename = '' - print("Error at" + filename, "line", self.line_number, ":") - print(" ", ' '.join(str(x) for x in a)) - sys.exit(-1) + def fail(self, msg: str) -> NoReturn: + raise ParseError(msg, filename=self.filename, lineno=self.line_number) def writeline(self, line: str) -> None: self.line_number += 1 @@ -74,7 +70,7 @@ def writeline(self, line: str) -> None: def pop_stack() -> TokenAndCondition: if not self.stack: - self.fail("#" + token + " without matching #if / #ifdef / #ifndef!") + self.fail(f"#{token} without matching #if / #ifdef / #ifndef!") return self.stack.pop() if self.continuation: @@ -145,7 +141,7 @@ def pop_stack() -> TokenAndCondition: if token in {'if', 'ifdef', 'ifndef', 'elif'}: if not condition: - self.fail("Invalid format for #" + token + " line: no argument!") + self.fail(f"Invalid format for #{token} line: no argument!") if token in {'if', 'elif'}: if not is_a_simple_defined(condition): condition = "(" + condition + ")" @@ -155,7 +151,8 @@ def pop_stack() -> TokenAndCondition: else: fields = condition.split() if len(fields) != 1: - self.fail("Invalid format for #" + token + " line: should be exactly one argument!") + self.fail(f"Invalid format for #{token} line: " + "should be exactly one argument!") symbol = fields[0] condition = 'defined(' + symbol + ')' if token == 'ifndef': diff --git a/Tools/clinic/libclinic/__init__.py b/Tools/clinic/libclinic/__init__.py index 0c3c6840901a42..d4e7a0c5cf7b76 100644 --- a/Tools/clinic/libclinic/__init__.py +++ b/Tools/clinic/libclinic/__init__.py @@ -1,5 +1,8 @@ from typing import Final +from .errors import ( + ClinicError, +) from .formatting import ( SIG_END_MARKER, c_repr, @@ -15,6 +18,9 @@ __all__ = [ + # Error handling + "ClinicError", + # Formatting helpers "SIG_END_MARKER", "c_repr", diff --git a/Tools/clinic/libclinic/errors.py b/Tools/clinic/libclinic/errors.py new file mode 100644 index 00000000000000..afb21b02386fe7 --- /dev/null +++ b/Tools/clinic/libclinic/errors.py @@ -0,0 +1,26 @@ +import dataclasses as dc + + +(a)dc.dataclass +class ClinicError(Exception): + message: str + _: dc.KW_ONLY + lineno: int | None = None + filename: str | None = None + + def __post_init__(self) -> None: + super().__init__(self.message) + + def report(self, *, warn_only: bool = False) -> str: + msg = "Warning" if warn_only else "Error" + if self.filename is not None: + msg += f" in file {self.filename!r}" + if self.lineno is not None: + msg += f" on line {self.lineno}" + msg += ":\n" + msg += f"{self.message}\n" + return msg + + +class ParseError(ClinicError): + pass

1 0

[3.11] gh-57795: Add news to idlelib/News3.txt (GH-113522) (#113524)
by terryjreedy 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/a486d10fc6a23df098f259147e43de6d9d… commit: a486d10fc6a23df098f259147e43de6d9dd00dd9 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: terryjreedy <tjreedy(a)udel.edu> date: 2023-12-27T21:10:39Z summary: [3.11] gh-57795: Add news to idlelib/News3.txt (GH-113522) (#113524) gh-57795: Add news to idlelib/News3.txt (GH-113522) (cherry picked from commit 6c98fce33a4c2d6671978f6286377af0d6e22182) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: M Lib/idlelib/News3.txt diff --git a/Lib/idlelib/News3.txt b/Lib/idlelib/News3.txt index cf6a97bcf5f950..5885a8e6e24624 100644 --- a/Lib/idlelib/News3.txt +++ b/Lib/idlelib/News3.txt @@ -4,7 +4,11 @@ Released after 2022-10-24 ========================= +gh-57795: Enter selected text into the Find box when opening +a Replace dialog. Patch by Roger Serwy and Zackery Spytz. + gh-113269: Fix test_editor hang on macOS Catalina. +Patch by Terry Reedy. gh-112939: Fix processing unsaved files when quitting IDLE on macOS. Patch by Ronald Oussoren and Christopher Chavez.

1 0

[3.12] gh-57795: Add news to idlelib/News3.txt (GH-113522) (#113523)
by terryjreedy 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/c1b396cdf3197581035c9a94f92d4151b2… commit: c1b396cdf3197581035c9a94f92d4151b2f57e80 branch: 3.12 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: terryjreedy <tjreedy(a)udel.edu> date: 2023-12-27T21:05:59Z summary: [3.12] gh-57795: Add news to idlelib/News3.txt (GH-113522) (#113523) gh-57795: Add news to idlelib/News3.txt (GH-113522) (cherry picked from commit 6c98fce33a4c2d6671978f6286377af0d6e22182) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: M Lib/idlelib/News3.txt diff --git a/Lib/idlelib/News3.txt b/Lib/idlelib/News3.txt index 6e72088028841f..a0624ab57b5d66 100644 --- a/Lib/idlelib/News3.txt +++ b/Lib/idlelib/News3.txt @@ -4,7 +4,11 @@ Released after 2023-10-02 ========================= +gh-57795: Enter selected text into the Find box when opening +a Replace dialog. Patch by Roger Serwy and Zackery Spytz. + gh-113269: Fix test_editor hang on macOS Catalina. +Patch by Terry Reedy. gh-112939: Fix processing unsaved files when quitting IDLE on macOS. Patch by Ronald Oussoren and Christopher Chavez.

1 0

gh-57795: Add news to idlelib/News3.txt (#113522)
by terryjreedy 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/6c98fce33a4c2d6671978f6286377af0d6… commit: 6c98fce33a4c2d6671978f6286377af0d6e22182 branch: main author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: terryjreedy <tjreedy(a)udel.edu> date: 2023-12-27T15:51:49-05:00 summary: gh-57795: Add news to idlelib/News3.txt (#113522) files: M Lib/idlelib/News3.txt diff --git a/Lib/idlelib/News3.txt b/Lib/idlelib/News3.txt index 308865d968814c..f38cc96eceb766 100644 --- a/Lib/idlelib/News3.txt +++ b/Lib/idlelib/News3.txt @@ -4,7 +4,11 @@ Released on 2024-10-xx ========================= +gh-57795: Enter selected text into the Find box when opening +a Replace dialog. Patch by Roger Serwy and Zackery Spytz. + gh-113269: Fix test_editor hang on macOS Catalina. +Patch by Terry Reedy. gh-112939: Fix processing unsaved files when quitting IDLE on macOS. Patch by Ronald Oussoren and Christopher Chavez.

1 0

[3.11] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113520)
by serhiy-storchaka 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/f9d25b56e12b9db689770ebf705a34e001… commit: f9d25b56e12b9db689770ebf705a34e001597131 branch: 3.11 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: serhiy-storchaka <storchaka(a)gmail.com> date: 2023-12-27T17:33:00Z summary: [3.11] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113520) (cherry picked from commit 0651936ae2bc6999f488f8c519b8d07a06a11557) Co-authored-by: Stanley <46876382+slateny(a)users.noreply.github.com> files: M Doc/library/tarfile.rst M Lib/tarfile.py diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index ced98a524f3520..dadbc6ea87f843 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -109,10 +109,12 @@ Some facts and figures: ``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile` object that processes its data as a stream of blocks. No random seeking will be done on the file. If given, *fileobj* may be any object that has a - :meth:`~io.TextIOBase.read` or :meth:`~io.TextIOBase.write` method (depending on the *mode*). *bufsize* - specifies the blocksize and defaults to ``20 * 512`` bytes. Use this variant - in combination with e.g. ``sys.stdin``, a socket :term:`file object` or a tape - device. However, such a :class:`TarFile` object is limited in that it does + :meth:`~io.RawIOBase.read` or :meth:`~io.RawIOBase.write` method + (depending on the *mode*) that works with bytes. + *bufsize* specifies the blocksize and defaults to ``20 * 512`` bytes. + Use this variant in combination with e.g. ``sys.stdin.buffer``, a socket + :term:`file object` or a tape device. + However, such a :class:`TarFile` object is limited in that it does not allow random access, see :ref:`tar-examples`. The currently possible modes: diff --git a/Lib/tarfile.py b/Lib/tarfile.py index 2808e7efc553a9..4aebe916d1bb7c 100755 --- a/Lib/tarfile.py +++ b/Lib/tarfile.py @@ -332,10 +332,11 @@ def write(self, s): class _Stream: """Class that serves as an adapter between TarFile and a stream-like object. The stream-like object only - needs to have a read() or write() method and is accessed - blockwise. Use of gzip or bzip2 compression is possible. - A stream-like object could be for example: sys.stdin, - sys.stdout, a socket, a tape device etc. + needs to have a read() or write() method that works with bytes, + and the method is accessed blockwise. + Use of gzip or bzip2 compression is possible. + A stream-like object could be for example: sys.stdin.buffer, + sys.stdout.buffer, a socket, a tape device etc. _Stream is intended to be used only internally. """

1 0

[3.12] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113519)
by serhiy-storchaka 27 Dec '23

27 Dec '23

https://github.com/python/cpython/commit/72410a3ecf9fde8362dccf9726fea2b641… commit: 72410a3ecf9fde8362dccf9726fea2b641237bfa branch: 3.12 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: serhiy-storchaka <storchaka(a)gmail.com> date: 2023-12-27T17:32:10Z summary: [3.12] gh-67641: Clarify documentation on bytes vs text with non-seeking tarfile stream (GH-31610) (GH-113519) (cherry picked from commit 0651936ae2bc6999f488f8c519b8d07a06a11557) Co-authored-by: Stanley <46876382+slateny(a)users.noreply.github.com> files: M Doc/library/tarfile.rst M Lib/tarfile.py diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index 7078fc04bfd0ee..6e34158084eb5c 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -116,10 +116,12 @@ Some facts and figures: ``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile` object that processes its data as a stream of blocks. No random seeking will be done on the file. If given, *fileobj* may be any object that has a - :meth:`~io.TextIOBase.read` or :meth:`~io.TextIOBase.write` method (depending on the *mode*). *bufsize* - specifies the blocksize and defaults to ``20 * 512`` bytes. Use this variant - in combination with e.g. ``sys.stdin``, a socket :term:`file object` or a tape - device. However, such a :class:`TarFile` object is limited in that it does + :meth:`~io.RawIOBase.read` or :meth:`~io.RawIOBase.write` method + (depending on the *mode*) that works with bytes. + *bufsize* specifies the blocksize and defaults to ``20 * 512`` bytes. + Use this variant in combination with e.g. ``sys.stdin.buffer``, a socket + :term:`file object` or a tape device. + However, such a :class:`TarFile` object is limited in that it does not allow random access, see :ref:`tar-examples`. The currently possible modes: diff --git a/Lib/tarfile.py b/Lib/tarfile.py index 02f5e3b66c0766..027a19b9ed5994 100755 --- a/Lib/tarfile.py +++ b/Lib/tarfile.py @@ -331,10 +331,11 @@ def write(self, s): class _Stream: """Class that serves as an adapter between TarFile and a stream-like object. The stream-like object only - needs to have a read() or write() method and is accessed - blockwise. Use of gzip or bzip2 compression is possible. - A stream-like object could be for example: sys.stdin, - sys.stdout, a socket, a tape device etc. + needs to have a read() or write() method that works with bytes, + and the method is accessed blockwise. + Use of gzip or bzip2 compression is possible. + A stream-like object could be for example: sys.stdin.buffer, + sys.stdout.buffer, a socket, a tape device etc. _Stream is intended to be used only internally. """

1 0