summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.10] gh-93453: Only emit deprecation warning in asyncio.get_event_loop ↵Łukasz Langa2022-12-063-9/+20
| | | | | | | | | | | when a new event loop is created (#100059) It no longer emits a deprecation warning if the current event loop was set. (cherry picked from commit 3fae04b10e2655a20a3aadb5e0d63e87206d0c67) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.10] gh-100001: Remove doc typo, add versionadded (GH-100042) (#100044)Miss Islington (bot)2022-12-061-1/+3
| | | | | | (cherry picked from commit bed15f87eadc726122185cf41efcdda289f4a7b1) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* gh-100001: Omit control characters in http.server stderr logs. (GH-100002)Miss Islington (bot)2022-12-051-0/+7
| | | | | | Replace control characters in http.server.BaseHTTPRequestHandler.log_message with an escaped \xHH sequence to avoid causing problems for the terminal the output is printed to. (cherry picked from commit d8ab0a4dfa48f881b4ac9ab857d2e9de42f72828) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* [3.10] dataclasses.rst: Prevent horizontal scrolling (gh-100025). (gh-100029)Eric V. Smith2022-12-051-1/+2
| | | | | | | (cherry picked from commit 51ee0a29e9b20c3e4a94a675e73a894ee2fe447b) Co-authored-by: Ram Rachum <ram@rachum.com> Co-authored-by: Ram Rachum <ram@rachum.com>
* gh-85747: "Preface" section of asyncio-eventloop.rst: Switch to active voice ↵Miss Islington (bot)2022-12-041-7/+10
| | | | | | | and suggest other edits (GH-99784) (cherry picked from commit bf26bdf6ac04878fc720e78422991aaedb9808a1) Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
* [3.10] GH-98906 ```re``` module: ```search() vs. match()``` section should ↵Miss Islington (bot)2022-11-301-6/+12
| | | | | | | | | | | | mention ```fullmatch()``` (GH-98916) (GH-99913) GH-98906 ```re``` module: ```search() vs. match()``` section should mention ```fullmatch()``` (GH-98916) Mention fullmatch along with search and match. (cherry picked from commit e0f91deb5930ecb02e7f8ced9bd82609e6889fb0) Co-authored-by: ram vikram singh <ramvikrams243@gmail.com> Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
* Docs: improve accuracy of socketserver reference (GH-24767)Miss Islington (bot)2022-11-291-7/+3
| | | | | (cherry picked from commit 052bc128ac0bcafd36a0cbee5f4c2a10d74468dc) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
* whatsnew-3.10: Mention PEP 647 in the Release highlights section. (GH-99853)Miss Islington (bot)2022-11-291-1/+2
| | | | | | | | Mention PEP 647 in the Release highlights section. Also re-ordered the list so it matches the order in the details sections below. (cherry picked from commit d74a58872c243bc766055d42f8280721629e3c82) Co-authored-by: Yilei "Dolee" Yang <yileiyang@google.com>
* gh-90717: Update the documentation for the altchars paremeter in base64 ↵Steve Dower2022-11-291-8/+11
| | | | | library (GH-94187) Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
* gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)Miss Islington (bot)2022-11-281-6/+25
| | | | | | | | | | | | | | | | | | | | These slots are marked "should be treated as read-only" in the table at the start of the document. That doesn't say anything about setting them in the static struct. `tp_bases` docs did say that it should be ``NULL`` (TIL!). If you ignore that, seemingly nothing bad happens. However, some slots may not be inherited, depending on which sub-slot structs are present. (FWIW, NumPy sets tp_bases and is affected by the quirk -- though to be fair, its DUAL_INHERIT code probably predates tp_bases docs, and also the result happens to be benign.) This patch makes things explicit. It also makes the summary table legend easier to scan. (cherry picked from commit 219696abb240607d3f807853c4c180825e60716e) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* Docs: both sqlite3 "point examples" now adapt to str (GH-99823)Miss Islington (bot)2022-11-271-1/+1
| | | | | (cherry picked from commit 276643e207d44c53b87a8108d5b00982defcce1e) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* doc: Remove backslashes in doctest grammar docs (GH-29346)Miss Islington (bot)2022-11-271-3/+3
| | | | | (cherry picked from commit 22860dbbc8b53954055847d2bb036af68b4ea409) Co-authored-by: George Zhang <geetransit@gmail.com>
* bpo-43327: Fix the docs for PyImport_ImportFrozenModuleObject() (GH-24659)Miss Islington (bot)2022-11-271-2/+2
| | | | | | | | | The docs stated that PyImport_ImportFrozenModuleObject() returns a new reference, but it actually returns an int. (cherry picked from commit 62a5dc13e941d01beb215db4218a10977914ab55) Co-authored-by: Zackery Spytz <zspytz@gmail.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* [3.10] gh-99795: Fix typo in importlib.resources.abc (GH-99796) (GH-99800)Jason R. Coombs2022-11-261-1/+1
| | | | | | | | | | Changing TraversableReader to TraversableResources at one place of the documentation. See GH-99795 for more details.. (cherry picked from commit 5f8898216e7b67b7de6b0b1aad9277e88bcebfdb) Co-authored-by: busywhitespace <busywhitespace@tuta.io> Co-authored-by: busywhitespace <busywhitespace@tuta.io>
* [3.10] gh-99502: mention bytes-like objects as input in ↵Miss Islington (bot)2022-11-261-1/+3
| | | | | | | | | | | | | `secrets.compare_digest` (GH-99512) (#99790) gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512) Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest It is the same function, just re-exported. So, I guess they should mention the same input types. (cherry picked from commit 47d673d81fc315069c14f9438ebe61fb70ef1ccc) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* Fix typo in `__match_args__` doc (GH-99785)Miss Islington (bot)2022-11-261-1/+1
| | | | | | A opy of GH-98549, whose author (@icecream17) uses a school computer that blocks the CLA site. I did not mention this in commit comment above so CLA bot does not pick up the name and request the CLA again. (cherry picked from commit a86d8545221b16e714ffe3bda5afafc1d4748d13) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* gh-96168: Add sqlite3 row factory how-to (GH-99507)Miss Islington (bot)2022-11-251-41/+119
| | | | | | | (cherry picked from commit 8749121b07f48994ea47f2e7ff75fb13c13953f6) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Fix rendering of audioop license in Doc/license.rst (GH-99752)Miss Islington (bot)2022-11-241-0/+3
| | | | | | | Also some cosmetic blank line additions for consistency with the formatting of the rest of the file. (cherry picked from commit b5b3904f05e77f044f158307bc6bdd2bc1b670a2) Co-authored-by: Zachary Ware <zach@python.org>
* GH-92892: Add section about variadic functions to ctypes documentation ↵Miss Islington (bot)2022-11-221-0/+20
| | | | | | | | | | | (GH-99529) On some platforms, and in particular macOS/arm64, the calling convention for variadic arguments is different from the regular calling convention. Add a section to the documentation to document this. (cherry picked from commit bc3a11d21ddef28047b18c0f6a5068fa9fb16da2) Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
* [3.10] gh-99146 struct module documentation should have more predictable ↵Miss Islington (bot)2022-11-221-76/+206
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | examples/warnings (GH-99141) (GH-99703) gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c16bb03c3d87f53b5fee10325b876262a78) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.10] GH-95815: Document less specific error for os.remove (GH-99571) (#99639)Miss Islington (bot)2022-11-211-1/+1
| | | | | | | | | | | | | GH-95815: Document less specific error for os.remove (GH-99571) os.remove can raise PermissionError instead of IsADirectoryError, when the object to be removed is a directory (in particular on macOS). This reverts a change done in GH-14262. (cherry picked from commit 1cae31d26ba621f6b1f0656ad3d69a0236338bad) Co-authored-by: Ronald Oussoren <ronaldoussoren@mac.com>
* [3.10] gh-85073: Add some missing links to source (GH-99363) (#99589)Stanley2022-11-198-0/+22
| | | | | (cherry picked from commit 27d8dc2c9d3de886a884f79f0621d4586c0e0f7a) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Doc: Replace question mark with fullstop (GH-99558)Miss Islington (bot)2022-11-181-1/+1
| | | | | | | The sentence "Set the LC_CTYPE locale to the user preferred locale." should end with a period instead of a question mark. (cherry picked from commit 0e09d2cc59cad61ad6a7a79aade52e9a2cfa7b34) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.10] gh-92119: ctypes: Print exception class name instead of its ↵Kamil Turek2022-11-131-3/+3
| | | | | | | representation (GH-98302) (#99452) gh-92119: ctypes: Print exception class name instead of its representation (#98302) (cherry picked from commit b9dedfe61dce2997e3e6be318d8c50b0c19c9394)
* gh-99392: Fix sqlite3 converter recipes (GH-99393)Miss Islington (bot)2022-11-121-3/+22
| | | | | (cherry picked from commit dfc1b17a23fed933cffa09eec125a7e8c90ea867) Co-authored-by: naglis <827324+naglis@users.noreply.github.com>
* gh-87604: Clarify in docs that sys.addaudithook is not for sandboxes (GH-99372)Miss Islington (bot)2022-11-111-0/+9
| | | | | (cherry picked from commit c3c3871415c86088d45abcf73ccd2c2b09dc5772) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-98366: use sphinx.locale._ as gettext() in pyspecific.py (GH-98437)Miss Islington (bot)2022-11-111-4/+4
| | | | | | | | fix(doc-tools): use sphinx.locale._ as gettext() for backward-compatibility in pyspecific.py [why] spinix 5.3 changed locale.translators from a defaultdict(gettext.NullTranslations) to a dict, which leads to failure of pyspecific.py. Use sphinx.locale._ as gettext to fix the issue. (cherry picked from commit d26ee8a0a552de111b8245ef0de63e3f3f535d9f) Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
* GH-99183: Document behavior of count() for empty substrings (GH-99339)Miss Islington (bot)2022-11-101-0/+6
| | | | | (cherry picked from commit 2f4af2d99cffed6ba81e4b8fd886de6ae8625a3f) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* gh-99238: clarify the type of the env dict. (GH-99253)Miss Islington (bot)2022-11-081-3/+7
| | | | | (cherry picked from commit 2eee9d9cd7eb1e396fa9a4af7c5fadeeafbdaa38) Co-authored-by: Gregory P. Smith <greg@krypto.org>
* Fix broken link in `asyncio-subprocesses` doc (GH-99214)Miss Islington (bot)2022-11-081-1/+1
| | | | | | | | | | | | | | | | | | | GH- Fix broken link in Doc/library/asyncio-subprocess.rst This is a trivial fix in documentation to fix a broken link. There is a broken link in [Doc/library/asyncio-subprocess.rst](https://docs.python.org/3/library/asyncio-subprocess.htmlGH-asyncio.subprocess.Process) for the function ``wait_for``: ![image](https://user-images.githubusercontent.com/37690409/200388894-fb6b7c42-b2cc-49ec-a239-e3472890db1f.png) I suppose this refers to the function ``asyncio.wait_for`` which is not clear in the docs. This PR fixes the link and the result looks like the following: ![image](https://user-images.githubusercontent.com/37690409/200389483-b4a92105-7d2c-4285-b0fc-78a6dc0be39c.png) (cherry picked from commit acf4d5d5bdecbc8756276731e09bae245d88518d) Co-authored-by: Mikael Koli <koli.mikael@gmail.com> Automerge-Triggered-By: GH:AlexWaygood
* [3.10] gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION ↵Miss Islington (bot)2022-11-071-0/+11
| | | | | | | | | | | | inheritance (GH-99002) (GH-99213) gh-96746: Docs: Clear up Py_TPFLAGS_DISALLOW_INSTANTIATION inheritance (GH-99002) The flag is not inherited, but its effect -- a NULL tp_new -- is. Drop hints for people who come here wanting to “disallow instantiation”. (cherry picked from commit 1438b779971605e516bd0a4051a704d6ffbbd58d) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* doc: Formatting and typo fixes (GH-98974)Miss Islington (bot)2022-11-073-10/+10
| | | | | (cherry picked from commit 728e42fcf51cbb2108caf1382df224c13b53d024) Co-authored-by: jmcb <joelsgp@protonmail.com>
* gh-94286 Fix documentation of print default param (GH-94297)Miss Islington (bot)2022-11-061-1/+1
| | | | | (cherry picked from commit 2db55e0c0069a928775fa819973a76f840c5ab5a) Co-authored-by: Nouran Ali <nouranalimohammed@gmail.com>
* minor edits to locale doc (GH-98537)Miss Islington (bot)2022-11-041-13/+16
| | | | | (cherry picked from commit c0bf7607a1c215cd92f2976c9e915b913fc149d1) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* Docs: add `named` to the list of styles in the sqlite3.paramstyle attr docs ↵Miss Islington (bot)2022-11-031-3/+4
| | | | | | | (GH-99078) (cherry picked from commit 016c7d37b6acfe2203542a2655080c6402b3be1f) Co-authored-by: Nick Pope <nick@nickpope.me.uk>
* [3.10] gh-98740: Fix validation of conditional expressions in RE (GH-98764) ↵Serhiy Storchaka2022-11-031-0/+3
| | | | | | | | | | | | | | | | (GH-99046) In very rare circumstances the JUMP opcode could be confused with the argument of the opcode in the "then" part which doesn't end with the JUMP opcode. This led to incorrect detection of the final JUMP opcode and incorrect calculation of the size of the subexpression. NOTE: Changed return value of functions _validate_inner() and _validate_charset() in Modules/_sre/sre.c. Now they return 0 on success, -1 on failure, and 1 if the last op is JUMP (which usually is a failure). Previously they returned 1 on success and 0 on failure. (cherry picked from commit e9ac890c0273aee413aa528cc202c3efa29f1d7a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-65002: Make note that null bytes are used to pad bytes (GH-98635)Miss Islington (bot)2022-11-031-1/+4
| | | | | (cherry picked from commit 8cd21c2c5d34a5c5e857782da58d773f29ff8821) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* Docs: Add 'as, match statement' to the index (GH-99001)Miss Islington (bot)2022-11-031-0/+1
| | | | | (cherry picked from commit 26720fffd090929fd2058b73e5970cc520b30aef) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* argparse howto: Use f-string in preference to "...".format() (GH-98883)Miss Islington (bot)2022-11-031-2/+2
| | | | | (cherry picked from commit 1fd20d0b57478d8b0d8d58718fa773135348bf98) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
* [3.10] gh-96265: Formatting changes for faq/programming (GH-98242) (#98994)Stanley2022-11-031-37/+46
| | | | | | | | | | | | | | | | | | | | * Formatting changes for faq/programming * Add missing method formatting, use non-literal formatting * Fix sphinx warnings * Some extra formatting missed earlier * More formatting suggestions from review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Add missing colon, avoid referening external module Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 0689b99bb8c4f6058af43a52effaa8a25609dbed) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
* gh-96997: Clarify the contract of PyMem_SetAllocator() (GH-98977)Miss Islington (bot)2022-11-021-0/+21
| | | | | (cherry picked from commit c053284e3930027847d5adf99efcb1aa5ccbacd1) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
* [3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958) ↵Jelle Zijlstra2022-11-021-2/+2
| | | | | | | | | | (#98986) [3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958). (cherry picked from commit 65d1407737befc3e9430eda8ae14ab1c7f9d8c7a) Co-authored-by: Sebastian Rittau <srittau@rittau.biz> Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* gh-92679: Clarify asyncio.loop.start_tls parameters (GH-92682)Miss Islington (bot)2022-11-021-3/+8
| | | | | (cherry picked from commit 898d0d9ad8328326ba5f7df9952e9dc287766ca3) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
* [3.10] [doc] Update cookbook example for socket-based logging in a ↵Miss Islington (bot)2022-11-011-7/+65
| | | | | | production sett… (GH-98922) (GH-98981) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Doc: use "unnumbered" footnotes (GH-98954)Miss Islington (bot)2022-11-011-2/+2
| | | | | | | | Use unnumbered footnote in this file to avoid reseting the footnotes numbering. Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1. (cherry picked from commit f042646595d1cdd2ecdc15222b1766f746d010f0) Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* gh-98576: Fix types in dataclass.InitVar example (gh-98577)Miss Islington (bot)2022-10-311-2/+2
| | | | | (cherry picked from commit 880bafc574bcd811dd7244f9a82056430b489996) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* glossary.rst: Fix typo in package definition (GH-98865)Miss Islington (bot)2022-10-291-1/+1
| | | | | | | | | This is a tiny typo fix of package definition in glossary. According to https://devguide.python.org/documentation/help-documenting/ simple typos don’t require issues of their own, but, instead, a pull request can by submitted directly. Automerge-Triggered-By: GH:AlexWaygood (cherry picked from commit fc94d55ff453a3101e4c00a394d4e38ae2fece13) Co-authored-by: ab <abousselmi@users.noreply.github.com>
* gh-93358: Fix python-config docs for how to embed Python (GH-98649)Miss Islington (bot)2022-10-291-6/+6
| | | | | (cherry picked from commit e063c23c65143a3afae3e201459dc0d52cb6fc96) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* Fix typo in contextvars docs (GH-98823)Miss Islington (bot)2022-10-281-1/+1
| | | | | (cherry picked from commit 72fa57a8fe2e9df637170dc97f994ac70931e8e9) Co-authored-by: cburroughs <chris.burroughs@gmail.com>
* [3.10] `argparse` docs: normalize constant references (#98765) (#98808)Alex Waygood2022-10-281-4/+5
| | | | | | | `argparse` docs: normalize constant references (#98765) (cherry picked from commit b27b57c6e44a276c8a9843fd37d4cf65b2827d5c) Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
generated by cgit v0.12 at 2026-01-05 20:25:59 (GMT)