summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* gh-128426: Mention PySequence_Fast in free-threading C API HOWTO (#128428)Nathan Goldbaum2025-01-031-2/+4
|
* gh-126180: Remove getopt and optparse deprecation notices (GH-126227)Alyssa Coghlan2024-12-232-18/+33
| | | | | | | | | | | | | * Remove getopt and optparse deprecation notices * Add new docs sections for command line app helper libraries * Add guidance on choosing a CLI parsing library to the optparse docs * Link to the new guidance from the argparse and getopt docs * Reword intro in docs section for superseded stdlib modules * Reframe the optparse->argparse guide as a migration guide rather than as an upgrade guide --------- Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [Docs] GDB howto: Fix block type of a cast example (#127621)Maciej Olko2024-12-051-1/+1
|
* gh-127271: Replace use of PyCell_GET/SET (gh-127272)Neil Schemenauer2024-12-031-0/+2
| | | | | | | | | | | | | | | | | | * Replace uses of `PyCell_GET` and `PyCell_SET`. These macros are not safe to use in the free-threaded build. Use `PyCell_GetRef()` and `PyCell_SetTakeRef()` instead. * Since `PyCell_GetRef()` returns a strong rather than borrowed ref, some code restructuring was required, e.g. `frame_get_var()` returns a strong ref now. * Add critical sections to `PyCell_GET` and `PyCell_SET`. * Move critical_section.h earlier in the Python.h file. * Add `PyCell_GET` to the free-threading howto table of APIs that return borrowed refs. * Add additional unit tests for free-threading.
* docs(logging): fix phrasing from "operation on" to "operate on" (#127543)Alexander Stepchenko2024-12-031-1/+1
|
* gh-101100: Fix sphinx warnings in `howto/*` (#127084)Yuki Kobayashi2024-11-262-100/+101
|
* gh-48020: [docs] Remove the logging howto suggested future FileHandler ↵Gregory P. Smith2024-11-071-5/+2
| | | | | | | | | multiprocessing support (GH-126531) Docs: Remove the logging howto potential promise of multiprocessing support in the future. Stick to the facts and suggestions, don't provide hope where we're not going to implement complexity that we'd rather the user implement themselves when needed.
* gh-95836: Add custom type converter examples to argparse tutorial (GH-125376)Savannah Ostrowski2024-10-171-0/+47
|
* GH-124478: Cleanup argparse documentation (#124877)Savannah Ostrowski2024-10-081-0/+55
| | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Tomas R <tomas.roun8@gmail.com>
* gh-75898: make use of thread more explicit in the "Socket Programming HOWTO" ↵Jan Kaliszewski2024-10-081-2/+2
| | | | document (#125023)
* Sorting techniques edits (#124701)Raymond Hettinger2024-09-281-3/+70
|
* gh-124370: Add "howto" for free-threaded Python (#124371)Sam Gross2024-09-252-0/+156
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * gh-124370: Add "howto" for free-threaded Python This is a guide aimed at people writing Python code, as oppposed to the existing guide for C API extension authors. * Add missing new line * Update Doc/howto/free-threading-python.rst Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> * interned -> immortalized * Apply suggestions from code review Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> * Update Doc/howto/free-threading-python.rst Co-authored-by: mpage <mpage@cs.stanford.edu> * Update docs * Apply suggestions from code review Co-authored-by: Carol Willing <carolcode@willingconsulting.com> * A few more updates * Additional comment on immortal objects * Mention specializing adaptive interpreter * Remove trailing whitespace * Remove mention of C macro --------- Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: mpage <mpage@cs.stanford.edu> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* gh-101100: Add a table of class attributes to the "Custom classes" section ↵Alex Waygood2024-09-254-9/+10
| | | | of the data model docs (#124480)
* Minor edits to the descriptor guide (GH-123928)Raymond Hettinger2024-09-131-4/+6
|
* gh-119802: Update memory management docs for free-threaded build (gh-124006)Donghee Na2024-09-131-0/+2
| | | | | | | | | | | | | | | | | | | * gh-119802: Update memory management docs for free-threaded build * nit * nit * Address code review * nit * Update Doc/c-api/memory.rst Co-authored-by: Sam Gross <colesbury@gmail.com> --------- Co-authored-by: Sam Gross <colesbury@gmail.com>
* GH-101599: Update docs to remove redundant option in argparse tutorial (#124025)Savannah Ostrowski2024-09-131-1/+1
|
* gh-119180: Documentation for PEP 649 and 749 (#122235)Jelle Zijlstra2024-09-111-2/+19
| | | | | Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* gh-109975: Add links to py-free-threading.github.io (#123776)Nathan Goldbaum2024-09-061-0/+6
| | | Co-authored-by: Victor Stinner <vstinner@python.org>
* gh-123463: Include logging_flow diagram in non-HTML docs (GH-123464)Alexander Bessman2024-09-041-0/+4
|
* Remove irrelevant detail from example code. (gh-123587)Raymond Hettinger2024-09-021-19/+10
|
* Simplify Property() recipe to focus on the essentials (gh-123585)Raymond Hettinger2024-09-011-20/+6
|
* gh-123517: Remove unnecessary ``:meth:`` parentheses (#123518)Wei-Hsiang (Matt) Wang2024-09-011-1/+1
|
* gh-123492: Remove unnecessary `:func:` parentheses (#123493)Wei-Hsiang (Matt) Wang2024-08-303-4/+4
|
* Fix typos in docs, error messages and comments (#122502)jianghuyiyuan2024-08-011-1/+1
| | | Signed-off-by: jianghuyiyuan <shuangcui@live.com>
* gh-119180: Add `annotationlib` module to support PEP 649 (#119891)Jelle Zijlstra2024-07-231-2/+6
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Docs: spelling and grammar fixes (#122084)Ville Skyttä2024-07-222-2/+2
| | | | | | Corrected some grammar and spelling issues in documentation. Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* gh-121035: Update PNG image for logging flow diagram. (GH-121323)Vinay Sajip2024-07-031-0/+0
|
* gh-121035: Further improve logging flow diagram with respect to dark/light ↵Vinay Sajip2024-07-022-2/+14
| | | | modes. (GH-121265)
* gh-121035: Improve logging flow diagram for dark/light modes. (GH-121254)Vinay Sajip2024-07-022-11/+62
|
* [doc] Update element positions and styles in logging flow diagram. (GH-121182)Vinay Sajip2024-06-301-132/+155
| | | Update element positions and styles.
* gh-121035: Update logging flow chart to include the lastResort handler. ↵Alexander Bessman2024-06-273-2/+283
| | | | (GH-121036)
* gh-120858: PyDict_Next should not lock the dict (#120859)Sam Gross2024-06-241-1/+19
| | | | | | | | | PyDict_Next no longer locks the dictionary in the free-threaded build. Locking around individual PyDict_Next calls is not sufficient because the function returns borrowed references and because it allows concurrent modifications during the iteraiton loop. The internal locking also interferes with correct external synchronization because it may suspend outer critical sections created by the caller.
* gh-118820: Zero-valued flag enum has no name (GH-118848)Nice Zombies2024-06-191-0/+8
| | | Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* Add a link to free-threading HOWTO to the index (follow-up to GH-119366) ↵Petr Viktorin2024-06-191-0/+1
| | | | (GH-120703)
* gh-119241: Add HOWTO for free-threaded C API extensions (#119877)Sam Gross2024-06-182-0/+255
| | | | | | Some sections adapted from https://github.com/Quansight-Labs/free-threaded-compatibility/ written by Nathan Goldbaum. Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
* Update the documentation howto index page and group docs into 3 logical ↵Carol Willing2024-06-174-5/+38
| | | | | | sections (GH-119366) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* gh-120345: Fix incorrect use of the :class: role with the "()" suffix ↵Serhiy Storchaka2024-06-121-1/+1
| | | | | | | (GH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
* gh-119057: Use better error messages for zero division (#119066)Nikita Sobolev2024-06-031-1/+1
|
* gh-119779: Fix pyporting howto docs (#119785)Awbert2024-05-301-2/+2
|
* docs: fix a few typos identified by codespell (#119516)Ned Batchelder2024-05-261-1/+1
|
* 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>
generated by cgit v0.12 at 2025-09-03 14:12:59 (GMT)