Mailman 3 October 2024 - Python-checkins

[3.12] gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in warnings docs (GH-125823) (GH-126217)
by willingc 31 Oct '24

31 Oct '24

https://github.com/python/cpython/commit/975911887dd767babfe06aa45e835b32c4… commit: 975911887dd767babfe06aa45e835b32c4112b51 branch: 3.12 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T18:31:35-07:00 summary: [3.12] gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in warnings docs (GH-125823) (GH-126217) gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in warnings docs (GH-125823) Change documentation (cherry picked from commit d467d9246cbe0ce5dc149c4c74223bb8374ece73) Co-authored-by: RUANG (James Roy) <longjinyii(a)outlook.com> files: M Doc/library/warnings.rst diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 511b94a386d5b9..0cd3ca3c9de73f 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -396,7 +396,7 @@ Available Functions ------------------- -.. function:: warn(message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=None) +.. function:: warn(message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=()) Issue a warning, or maybe ignore it or raise an exception. The *category* argument, if given, must be a :ref:`warning category class <warning-categories>`; it

1 0

gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in warnings docs (GH-125823)
by willingc 31 Oct '24

31 Oct '24

https://github.com/python/cpython/commit/d467d9246cbe0ce5dc149c4c74223bb837… commit: d467d9246cbe0ce5dc149c4c74223bb8374ece73 branch: main author: RUANG (James Roy) <longjinyii(a)outlook.com> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T18:15:07-07:00 summary: gh-125818: Fix incorrect signature of argument `skip_file_prefixes` in warnings docs (GH-125823) Change documentation files: M Doc/library/warnings.rst diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 5ea65cbd8ca94c..1e7c4c8b915e7e 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -398,7 +398,7 @@ Available Functions ------------------- -.. function:: warn(message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=None) +.. function:: warn(message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=()) Issue a warning, or maybe ignore it or raise an exception. The *category* argument, if given, must be a :ref:`warning category class <warning-categories>`; it

1 0

gh-126178: NFC Separate Emscripten and WASI standard lib disables in configure (#126179)
by freakboy3742 31 Oct '24

31 Oct '24

https://github.com/python/cpython/commit/b3122aa6132de263f389317efe9dcf2b14… commit: b3122aa6132de263f389317efe9dcf2b14c6b393 branch: main author: Hood Chatham <roberthoodchatham(a)gmail.com> committer: freakboy3742 <russell(a)keith-magee.com> date: 2024-10-31T08:51:11+08:00 summary: gh-126178: NFC Separate Emscripten and WASI standard lib disables in configure (#126179) Separate the Emscripten and WASI stdlib configuration in configure. files: M configure M configure.ac diff --git a/configure b/configure index 5be57e39309b91..3989de82a99ecd 100755 --- a/configure +++ b/configure @@ -29254,7 +29254,7 @@ case $ac_sys_system in #( py_cv_module__scproxy=n/a ;; #( - Emscripten|WASI) : + Emscripten) : @@ -29276,9 +29276,6 @@ case $ac_sys_system in #( py_cv_module_syslog=n/a py_cv_module_=n/a - case $ac_sys_system/$ac_sys_emscripten_target in #( - Emscripten/browser*) : - py_cv_module_fcntl=n/a @@ -29286,10 +29283,28 @@ case $ac_sys_system in #( py_cv_module_termios=n/a py_cv_module_=n/a - ;; #( - Emscripten/node*) : - ;; #( - WASI/*) : + ;; #( + WASI) : + + + + py_cv_module__curses=n/a + py_cv_module__curses_panel=n/a + py_cv_module__dbm=n/a + py_cv_module__gdbm=n/a + py_cv_module__multiprocessing=n/a + py_cv_module__posixshmem=n/a + py_cv_module__posixsubprocess=n/a + py_cv_module__scproxy=n/a + py_cv_module__tkinter=n/a + py_cv_module__interpreters=n/a + py_cv_module__interpchannels=n/a + py_cv_module__interpqueues=n/a + py_cv_module_grp=n/a + py_cv_module_pwd=n/a + py_cv_module_resource=n/a + py_cv_module_syslog=n/a + py_cv_module_=n/a @@ -29305,11 +29320,6 @@ case $ac_sys_system in #( py_cv_module_xxlimited_35=n/a py_cv_module_=n/a - - ;; #( - *) : - ;; -esac ;; #( *) : diff --git a/configure.ac b/configure.ac index caf0244cc7b54b..6a98cc5e2a0835 100644 --- a/configure.ac +++ b/configure.ac @@ -7622,12 +7622,11 @@ AS_CASE([$ac_sys_system], [CYGWIN*], [PY_STDLIB_MOD_SET_NA([_scproxy])], [QNX*], [PY_STDLIB_MOD_SET_NA([_scproxy])], [FreeBSD*], [PY_STDLIB_MOD_SET_NA([_scproxy])], - [Emscripten|WASI], [ + [Emscripten], [ dnl subprocess and multiprocessing are not supported (no fork syscall). dnl curses and tkinter user interface are not available. dnl dbm and gdbm aren't available, too. - dnl Emscripten and WASI provide only stubs for pwd, grp APIs. - dnl resource functions (get/setrusage) are stubs, too. + dnl pwd, grp APIs, and resource functions (get/setrusage) are stubs. PY_STDLIB_MOD_SET_NA( [_curses], [_curses_panel], @@ -7646,33 +7645,50 @@ AS_CASE([$ac_sys_system], [resource], [syslog], ) - AS_CASE([$ac_sys_system/$ac_sys_emscripten_target], - [Emscripten/browser*], [ - dnl These modules are not particularly useful in browsers. - PY_STDLIB_MOD_SET_NA( - [fcntl], - [readline], - [termios], - ) - ], - [Emscripten/node*], [], - [WASI/*], [ - dnl WASI SDK 15.0 does not support file locking, mmap, and more. - dnl Test modules that must be compiled as shared libraries are not supported - dnl (see Modules/Setup.stdlib.in). - PY_STDLIB_MOD_SET_NA( - [_ctypes_test], - [_testexternalinspection], - [_testimportmultiple], - [_testmultiphase], - [_testsinglephase], - [fcntl], - [mmap], - [termios], - [xxlimited], - [xxlimited_35], - ) - ] + dnl fcntl, readline, and termios are not particularly useful in browsers. + PY_STDLIB_MOD_SET_NA( + [fcntl], + [readline], + [termios], + ) + ], + [WASI], [ + dnl subprocess and multiprocessing are not supported (no fork syscall). + dnl curses and tkinter user interface are not available. + dnl dbm and gdbm aren't available, too. + dnl pwd, grp APIs, and resource functions (get/setrusage) are stubs. + PY_STDLIB_MOD_SET_NA( + [_curses], + [_curses_panel], + [_dbm], + [_gdbm], + [_multiprocessing], + [_posixshmem], + [_posixsubprocess], + [_scproxy], + [_tkinter], + [_interpreters], + [_interpchannels], + [_interpqueues], + [grp], + [pwd], + [resource], + [syslog], + ) + dnl WASI SDK 15.0 does not support file locking, mmap, and more. + dnl Test modules that must be compiled as shared libraries are not supported + dnl (see Modules/Setup.stdlib.in). + PY_STDLIB_MOD_SET_NA( + [_ctypes_test], + [_testexternalinspection], + [_testimportmultiple], + [_testmultiphase], + [_testsinglephase], + [fcntl], + [mmap], + [termios], + [xxlimited], + [xxlimited_35], ) ], [PY_STDLIB_MOD_SET_NA([_scproxy])]

1 0

Add myself to CODEOWNERS for WASM/emscripten and Android (#126210)
by freakboy3742 31 Oct '24

31 Oct '24

https://github.com/python/cpython/commit/ac3a2c8abceeec44848635c26f09ff382b… commit: ac3a2c8abceeec44848635c26f09ff382bbcab73 branch: main author: Russell Keith-Magee <russell(a)keith-magee.com> committer: freakboy3742 <russell(a)keith-magee.com> date: 2024-10-31T00:12:37Z summary: Add myself to CODEOWNERS for WASM/emscripten and Android (#126210) Add RKM to CODEOWNERS for WASM/emscripten and Android. files: M .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index e929ac8c474b2f..9024639e25fcdf 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -255,8 +255,8 @@ Modules/_interp*module.c @ericsnowcurrently Lib/test/test_interpreters/ @ericsnowcurrently # Android -**/*Android* @mhsmith -**/*android* @mhsmith +**/*Android* @mhsmith @freakboy3742 +**/*android* @mhsmith @freakboy3742 # iOS (but not termios) **/iOS* @freakboy3742 @@ -267,7 +267,7 @@ Lib/test/test_interpreters/ @ericsnowcurrently **/*-ios* @freakboy3742 # WebAssembly -/Tools/wasm/ @brettcannon +/Tools/wasm/ @brettcannon @freakboy3742 # SBOM /Misc/externals.spdx.json @sethmlarson

1 0

[3.12] gh-116633: Add a note about buggy behavior of csv.QUOTE_NOTNULL and csv.QUOTE_STRINGS (GH-117235)
by willingc 31 Oct '24

31 Oct '24

https://github.com/python/cpython/commit/6bfe5fbc19b96d6dc4c5f5f45bbb1acde4… commit: 6bfe5fbc19b96d6dc4c5f5f45bbb1acde45ade8f branch: 3.12 author: Prometheus3375 <35541026+Prometheus3375(a)users.noreply.github.com> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T17:08:28-07:00 summary: [3.12] gh-116633: Add a note about buggy behavior of csv.QUOTE_NOTNULL and csv.QUOTE_STRINGS (GH-117235) * Add a note about bug * Properly link constants files: M Doc/library/csv.rst diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst index 533cdf13974be6..8e432078e1949a 100644 --- a/Doc/library/csv.rst +++ b/Doc/library/csv.rst @@ -365,6 +365,12 @@ The :mod:`csv` module defines the following constants: .. versionadded:: 3.12 +.. note:: + + Due to a bug, constants :data:`QUOTE_NOTNULL` and :data:`QUOTE_STRINGS` + do not affect behaviour of :class:`reader` objects. + This bug is fixed in Python 3.13. + The :mod:`csv` module defines the following exception:

1 0

GH-126205: Fix conversion of UNC paths to file URIs (#126208)
by barneygale 30 Oct '24

30 Oct '24

https://github.com/python/cpython/commit/951cb2c369e8b8fb9f93662658391a53fd… commit: 951cb2c369e8b8fb9f93662658391a53fd727787 branch: main author: Barney Gale <barney.gale(a)gmail.com> committer: barneygale <barney.gale(a)gmail.com> date: 2024-10-30T22:56:58Z summary: GH-126205: Fix conversion of UNC paths to file URIs (#126208) File URIs for Windows UNC paths should begin with two slashes, not four. files: A Misc/NEWS.d/next/Library/2024-10-30-20-45-17.gh-issue-126205.CHEmtx.rst M Lib/nturl2path.py M Lib/test/test_urllib.py diff --git a/Lib/nturl2path.py b/Lib/nturl2path.py index 61852aff58912d..6453f202c26d14 100644 --- a/Lib/nturl2path.py +++ b/Lib/nturl2path.py @@ -55,16 +55,11 @@ def pathname2url(p): if p[:4] == '\\\\?\\': p = p[4:] if p[:4].upper() == 'UNC\\': - p = '\\' + p[4:] + p = '\\\\' + p[4:] elif p[1:2] != ':': raise OSError('Bad path: ' + p) if not ':' in p: # No drive specifier, just convert slashes and quote the name - if p[:2] == '\\\\': - # path is something like \\host\path\on\remote\host - # convert this to ////host/path/on/remote/host - # (notice doubling of slashes at the start of the path) - p = '\\\\' + p components = p.split('\\') return urllib.parse.quote('/'.join(components)) comp = p.split(':', maxsplit=2) diff --git a/Lib/test/test_urllib.py b/Lib/test/test_urllib.py index dc852c8f02758c..3ee17f96b817e1 100644 --- a/Lib/test/test_urllib.py +++ b/Lib/test/test_urllib.py @@ -1524,7 +1524,7 @@ def test_pathname2url_win(self): # Test special prefixes are correctly handled in pathname2url() fn = urllib.request.pathname2url self.assertEqual(fn('\\\\?\\C:\\dir'), '///C:/dir') - self.assertEqual(fn('\\\\?\\unc\\server\\share\\dir'), '/server/share/dir') + self.assertEqual(fn('\\\\?\\unc\\server\\share\\dir'), '//server/share/dir') self.assertEqual(fn("C:"), '///C:') self.assertEqual(fn("C:\\"), '///C:') self.assertEqual(fn('C:\\a\\b.c'), '///C:/a/b.c') @@ -1535,14 +1535,14 @@ def test_pathname2url_win(self): self.assertRaises(IOError, fn, "XX:\\") # No drive letter self.assertEqual(fn("\\folder\\test\\"), '/folder/test/') - self.assertEqual(fn("\\\\folder\\test\\"), '////folder/test/') - self.assertEqual(fn("\\\\\\folder\\test\\"), '/////folder/test/') - self.assertEqual(fn('\\\\some\\share\\'), '////some/share/') - self.assertEqual(fn('\\\\some\\share\\a\\b.c'), '////some/share/a/b.c') - self.assertEqual(fn('\\\\some\\share\\a\\b%#c\xe9'), '////some/share/a/b%25%23c%C3%A9') + self.assertEqual(fn("\\\\folder\\test\\"), '//folder/test/') + self.assertEqual(fn("\\\\\\folder\\test\\"), '///folder/test/') + self.assertEqual(fn('\\\\some\\share\\'), '//some/share/') + self.assertEqual(fn('\\\\some\\share\\a\\b.c'), '//some/share/a/b.c') + self.assertEqual(fn('\\\\some\\share\\a\\b%#c\xe9'), '//some/share/a/b%25%23c%C3%A9') # Round-tripping urls = ['///C:', - '/////folder/test/', + '///folder/test/', '///C:/foo/bar/spam.foo'] for url in urls: self.assertEqual(fn(urllib.request.url2pathname(url)), url) diff --git a/Misc/NEWS.d/next/Library/2024-10-30-20-45-17.gh-issue-126205.CHEmtx.rst b/Misc/NEWS.d/next/Library/2024-10-30-20-45-17.gh-issue-126205.CHEmtx.rst new file mode 100644 index 00000000000000..c92ffb75056606 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2024-10-30-20-45-17.gh-issue-126205.CHEmtx.rst @@ -0,0 +1,2 @@ +Fix issue where :func:`urllib.request.pathname2url` generated URLs beginning +with four slashes (rather than two) when given a Windows UNC path.

1 0

gh-121267: Improve performance of tarfile (#121267) (#121269)
by hauntsaninja 30 Oct '24

30 Oct '24

https://github.com/python/cpython/commit/2b2d607095335024e5e2bb358e3ef37650… commit: 2b2d607095335024e5e2bb358e3ef37650536839 branch: main author: Johan Förberg <johan(a)forberg.se> committer: hauntsaninja <12621235+hauntsaninja(a)users.noreply.github.com> date: 2024-10-30T15:08:30-07:00 summary: gh-121267: Improve performance of tarfile (#121267) (#121269) Tarfile in the default write mode spends much of its time resolving UIDs into usernames and GIDs into group names. By caching these mappings, a significant speedup can be achieved. In my simple benchmark[1], this extra caching speeds up tarfile by 8x. [1] https://gist.github.com/jforberg/86af759c796199740c31547ae828aef2 --------- Co-authored-by: Tian Gao <gaogaotiantian(a)hotmail.com> Co-authored-by: Bénédikt Tran <10796600+picnixz(a)users.noreply.github.com> Co-authored-by: Shantanu <12621235+hauntsaninja(a)users.noreply.github.com> files: A Misc/NEWS.d/next/Library/2024-07-02-15-56-42.gh-issue-121267.yFBWkh.rst M Lib/tarfile.py diff --git a/Lib/tarfile.py b/Lib/tarfile.py index 1475b3da2d3293..a0fab46b24e249 100644 --- a/Lib/tarfile.py +++ b/Lib/tarfile.py @@ -1760,6 +1760,8 @@ def __init__(self, name=None, mode="r", fileobj=None, format=None, # current position in the archive file self.inodes = {} # dictionary caching the inodes of # archive members already added + self._unames = {} # Cached mappings of uid -> uname + self._gnames = {} # Cached mappings of gid -> gname try: if self.mode == "r": @@ -2138,16 +2140,23 @@ def gettarinfo(self, name=None, arcname=None, fileobj=None): tarinfo.mtime = statres.st_mtime tarinfo.type = type tarinfo.linkname = linkname + + # Calls to pwd.getpwuid() and grp.getgrgid() tend to be expensive. To + # speed things up, cache the resolved usernames and group names. if pwd: - try: - tarinfo.uname = pwd.getpwuid(tarinfo.uid)[0] - except KeyError: - pass + if tarinfo.uid not in self._unames: + try: + self._unames[tarinfo.uid] = pwd.getpwuid(tarinfo.uid)[0] + except KeyError: + self._unames[tarinfo.uid] = '' + tarinfo.uname = self._unames[tarinfo.uid] if grp: - try: - tarinfo.gname = grp.getgrgid(tarinfo.gid)[0] - except KeyError: - pass + if tarinfo.gid not in self._gnames: + try: + self._gnames[tarinfo.gid] = grp.getgrgid(tarinfo.gid)[0] + except KeyError: + self._gnames[tarinfo.gid] = '' + tarinfo.gname = self._gnames[tarinfo.gid] if type in (CHRTYPE, BLKTYPE): if hasattr(os, "major") and hasattr(os, "minor"): diff --git a/Misc/NEWS.d/next/Library/2024-07-02-15-56-42.gh-issue-121267.yFBWkh.rst b/Misc/NEWS.d/next/Library/2024-07-02-15-56-42.gh-issue-121267.yFBWkh.rst new file mode 100644 index 00000000000000..9e52405c15a82d --- /dev/null +++ b/Misc/NEWS.d/next/Library/2024-07-02-15-56-42.gh-issue-121267.yFBWkh.rst @@ -0,0 +1,2 @@ +Improve the performance of :mod:`tarfile` when writing files, by caching user names +and group names.

1 0

[3.13] gh-124872: Refine contextvars documentation (GH-124773) (#125233)
by willingc 30 Oct '24

30 Oct '24

https://github.com/python/cpython/commit/2db2b5ea9cc689644bc7bc93f27a3e1542… commit: 2db2b5ea9cc689644bc7bc93f27a3e154228848a branch: 3.13 author: Richard Hansen <rhansen(a)rhansen.org> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T20:48:02Z summary: [3.13] gh-124872: Refine contextvars documentation (GH-124773) (#125233) [3.13] gh-124872: Refine contextvars documentation * Add definitions for "context", "current context", and "context management protocol". * Update related definitions to be consistent with the new definitions. * Restructure the documentation for the `contextvars.Context` class to prepare for adding context manager support, and for consistency with the definitions. * Use `testcode` and `testoutput` to test the `Context.run` example. (cherry-picked from commit 99400930ac1d4e5e10a5ae30f8202d8bc2661e39) Co-authored-by: Carol Willing <carolcode(a)willingconsulting.com> files: A Misc/NEWS.d/next/Documentation/2024-10-10-02-56-24.gh-issue-124872.0mDDOq.rst M Doc/glossary.rst M Doc/library/contextvars.rst diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 3c931a7c2a9392..5c56c419514da1 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -260,19 +260,33 @@ Glossary advanced mathematical feature. If you're not aware of a need for them, it's almost certain you can safely ignore them. + context + This term has different meanings depending on where and how it is used. + Some common meanings: + + * The temporary state or environment established by a :term:`context + manager` via a :keyword:`with` statement. + * The collection of keyvalue bindings associated with a particular + :class:`contextvars.Context` object and accessed via + :class:`~contextvars.ContextVar` objects. Also see :term:`context + variable`. + * A :class:`contextvars.Context` object. Also see :term:`current + context`. + + context management protocol + The :meth:`~object.__enter__` and :meth:`~object.__exit__` methods called + by the :keyword:`with` statement. See :pep:`343`. + context manager - An object which controls the environment seen in a :keyword:`with` - statement by defining :meth:`~object.__enter__` and :meth:`~object.__exit__` methods. - See :pep:`343`. + An object which implements the :term:`context management protocol` and + controls the environment seen in a :keyword:`with` statement. See + :pep:`343`. context variable - A variable which can have different values depending on its context. - This is similar to Thread-Local Storage in which each execution - thread may have a different value for a variable. However, with context - variables, there may be several contexts in one execution thread and the - main usage for context variables is to keep track of variables in + A variable whose value depends on which context is the :term:`current + context`. Values are accessed via :class:`contextvars.ContextVar` + objects. Context variables are primarily used to isolate state between concurrent asynchronous tasks. - See :mod:`contextvars`. contiguous .. index:: C-contiguous, Fortran contiguous @@ -306,6 +320,14 @@ Glossary is used when necessary to distinguish this implementation from others such as Jython or IronPython. + current context + The :term:`context` (:class:`contextvars.Context` object) that is + currently used by :class:`~contextvars.ContextVar` objects to access (get + or set) the values of :term:`context variables <context variable>`. Each + thread has its own current context. Frameworks for executing asynchronous + tasks (see :mod:`asyncio`) associate each task with a context which + becomes the current context whenever the task starts or resumes execution. + decorator A function returning another function, usually applied as a function transformation using the ``@wrapper`` syntax. Common examples for diff --git a/Doc/library/contextvars.rst b/Doc/library/contextvars.rst index 2a79dfe8f81e26..2b1fb9fdd29cd8 100644 --- a/Doc/library/contextvars.rst +++ b/Doc/library/contextvars.rst @@ -144,51 +144,89 @@ Manual Context Management To get a copy of the current context use the :func:`~contextvars.copy_context` function. - Every thread will have a different top-level :class:`~contextvars.Context` - object. This means that a :class:`ContextVar` object behaves in a similar - fashion to :func:`threading.local` when values are assigned in different - threads. + Each thread has its own effective stack of :class:`!Context` objects. The + :term:`current context` is the :class:`!Context` object at the top of the + current thread's stack. All :class:`!Context` objects in the stacks are + considered to be *entered*. + + *Entering* a context, which can be done by calling its :meth:`~Context.run` + method, makes the context the current context by pushing it onto the top of + the current thread's context stack. + + *Exiting* from the current context, which can be done by returning from the + callback passed to the :meth:`~Context.run` method, restores the current + context to what it was before the context was entered by popping the context + off the top of the context stack. + + Since each thread has its own context stack, :class:`ContextVar` objects + behave in a similar fashion to :func:`threading.local` when values are + assigned in different threads. + + Attempting to enter an already entered context, including contexts entered in + other threads, raises a :exc:`RuntimeError`. + + After exiting a context, it can later be re-entered (from any thread). + + Any changes to :class:`ContextVar` values via the :meth:`ContextVar.set` + method are recorded in the current context. The :meth:`ContextVar.get` + method returns the value associated with the current context. Exiting a + context effectively reverts any changes made to context variables while the + context was entered (if needed, the values can be restored by re-entering the + context). Context implements the :class:`collections.abc.Mapping` interface. .. method:: run(callable, *args, **kwargs) - Execute ``callable(*args, **kwargs)`` code in the context object - the *run* method is called on. Return the result of the execution - or propagate an exception if one occurred. + Enters the Context, executes ``callable(*args, **kwargs)``, then exits the + Context. Returns *callable*'s return value, or propagates an exception if + one occurred. + + Example: + + .. testcode:: + + import contextvars - Any changes to any context variables that *callable* makes will - be contained in the context object:: + var = contextvars.ContextVar('var') + var.set('spam') + print(var.get()) # 'spam' - var = ContextVar('var') - var.set('spam') + ctx = contextvars.copy_context() - def main(): - # 'var' was set to 'spam' before - # calling 'copy_context()' and 'ctx.run(main)', so: - # var.get() == ctx[var] == 'spam' + def main(): + # 'var' was set to 'spam' before + # calling 'copy_context()' and 'ctx.run(main)', so: + print(var.get()) # 'spam' + print(ctx[var]) # 'spam' - var.set('ham') + var.set('ham') - # Now, after setting 'var' to 'ham': - # var.get() == ctx[var] == 'ham' + # Now, after setting 'var' to 'ham': + print(var.get()) # 'ham' + print(ctx[var]) # 'ham' - ctx = copy_context() + # Any changes that the 'main' function makes to 'var' + # will be contained in 'ctx'. + ctx.run(main) - # Any changes that the 'main' function makes to 'var' - # will be contained in 'ctx'. - ctx.run(main) + # The 'main()' function was run in the 'ctx' context, + # so changes to 'var' are contained in it: + print(ctx[var]) # 'ham' - # The 'main()' function was run in the 'ctx' context, - # so changes to 'var' are contained in it: - # ctx[var] == 'ham' + # However, outside of 'ctx', 'var' is still set to 'spam': + print(var.get()) # 'spam' - # However, outside of 'ctx', 'var' is still set to 'spam': - # var.get() == 'spam' + .. testoutput:: + :hide: - The method raises a :exc:`RuntimeError` when called on the same - context object from more than one OS thread, or when called - recursively. + spam + spam + spam + ham + ham + ham + spam .. method:: copy() diff --git a/Misc/NEWS.d/next/Documentation/2024-10-10-02-56-24.gh-issue-124872.0mDDOq.rst b/Misc/NEWS.d/next/Documentation/2024-10-10-02-56-24.gh-issue-124872.0mDDOq.rst new file mode 100644 index 00000000000000..69a5c764d05a2e --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2024-10-10-02-56-24.gh-issue-124872.0mDDOq.rst @@ -0,0 +1,3 @@ +Added definitions for :term:`context`, :term:`current context`, and +:term:`context management protocol`, updated related definitions to be +consistent, and expanded the documentation for :class:`contextvars.Context`.

1 0

[3.12]: gh-103484: Relink _xxsubinterpretersmodule.c in whatsnew/3.12.rst (GH-124183)
by willingc 30 Oct '24

30 Oct '24

https://github.com/python/cpython/commit/3ef8a3a9004ff7ed2bf6f2f67f13ff5b37… commit: 3ef8a3a9004ff7ed2bf6f2f67f13ff5b37c42204 branch: 3.12 author: Rafael Fontenelle <rffontenelle(a)users.noreply.github.com> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T13:46:13-07:00 summary: [3.12]: gh-103484: Relink _xxsubinterpretersmodule.c in whatsnew/3.12.rst (GH-124183) Relink _xxsubinterpretersmodule.c in whatsnew/3.12.rst files: M Doc/whatsnew/3.12.rst diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst index 7ec1935ce956d3..c99c4559a79f91 100644 --- a/Doc/whatsnew/3.12.rst +++ b/Doc/whatsnew/3.12.rst @@ -359,7 +359,7 @@ create an interpreter with its own GIL: /* The new interpreter is now active in the current thread. */ For further examples how to use the C-API for sub-interpreters with a -per-interpreter GIL, see ``Modules/_xxsubinterpretersmodule.c``. +per-interpreter GIL, see :source:`Modules/_xxsubinterpretersmodule.c`. (Contributed by Eric Snow in :gh:`104210`, etc.)

1 0

[3.12] Prefer "similar" over "equivalent" in tutorial (GH-125343) (GH-125373)
by willingc 30 Oct '24

30 Oct '24

https://github.com/python/cpython/commit/a089adfb539ebd83545fea0397d90d32e4… commit: a089adfb539ebd83545fea0397d90d32e4cc8bc9 branch: 3.12 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: willingc <carolcode(a)willingconsulting.com> date: 2024-10-30T13:34:13-07:00 summary: [3.12] Prefer "similar" over "equivalent" in tutorial (GH-125343) (GH-125373) Prefer "similar" over "equivalent" in tutorial (GH-125343) In the datastructures tutorial doc, some operations are described as "equivalent to" others. This has led to some user-confusion -- at least in the Discourse forums -- about cases in which the operations differ. This change doesn't systematically eliminate the word "equivalent" from the tutorial. It just substitutes "similar to" in several cases in which "equivalent to" could mislead users into expecting exact equivalence. (cherry picked from commit 4a2282b0679bbf7b7fbd36aae1b1565145238961) Co-authored-by: Stephen Rosen <sirosen(a)globus.org> files: M Doc/tutorial/datastructures.rst diff --git a/Doc/tutorial/datastructures.rst b/Doc/tutorial/datastructures.rst index 73f17adeea72de..31941bc112a135 100644 --- a/Doc/tutorial/datastructures.rst +++ b/Doc/tutorial/datastructures.rst @@ -19,13 +19,13 @@ objects: .. method:: list.append(x) :noindex: - Add an item to the end of the list. Equivalent to ``a[len(a):] = [x]``. + Add an item to the end of the list. Similar to ``a[len(a):] = [x]``. .. method:: list.extend(iterable) :noindex: - Extend the list by appending all the items from the iterable. Equivalent to + Extend the list by appending all the items from the iterable. Similar to ``a[len(a):] = iterable``. @@ -56,7 +56,7 @@ objects: .. method:: list.clear() :noindex: - Remove all items from the list. Equivalent to ``del a[:]``. + Remove all items from the list. Similar to ``del a[:]``. .. method:: list.index(x[, start[, end]]) @@ -93,7 +93,7 @@ objects: .. method:: list.copy() :noindex: - Return a shallow copy of the list. Equivalent to ``a[:]``. + Return a shallow copy of the list. Similar to ``a[:]``. An example that uses most of the list methods::

1 0