summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] gh-119241: Add HOWTO for free-threaded C API extensions (GH-119877) ↵Miss Islington (bot)2024-06-182-0/+255
| | | | | | | | | | | (#120693) Some sections adapted from https://github.com/Quansight-Labs/free-threaded-compatibility/ written by Nathan Goldbaum. (cherry picked from commit 02b272b7026b68e70b4a4d9a0ca080904aed374c) Co-authored-by: Sam Gross <colesbury@gmail.com> Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
* [3.13] gh-120345: Fix incorrect use of the :class: role with the "()" suffix ↵Miss Islington (bot)2024-06-121-1/+1
| | | | | | | | | | (GH-120347) (GH-120411) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method. (cherry picked from commit 92c9c6ae147e1e658bbc8d454f8c7b2c4dea31d1) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-119779: Fix pyporting howto docs (GH-119785) (#119788)Miss Islington (bot)2024-05-301-2/+2
| | | | | | gh-119779: Fix pyporting howto docs (GH-119785) (cherry picked from commit 6fb191be15fd49da10506de29b6393ffdf59b894) Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
* [3.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)Miss Islington (bot)2024-05-261-1/+1
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* gh-118671: Updated dead ActiveState links (#118730)trag1c2024-05-081-1/+1
| | | | | Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* gh-118518: Improve perf docs (#118708)Pablo Galindo Salgado2024-05-071-22/+48
|
* gh-118518: Rename `PYTHONPERFJITSUPPORT` and `-X perfjit` with underscores ↵Hugo van Kemenade2024-05-071-4/+4
| | | | (#118693)
* gh-118518: Allow perf to work without frame pointers (#112254)Pablo Galindo Salgado2024-05-051-0/+33
|
* Fix typo in Doc/howto/timerfd.rst (GH-118376)Xie Yanbo2024-04-291-1/+1
|
* Docs: add link roles with Sphinx extlinks (#117850)Hugo van Kemenade2024-04-152-9/+6
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Add 'The Python 2.3 Method Resolution Order' (#116435)Hugo van Kemenade2024-04-152-0/+672
|
* [doc] Update logging documentation to improve grammar and elucidate an ↵Vinay Sajip2024-04-041-4/+64
| | | | example. (GH-117541)
* [docs] Fix typo in docstring and add example to logging cookbook. (GH-117157)Vinay Sajip2024-03-221-14/+126
|
* gh-98731: Improvements to the logging documentation (GH-101618)Nir Friedman2024-03-131-77/+41
| | | Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
* [doc]: Update cookbook recipe for Qt6. (GH-116719)Vinay Sajip2024-03-131-13/+36
|
* 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>
* gh-101860: Expose __name__ on property (GH-101876)Eugene Toder2024-02-201-4/+15
| | | | | Useful for introspection and consistent with functions and other descriptors.
* gh-113157: Document and test __get__ for MethodType (gh-115492)Raymond Hettinger2024-02-201-2/+18
|
* Make the title match the content (GH-115702)Raymond Hettinger2024-02-202-5/+5
|
* Modernize the Sorting HowTo guide (gh-115479)Raymond Hettinger2024-02-201-6/+54
|
* gh-115233: Fix an example in the Logging Cookbook (GH-115325)Serhiy Storchaka2024-02-121-6/+4
| | | | | Also add more tests for LoggerAdapter. Also support stacklevel in LoggerAdapter._log().
* gh-114785: Remove content from `Porting from Python2` how-to (#114805)Nikita Sobolev2024-02-122-411/+19
| | | | | | Keep the page though, because people might still rely on it (the traffic shows that they do). Instead of our own manual we now give links to the 3rd-party ones. Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* gh-114803: Mention that `@dataclass` should not be applied on enums (GH-114891)Nikita Sobolev2024-02-031-1/+18
| | | | Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru> Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* Update LOGGING example taken from Django docs. (#114903)Mariusz Felisiak2024-02-031-14/+11
| | | | | | | For example, Django no longer provides a custom NullHandler https://github.com/django/django/commit/6c66a41c3dc697dc3bda4e31e8b05084d2ede915 * Remove require_debug_true.
* gh-101100: Fix sphinx warnings in `howto/logging.rst` (#114846)Nikita Sobolev2024-02-011-21/+22
| | | Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* gh-101100: Fix Sphinx warnings in `howto/urllib2.rst` and ↵Hugo van Kemenade2024-01-141-9/+9
| | | | `library/http.client.rst` (#114060)
* gh-113625: Align object addresses in the Descriptor HowTo Guide (#113894)Raymond Hettinger2024-01-101-1/+1
|
* gh-113350: Improve the wording of python logging docs to remove an ambiguity ↵Vaishnavi Maheshwari2023-12-272-7/+6
| | | | | around use of the word "higher". (GH-113491) Co-authored-by: Wei-Hsiang (Matt) Wang <mattwang44@gmail.com>
* gh-101100: Fix Sphinx warnings in `howto/isolating-extensions.rst` (#113493)Hugo van Kemenade2023-12-261-2/+2
|
* gh-101100: Improve documentation on function attributes (#112933)Alex Waygood2023-12-112-4/+7
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-112328: [Enum] Make some private attributes public. (GH-112514)Ethan Furman2023-12-051-20/+47
| | | | | | | | | | | | | * [Enum] Make some private attributes public. - ``_EnumDict`` --> ``EnumDict`` - ``EnumDict._member_names`` --> ``EnumDict.member_names`` - ``Enum._add_alias_`` - ``Enum._add_value_alias_`` --------- Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [Enum] update class creation for RuntimeError changes (GH-111815)Ethan Furman2023-11-291-1/+0
|
* Descriptor HowTo: Sync the error-messages with the C code. Add tests. ↵Raymond Hettinger2023-11-251-3/+40
| | | | (gh-112403)
* Remove bogus annotations from the descriptor howto guide (#112349)Raymond Hettinger2023-11-231-3/+3
|
* gh-110812: Isolating Extension Modules HOWTO: List GC-related gotchas ↵Petr Viktorin2023-11-161-6/+97
| | | | | | (GH-111504) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* Fix typo in perf profiling docs (#112112)Ryuji Tsutsui2023-11-151-1/+1
|
* gh-111895: Convert definition list to bullet list for readability on mobile ↵Hugo van Kemenade2023-11-091-6/+6
| | | | | (#111898) Convert definition list to bullet list for readability on mobile
* Glossary: Add "static type checker" (#111837)Jelle Zijlstra2023-11-081-2/+3
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-111724: Fix doctest `ResourceWarning` in `howto/descriptor.rst` (#111725)Nikita Sobolev2023-11-041-0/+4
| | | Close database connection explicitly in test cleanup.
* gh-111181: Fix enum doctests (GH-111180)Nikita Sobolev2023-10-301-3/+6
| | | Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
* gh-89519: Remove classmethod descriptor chaining, deprecated since 3.11 ↵Raymond Hettinger2023-10-271-31/+10
| | | | (gh-110163)
* gh-110383: Italicize variable name (#111206)Nick2023-10-231-1/+1
|
* gh-110383: Added explanation about simplest regex use case for quantifiers. ↵Nick2023-10-231-0/+3
| | | | | | (#111110) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-110631: Fix reST indentation (#110724)Ezio Melotti2023-10-112-15/+14
| | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.
* GH-107518: Remove the Argument Clinic How-To (#109900)Adam Turner2023-10-112-2062/+5
| | | | | * Remove the content of the Argument Clinic HOWTO * Update cross-references to the Argument Clinic * Add a note directing readers to the devguide
* gh-108277: Add os.timerfd_create() function (#108382)Masaru Tsuchiyama2023-10-072-0/+231
| | | | | | | | Add wrapper for timerfd_create, timerfd_settime, and timerfd_gettime to os module. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
* Fix env var typo in perf profiling docs (#110404)Harmen Stoppels2023-10-051-2/+1
| | | Fix typo in docs
* gh-101100: Fix references to ``URLError`` and ``HTTPError`` in ↵Yuki K2023-09-291-8/+8
| | | | | ``howto/urllib2.rst`` (#107966) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-109634: Use :samp: role (GH-109635)Serhiy Storchaka2023-09-232-3/+3
|
* gh-108682: [Enum] raise TypeError if super().__new__ called in custom ↵Ethan Furman2023-08-311-1/+22
| | | | | | | | | | | __new__ (GH-108704) When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. . member = object.__new__(cls) member = int.__new__(cls, value) member = str.__new__(cls, value) Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected.
generated by cgit v0.12 at 2024-11-25 01:25:47 (GMT)