blob: bebf7429b0e63e0d22b4d08cf6c45251b4876f23 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001.. _library-index:
2
3###############################
4 The Python Standard Library
5###############################
6
Benjamin Petersond7b03282008-09-13 15:58:53 +00007While :ref:`reference-index` describes the exact syntax and
Georg Brandl116aa622007-08-15 14:28:22 +00008semantics of the Python language, this library reference manual
9describes the standard library that is distributed with Python. It also
10describes some of the optional components that are commonly included
11in Python distributions.
12
13Python's standard library is very extensive, offering a wide range of
14facilities as indicated by the long table of contents listed below. The
15library contains built-in modules (written in C) that provide access to
16system functionality such as file I/O that would otherwise be
17inaccessible to Python programmers, as well as modules written in Python
18that provide standardized solutions for many problems that occur in
19everyday programming. Some of these modules are explicitly designed to
20encourage and enhance the portability of Python programs by abstracting
21away platform-specifics into platform-neutral APIs.
22
Ned Deily8be21422015-03-09 01:55:02 -070023The Python installers for the Windows platform usually include
Georg Brandl116aa622007-08-15 14:28:22 +000024the entire standard library and often also include many additional
25components. For Unix-like operating systems Python is normally provided
26as a collection of packages, so it may be necessary to use the packaging
27tools provided with the operating system to obtain some or all of the
28optional components.
29
30In addition to the standard library, there is a growing collection of
Christian Heimes5e696852008-04-09 08:37:03 +000031several thousand components (from individual programs and modules to
32packages and entire application development frameworks), available from
Stéphane Wirtel19177fb2018-05-15 20:58:35 +020033the `Python Package Index <https://pypi.org>`_.
Georg Brandl116aa622007-08-15 14:28:22 +000034
Yury Selivanovc62ab282018-09-17 18:12:21 -040035.. We don't use :numbered: option for the TOC below as it enforces
36 numbered sections for the entire stdlib docs. If desired,
37 :numbered: can be enabled on a per-module basis.
Georg Brandl116aa622007-08-15 14:28:22 +000038.. toctree::
39 :maxdepth: 2
40
41 intro.rst
42 functions.rst
43 constants.rst
Georg Brandl116aa622007-08-15 14:28:22 +000044 stdtypes.rst
45 exceptions.rst
46
Nick Coghlan273069c2012-08-20 17:14:07 +100047 text.rst
48 binary.rst
Georg Brandl116aa622007-08-15 14:28:22 +000049 datatypes.rst
50 numeric.rst
Georg Brandl77041b22011-01-06 09:23:19 +000051 functional.rst
Georg Brandl116aa622007-08-15 14:28:22 +000052 filesys.rst
53 persistence.rst
54 archiving.rst
55 fileformats.rst
56 crypto.rst
57 allos.rst
Nick Coghlanbac9a532012-08-20 18:05:46 +100058 concurrency.rst
Yury Selivanovbd093352018-02-16 11:47:54 -050059 contextvars.rst
Georg Brandl116aa622007-08-15 14:28:22 +000060 ipc.rst
61 netdata.rst
62 markup.rst
63 internet.rst
64 mm.rst
65 i18n.rst
66 frameworks.rst
67 tk.rst
68 development.rst
Georg Brandl546e2d62007-09-12 18:04:37 +000069 debug.rst
Nick Coghland0cf0632013-11-11 22:11:55 +100070 distribution.rst
Georg Brandl116aa622007-08-15 14:28:22 +000071 python.rst
72 custominterp.rst
73 modules.rst
74 language.rst
75 misc.rst
76 windows.rst
77 unix.rst
Georg Brandldbf83442014-10-11 14:47:11 +020078 superseded.rst
Georg Brandl116aa622007-08-15 14:28:22 +000079 undoc.rst