Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-03-11 15:31:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
cpython/Doc/library
History
Pablo Galindo Salgado 4279785b31
gh-140727: Restructure profiling documentation for PEP 799 (#142373) 
* Add profiling module documentation structure

PEP 799 introduces a new `profiling` package that reorganizes Python's
profiling tools under a unified namespace. This commit adds the documentation
structure to match: a main entry point (profiling.rst) that helps users choose
between profilers, detailed docs for the tracing profiler (profiling-tracing.rst),
and separated pstats documentation.

The tracing profiler docs note that cProfile remains as a backward-compatible
alias, so existing code continues to work. The pstats module gets its own page
since it's used by both profiler types and deserves focused documentation.

* Add profiling.sampling documentation

The sampling profiler is new in Python 3.15 and works fundamentally differently
from the tracing profiler. It observes programs from outside by periodically
capturing stack snapshots, which means zero overhead on the profiled code. This
makes it practical for production use where you can attach to live servers.

The docs explain the key concepts (statistical vs deterministic profiling),
provide quick examples upfront, document all output formats (pstats, flamegraph,
gecko, heatmap), and cover the live TUI mode. The defaults table helps users
understand what happens without any flags.

* Wire profiling docs into the documentation tree

Add the new profiling module pages to the Debugging and Profiling toctree.
The order places the main profiling.rst entry point first, followed by the
two profiler implementations, then pstats, and finally the deprecated profile
module last.

* Convert profile.rst to deprecation stub

The pure Python profile module is deprecated in 3.15 and scheduled for removal
in 3.17. Users should migrate to profiling.tracing (or use the cProfile alias
which continues to work).

The page now focuses on helping existing users migrate: it shows the old vs new
import style, keeps the shared API reference since both modules have the same
interface, and preserves the calibration docs for anyone still using the pure
Python implementation during the transition period.

* Update CLI module references for profiling restructure

Point cProfile to profiling.tracing docs and add profiling.sampling to the
list of modules with CLI interfaces. The old profile-cli label no longer
exists after the documentation restructure.

* Update whatsnew to link to profiling module docs

Enable cross-references to the new profiling module documentation and update
the CLI examples to use the current syntax with the attach subcommand. Also
reference profiling.tracing instead of cProfile since that's the new canonical
name.
2025-12-09 12:55:04 +00:00
..
__future__.rst gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) 2025-07-07 12:31:13 +02:00
__main__.rst gh-128720: Fix doc inacurracy about __main__.__file__ existence in the REPL (#128721) 2025-01-21 19:52:21 +00:00
_thread.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
abc.rst Docs: Fix some semantic usages of iterator.__iter__ (GH-130172) 2025-02-25 13:38:47 +01:00
aifc.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
allos.rst gh-126180: Remove getopt and optparse deprecation notices (GH-126227) 2024-12-23 14:17:19 +10:00
annotationlib.rst gh-138764: annotationlib: Make call_annotate_function fallback to using VALUE annotations if both the requested format and VALUE_WITH_FAKE_GLOBALS are not implemented (#138803) 2025-10-21 15:57:43 +00:00
archiving.rst gh-132983: Add documentation for compression.zstd (GH-133911) 2025-05-21 07:18:21 -07:00
argparse.rst GH-141963: Clarify argparse documentation (GH-141964) 2025-11-28 23:23:34 -08:00
array.rst gh-137183: Document that array.array typecode w is new in 3.13 (GH-137184) 2025-07-29 17:23:44 +02:00
ast.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
asynchat.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
asyncio-api-index.rst Doc: Found some remaining default roles. (GH-98392) 2022-10-18 15:46:18 +02:00
asyncio-dev.rst gh-133515: fix docs for unawaited coroutines in debug mode (#134081) 2025-05-16 21:01:15 +05:30
asyncio-eventloop.rst gh-118516: clarify that subprocess are automatically killed if transport gets garbage collected (#140997) 2025-11-06 10:21:13 +05:30
asyncio-exceptions.rst Clarify state of CancelledError in doc (#106453) 2023-07-05 08:07:02 -07:00
asyncio-extending.rst gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) 2023-07-29 08:48:10 +03:00
asyncio-future.rst gh-137026: Add an explainer guide for asyncio (GH-137215) 2025-08-08 22:29:51 -07:00
asyncio-graph.rst Python 3.14.0a5 2025-02-11 19:16:29 +02:00
asyncio-llapi-index.rst gh-124694: Add concurrent.futures.InterpreterPoolExecutor (gh-124548) 2024-10-16 16:50:46 -06:00
asyncio-platforms.rst GH-120804: add docs for removal for asyncio child watchers (#120895) 2024-06-23 13:14:12 +00:00
asyncio-policy.rst Python 3.14.0a4 2025-01-14 13:52:58 +02:00
asyncio-protocol.rst gh-90483: fix docs of SubprocessTransport.get_pipe_transport (#137852) 2025-08-16 11:11:45 +00:00
asyncio-queue.rst Fix Queue.shutdown docs for condition to unblock a join (gh-137088) 2025-07-25 07:56:28 -06:00
asyncio-runner.rst gh-127949: make deprecation of policy system more prominent (#128290) 2024-12-27 15:13:41 +00:00
asyncio-stream.rst gh-138703: clarify data buffer requirement of asyncio.StreamWriter.write (#139564) 2025-10-04 21:44:05 +05:30
asyncio-subprocess.rst gh-118516: clarify that subprocess are automatically killed if transport gets garbage collected (#140997) 2025-11-06 10:21:13 +05:30
asyncio-sync.rst gh-101359: clarify docs for asyncio.Event.clear (#137849) 2025-08-16 10:50:54 +00:00
asyncio-task.rst gh-141186: document asyncio.Task cancellation propagation behavior (#141249) 2025-11-09 10:19:29 +05:30
asyncio.rst gh-140569: recommend the new REPL in the asyncio REPL docs (#140570) 2025-11-06 11:09:07 +05:30
asyncore.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
atexit.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
audioop.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
audit_events.rst Python 3.14.0b1 2025-05-06 18:33:52 +03:00
base64.rst gh-134201: Expand explanation of Base85 encodings in base64 docs (#134288) 2025-05-19 18:59:06 -05:00
bdb.rst [Docs] Fix typo in bdb: is_skipped_line to is_skipped_module (#141771) 2025-11-19 18:39:54 -08:00
binary.rst
binascii.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
bisect.rst GH-138465: Improve documentation for common sequence methods (#138474) 2025-09-05 20:55:02 +01:00
builtins.rst gh-99030: Added documentation links for types and exceptions (GH-123857) 2024-10-20 17:36:27 -07:00
bz2.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
calendar.rst gh-108202: `calendar: Document prweek` (#108466) 2025-12-08 09:54:59 +00:00
cgi.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
cgitb.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
chunk.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
cmath.rst gh-137871: Clarify cmath.nan documentation by linking to math module (#137876) 2025-10-14 11:24:43 +03:00
cmd.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
cmdline.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
cmdlinelibs.rst gh-137777: Disband the 'Program Frameworks' chapter (#137796) 2025-08-15 18:41:09 +01:00
code.rst gh-131885: Document * for code.InteractiveConsole (#132029) 2025-10-31 11:16:32 +01:00
codecs.rst Docs: Fix typo in codecs documentation (GH-140883) 2025-11-03 16:47:52 +01:00
codeop.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
collections.abc.rst gh-105812: Use the `:deco:` role in place of manual decorator markup (#139619) 2025-10-05 21:15:36 +01:00
collections.rst gh-141721: Improve docstring for LastUpdatedOrderedDict example (gh141724) 2025-11-19 12:22:27 -06:00
colorsys.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
compileall.rst gh-133503: clarify compileall -s/-p docs (#134756) 2025-06-01 10:18:31 +02:00
compression.rst GH-123299: Copyedit 3.14 What's New: New and Improved Modules (#139530) 2025-10-04 15:58:51 +03:00
compression.zstd.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
concurrency.rst gh-134939: Add the concurrent.interpreters Module (gh-133958) 2025-06-11 17:35:48 -06:00
concurrent.futures.rst gh-124694: Add versionadded note to InterpreterPoolExecutor (#140468) 2025-10-25 18:29:46 -05:00
concurrent.interpreters.rst Minor documentation improvements (#140626) 2025-11-06 19:11:50 +02:00
concurrent.rst gh-134939: Add the concurrent.interpreters Module (gh-133958) 2025-06-11 17:35:48 -06:00
configparser.rst gh-65697: Prevent configparser from writing keys it cannot properly read (#129270) 2025-02-23 11:06:33 -05:00
constants.rst gh-138307: Update the Ellipsis documentation (#138306) 2025-09-03 07:27:22 -04:00
contextlib.rst gh-139452: Clarify redirect_stdout, stderr behavior (gh-139490) 2025-10-08 08:28:29 -05:00
contextvars.rst fix typos in contextvars asyncio support example docs (#141219) 2025-11-08 09:08:19 +00:00
copy.rst gh-134559: Add versionadded for `object.__replace__()` (#134672) 2025-05-26 10:39:04 +01:00
copyreg.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
crypt.rst gh-139672: Remove references to passlib (#139673) 2025-10-09 20:13:38 +03:00
crypto.rst gh-104773: PEP 594: Remove the crypt module (#104908) 2023-05-25 15:45:46 +02:00
csv.rst gh-137952: update csv.Sniffer().has_header() docs to describe the actual off-by-onish behavior (GH-137953) 2025-11-12 00:03:14 +00:00
ctypes.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
curses.ascii.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
curses.panel.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
curses.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
custominterp.rst
dataclasses.rst gh-105812: Use the `:deco:` role in place of manual decorator markup (#139619) 2025-10-05 21:15:36 +01:00
datatypes.rst
datetime.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
dbm.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
debug.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
decimal.rst GH-121970: Remove Docutils list monkeypatch (#142056) 2025-11-29 14:28:23 +00:00
development.rst gh-104780: Remove 2to3 program and lib2to3 module (#104781) 2023-05-23 19:40:02 +02:00
devmode.rst gh-101100: Fix sphinx warnings in library/devmode.rst (#109963) 2023-09-27 16:07:28 +03:00
dialog.rst gh-135756: Fix nonexistent parameter in tkinter docs (#135770) 2025-06-20 18:45:36 -04:00
difflib.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
dis.rst gh-140980: document SET_FUNCTION_ATTRIBUTE flag for annotate function (#141306) 2025-11-09 19:59:06 +01:00
distribution.rst
distutils.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
doctest.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
email.charset.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.compat32-message.rst gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst (#136323) 2025-07-07 19:28:44 +03:00
email.contentmanager.rst gh-121542: Document trailing newline behavior in set_content() (#121543) 2025-01-18 20:34:40 +02:00
email.encoders.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.errors.rst gh-101100: Fix sphinx warnings in library/email.errors.rst (#130774) 2025-03-03 11:56:45 +02:00
email.examples.rst Fix the french used in the email documentation (GH-106279) 2023-07-16 19:14:08 +02:00
email.generator.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.header.rst Docs: Fix duplicate word typos (GH-135958) 2025-06-26 20:00:19 -04:00
email.headerregistry.rst Docs: Fix typo in email.headerregistry.rst (#140965) 2025-11-04 14:29:13 -05:00
email.iterators.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.message.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
email.mime.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.parser.rst Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (#136475)" (#136629) 2025-07-14 12:13:15 +03:00
email.policy.rst Docs: fix MessageDefect references in email.policy docs (#128468) 2025-01-05 22:58:31 +01:00
email.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.utils.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
ensurepip.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
enum.rst gh-139487: add missing imports for standalone doctest Enum examples (#139488) 2025-10-02 12:28:29 +02:00
errno.rst gh-85046: Document errno constants (#126420) 2025-01-28 01:12:45 +01:00
exceptions.rst gh-141732: Fix ExceptionGroup repr changing when original exception sequence is mutated (#141736) 2025-12-07 21:04:04 +00:00
faulthandler.rst gh-127604: Docs: Include a C stack in the faulthandler example (GH-136081) 2025-06-29 10:58:26 -04:00
fcntl.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
filecmp.rst Use roles :data: and :const: for referencing module variables (GH-129507) 2025-02-04 16:16:41 +02:00
fileformats.rst
fileinput.rst gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347) 2024-06-12 17:23:03 +03:00
filesys.rst gh-126180: Remove getopt and optparse deprecation notices (GH-126227) 2024-12-23 14:17:19 +10:00
fnmatch.rst gh-74598: document that fnmatch.filterfalse is affected by cache limitation (#136781) 2025-07-19 09:51:11 +00:00
fractions.rst gh-122450: Expand documentation for `Rational and Fraction` (#136800) 2025-08-04 02:15:59 +00:00
frameworks.rst gh-137777: Disband the 'Program Frameworks' chapter (#137796) 2025-08-15 18:41:09 +01:00
ftplib.rst gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697) 2024-07-13 16:16:26 +02:00
functional.rst
functions.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
functools.rst gh-141831: Document behavior of functools.lru_cache with concurrent access (gh-141869) 2025-11-24 14:36:09 +00:00
gc.rst GH-140638: Add a GC "candidates" stat (GH-141814) 2025-11-22 21:59:14 +00:00
getopt.rst gh-126180: Remove getopt and optparse deprecation notices (GH-126227) 2024-12-23 14:17:19 +10:00
getpass.rst gh-138514: getpass: restrict echo_char to a single ASCII character (#138591) 2025-09-16 16:21:55 +02:00
gettext.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
glob.rst docs: be clearer that glob results are unordered (#140184) 2025-10-19 16:16:35 -04:00
graphlib.rst Python 3.14.0a7 2025-04-08 14:20:51 +03:00
grp.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
gzip.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
hashlib-blake2-tree.png
hashlib.rst gh-139495: Fix hashlib.file_digest() versionchanged description of BlockingIOError (GH-139496) 2025-10-02 12:50:36 -07:00
heapq-binary-tree.svg gh-133530: Replace binary tree textual digram with image (gh-133591) 2025-05-07 19:05:06 -05:00
heapq.rst Minor documentation improvements (#140626) 2025-11-06 19:11:50 +02:00
hmac.rst GH-101100: Resolve reference warnings in whatsnew/3.7.rst (#138410) 2025-09-03 09:20:16 +03:00
html.entities.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
html.parser.rst gh-137836: Support more RAWTEXT and PLAINTEXT elements in HTMLParser (GH-137837) 2025-10-31 17:44:02 +02:00
html.rst gh-139006: Doc: Clarify html.escape function description (#139016) 2025-09-17 21:45:34 +08:00
http.client.rst gh-139434: Update selected RFC 2822 references to RFC 5322 (#139435) 2025-11-04 14:46:07 -05:00
http.cookiejar.rst Fix minor typo: 'web site' -> 'website' (GH-140561) 2025-11-04 10:23:49 +01:00
http.cookies.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
http.rst gh-102247: Improve documentation of http.HTTPStatus members update (#133190) 2025-10-14 11:18:17 +03:00
http.server.rst gh-139434: Update selected RFC 2822 references to RFC 5322 (#139435) 2025-11-04 14:46:07 -05:00
i18n.rst
idle.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
imaplib.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
imghdr.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
imp.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
importlib.metadata.rst Docs: fix a couple typos in Doc/ (GH-132927) 2025-04-27 15:56:58 -07:00
importlib.resources.abc.rst gh-110631: Fix some incorrect indents in the documentation (#129312) 2025-05-21 13:52:02 +00:00
importlib.resources.rst gh-138044: Fix importlib.resources.files deprecation docs (#139632) 2025-10-12 01:52:01 +03:00
importlib.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
index.rst gh-137777: Disband the 'Program Frameworks' chapter (#137796) 2025-08-15 18:41:09 +01:00
inspect.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
internet.rst GH-97950: Use new-style index directive ('module') (#103996) 2023-05-04 10:17:12 +02:00
intro.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
io.rst gh-133982: Test _pyio.BytesIO in free-threaded tests (gh-136218) 2025-07-04 11:27:21 +09:00
ipaddress.rst gh-136752: Clarify documentation for `IPv{N}Address.is_reserved` (#136794) 2025-07-19 14:43:56 +00:00
ipc.rst
itertools.rst Docs: Improve example for `itertools.batched()` (#136775) 2025-07-19 10:29:44 +01:00
json.rst gh-140793: Improve documentatation and tests for the ensure_ascii option in the json module (GH-140906) 2025-11-08 12:07:27 +02:00
kde_example.png Improve kde graph with better caption and number formatting (gh-113967) 2024-01-11 18:25:18 -06:00
keyword.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
language.rst
linecache.rst gh-60115: Support frozen modules for linecache.getline() (#131638) 2025-04-02 19:50:01 -04:00
locale.rst gh-141004: Document pyctype.h macros (GH-141272) 2025-11-10 05:05:06 -05:00
logging.config.rst Docs: Fix markups for emphasis (GH-135598) 2025-06-18 13:32:43 -04:00
logging.handlers.rst gh-134817: Restore accidentally deleted line in documentation. (GH-141013) 2025-11-04 18:29:44 +00:00
logging.rst gh-138162: Fix logging.LoggerAdapter with merge_extra=True and without the extra argument (GH-140511) 2025-10-30 12:52:02 +02:00
lzma.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
mailbox.rst gh-139434: Update selected RFC 2822 references to RFC 5322 (#139435) 2025-11-04 14:46:07 -05:00
mailcap.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
markup.rst
marshal.rst Python 3.14.0a2 2024-11-19 16:52:44 +02:00
math.integer.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
math.rst math.dist documentation: add 'strict=True' to equivalent code (#141819) 2025-11-23 17:33:27 -06:00
mimetypes.rst gh-75223: Deprecate undotted extensions in mimetypes.MimeTypes.add_type (#128638) 2025-04-28 14:23:57 +00:00
mm.rst
mmap.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
modulefinder.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
modules.rst
msilib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
msvcrt.rst gh-139707: Specify winreg, msvcrt and winsound module availability in docs (GH-140429) 2025-11-10 14:37:34 +01:00
multiprocessing.rst gh-142066: Fix grammar in multiprocessing Pipes and Queues (GH-142121) 2025-11-30 18:14:20 -08:00
multiprocessing.shared_memory.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
netdata.rst
netrc.rst gh-135815: skip netrc security checks if os.getuid is missing (#135816) 2025-06-22 19:48:06 +00:00
nis.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
nntplib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
numbers.rst gh-122450: Expand documentation for `Rational and Fraction` (#136800) 2025-08-04 02:15:59 +00:00
numeric.rst gh-81313: Add the math.integer module (PEP-791) (GH-133909) 2025-10-31 16:13:43 +02:00
operator.rst gh-115808: Add `is_none and is_not_none to operator` (#115814) 2024-08-10 20:16:34 +01:00
optparse.rst gh-126180: Remove getopt and optparse deprecation notices (GH-126227) 2024-12-23 14:17:19 +10:00
os.path.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
os.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
ossaudiodev.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
pathlib-inheritance.png
pathlib-inheritance.svg
pathlib.rst GH-101100: Remove some entries from `nitpick_ignore` (#138464) 2025-09-08 22:10:26 +00:00
pdb.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
persistence.rst
pickle.rst GH-138465: Improve documentation for common sequence methods (#138474) 2025-09-05 20:55:02 +01:00
pickletools.rst gh-93096: Update and document pickletools CLI (#131273) 2025-03-17 09:36:30 +00:00
pipes.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
pkgutil.rst Docs: Emphasize parameter name in pkgutil.iter_importers (GH-135597) 2025-06-19 08:56:43 -04:00
platform.rst gh-138952: Document platform.machine() output casing inconsistency across platforms (#138962) 2025-09-17 15:56:21 +01:00
plistlib.rst gh-101100: Fix sphinx warnings in library/plistlib.rst (#132422) 2025-04-13 18:35:26 +00:00
poplib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
posix.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pprint.rst gh-139155: Remove "dictionaries are sorted by key" note in pprint docs (GH-139159) 2025-10-12 12:48:22 -04:00
profile.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
profiling.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
profiling.sampling.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
profiling.tracing.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
pstats.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
pty.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
pwd.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
py_compile.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pyclbr.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
pydoc.rst Doc: Note that pydoc uses and prefers `MANPAGER` (#125362) 2024-10-29 23:12:02 +00:00
pyexpat.rst gh-139313: Improve docs on XML security (GH-139460) 2025-11-05 20:59:59 +02:00
python.rst gh-134939: Add the concurrent.interpreters Module (gh-133958) 2025-06-11 17:35:48 -06:00
queue.rst Fix Queue.shutdown docs for condition to unblock a join (gh-137088) 2025-07-25 07:56:28 -06:00
quopri.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
random.rst Docs: Fix typo in random_derangement recipe (GH-138599) 2025-09-06 16:53:49 -04:00
re.rst gh-122055: Clarify documentation for empty matches in RE (GH-133169) 2025-05-19 15:27:50 +02:00
readline.rst gh-48752: Add readline.get_pre_input_hook() function (#141586) 2025-12-05 13:18:54 +01:00
removed.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
reprlib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
resource.rst gh-101100: Fix sphinx warnings in library/resource.rst (#140023) 2025-10-20 10:15:40 +03:00
rlcompleter.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
runpy.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
sched.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
secrets.rst gh-123789: secrets.randbits returns only non-negative int (#123801) 2024-09-07 21:17:59 -07:00
security_warnings.rst gh-127502: Remove XML vulnerability table (GH-135294) 2025-07-07 11:03:07 +02:00
select.rst Document None for timeout argument of select.select (#142177) 2025-12-02 10:57:09 +02:00
selectors.rst GH-121970: Replace custom abstract method directive with the `:abstract:` option (#129311) 2025-02-22 01:53:57 +00:00
shelve.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
shlex.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
shutil.rst GH-101100: Resolve reference warnings in whatsnew/2.7.rst (#138415) 2025-09-03 11:33:13 +00:00
signal.rst gh-101100: Fix sphinx warnings in library/resource.rst (#140023) 2025-10-20 10:15:40 +03:00
site.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
smtpd.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
smtplib.rst gh-137339: Clarify host and port parameter behavior in smtplib.SMTP{_SSL} initialization (#137340) 2025-11-11 15:25:26 -05:00
sndhdr.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
socket.rst Docs: Prepare for Sphinx 9 (#142057) 2025-11-29 16:49:37 +02:00
socketserver.rst Docs: Fix typo in socketserver documentation (#140956) 2025-11-17 13:47:28 +02:00
spwd.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
sqlite3.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
ssl.rst GH-121970: Remove Docutils list monkeypatch (#142056) 2025-11-29 14:28:23 +00:00
stat.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
statistics.rst gh-121977: Add tips for handling unhashable data (#122075) 2024-07-21 05:53:26 +00:00
stdtypes.rst gh-101100: Fix references to the set methods (GH-141857) 2025-12-05 16:22:38 +02:00
string.rst gh-141007: update string module source code link (#141008) 2025-11-04 19:05:49 -05:00
string.templatelib.rst gh-138558: Improve description of `Interpolation.expression` (#139187) 2025-10-04 22:06:56 +01:00
stringprep.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
struct.rst gh-121249: fix complex formatting codes in the struct docs (note 10) (GH-133249) 2025-05-02 18:27:07 +02:00
subprocess.rst gh-141473: Document not calling Popen.wait after Popen.communicate times out. (GH-142101) 2025-11-30 18:50:05 -08:00
sunau.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
superseded.rst gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
symtable.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
sys.monitoring.rst Document that returning sys.monitoring.DISABLE in response to a global event raises ValueError (#140726) 2025-11-04 10:28:17 -08:00
sys.rst gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (#141233) 2025-11-08 12:22:02 +00:00
sys_path_init.rst Docs: fix some typos in Doc/library (#132511) 2025-04-14 13:24:46 +00:00
sysconfig.rst Replace obsolete platforms with more recent examples (#132455) 2025-10-10 05:38:13 +00:00
syslog.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tabnanny.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tachyon-logo.png gh-140727: Restructure profiling documentation for PEP 799 (#142373) 2025-12-09 12:55:04 +00:00
tarfile.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
telnetlib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
tempfile.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
termios.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
test.rst Docs: Fix typo in test.support.linked_to_musl function name (#138406) 2025-09-03 14:52:13 +02:00
text.rst gh-132661: Document t-strings and templatelib (#135229) 2025-07-22 12:44:13 +03:00
textwrap.rst docs: fix a few typos identified by codespell (#119516) 2024-05-25 18:13:31 -07:00
threading.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
time.rst gh-141246: Link to correct Windows docs in time.sleep() doc (#141248) 2025-11-08 15:56:48 +01:00
timeit.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tk.rst gh-137777: Disband the 'Program Frameworks' chapter (#137796) 2025-08-15 18:41:09 +01:00
tk_msg.png
tkinter.colorchooser.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.dnd.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
tkinter.font.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.messagebox.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
tkinter.scrolledtext.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.ttk.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
token-list.inc gh-130587: Add hand-written docs for non-OP tokens (GH-130588) 2025-03-19 16:42:11 +01:00
token.rst gh-135263: Fix typo in token.NAME documentation (#135275) 2025-06-08 22:59:26 +03:00
tokenize.rst gh-129020: Remove ambiguous sentence from tokenize.untokenize docs (#129021) 2025-01-20 00:05:22 +00:00
tomllib.rst Python 3.14.0a2 2024-11-19 16:52:44 +02:00
trace.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
traceback.rst gh-128481: indicate that the default value for FrameSummary.end_lineno changed in 3.13 (#130755) 2025-03-02 18:16:51 +01:00
tracemalloc.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tty.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
turtle-star.pdf
turtle-star.png
turtle-star.ps
turtle.rst gh-139533: fix refs to code without proper markups on turtledemo doc (GH-139534) 2025-11-11 11:35:55 -08:00
types.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
typing.rst gh-133601: Remove deprecated typing.no_type_check_decorator (#133602) 2025-10-20 21:10:44 +00:00
unicodedata.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
unittest.mock-examples.rst gh-62480: De-personalize "Coping with mutable arguments" section in unittest.mock examples (#141323) 2025-11-17 13:44:44 +02:00
unittest.mock.rst Replace "ordered arguments" with "positional arguments" in unittest.mock documentation (GH-137552) 2025-08-08 14:00:18 +00:00
unittest.rst gh-101100: Fix sphinx warnings in library/unittest.rst (#140109) 2025-11-22 21:16:09 +02:00
unix.rst gh-137777: Disband the 'Program Frameworks' chapter (#137796) 2025-08-15 18:41:09 +01:00
urllib.error.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
urllib.parse.rst Added a warning to the urljoin docs, indicating that it is not safe to use with attacker controlled URLs (GH-126659) 2024-11-15 18:09:05 -05:00
urllib.request.rst gh-137341: Remove more word duplications (GH-137342) 2025-08-03 19:41:12 +03:00
urllib.robotparser.rst Fix minor typo: 'web site' -> 'website' (GH-140561) 2025-11-04 10:23:49 +01:00
urllib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
uu.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
uuid.rst gh-137847: Add examples for UUIDv6-8 (#137848) 2025-08-18 11:24:19 +00:00
venv.rst gh-133951: Add venv changes to documentation and whatsnew (GH-139704) 2025-10-21 10:52:57 +02:00
warnings.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
wave.rst gh-75593: Add support of bytes and path-like paths in wave.open() (GH-140951) 2025-11-12 10:20:55 +02:00
weakref.rst Docs: Standardise versionchanged text in weakref.rst (#122898) 2024-08-11 21:40:11 +01:00
webbrowser.rst gh-130160: Add anchors to CLI Usage section for cmdline (#133182) 2025-11-17 14:51:21 +00:00
windows.rst
winreg.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
winsound.rst gh-139707: Specify winreg, msvcrt and winsound module availability in docs (GH-140429) 2025-11-10 14:37:34 +01:00
wsgiref.rst gh-127522: wsgiref: indicate that start_response objects should follow a specific protocol (GH-127525) 2025-02-24 13:43:56 +01:00
xdrlib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
xml.dom.minidom.rst gh-127502: Remove XML vulnerability table (GH-135294) 2025-07-07 11:03:07 +02:00
xml.dom.pulldom.rst Correct class name from PullDom to PullDOM (#141207) 2025-11-19 12:30:53 +02:00
xml.dom.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.etree.elementtree.rst Python 3.15.0a2 2025-11-18 16:51:17 +02:00
xml.rst gh-139313: Improve docs on XML security (GH-139460) 2025-11-05 20:59:59 +02:00
xml.sax.handler.rst gh-141994: Warn of XXE vulnerability in documentation of SAX feature xml.sax.handler.feature_external_ges (GH-141996) 2025-11-28 23:08:17 -08:00
xml.sax.reader.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.sax.rst gh-127502: Remove XML vulnerability table (GH-135294) 2025-07-07 11:03:07 +02:00
xml.sax.utils.rst gh-141650: Fix typo in xml.sax.saxutils.unescape documentation (#141652) 2025-11-17 13:35:01 +02:00
xmlrpc.client.rst gh-140505: Fix 'parameters' to 'arguments' in xmlrpc.client.MultiCall docs (GH-141942) 2025-11-27 18:01:15 +01:00
xmlrpc.rst gh-101100: Fix sphinx warnings in whatsnew/3.0.rst (#127662) 2024-12-10 12:22:37 +02:00
xmlrpc.server.rst gh-127502: Remove XML vulnerability table (GH-135294) 2025-07-07 11:03:07 +02:00
zipapp.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
zipfile.rst Docs: multi-disk ZIP files -> multipart ZIP files (GH-141962) 2025-11-28 23:11:59 -08:00
zipimport.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
zlib.rst gh-139707: Add docs for optional modules (GH-140171) 2025-11-06 11:49:44 +01:00
zoneinfo.rst Doc/library/zoneinfo.rst: Fix typo (#139190) 2025-09-22 07:25:39 -04:00