blob: 16fc7f0783c8cbc94b7574ffae35aa4d6381ad49 [file] [log] [blame]
Guido van Rossumf10aa982007-08-17 18:30:38 +00001.. _glossary:
2
3********
4Glossary
5********
6
7.. if you add new entries, keep the alphabetical sorting!
8
9.. glossary::
10
11 ``>>>``
Benjamin Peterson5478b472008-09-17 22:25:09 +000012 The default Python prompt of the interactive shell. Often seen for code
13 examples which can be executed interactively in the interpreter.
Georg Brandl48310cd2009-01-03 21:18:54 +000014
Guido van Rossumf10aa982007-08-17 18:30:38 +000015 ``...``
Benjamin Peterson5478b472008-09-17 22:25:09 +000016 The default Python prompt of the interactive shell when entering code for
Andrés Delfino68680032018-06-16 00:46:38 -030017 an indented code block, when within a pair of matching left and right
18 delimiters (parentheses, square brackets, curly braces or triple quotes),
19 or after specifying a decorator.
Christian Heimesd8654cf2007-12-02 15:22:16 +000020
Benjamin Petersond6313712008-07-31 16:23:04 +000021 2to3
22 A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl6faee4e2010-09-21 14:48:28 +000023 handling most of the incompatibilities which can be detected by parsing the
Benjamin Petersond6313712008-07-31 16:23:04 +000024 source and traversing the parse tree.
25
26 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
27 entry point is provided as :file:`Tools/scripts/2to3`. See
28 :ref:`2to3-reference`.
29
Georg Brandl86b2fb92008-07-16 03:43:04 +000030 abstract base class
Éric Araujofa088db2011-06-04 18:42:38 +020031 Abstract base classes complement :term:`duck-typing` by
Georg Brandl22b34312009-07-26 14:54:51 +000032 providing a way to define interfaces when other techniques like
Éric Araujofa088db2011-06-04 18:42:38 +020033 :func:`hasattr` would be clumsy or subtly wrong (for example with
Éric Araujo04ac59a2011-08-19 09:07:46 +020034 :ref:`magic methods <special-lookup>`). ABCs introduce virtual
35 subclasses, which are classes that don't inherit from a class but are
36 still recognized by :func:`isinstance` and :func:`issubclass`; see the
37 :mod:`abc` module documentation. Python comes with many built-in ABCs for
Éric Araujo459b4522011-06-04 21:16:42 +020038 data structures (in the :mod:`collections.abc` module), numbers (in the
Éric Araujofa088db2011-06-04 18:42:38 +020039 :mod:`numbers` module), streams (in the :mod:`io` module), import finders
40 and loaders (in the :mod:`importlib.abc` module). You can create your own
41 ABCs with the :mod:`abc` module.
Benjamin Peterson41181742008-07-02 20:22:54 +000042
Andrés Delfinof2290fb2018-05-14 16:04:55 -030043 annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -030044 A label associated with a variable, a class
45 attribute or a function parameter or return value,
46 used by convention as a :term:`type hint`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030047
Andrés Delfino2298c0e2018-05-26 15:18:02 -030048 Annotations of local variables cannot be accessed at runtime, but
Andrés Delfino6e33f812018-05-26 09:43:39 -030049 annotations of global variables, class attributes, and functions
50 are stored in the :attr:`__annotations__`
51 special attribute of modules, classes, and functions,
52 respectively.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030053
Andrés Delfino6e33f812018-05-26 09:43:39 -030054 See :term:`variable annotation`, :term:`function annotation`, :pep:`484`
55 and :pep:`526`, which describe this functionality.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030056
Christian Heimesd8654cf2007-12-02 15:22:16 +000057 argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080058 A value passed to a :term:`function` (or :term:`method`) when calling the
Zachary Waree1391a02013-11-22 13:58:34 -060059 function. There are two kinds of argument:
Christian Heimesd8654cf2007-12-02 15:22:16 +000060
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080061 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
62 ``name=``) in a function call or passed as a value in a dictionary
63 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
64 arguments in the following calls to :func:`complex`::
65
66 complex(real=3, imag=5)
67 complex(**{'real': 3, 'imag': 5})
68
69 * :dfn:`positional argument`: an argument that is not a keyword argument.
70 Positional arguments can appear at the beginning of an argument list
71 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
72 For example, ``3`` and ``5`` are both positional arguments in the
73 following calls::
74
75 complex(3, 5)
76 complex(*(3, 5))
77
78 Arguments are assigned to the named local variables in a function body.
79 See the :ref:`calls` section for the rules governing this assignment.
80 Syntactically, any expression can be used to represent an argument; the
81 evaluated value is assigned to the local variable.
82
83 See also the :term:`parameter` glossary entry, the FAQ question on
84 :ref:`the difference between arguments and parameters
85 <faq-argument-vs-parameter>`, and :pep:`362`.
Benjamin Peterson5478b472008-09-17 22:25:09 +000086
Yury Selivanovf3e40fa2015-05-21 11:50:30 -040087 asynchronous context manager
88 An object which controls the environment seen in an
89 :keyword:`async with` statement by defining :meth:`__aenter__` and
90 :meth:`__aexit__` methods. Introduced by :pep:`492`.
91
Yury Selivanov03660042016-12-15 17:36:05 -050092 asynchronous generator
93 A function which returns an :term:`asynchronous generator iterator`. It
94 looks like a coroutine function defined with :keyword:`async def` except
95 that it contains :keyword:`yield` expressions for producing a series of
96 values usable in an :keyword:`async for` loop.
97
98 Usually refers to a asynchronous generator function, but may refer to an
99 *asynchronous generator iterator* in some contexts. In cases where the
100 intended meaning isn't clear, using the full terms avoids ambiguity.
101
102 An asynchronous generator function may contain :keyword:`await`
103 expressions as well as :keyword:`async for`, and :keyword:`async with`
104 statements.
105
106 asynchronous generator iterator
107 An object created by a :term:`asynchronous generator` function.
108
109 This is an :term:`asynchronous iterator` which when called using the
110 :meth:`__anext__` method returns an awaitable object which will execute
111 that the body of the asynchronous generator function until the
112 next :keyword:`yield` expression.
113
114 Each :keyword:`yield` temporarily suspends processing, remembering the
115 location execution state (including local variables and pending
116 try-statements). When the *asynchronous generator iterator* effectively
117 resumes with another awaitable returned by :meth:`__anext__`, it
Andrés Delfinod689f972018-06-09 22:43:45 -0300118 picks up where it left off. See :pep:`492` and :pep:`525`.
Yury Selivanov03660042016-12-15 17:36:05 -0500119
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400120 asynchronous iterable
121 An object, that can be used in an :keyword:`async for` statement.
Berker Peksagaf511402016-06-11 22:40:41 +0300122 Must return an :term:`asynchronous iterator` from its
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400123 :meth:`__aiter__` method. Introduced by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400124
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400125 asynchronous iterator
Andrés Delfinocf2c5e82018-08-09 12:45:41 -0300126 An object that implements the :meth:`__aiter__` and :meth:`__anext__`
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400127 methods. ``__anext__`` must return an :term:`awaitable` object.
Andrés Delfinocf2c5e82018-08-09 12:45:41 -0300128 :keyword:`async for` resolves the awaitables returned by an asynchronous
129 iterator's :meth:`__anext__` method until it raises a
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400130 :exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
131
Benjamin Peterson5478b472008-09-17 22:25:09 +0000132 attribute
133 A value associated with an object which is referenced by name using
134 dotted expressions. For example, if an object *o* has an attribute
135 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +0000136
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400137 awaitable
138 An object that can be used in an :keyword:`await` expression. Can be
139 a :term:`coroutine` or an object with an :meth:`__await__` method.
140 See also :pep:`492`.
141
Guido van Rossumf10aa982007-08-17 18:30:38 +0000142 BDFL
143 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Sanyam Khurana1b4587a2017-12-06 22:09:33 +0530144 <https://gvanrossum.github.io/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +0000145
Antoine Pitroudd799d22013-12-05 23:46:32 +0100146 binary file
147 A :term:`file object` able to read and write
148 :term:`bytes-like objects <bytes-like object>`.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +0200149 Examples of binary files are files opened in binary mode (``'rb'``,
150 ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer`,
151 :data:`sys.stdout.buffer`, and instances of :class:`io.BytesIO` and
152 :class:`gzip.GzipFile`.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100153
Andrés Delfino0c4be822018-05-20 12:12:50 -0300154 See also :term:`text file` for a file object able to read and write
155 :class:`str` objects.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100156
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300157 bytes-like object
Stefan Krah70e543b2015-08-08 14:33:28 +0200158 An object that supports the :ref:`bufferobjects` and can
159 export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,
160 :class:`bytearray`, and :class:`array.array` objects, as well as many
161 common :class:`memoryview` objects. Bytes-like objects can
Larry Hastingsab792ac2015-04-13 11:30:56 -0400162 be used for various operations that work with binary data; these include
163 compression, saving to a binary file, and sending over a socket.
164
165 Some operations need the binary data to be mutable. The documentation
166 often refers to these as "read-write bytes-like objects". Example
167 mutable buffer objects include :class:`bytearray` and a
168 :class:`memoryview` of a :class:`bytearray`.
169 Other operations require the binary data to be stored in
170 immutable objects ("read-only bytes-like objects"); examples
171 of these include :class:`bytes` and a :class:`memoryview`
172 of a :class:`bytes` object.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300173
Georg Brandl9afde1c2007-11-01 20:32:30 +0000174 bytecode
175 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +0000176 of a Python program in the CPython interpreter. The bytecode is also
Xiang Zhang0710d752017-03-11 13:02:52 +0800177 cached in ``.pyc`` files so that executing the same file is
Brett Cannon8315fd12010-07-02 22:03:00 +0000178 faster the second time (recompilation from source to bytecode can be
179 avoided). This "intermediate language" is said to run on a
180 :term:`virtual machine` that executes the machine code corresponding to
181 each bytecode. Do note that bytecodes are not expected to work between
182 different Python virtual machines, nor to be stable between Python
183 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000184
Georg Brandl2cb72d32010-07-03 10:26:54 +0000185 A list of bytecode instructions can be found in the documentation for
186 :ref:`the dis module <bytecodes>`.
187
Benjamin Peterson5478b472008-09-17 22:25:09 +0000188 class
189 A template for creating user-defined objects. Class definitions
190 normally contain method definitions which operate on instances of the
191 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000192
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300193 class variable
194 A variable defined in a class and intended to be modified only at
195 class level (i.e., not in an instance of the class).
196
Benjamin Peterson5478b472008-09-17 22:25:09 +0000197 coercion
198 The implicit conversion of an instance of one type to another during an
199 operation which involves two arguments of the same type. For example,
200 ``int(3.15)`` converts the floating point number to the integer ``3``, but
201 in ``3+4.5``, each argument is of a different type (one int, one float),
202 and both must be converted to the same type before they can be added or it
Benjamin Peterson2d718222008-11-21 00:25:02 +0000203 will raise a ``TypeError``. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000204 compatible types would have to be normalized to the same value by the
205 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000206
Guido van Rossumf10aa982007-08-17 18:30:38 +0000207 complex number
208 An extension of the familiar real number system in which all numbers are
209 expressed as a sum of a real part and an imaginary part. Imaginary
210 numbers are real multiples of the imaginary unit (the square root of
211 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000212 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000213 written with this latter notation; the imaginary part is written with a
214 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
215 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
216 advanced mathematical feature. If you're not aware of a need for them,
217 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000218
Christian Heimes895627f2007-12-08 17:28:33 +0000219 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000220 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000221 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
222 See :pep:`343`.
223
Stefan Krah70e543b2015-08-08 14:33:28 +0200224 contiguous
225 .. index:: C-contiguous, Fortran contiguous
226
227 A buffer is considered contiguous exactly if it is either
228 *C-contiguous* or *Fortran contiguous*. Zero-dimensional buffers are
229 C and Fortran contiguous. In one-dimensional arrays, the items
Martin Panter46f50722016-05-26 05:35:26 +0000230 must be laid out in memory next to each other, in order of
Stefan Krah70e543b2015-08-08 14:33:28 +0200231 increasing indexes starting from zero. In multidimensional
232 C-contiguous arrays, the last index varies the fastest when
233 visiting items in order of memory address. However, in
234 Fortran contiguous arrays, the first index varies the fastest.
235
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400236 coroutine
237 Coroutines is a more generalized form of subroutines. Subroutines are
Yury Selivanov66f88282015-06-24 11:04:15 -0400238 entered at one point and exited at another point. Coroutines can be
239 entered, exited, and resumed at many different points. They can be
240 implemented with the :keyword:`async def` statement. See also
241 :pep:`492`.
242
243 coroutine function
244 A function which returns a :term:`coroutine` object. A coroutine
245 function may be defined with the :keyword:`async def` statement,
246 and may contain :keyword:`await`, :keyword:`async for`, and
247 :keyword:`async with` keywords. These were introduced
248 by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400249
Benjamin Peterson5478b472008-09-17 22:25:09 +0000250 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000251 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100252 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000253 is used when necessary to distinguish this implementation from others
254 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000255
Christian Heimesd8654cf2007-12-02 15:22:16 +0000256 decorator
257 A function returning another function, usually applied as a function
258 transformation using the ``@wrapper`` syntax. Common examples for
259 decorators are :func:`classmethod` and :func:`staticmethod`.
260
261 The decorator syntax is merely syntactic sugar, the following two
262 function definitions are semantically equivalent::
263
264 def f(...):
265 ...
266 f = staticmethod(f)
267
268 @staticmethod
269 def f(...):
270 ...
271
Georg Brandlaf265f42008-12-07 15:06:20 +0000272 The same concept exists for classes, but is less commonly used there. See
273 the documentation for :ref:`function definitions <function>` and
274 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000275
Guido van Rossumf10aa982007-08-17 18:30:38 +0000276 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000277 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000278 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000279 binding behavior is triggered upon attribute lookup. Normally, using
280 *a.b* to get, set or delete an attribute looks up the object named *b* in
281 the class dictionary for *a*, but if *b* is a descriptor, the respective
282 descriptor method gets called. Understanding descriptors is a key to a
283 deep understanding of Python because they are the basis for many features
284 including functions, methods, properties, class methods, static methods,
285 and reference to super classes.
286
287 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000288
Guido van Rossumf10aa982007-08-17 18:30:38 +0000289 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700290 An associative array, where arbitrary keys are mapped to values. The
291 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
292 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000293
Martin Panter85b8f452015-10-07 09:56:46 +0000294 dictionary view
295 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
296 :meth:`dict.items` are called dictionary views. They provide a dynamic
297 view on the dictionary’s entries, which means that when the dictionary
298 changes, the view reflects these changes. To force the
299 dictionary view to become a full list use ``list(dictview)``. See
300 :ref:`dict-views`.
301
Georg Brandl3dbca812008-07-23 16:10:53 +0000302 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000303 A string literal which appears as the first expression in a class,
304 function or module. While ignored when the suite is executed, it is
305 recognized by the compiler and put into the :attr:`__doc__` attribute
306 of the enclosing class, function or module. Since it is available via
307 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000308 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000309
310 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000311 A programming style which does not look at an object's type to determine
312 if it has the right interface; instead, the method or attribute is simply
313 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000314 must be a duck.") By emphasizing interfaces rather than specific types,
315 well-designed code improves its flexibility by allowing polymorphic
316 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000317 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200318 with :term:`abstract base classes <abstract base class>`.) Instead, it
319 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000320
Guido van Rossumf10aa982007-08-17 18:30:38 +0000321 EAFP
322 Easier to ask for forgiveness than permission. This common Python coding
323 style assumes the existence of valid keys or attributes and catches
324 exceptions if the assumption proves false. This clean and fast style is
325 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000326 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000327 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000328
Christian Heimesd8654cf2007-12-02 15:22:16 +0000329 expression
330 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000331 an expression is an accumulation of expression elements like literals,
332 names, attribute access, operators or function calls which all return a
333 value. In contrast to many other languages, not all language constructs
334 are expressions. There are also :term:`statement`\s which cannot be used
335 as expressions, such as :keyword:`if`. Assignments are also statements,
336 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000337
Guido van Rossumf10aa982007-08-17 18:30:38 +0000338 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000339 A module written in C or C++, using Python's C API to interact with the
340 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000341
Mariatta33db0682017-03-30 12:12:18 -0700342 f-string
343 String literals prefixed with ``'f'`` or ``'F'`` are commonly called
344 "f-strings" which is short for
345 :ref:`formatted string literals <f-strings>`. See also :pep:`498`.
346
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000347 file object
348 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000349 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
350 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300351 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000352 (for example standard input/output, in-memory buffers, sockets, pipes,
353 etc.). File objects are also called :dfn:`file-like objects` or
354 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000355
Antoine Pitroudd799d22013-12-05 23:46:32 +0100356 There are actually three categories of file objects: raw
357 :term:`binary files <binary file>`, buffered
358 :term:`binary files <binary file>` and :term:`text files <text file>`.
359 Their interfaces are defined in the :mod:`io` module. The canonical
360 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000361
362 file-like object
363 A synonym for :term:`file object`.
364
Brett Cannon51d4aab2009-01-25 04:21:39 +0000365 finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800366 An object that tries to find the :term:`loader` for a module that is
367 being imported.
368
369 Since Python 3.3, there are two types of finder: :term:`meta path finders
370 <meta path finder>` for use with :data:`sys.meta_path`, and :term:`path
371 entry finders <path entry finder>` for use with :data:`sys.path_hooks`.
372
373 See :pep:`302`, :pep:`420` and :pep:`451` for much more detail.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000374
Benjamin Peterson2d718222008-11-21 00:25:02 +0000375 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000376 Mathematical division that rounds down to nearest integer. The floor
377 division operator is ``//``. For example, the expression ``11 // 4``
378 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
379 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
380 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000381
Christian Heimesd8654cf2007-12-02 15:22:16 +0000382 function
383 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800384 be passed zero or more :term:`arguments <argument>` which may be used in
385 the execution of the body. See also :term:`parameter`, :term:`method`,
386 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000387
R David Murray25cd0912013-05-06 12:58:16 -0400388 function annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -0300389 An :term:`annotation` of a function parameter or return value.
R David Murray25cd0912013-05-06 12:58:16 -0400390
Andrés Delfino6e33f812018-05-26 09:43:39 -0300391 Function annotations are usually used for
392 :term:`type hints <type hint>`: for example this function is expected to take two
393 :class:`int` arguments and is also expected to have an :class:`int`
394 return value::
Guido van Rossum95e4d582018-01-26 08:20:18 -0800395
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300396 def sum_two_numbers(a: int, b: int) -> int:
397 return a + b
398
Andrés Delfino6e33f812018-05-26 09:43:39 -0300399 Function annotation syntax is explained in section :ref:`function`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300400
Andrés Delfino6e33f812018-05-26 09:43:39 -0300401 See :term:`variable annotation` and :pep:`484`,
402 which describe this functionality.
R David Murray25cd0912013-05-06 12:58:16 -0400403
Guido van Rossumf10aa982007-08-17 18:30:38 +0000404 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000405 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000406 which are not compatible with the current interpreter.
407
408 By importing the :mod:`__future__` module and evaluating its variables,
409 you can see when a new feature was first added to the language and when it
410 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000411
Guido van Rossumf10aa982007-08-17 18:30:38 +0000412 >>> import __future__
413 >>> __future__.division
414 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
415
416 garbage collection
417 The process of freeing memory when it is not used anymore. Python
418 performs garbage collection via reference counting and a cyclic garbage
Antoine Pitrou4b965932017-12-19 19:48:45 +0100419 collector that is able to detect and break reference cycles. The
420 garbage collector can be controlled using the :mod:`gc` module.
Georg Brandl48310cd2009-01-03 21:18:54 +0000421
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000422 .. index:: single: generator
423
Guido van Rossumf10aa982007-08-17 18:30:38 +0000424 generator
Yury Selivanov5376ba92015-06-22 12:19:30 -0400425 A function which returns a :term:`generator iterator`. It looks like a
426 normal function except that it contains :keyword:`yield` expressions
427 for producing a series of values usable in a for-loop or that can be
428 retrieved one at a time with the :func:`next` function.
429
430 Usually refers to a generator function, but may refer to a
431 *generator iterator* in some contexts. In cases where the intended
432 meaning isn't clear, using the full terms avoids ambiguity.
433
434 generator iterator
435 An object created by a :term:`generator` function.
436
437 Each :keyword:`yield` temporarily suspends processing, remembering the
438 location execution state (including local variables and pending
Andrés Delfinod689f972018-06-09 22:43:45 -0300439 try-statements). When the *generator iterator* resumes, it picks up where
440 it left off (in contrast to functions which start fresh on every
Yury Selivanov5376ba92015-06-22 12:19:30 -0400441 invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000442
Guido van Rossumf10aa982007-08-17 18:30:38 +0000443 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000444
Guido van Rossumf10aa982007-08-17 18:30:38 +0000445 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000446 An expression that returns an iterator. It looks like a normal expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000447 followed by a :keyword:`for` expression defining a loop variable, range,
448 and an optional :keyword:`if` expression. The combined expression
449 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000450
Guido van Rossumf10aa982007-08-17 18:30:38 +0000451 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
452 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000453
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200454 generic function
455 A function composed of multiple functions implementing the same operation
456 for different types. Which implementation should be used during a call is
457 determined by the dispatch algorithm.
458
459 See also the :term:`single dispatch` glossary entry, the
460 :func:`functools.singledispatch` decorator, and :pep:`443`.
461
462
Guido van Rossumf10aa982007-08-17 18:30:38 +0000463 GIL
464 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000465
Guido van Rossumf10aa982007-08-17 18:30:38 +0000466 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000467 The mechanism used by the :term:`CPython` interpreter to assure that
468 only one thread executes Python :term:`bytecode` at a time.
469 This simplifies the CPython implementation by making the object model
470 (including critical built-in types such as :class:`dict`) implicitly
471 safe against concurrent access. Locking the entire interpreter
472 makes it easier for the interpreter to be multi-threaded, at the
473 expense of much of the parallelism afforded by multi-processor
474 machines.
475
476 However, some extension modules, either standard or third-party,
477 are designed so as to release the GIL when doing computationally-intensive
478 tasks such as compression or hashing. Also, the GIL is always released
479 when doing I/O.
480
481 Past efforts to create a "free-threaded" interpreter (one which locks
482 shared data at a much finer granularity) have not been successful
483 because performance suffered in the common single-processor case. It
484 is believed that overcoming this performance issue would make the
485 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000486
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800487
488 hash-based pyc
INADA Naoki40a536b2018-03-28 22:07:57 +0900489 A bytecode cache file that uses the hash rather than the last-modified
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800490 time of the corresponding source file to determine its validity. See
491 :ref:`pyc-invalidation`.
492
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000493 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000494 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000495 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000496 other objects (it needs an :meth:`__eq__` method). Hashable objects which
497 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000498
499 Hashability makes an object usable as a dictionary key and a set member,
500 because these data structures use the hash value internally.
501
csabella64c887a2017-04-01 22:50:47 -0400502 All of Python's immutable built-in objects are hashable; mutable
503 containers (such as lists or dictionaries) are not. Objects which are
504 instances of user-defined classes are hashable by default. They all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200505 compare unequal (except with themselves), and their hash value is derived
506 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000507
Guido van Rossumf10aa982007-08-17 18:30:38 +0000508 IDLE
509 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000510 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000511 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000512
Guido van Rossumf10aa982007-08-17 18:30:38 +0000513 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000514 An object with a fixed value. Immutable objects include numbers, strings and
515 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000516 be created if a different value has to be stored. They play an important
517 role in places where a constant hash value is needed, for example as a key
518 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000519
Barry Warsawdadebab2012-07-31 16:03:09 -0400520 import path
521 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000522 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400523 import, this list of locations usually comes from :data:`sys.path`, but
524 for subpackages it may also come from the parent package's ``__path__``
525 attribute.
526
Barry Warsawd7d21942012-07-29 16:36:17 -0400527 importing
528 The process by which Python code in one module is made available to
529 Python code in another module.
530
Brett Cannon51d4aab2009-01-25 04:21:39 +0000531 importer
532 An object that both finds and loads a module; both a
533 :term:`finder` and :term:`loader` object.
534
Guido van Rossumf10aa982007-08-17 18:30:38 +0000535 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000536 Python has an interactive interpreter which means you can enter
537 statements and expressions at the interpreter prompt, immediately
538 execute them and see their results. Just launch ``python`` with no
539 arguments (possibly by selecting it from your computer's main
540 menu). It is a very powerful way to test out new ideas or inspect
541 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000542
Guido van Rossumf10aa982007-08-17 18:30:38 +0000543 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000544 Python is an interpreted language, as opposed to a compiled one,
545 though the distinction can be blurry because of the presence of the
546 bytecode compiler. This means that source files can be run directly
547 without explicitly creating an executable which is then run.
548 Interpreted languages typically have a shorter development/debug cycle
549 than compiled ones, though their programs generally also run more
550 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000551
Antoine Pitrou5db1bb82014-12-07 01:28:27 +0100552 interpreter shutdown
553 When asked to shut down, the Python interpreter enters a special phase
554 where it gradually releases all allocated resources, such as modules
555 and various critical internal structures. It also makes several calls
556 to the :term:`garbage collector <garbage collection>`. This can trigger
557 the execution of code in user-defined destructors or weakref callbacks.
558 Code executed during the shutdown phase can encounter various
559 exceptions as the resources it relies on may not function anymore
560 (common examples are library modules or the warnings machinery).
561
562 The main reason for interpreter shutdown is that the ``__main__`` module
563 or the script being run has finished executing.
564
Guido van Rossumf10aa982007-08-17 18:30:38 +0000565 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200566 An object capable of returning its members one at a time. Examples of
567 iterables include all sequence types (such as :class:`list`, :class:`str`,
568 and :class:`tuple`) and some non-sequence types like :class:`dict`,
569 :term:`file objects <file object>`, and objects of any classes you define
Raymond Hettinger0bf287b2017-09-25 00:52:06 -0700570 with an :meth:`__iter__` method or with a :meth:`__getitem__` method
571 that implements :term:`Sequence` semantics.
572
573 Iterables can be
Ezio Melottid581fff2013-01-02 22:29:09 +0200574 used in a :keyword:`for` loop and in many other places where a sequence is
575 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
576 as an argument to the built-in function :func:`iter`, it returns an
577 iterator for the object. This iterator is good for one pass over the set
578 of values. When using iterables, it is usually not necessary to call
579 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000580 statement does that automatically for you, creating a temporary unnamed
581 variable to hold the iterator for the duration of the loop. See also
582 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000583
Guido van Rossumf10aa982007-08-17 18:30:38 +0000584 iterator
585 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300586 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000587 :func:`next`) return successive items in the stream. When no more data
588 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000589 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000590 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
591 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000592 object itself so every iterator is also iterable and may be used in most
593 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000594 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000595 :class:`list`) produces a fresh new iterator each time you pass it to the
596 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
597 with an iterator will just return the same exhausted iterator object used
598 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000599
Georg Brandl9afde1c2007-11-01 20:32:30 +0000600 More information can be found in :ref:`typeiter`.
601
Georg Brandlc275e152010-11-05 07:10:41 +0000602 key function
603 A key function or collation function is a callable that returns a value
604 used for sorting or ordering. For example, :func:`locale.strxfrm` is
605 used to produce a sort key that is aware of locale specific sort
606 conventions.
607
608 A number of tools in Python accept key functions to control how elements
609 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700610 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
611 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
612 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000613
614 There are several ways to create a key function. For example. the
615 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700616 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000617 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200618 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000619 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
620 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
621 <sortinghowto>` for examples of how to create and use key functions.
622
Christian Heimesd8654cf2007-12-02 15:22:16 +0000623 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800624 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000625
626 lambda
627 An anonymous inline function consisting of a single :term:`expression`
628 which is evaluated when the function is called. The syntax to create
Andrés Delfino268cc7c2018-05-22 02:57:45 -0300629 a lambda function is ``lambda [parameters]: expression``
Christian Heimesd8654cf2007-12-02 15:22:16 +0000630
Guido van Rossumf10aa982007-08-17 18:30:38 +0000631 LBYL
632 Look before you leap. This coding style explicitly tests for
633 pre-conditions before making calls or lookups. This style contrasts with
634 the :term:`EAFP` approach and is characterized by the presence of many
635 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000636
Raymond Hettinger09f44142010-12-17 20:19:50 +0000637 In a multi-threaded environment, the LBYL approach can risk introducing a
638 race condition between "the looking" and "the leaping". For example, the
639 code, ``if key in mapping: return mapping[key]`` can fail if another
640 thread removes *key* from *mapping* after the test, but before the lookup.
641 This issue can be solved with locks or by using the EAFP approach.
642
Benjamin Peterson5478b472008-09-17 22:25:09 +0000643 list
644 A built-in Python :term:`sequence`. Despite its name it is more akin
645 to an array in other languages than to a linked list since access to
Andrés Delfino7469ff52018-06-15 23:42:09 -0300646 elements is O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000647
Guido van Rossumf10aa982007-08-17 18:30:38 +0000648 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000649 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000650 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000651 range(256) if x % 2 == 0]`` generates a list of strings containing
652 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
653 clause is optional. If omitted, all elements in ``range(256)`` are
654 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000655
Brett Cannon51d4aab2009-01-25 04:21:39 +0000656 loader
657 An object that loads a module. It must define a method named
658 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000659 :term:`finder`. See :pep:`302` for details and
660 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000661
Guido van Rossumf10aa982007-08-17 18:30:38 +0000662 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000663 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200664 methods specified in the :class:`~collections.abc.Mapping` or
665 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200666 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
667 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000668 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000669
Barry Warsawd7d21942012-07-29 16:36:17 -0400670 meta path finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800671 A :term:`finder` returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400672 finders are related to, but different from :term:`path entry finders
673 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400674
Brett Cannonccddbb12015-12-04 15:46:21 -0800675 See :class:`importlib.abc.MetaPathFinder` for the methods that meta path
676 finders implement.
677
Guido van Rossumf10aa982007-08-17 18:30:38 +0000678 metaclass
679 The class of a class. Class definitions create a class name, a class
680 dictionary, and a list of base classes. The metaclass is responsible for
681 taking those three arguments and creating the class. Most object oriented
682 programming languages provide a default implementation. What makes Python
683 special is that it is possible to create custom metaclasses. Most users
684 never need this tool, but when the need arises, metaclasses can provide
685 powerful, elegant solutions. They have been used for logging attribute
686 access, adding thread-safety, tracking object creation, implementing
687 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000688
689 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000690
691 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000692 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000693 of an instance of that class, the method will get the instance object as
694 its first :term:`argument` (which is usually called ``self``).
695 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000696
Michael Foord95fc51d2010-11-20 15:07:30 +0000697 method resolution order
698 Method Resolution Order is the order in which base classes are searched
699 for a member during lookup. See `The Python 2.3 Method Resolution Order
Senthil Kumaran3858a1c2016-01-09 22:33:54 -0800700 <https://www.python.org/download/releases/2.3/mro/>`_ for details of the
701 algorithm used by the Python interpreter since the 2.3 release.
Michael Foord95fc51d2010-11-20 15:07:30 +0000702
Barry Warsawd7d21942012-07-29 16:36:17 -0400703 module
704 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400705 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400706 into Python by the process of :term:`importing`.
707
Georg Brandlbcce1252013-10-08 08:06:18 +0200708 See also :term:`package`.
709
Eric Snowca2d8542013-12-16 23:06:52 -0700710 module spec
711 A namespace containing the import-related information used to load a
Brett Cannonccddbb12015-12-04 15:46:21 -0800712 module. An instance of :class:`importlib.machinery.ModuleSpec`.
Eric Snowca2d8542013-12-16 23:06:52 -0700713
Michael Foord95fc51d2010-11-20 15:07:30 +0000714 MRO
715 See :term:`method resolution order`.
716
Guido van Rossumf10aa982007-08-17 18:30:38 +0000717 mutable
718 Mutable objects can change their value but keep their :func:`id`. See
719 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000720
721 named tuple
Raymond Hettingerd04fa312009-02-04 19:45:13 +0000722 Any tuple-like class whose indexable elements are also accessible using
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000723 named attributes (for example, :func:`time.localtime` returns a
724 tuple-like object where the *year* is accessible either with an
725 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
726
727 A named tuple can be a built-in type such as :class:`time.struct_time`,
728 or it can be created with a regular class definition. A full featured
729 named tuple can also be created with the factory function
730 :func:`collections.namedtuple`. The latter approach automatically
731 provides extra features such as a self-documenting representation like
732 ``Employee(name='jones', title='programmer')``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000733
Guido van Rossumf10aa982007-08-17 18:30:38 +0000734 namespace
735 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000736 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000737 as nested namespaces in objects (in methods). Namespaces support
738 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300739 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
740 their namespaces. Namespaces also aid readability and maintainability by
741 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200742 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000743 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000744 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000745
Barry Warsawd7d21942012-07-29 16:36:17 -0400746 namespace package
747 A :pep:`420` :term:`package` which serves only as a container for
748 subpackages. Namespace packages may have no physical representation,
749 and specifically are not like a :term:`regular package` because they
750 have no ``__init__.py`` file.
751
Georg Brandlbcce1252013-10-08 08:06:18 +0200752 See also :term:`module`.
753
Guido van Rossumf10aa982007-08-17 18:30:38 +0000754 nested scope
755 The ability to refer to a variable in an enclosing definition. For
756 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000757 variables in the outer function. Note that nested scopes by default work
758 only for reference and not for assignment. Local variables both read and
759 write in the innermost scope. Likewise, global variables read and write
760 to the global namespace. The :keyword:`nonlocal` allows writing to outer
761 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000762
Guido van Rossumf10aa982007-08-17 18:30:38 +0000763 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000764 Old name for the flavor of classes now used for all class objects. In
765 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300766 versatile features like :attr:`~object.__slots__`, descriptors,
767 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000768
Benjamin Peterson5478b472008-09-17 22:25:09 +0000769 object
770 Any data with state (attributes or value) and defined behavior
771 (methods). Also the ultimate base class of any :term:`new-style
772 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000773
Barry Warsawd7d21942012-07-29 16:36:17 -0400774 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200775 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400776 subpackages. Technically, a package is a Python module with an
777 ``__path__`` attribute.
778
Georg Brandlbcce1252013-10-08 08:06:18 +0200779 See also :term:`regular package` and :term:`namespace package`.
780
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800781 parameter
782 A named entity in a :term:`function` (or method) definition that
783 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600784 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800785
786 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
787 either :term:`positionally <argument>` or as a :term:`keyword argument
788 <argument>`. This is the default kind of parameter, for example *foo*
789 and *bar* in the following::
790
791 def func(foo, bar=None): ...
792
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +0300793 .. _positional-only_parameter:
794
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800795 * :dfn:`positional-only`: specifies an argument that can be supplied only
796 by position. Python has no syntax for defining positional-only
797 parameters. However, some built-in functions have positional-only
798 parameters (e.g. :func:`abs`).
799
Zachary Waree1391a02013-11-22 13:58:34 -0600800 .. _keyword-only_parameter:
801
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800802 * :dfn:`keyword-only`: specifies an argument that can be supplied only
803 by keyword. Keyword-only parameters can be defined by including a
804 single var-positional parameter or bare ``*`` in the parameter list
805 of the function definition before them, for example *kw_only1* and
806 *kw_only2* in the following::
807
808 def func(arg, *, kw_only1, kw_only2): ...
809
810 * :dfn:`var-positional`: specifies that an arbitrary sequence of
811 positional arguments can be provided (in addition to any positional
812 arguments already accepted by other parameters). Such a parameter can
813 be defined by prepending the parameter name with ``*``, for example
814 *args* in the following::
815
816 def func(*args, **kwargs): ...
817
818 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
819 can be provided (in addition to any keyword arguments already accepted
820 by other parameters). Such a parameter can be defined by prepending
821 the parameter name with ``**``, for example *kwargs* in the example
822 above.
823
824 Parameters can specify both optional and required arguments, as well as
825 default values for some optional arguments.
826
827 See also the :term:`argument` glossary entry, the FAQ question on
828 :ref:`the difference between arguments and parameters
829 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
830 :ref:`function` section, and :pep:`362`.
831
Barry Warsawdadebab2012-07-31 16:03:09 -0400832 path entry
833 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000834 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400835
836 path entry finder
837 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
838 (i.e. a :term:`path entry hook`) which knows how to locate modules given
839 a :term:`path entry`.
840
Brett Cannonccddbb12015-12-04 15:46:21 -0800841 See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
842 finders implement.
843
Barry Warsawdadebab2012-07-31 16:03:09 -0400844 path entry hook
845 A callable on the :data:`sys.path_hook` list which returns a :term:`path
846 entry finder` if it knows how to find modules on a specific :term:`path
847 entry`.
848
Nick Coghlan1685db02012-08-20 13:49:08 +1000849 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400850 One of the default :term:`meta path finders <meta path finder>` which
851 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400852
Brett Cannonc28592b2016-06-24 12:21:47 -0700853 path-like object
854 An object representing a file system path. A path-like object is either
855 a :class:`str` or :class:`bytes` object representing a path, or an object
856 implementing the :class:`os.PathLike` protocol. An object that supports
857 the :class:`os.PathLike` protocol can be converted to a :class:`str` or
858 :class:`bytes` file system path by calling the :func:`os.fspath` function;
859 :func:`os.fsdecode` and :func:`os.fsencode` can be used to guarantee a
860 :class:`str` or :class:`bytes` result instead, respectively. Introduced
861 by :pep:`519`.
862
Andrés Delfinod5f14422018-05-17 04:51:50 -0300863 PEP
864 Python Enhancement Proposal. A PEP is a design document
865 providing information to the Python community, or describing a new
866 feature for Python or its processes or environment. PEPs should
867 provide a concise technical specification and a rationale for proposed
868 features.
869
870 PEPs are intended to be the primary mechanisms for proposing major new
871 features, for collecting community input on an issue, and for documenting
872 the design decisions that have gone into Python. The PEP author is
873 responsible for building consensus within the community and documenting
874 dissenting opinions.
875
876 See :pep:`1`.
877
Barry Warsawd7d21942012-07-29 16:36:17 -0400878 portion
879 A set of files in a single directory (possibly stored in a zip file)
880 that contribute to a namespace package, as defined in :pep:`420`.
881
Christian Heimesd8654cf2007-12-02 15:22:16 +0000882 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800883 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000884
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000885 provisional API
886 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400887 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000888 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300889 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000890 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300891 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000892 fundamental flaws are uncovered that were missed prior to the inclusion
893 of the API.
894
895 Even for provisional APIs, backwards incompatible changes are seen as
896 a "solution of last resort" - every attempt will still be made to find
897 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300898
Barry Warsawd7d21942012-07-29 16:36:17 -0400899 This process allows the standard library to continue to evolve over
900 time, without locking in problematic design errors for extended periods
901 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300902
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000903 provisional package
904 See :term:`provisional API`.
905
Guido van Rossumf10aa982007-08-17 18:30:38 +0000906 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400907 Nickname for the Python 3.x release line (coined long ago when the
908 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000909 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000910
Christian Heimesd8654cf2007-12-02 15:22:16 +0000911 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000912 An idea or piece of code which closely follows the most common idioms
913 of the Python language, rather than implementing code using concepts
914 common to other languages. For example, a common idiom in Python is
915 to loop over all elements of an iterable using a :keyword:`for`
916 statement. Many other languages don't have this type of construct, so
917 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000918
Christian Heimesd8654cf2007-12-02 15:22:16 +0000919 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000920 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000921
922 As opposed to the cleaner, Pythonic method::
923
924 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000925 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000926
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100927 qualified name
928 A dotted name showing the "path" from a module's global scope to a
929 class, function or method defined in that module, as defined in
930 :pep:`3155`. For top-level functions and classes, the qualified name
931 is the same as the object's name::
932
933 >>> class C:
934 ... class D:
935 ... def meth(self):
936 ... pass
937 ...
938 >>> C.__qualname__
939 'C'
940 >>> C.D.__qualname__
941 'C.D'
942 >>> C.D.meth.__qualname__
943 'C.D.meth'
944
Barry Warsawd7d21942012-07-29 16:36:17 -0400945 When used to refer to modules, the *fully qualified name* means the
946 entire dotted path to the module, including any parent packages,
947 e.g. ``email.mime.text``::
948
949 >>> import email.mime.text
950 >>> email.mime.text.__name__
951 'email.mime.text'
952
Guido van Rossumf10aa982007-08-17 18:30:38 +0000953 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000954 The number of references to an object. When the reference count of an
955 object drops to zero, it is deallocated. Reference counting is
956 generally not visible to Python code, but it is a key element of the
957 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000958 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000959 reference count for a particular object.
960
Barry Warsawd7d21942012-07-29 16:36:17 -0400961 regular package
962 A traditional :term:`package`, such as a directory containing an
963 ``__init__.py`` file.
964
Georg Brandlbcce1252013-10-08 08:06:18 +0200965 See also :term:`namespace package`.
966
Guido van Rossumf10aa982007-08-17 18:30:38 +0000967 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +0000968 A declaration inside a class that saves memory by pre-declaring space for
969 instance attributes and eliminating instance dictionaries. Though
970 popular, the technique is somewhat tricky to get right and is best
971 reserved for rare cases where there are large numbers of instances in a
972 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +0000973
Guido van Rossumf10aa982007-08-17 18:30:38 +0000974 sequence
975 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +0000976 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +0300977 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000978 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +0000979 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +0000980 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
981 mapping rather than a sequence because the lookups use arbitrary
982 :term:`immutable` keys rather than integers.
983
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -0500984 The :class:`collections.abc.Sequence` abstract base class
985 defines a much richer interface that goes beyond just
986 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
987 :meth:`index`, :meth:`__contains__`, and
988 :meth:`__reversed__`. Types that implement this expanded
989 interface can be registered explicitly using
990 :func:`~abc.register`.
991
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200992 single dispatch
993 A form of :term:`generic function` dispatch where the implementation is
994 chosen based on the type of a single argument.
995
Christian Heimesd8654cf2007-12-02 15:22:16 +0000996 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +0000997 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +0000998 created using the subscript notation, ``[]`` with colons between numbers
999 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +00001000 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001001
Georg Brandlaf265f42008-12-07 15:06:20 +00001002 special method
1003 A method that is called implicitly by Python to execute a certain
1004 operation on a type, such as addition. Such methods have names starting
1005 and ending with double underscores. Special methods are documented in
1006 :ref:`specialnames`.
1007
Christian Heimesd8654cf2007-12-02 15:22:16 +00001008 statement
1009 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +02001010 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +00001011 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001012
Benjamin Peterson82f614b2011-04-20 18:27:32 -05001013 struct sequence
Florent Xiclunaf8240d62011-11-11 19:58:53 +01001014 A tuple with named elements. Struct sequences expose an interface similar
Zachary Ware98b976a2018-09-01 20:59:27 -05001015 to :term:`named tuple` in that elements can be accessed either by
Benjamin Peterson82f614b2011-04-20 18:27:32 -05001016 index or as an attribute. However, they do not have any of the named tuple
1017 methods like :meth:`~collections.somenamedtuple._make` or
1018 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
1019 include :data:`sys.float_info` and the return value of :func:`os.stat`.
1020
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001021 text encoding
1022 A codec which encodes Unicode strings to bytes.
1023
Antoine Pitroudd799d22013-12-05 23:46:32 +01001024 text file
1025 A :term:`file object` able to read and write :class:`str` objects.
1026 Often, a text file actually accesses a byte-oriented datastream
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001027 and handles the :term:`text encoding` automatically.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +02001028 Examples of text files are files opened in text mode (``'r'`` or ``'w'``),
1029 :data:`sys.stdin`, :data:`sys.stdout`, and instances of
1030 :class:`io.StringIO`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001031
Andrés Delfino0c4be822018-05-20 12:12:50 -03001032 See also :term:`binary file` for a file object able to read and write
1033 :term:`bytes-like objects <bytes-like object>`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001034
Benjamin Peterson5478b472008-09-17 22:25:09 +00001035 triple-quoted string
1036 A string which is bound by three instances of either a quotation mark
1037 (") or an apostrophe ('). While they don't provide any functionality
1038 not available with single-quoted strings, they are useful for a number
1039 of reasons. They allow you to include unescaped single and double
1040 quotes within a string and they can span multiple lines without the
1041 use of the continuation character, making them especially useful when
1042 writing docstrings.
1043
Guido van Rossumf10aa982007-08-17 18:30:38 +00001044 type
1045 The type of a Python object determines what kind of object it is; every
1046 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +03001047 :attr:`~instance.__class__` attribute or can be retrieved with
1048 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +00001049
Andrés Delfino6e33f812018-05-26 09:43:39 -03001050 type alias
1051 A synonym for a type, created by assigning the type to an identifier.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001052
Andrés Delfino6e33f812018-05-26 09:43:39 -03001053 Type aliases are useful for simplifying :term:`type hints <type hint>`.
1054 For example::
1055
1056 from typing import List, Tuple
1057
1058 def remove_gray_shades(
1059 colors: List[Tuple[int, int, int]]) -> List[Tuple[int, int, int]]:
1060 pass
1061
1062 could be made more readable like this::
1063
1064 from typing import List, Tuple
1065
1066 Color = Tuple[int, int, int]
1067
1068 def remove_gray_shades(colors: List[Color]) -> List[Color]:
1069 pass
1070
1071 See :mod:`typing` and :pep:`484`, which describe this functionality.
1072
1073 type hint
1074 An :term:`annotation` that specifies the expected type for a variable, a class
1075 attribute, or a function parameter or return value.
1076
1077 Type hints are optional and are not enforced by Python but
1078 they are useful to static type analysis tools, and aid IDEs with code
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001079 completion and refactoring.
1080
Andrés Delfino6e33f812018-05-26 09:43:39 -03001081 Type hints of global variables, class attributes, and functions,
1082 but not local variables, can be accessed using
1083 :func:`typing.get_type_hints`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001084
Andrés Delfino6e33f812018-05-26 09:43:39 -03001085 See :mod:`typing` and :pep:`484`, which describe this functionality.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001086
R David Murray1b00f252012-08-15 10:43:58 -04001087 universal newlines
1088 A manner of interpreting text streams in which all of the following are
1089 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
1090 the Windows convention ``'\r\n'``, and the old Macintosh convention
1091 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -04001092 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -04001093
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001094 variable annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -03001095 An :term:`annotation` of a variable or a class attribute.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001096
Andrés Delfino6e33f812018-05-26 09:43:39 -03001097 When annotating a variable or a class attribute, assignment is optional::
1098
1099 class C:
1100 field: 'annotation'
1101
1102 Variable annotations are usually used for
1103 :term:`type hints <type hint>`: for example this variable is expected to take
1104 :class:`int` values::
Guido van Rossum95e4d582018-01-26 08:20:18 -08001105
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001106 count: int = 0
1107
Andrés Delfino6e33f812018-05-26 09:43:39 -03001108 Variable annotation syntax is explained in section :ref:`annassign`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001109
Andrés Delfino6e33f812018-05-26 09:43:39 -03001110 See :term:`function annotation`, :pep:`484`
1111 and :pep:`526`, which describe this functionality.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001112
Nick Coghlan1d520962014-09-06 20:38:23 +10001113 virtual environment
1114 A cooperatively isolated runtime environment that allows Python users
1115 and applications to install and upgrade Python distribution packages
1116 without interfering with the behaviour of other Python applications
1117 running on the same system.
1118
Brett Cannon15552c32016-07-08 10:46:21 -07001119 See also :mod:`venv`.
Nick Coghlan1d520962014-09-06 20:38:23 +10001120
Benjamin Peterson5478b472008-09-17 22:25:09 +00001121 virtual machine
1122 A computer defined entirely in software. Python's virtual machine
1123 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +00001124
Guido van Rossumf10aa982007-08-17 18:30:38 +00001125 Zen of Python
1126 Listing of Python design principles and philosophies that are helpful in
1127 understanding and using the language. The listing can be found by typing
1128 "``import this``" at the interactive prompt.