summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* gh-115777: Fix double versionadded directives (GH-116269)Serhiy Storchaka2024-03-056-24/+8
|
* gh-57141: Add dircmp shallow option (GH-109499)Tobias Rautenkranz2024-03-041-2/+7
| | | | | Co-authored-by: Steve Ward <planet36@gmail.com> Co-authored-by: Sanyam Khurana <8039608+CuriousLearner@users.noreply.github.com>
* Consistently spell out *predicate* instead of *pred*. (gh-116308)Raymond Hettinger2024-03-041-23/+16
|
* gh-115256: Remove refcycles from tarfile writing (GH-115257)pan3242024-03-041-0/+3
|
* GH-116271 Docs: provide clarification for object assignments in the Tutorial ↵Kerim Kabirov2024-03-041-7/+24
| | | | | | | section (#116283) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* gh-116010: Remove link to deprecated PEP 6 in FAQ guide (#116246)Iman Tabrizian2024-03-031-3/+5
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* gh-116281: Remove wrong '\' from '\*' in some doc signatures (#116282)HarryLHW2024-03-033-6/+6
|
* Docs: update using/configure.rst (#116274)Hugo van Kemenade2024-03-031-23/+31
|
* gh-72971: Clarify the special no-TypeError behavior for equality (#110729)Gouvernathor2024-03-031-1/+4
|
* gh-104711: Add security warning to the CGIHTTPRequestHandler document ↵AN Long2024-03-011-0/+6
| | | | (GH-115915)
* gh-116035: Document that both tzinfo and fold are ignored in comparisons if ↵Serhiy Storchaka2024-03-011-2/+8
| | | | | tzinfo is the same (GH-116187) This mostly restores information removed in c12240ed28aac6494750e00143bc550c4d6d8ad1 (GH-114749).
* gh-104219: Document that idunders can return NotImplemented (#104220)Gouvernathor2024-03-011-2/+4
| | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-115398: Expose Expat >=2.6.0 reparse deferral API (CVE-2023-52425) ↵Sebastian Pipping2024-02-293-0/+71
| | | | | | | | | | | | | | | | | | | | | (GH-115623) Allow controlling Expat >=2.6.0 reparse deferral (CVE-2023-52425) by adding five new methods: - `xml.etree.ElementTree.XMLParser.flush` - `xml.etree.ElementTree.XMLPullParser.flush` - `xml.parsers.expat.xmlparser.GetReparseDeferralEnabled` - `xml.parsers.expat.xmlparser.SetReparseDeferralEnabled` - `xml.sax.expatreader.ExpatParser.flush` Based on the "flush" idea from https://github.com/python/cpython/pull/115138#issuecomment-1932444270 . ### Notes - Please treat as a security fix related to CVE-2023-52425. Includes code suggested-by: Snild Dolkow <snild@sony.com> and by core dev Serhiy Storchaka.
* Fix rendering of null character in ast.rst (#116080)Shantanu2024-02-291-1/+1
|
* gh-73580: Docs for tunnelling TLS through TLS (GH-22539)Carl Bordum Hansen2024-02-291-0/+3
|
* Docs: mark up NotImplemented using the :data: role throughout the docs (#116135)Erlend E. Aasland2024-02-2914-37/+37
|
* gh-115811: Update documentation to add some Logger attributes. (GH-116109)Vinay Sajip2024-02-291-0/+36
|
* Make the iter_except() recipe more compact. (gh-116132)Raymond Hettinger2024-02-291-20/+1
| | | Only one example is needed
* gh-115881: Document feature_version limitations (#115980)Shantanu2024-02-291-6/+9
|
* gh-115937: Remove implementation details from inspect.signature() docs (#116086)Erlend E. Aasland2024-02-291-3/+7
| | | | | Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-115821: [Enum] better error message for calling super().__new__() (GH-116063)Ethan Furman2024-02-281-0/+3
| | | | docs now state to not call super().__new__ if super().__new__ is called, a better error message is now used
* Update an out-of-date example in the itertools recipe intro (gh-116082)Raymond Hettinger2024-02-281-1/+1
|
* Improve all_equal() recipe (gh-116081)Raymond Hettinger2024-02-281-3/+4
| | | Replace conjuction of next() calls with simpler len()/take() logic. Add key function.
* GH-115986 Reorder pprint docs and amend some references (#116019)Kerim Kabirov2024-02-281-89/+92
| | | | | | | | | Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout.
* doc: Use super() in subclassed JSONEncoder examples (GH-115565)Jan Max Meyer2024-02-281-2/+2
| | | | Replace calls to `json.JSONEncoder.default(self, obj)` by `super().default(obj)` within the examples of the documentation.
* gh-78612: Mark up eval() using param list (#115212)Erlend E. Aasland2024-02-281-5/+15
| | | Also mention that the 'expression' parameter can be a string.
* gh-105858: Improve AST node constructors (#105880)Jelle Zijlstra2024-02-282-11/+29
| | | | | | | | | | | | | | | | | Demonstration: >>> ast.FunctionDef.__annotations__ {'name': <class 'str'>, 'args': <class 'ast.arguments'>, 'body': list[ast.stmt], 'decorator_list': list[ast.expr], 'returns': ast.expr | None, 'type_comment': str | None, 'type_params': list[ast.type_param]} >>> ast.FunctionDef() <stdin>:1: DeprecationWarning: FunctionDef.__init__ missing 1 required positional argument: 'name'. This will become an error in Python 3.15. <stdin>:1: DeprecationWarning: FunctionDef.__init__ missing 1 required positional argument: 'args'. This will become an error in Python 3.15. <ast.FunctionDef object at 0x101959460> >>> node = ast.FunctionDef(name="foo", args=ast.arguments()) >>> node.decorator_list [] >>> ast.FunctionDef(whatever="you want", name="x", args=ast.arguments()) <stdin>:1: DeprecationWarning: FunctionDef.__init__ got an unexpected keyword argument 'whatever'. Support for arbitrary keyword arguments is deprecated and will be removed in Python 3.15. <ast.FunctionDef object at 0x1019581f0>
* gh-115315: Update time.rst to include microseconds field (%f) in chart (#115316)Tahoma Software2024-02-271-6/+16
| | | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* Doc: Clarify the return type of Event.wait when timeout is used (GH-104168)Phil Elson2024-02-261-10/+7
|
* gh-115091: Remove a left-over sentence that refers to Py_OptimizeFlag from ↵Antti Haapala2024-02-261-4/+0
| | | | | | | ctypes documentation (GH-115092) Remove a left-over sentence that refers to Py_OptimizeFlag Remove a left-over sentence that refers to an example that was present in Python 3.10 and was using ``Py_OptimizeFlag``.
* gh-101100: Fix Sphinx warnings in `whatsnew/2.1.rst` (#112357)Hugo van Kemenade2024-02-262-38/+37
| | | | | Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-115921: Change 'equation' to 'expression' in random.rst (#115927)Terry Jan Reedy2024-02-261-1/+2
| | | In uniform function entry.
* GH-101112: Add "pattern language" section to pathlib docs (#114030)Barney Gale2024-02-261-56/+103
| | | Explain the `full_match()` / `glob()` / `rglob()` pattern language in its own section. Move `rglob()` documentation under `glob()` and reduce duplicated text.
* gh-115532: Add kernel density estimation to the statistics module (gh-115863)Raymond Hettinger2024-02-252-40/+57
|
* gh-115799: Add missing double-quote in docs (#115884)bssyousefi2024-02-251-1/+1
|
* gh-101100: Fix broken xrefs in fcntl module doc (#115691)Skip Montanaro2024-02-253-16/+28
| | | | | | | | | | | | | | | | | | | | | * clean up fcntl module doc * simplify * a few changes, based on suggestion by CAM-Gerlach * nitpick ignore for a couple other C functions mentioned in the fcntl module doc * more changes, especially related to LOCK_* constants * :data: back to :const: * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> --------- Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* bpo-31116: Add Z85 variant to base64 (GH-30598)Matan Perelman2024-02-252-0/+26
| | | Z85 specification: https://rfc.zeromq.org/spec/32/
* gh-96471: Correct docs for queue shutdown (#115838)Laurie O2024-02-251-4/+3
|
* gh-113479: Link to workaround for subtle issue with takewhile() (gh-115890)Raymond Hettinger2024-02-251-33/+41
|
* gh-103417: Fix the scheduler example (GH-111497)mauricelambert2024-02-251-1/+1
| | | | | Arguments to enterabs() are specified as Unix time. If the scheduler use the time.monotonic timer, the code will take decades to complete.
* gh-101100: Fix Sphinx warnings in `whatsnew/2.0.rst` (#112351)Hugo van Kemenade2024-02-252-53/+53
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Add an example of of custom `__repr__` (#112761)Oh seungmin2024-02-251-0/+10
| | | | | | | Added to repr entry in Doc/library/functions.rst. --------- Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
* Erase some unnecessary quotes on data model doc (#113521)Adorilson Bezerra2024-02-252-5/+4
| | | | Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug.
* gh-113202: Add whatsnew entry for the batched() strict option. (gh-115889)Raymond Hettinger2024-02-241-0/+8
|
* gh-115872: Doc: remove obsolete reference to MSI packages (#115873)partev2024-02-241-1/+1
|
* Insert missing apostrophes in ctypes documentation (#115090)jmcb2024-02-231-3/+3
|
* gh-54358: Clarify data chunking in pyexpat (GH-31629)Stanley2024-02-231-2/+6
| | | | Co-authored-by: Éric Araujo <merwok@netwok.org>
* gh-89480: Document the gdb helpers (GH-115657)Pablo Galindo Salgado2024-02-232-0/+450
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Content adapted from https://devguide.python.org/development-tools/gdb/# and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (#977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebugging#New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
* Update http.cookiejar document for cookie object attributes (GH-101885)NewUserHa2024-02-221-0/+5
|
* gh-115795: Doc: fix obsolete URL (#115749)partev2024-02-221-1/+1
|