blob: 778fd404381575ba5881d2a8eecde4a100e3dc05 [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 ``...``
Pablo Galindob4db2492018-11-04 22:36:25 +000016 Can refer to:
17
Sanyam Khurana90fb04c2019-05-11 15:04:10 -040018 * The default Python prompt of the interactive shell when entering the
19 code for an indented code block, when within a pair of matching left and
20 right delimiters (parentheses, square brackets, curly braces or triple
21 quotes), or after specifying a decorator.
Pablo Galindob4db2492018-11-04 22:36:25 +000022
23 * The :const:`Ellipsis` built-in constant.
Christian Heimesd8654cf2007-12-02 15:22:16 +000024
Benjamin Petersond6313712008-07-31 16:23:04 +000025 2to3
26 A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl6faee4e2010-09-21 14:48:28 +000027 handling most of the incompatibilities which can be detected by parsing the
Benjamin Petersond6313712008-07-31 16:23:04 +000028 source and traversing the parse tree.
29
30 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
31 entry point is provided as :file:`Tools/scripts/2to3`. See
32 :ref:`2to3-reference`.
33
Georg Brandl86b2fb92008-07-16 03:43:04 +000034 abstract base class
Éric Araujofa088db2011-06-04 18:42:38 +020035 Abstract base classes complement :term:`duck-typing` by
Georg Brandl22b34312009-07-26 14:54:51 +000036 providing a way to define interfaces when other techniques like
Éric Araujofa088db2011-06-04 18:42:38 +020037 :func:`hasattr` would be clumsy or subtly wrong (for example with
Éric Araujo04ac59a2011-08-19 09:07:46 +020038 :ref:`magic methods <special-lookup>`). ABCs introduce virtual
39 subclasses, which are classes that don't inherit from a class but are
40 still recognized by :func:`isinstance` and :func:`issubclass`; see the
41 :mod:`abc` module documentation. Python comes with many built-in ABCs for
Éric Araujo459b4522011-06-04 21:16:42 +020042 data structures (in the :mod:`collections.abc` module), numbers (in the
Éric Araujofa088db2011-06-04 18:42:38 +020043 :mod:`numbers` module), streams (in the :mod:`io` module), import finders
44 and loaders (in the :mod:`importlib.abc` module). You can create your own
45 ABCs with the :mod:`abc` module.
Benjamin Peterson41181742008-07-02 20:22:54 +000046
Andrés Delfinof2290fb2018-05-14 16:04:55 -030047 annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -030048 A label associated with a variable, a class
49 attribute or a function parameter or return value,
50 used by convention as a :term:`type hint`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030051
Andrés Delfino2298c0e2018-05-26 15:18:02 -030052 Annotations of local variables cannot be accessed at runtime, but
Andrés Delfino6e33f812018-05-26 09:43:39 -030053 annotations of global variables, class attributes, and functions
54 are stored in the :attr:`__annotations__`
55 special attribute of modules, classes, and functions,
56 respectively.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030057
Andrés Delfino6e33f812018-05-26 09:43:39 -030058 See :term:`variable annotation`, :term:`function annotation`, :pep:`484`
59 and :pep:`526`, which describe this functionality.
Andrés Delfinof2290fb2018-05-14 16:04:55 -030060
Christian Heimesd8654cf2007-12-02 15:22:16 +000061 argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080062 A value passed to a :term:`function` (or :term:`method`) when calling the
Zachary Waree1391a02013-11-22 13:58:34 -060063 function. There are two kinds of argument:
Christian Heimesd8654cf2007-12-02 15:22:16 +000064
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080065 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
66 ``name=``) in a function call or passed as a value in a dictionary
67 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
68 arguments in the following calls to :func:`complex`::
69
70 complex(real=3, imag=5)
71 complex(**{'real': 3, 'imag': 5})
72
73 * :dfn:`positional argument`: an argument that is not a keyword argument.
74 Positional arguments can appear at the beginning of an argument list
75 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
76 For example, ``3`` and ``5`` are both positional arguments in the
77 following calls::
78
79 complex(3, 5)
80 complex(*(3, 5))
81
82 Arguments are assigned to the named local variables in a function body.
83 See the :ref:`calls` section for the rules governing this assignment.
84 Syntactically, any expression can be used to represent an argument; the
85 evaluated value is assigned to the local variable.
86
87 See also the :term:`parameter` glossary entry, the FAQ question on
88 :ref:`the difference between arguments and parameters
89 <faq-argument-vs-parameter>`, and :pep:`362`.
Benjamin Peterson5478b472008-09-17 22:25:09 +000090
Yury Selivanovf3e40fa2015-05-21 11:50:30 -040091 asynchronous context manager
92 An object which controls the environment seen in an
93 :keyword:`async with` statement by defining :meth:`__aenter__` and
94 :meth:`__aexit__` methods. Introduced by :pep:`492`.
95
Yury Selivanov03660042016-12-15 17:36:05 -050096 asynchronous generator
97 A function which returns an :term:`asynchronous generator iterator`. It
98 looks like a coroutine function defined with :keyword:`async def` except
99 that it contains :keyword:`yield` expressions for producing a series of
100 values usable in an :keyword:`async for` loop.
101
Windson yanga9655b72018-11-13 01:42:38 +0800102 Usually refers to an asynchronous generator function, but may refer to an
Yury Selivanov03660042016-12-15 17:36:05 -0500103 *asynchronous generator iterator* in some contexts. In cases where the
104 intended meaning isn't clear, using the full terms avoids ambiguity.
105
106 An asynchronous generator function may contain :keyword:`await`
107 expressions as well as :keyword:`async for`, and :keyword:`async with`
108 statements.
109
110 asynchronous generator iterator
111 An object created by a :term:`asynchronous generator` function.
112
113 This is an :term:`asynchronous iterator` which when called using the
114 :meth:`__anext__` method returns an awaitable object which will execute
Sebastián Ramírez25221b32018-11-15 09:51:56 +0400115 the body of the asynchronous generator function until the next
116 :keyword:`yield` expression.
Yury Selivanov03660042016-12-15 17:36:05 -0500117
118 Each :keyword:`yield` temporarily suspends processing, remembering the
119 location execution state (including local variables and pending
120 try-statements). When the *asynchronous generator iterator* effectively
121 resumes with another awaitable returned by :meth:`__anext__`, it
Andrés Delfinod689f972018-06-09 22:43:45 -0300122 picks up where it left off. See :pep:`492` and :pep:`525`.
Yury Selivanov03660042016-12-15 17:36:05 -0500123
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400124 asynchronous iterable
125 An object, that can be used in an :keyword:`async for` statement.
Berker Peksagaf511402016-06-11 22:40:41 +0300126 Must return an :term:`asynchronous iterator` from its
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400127 :meth:`__aiter__` method. Introduced by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400128
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400129 asynchronous iterator
Andrés Delfinocf2c5e82018-08-09 12:45:41 -0300130 An object that implements the :meth:`__aiter__` and :meth:`__anext__`
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400131 methods. ``__anext__`` must return an :term:`awaitable` object.
Andrés Delfinocf2c5e82018-08-09 12:45:41 -0300132 :keyword:`async for` resolves the awaitables returned by an asynchronous
133 iterator's :meth:`__anext__` method until it raises a
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400134 :exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
135
Benjamin Peterson5478b472008-09-17 22:25:09 +0000136 attribute
137 A value associated with an object which is referenced by name using
138 dotted expressions. For example, if an object *o* has an attribute
139 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +0000140
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400141 awaitable
142 An object that can be used in an :keyword:`await` expression. Can be
143 a :term:`coroutine` or an object with an :meth:`__await__` method.
144 See also :pep:`492`.
145
Guido van Rossumf10aa982007-08-17 18:30:38 +0000146 BDFL
147 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Sanyam Khurana1b4587a2017-12-06 22:09:33 +0530148 <https://gvanrossum.github.io/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +0000149
Antoine Pitroudd799d22013-12-05 23:46:32 +0100150 binary file
151 A :term:`file object` able to read and write
152 :term:`bytes-like objects <bytes-like object>`.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +0200153 Examples of binary files are files opened in binary mode (``'rb'``,
154 ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer`,
155 :data:`sys.stdout.buffer`, and instances of :class:`io.BytesIO` and
156 :class:`gzip.GzipFile`.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100157
Andrés Delfino0c4be822018-05-20 12:12:50 -0300158 See also :term:`text file` for a file object able to read and write
159 :class:`str` objects.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100160
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300161 bytes-like object
Stefan Krah70e543b2015-08-08 14:33:28 +0200162 An object that supports the :ref:`bufferobjects` and can
163 export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,
164 :class:`bytearray`, and :class:`array.array` objects, as well as many
165 common :class:`memoryview` objects. Bytes-like objects can
Larry Hastingsab792ac2015-04-13 11:30:56 -0400166 be used for various operations that work with binary data; these include
167 compression, saving to a binary file, and sending over a socket.
168
169 Some operations need the binary data to be mutable. The documentation
170 often refers to these as "read-write bytes-like objects". Example
171 mutable buffer objects include :class:`bytearray` and a
172 :class:`memoryview` of a :class:`bytearray`.
173 Other operations require the binary data to be stored in
174 immutable objects ("read-only bytes-like objects"); examples
175 of these include :class:`bytes` and a :class:`memoryview`
176 of a :class:`bytes` object.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300177
Georg Brandl9afde1c2007-11-01 20:32:30 +0000178 bytecode
179 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +0000180 of a Python program in the CPython interpreter. The bytecode is also
Xiang Zhang0710d752017-03-11 13:02:52 +0800181 cached in ``.pyc`` files so that executing the same file is
Brett Cannon8315fd12010-07-02 22:03:00 +0000182 faster the second time (recompilation from source to bytecode can be
183 avoided). This "intermediate language" is said to run on a
184 :term:`virtual machine` that executes the machine code corresponding to
185 each bytecode. Do note that bytecodes are not expected to work between
186 different Python virtual machines, nor to be stable between Python
187 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000188
Georg Brandl2cb72d32010-07-03 10:26:54 +0000189 A list of bytecode instructions can be found in the documentation for
190 :ref:`the dis module <bytecodes>`.
191
Miss Islington (bot)ddd3c462020-06-22 19:22:45 -0700192 callback
193 A subroutine function which is passed as an argument to be executed at
194 some point in the future.
195
Benjamin Peterson5478b472008-09-17 22:25:09 +0000196 class
197 A template for creating user-defined objects. Class definitions
198 normally contain method definitions which operate on instances of the
199 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000200
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300201 class variable
202 A variable defined in a class and intended to be modified only at
203 class level (i.e., not in an instance of the class).
204
Benjamin Peterson5478b472008-09-17 22:25:09 +0000205 coercion
206 The implicit conversion of an instance of one type to another during an
207 operation which involves two arguments of the same type. For example,
208 ``int(3.15)`` converts the floating point number to the integer ``3``, but
209 in ``3+4.5``, each argument is of a different type (one int, one float),
210 and both must be converted to the same type before they can be added or it
Stéphane Wirtele483f022018-10-26 12:52:11 +0200211 will raise a :exc:`TypeError`. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000212 compatible types would have to be normalized to the same value by the
213 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000214
Guido van Rossumf10aa982007-08-17 18:30:38 +0000215 complex number
216 An extension of the familiar real number system in which all numbers are
217 expressed as a sum of a real part and an imaginary part. Imaginary
218 numbers are real multiples of the imaginary unit (the square root of
219 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000220 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000221 written with this latter notation; the imaginary part is written with a
222 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
223 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
224 advanced mathematical feature. If you're not aware of a need for them,
225 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000226
Christian Heimes895627f2007-12-08 17:28:33 +0000227 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000228 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000229 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
230 See :pep:`343`.
231
Julien Palard0811f2d2019-05-28 14:04:42 +0200232 context variable
Vinodhini Balusamyc0a1a072019-05-14 22:11:41 +1000233 A variable which can have different values depending on its context.
234 This is similar to Thread-Local Storage in which each execution
235 thread may have a different value for a variable. However, with context
236 variables, there may be several contexts in one execution thread and the
237 main usage for context variables is to keep track of variables in
238 concurrent asynchronous tasks.
239 See :mod:`contextvars`.
240
Stefan Krah70e543b2015-08-08 14:33:28 +0200241 contiguous
242 .. index:: C-contiguous, Fortran contiguous
243
244 A buffer is considered contiguous exactly if it is either
245 *C-contiguous* or *Fortran contiguous*. Zero-dimensional buffers are
246 C and Fortran contiguous. In one-dimensional arrays, the items
Martin Panter46f50722016-05-26 05:35:26 +0000247 must be laid out in memory next to each other, in order of
Stefan Krah70e543b2015-08-08 14:33:28 +0200248 increasing indexes starting from zero. In multidimensional
249 C-contiguous arrays, the last index varies the fastest when
250 visiting items in order of memory address. However, in
251 Fortran contiguous arrays, the first index varies the fastest.
252
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400253 coroutine
Kyle Stanleye4070132019-09-30 20:12:21 -0400254 Coroutines are a more generalized form of subroutines. Subroutines are
Yury Selivanov66f88282015-06-24 11:04:15 -0400255 entered at one point and exited at another point. Coroutines can be
256 entered, exited, and resumed at many different points. They can be
257 implemented with the :keyword:`async def` statement. See also
258 :pep:`492`.
259
260 coroutine function
261 A function which returns a :term:`coroutine` object. A coroutine
262 function may be defined with the :keyword:`async def` statement,
263 and may contain :keyword:`await`, :keyword:`async for`, and
264 :keyword:`async with` keywords. These were introduced
265 by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400266
Benjamin Peterson5478b472008-09-17 22:25:09 +0000267 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000268 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100269 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000270 is used when necessary to distinguish this implementation from others
271 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000272
Christian Heimesd8654cf2007-12-02 15:22:16 +0000273 decorator
274 A function returning another function, usually applied as a function
275 transformation using the ``@wrapper`` syntax. Common examples for
276 decorators are :func:`classmethod` and :func:`staticmethod`.
277
278 The decorator syntax is merely syntactic sugar, the following two
279 function definitions are semantically equivalent::
280
281 def f(...):
282 ...
283 f = staticmethod(f)
284
285 @staticmethod
286 def f(...):
287 ...
288
Georg Brandlaf265f42008-12-07 15:06:20 +0000289 The same concept exists for classes, but is less commonly used there. See
290 the documentation for :ref:`function definitions <function>` and
291 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000292
Guido van Rossumf10aa982007-08-17 18:30:38 +0000293 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000294 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000295 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000296 binding behavior is triggered upon attribute lookup. Normally, using
297 *a.b* to get, set or delete an attribute looks up the object named *b* in
298 the class dictionary for *a*, but if *b* is a descriptor, the respective
299 descriptor method gets called. Understanding descriptors is a key to a
300 deep understanding of Python because they are the basis for many features
301 including functions, methods, properties, class methods, static methods,
302 and reference to super classes.
303
Miss Skeleton (bot)f8d96b92020-10-23 13:49:32 -0700304 For more information about descriptors' methods, see :ref:`descriptors`
305 or the :ref:`Descriptor How To Guide <descriptorhowto>`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000306
Guido van Rossumf10aa982007-08-17 18:30:38 +0000307 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700308 An associative array, where arbitrary keys are mapped to values. The
309 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
310 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000311
Martin Panter85b8f452015-10-07 09:56:46 +0000312 dictionary view
313 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
314 :meth:`dict.items` are called dictionary views. They provide a dynamic
315 view on the dictionary’s entries, which means that when the dictionary
316 changes, the view reflects these changes. To force the
317 dictionary view to become a full list use ``list(dictview)``. See
318 :ref:`dict-views`.
319
Georg Brandl3dbca812008-07-23 16:10:53 +0000320 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000321 A string literal which appears as the first expression in a class,
322 function or module. While ignored when the suite is executed, it is
323 recognized by the compiler and put into the :attr:`__doc__` attribute
324 of the enclosing class, function or module. Since it is available via
325 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000326 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000327
328 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000329 A programming style which does not look at an object's type to determine
330 if it has the right interface; instead, the method or attribute is simply
331 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000332 must be a duck.") By emphasizing interfaces rather than specific types,
333 well-designed code improves its flexibility by allowing polymorphic
334 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000335 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200336 with :term:`abstract base classes <abstract base class>`.) Instead, it
337 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000338
Guido van Rossumf10aa982007-08-17 18:30:38 +0000339 EAFP
340 Easier to ask for forgiveness than permission. This common Python coding
341 style assumes the existence of valid keys or attributes and catches
342 exceptions if the assumption proves false. This clean and fast style is
343 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000344 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000345 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000346
Christian Heimesd8654cf2007-12-02 15:22:16 +0000347 expression
348 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000349 an expression is an accumulation of expression elements like literals,
350 names, attribute access, operators or function calls which all return a
351 value. In contrast to many other languages, not all language constructs
352 are expressions. There are also :term:`statement`\s which cannot be used
Serhiy Storchaka2b57c432018-12-19 08:09:46 +0200353 as expressions, such as :keyword:`while`. Assignments are also statements,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000354 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000355
Guido van Rossumf10aa982007-08-17 18:30:38 +0000356 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000357 A module written in C or C++, using Python's C API to interact with the
358 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000359
Mariatta33db0682017-03-30 12:12:18 -0700360 f-string
361 String literals prefixed with ``'f'`` or ``'F'`` are commonly called
362 "f-strings" which is short for
363 :ref:`formatted string literals <f-strings>`. See also :pep:`498`.
364
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000365 file object
366 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000367 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
368 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300369 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000370 (for example standard input/output, in-memory buffers, sockets, pipes,
371 etc.). File objects are also called :dfn:`file-like objects` or
372 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000373
Antoine Pitroudd799d22013-12-05 23:46:32 +0100374 There are actually three categories of file objects: raw
375 :term:`binary files <binary file>`, buffered
376 :term:`binary files <binary file>` and :term:`text files <text file>`.
377 Their interfaces are defined in the :mod:`io` module. The canonical
378 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000379
380 file-like object
381 A synonym for :term:`file object`.
382
Brett Cannon51d4aab2009-01-25 04:21:39 +0000383 finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800384 An object that tries to find the :term:`loader` for a module that is
385 being imported.
386
387 Since Python 3.3, there are two types of finder: :term:`meta path finders
388 <meta path finder>` for use with :data:`sys.meta_path`, and :term:`path
389 entry finders <path entry finder>` for use with :data:`sys.path_hooks`.
390
391 See :pep:`302`, :pep:`420` and :pep:`451` for much more detail.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000392
Benjamin Peterson2d718222008-11-21 00:25:02 +0000393 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000394 Mathematical division that rounds down to nearest integer. The floor
395 division operator is ``//``. For example, the expression ``11 // 4``
396 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
397 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
398 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000399
Christian Heimesd8654cf2007-12-02 15:22:16 +0000400 function
401 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800402 be passed zero or more :term:`arguments <argument>` which may be used in
403 the execution of the body. See also :term:`parameter`, :term:`method`,
404 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000405
R David Murray25cd0912013-05-06 12:58:16 -0400406 function annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -0300407 An :term:`annotation` of a function parameter or return value.
R David Murray25cd0912013-05-06 12:58:16 -0400408
Andrés Delfino6e33f812018-05-26 09:43:39 -0300409 Function annotations are usually used for
Windson yanga9655b72018-11-13 01:42:38 +0800410 :term:`type hints <type hint>`: for example, this function is expected to take two
Andrés Delfino6e33f812018-05-26 09:43:39 -0300411 :class:`int` arguments and is also expected to have an :class:`int`
412 return value::
Guido van Rossum95e4d582018-01-26 08:20:18 -0800413
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300414 def sum_two_numbers(a: int, b: int) -> int:
415 return a + b
416
Andrés Delfino6e33f812018-05-26 09:43:39 -0300417 Function annotation syntax is explained in section :ref:`function`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -0300418
Andrés Delfino6e33f812018-05-26 09:43:39 -0300419 See :term:`variable annotation` and :pep:`484`,
420 which describe this functionality.
R David Murray25cd0912013-05-06 12:58:16 -0400421
Guido van Rossumf10aa982007-08-17 18:30:38 +0000422 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000423 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000424 which are not compatible with the current interpreter.
425
426 By importing the :mod:`__future__` module and evaluating its variables,
427 you can see when a new feature was first added to the language and when it
428 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000429
Guido van Rossumf10aa982007-08-17 18:30:38 +0000430 >>> import __future__
431 >>> __future__.division
432 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
433
434 garbage collection
435 The process of freeing memory when it is not used anymore. Python
436 performs garbage collection via reference counting and a cyclic garbage
Antoine Pitrou4b965932017-12-19 19:48:45 +0100437 collector that is able to detect and break reference cycles. The
438 garbage collector can be controlled using the :mod:`gc` module.
Georg Brandl48310cd2009-01-03 21:18:54 +0000439
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000440 .. index:: single: generator
441
Guido van Rossumf10aa982007-08-17 18:30:38 +0000442 generator
Yury Selivanov5376ba92015-06-22 12:19:30 -0400443 A function which returns a :term:`generator iterator`. It looks like a
444 normal function except that it contains :keyword:`yield` expressions
445 for producing a series of values usable in a for-loop or that can be
446 retrieved one at a time with the :func:`next` function.
447
448 Usually refers to a generator function, but may refer to a
449 *generator iterator* in some contexts. In cases where the intended
450 meaning isn't clear, using the full terms avoids ambiguity.
451
452 generator iterator
453 An object created by a :term:`generator` function.
454
455 Each :keyword:`yield` temporarily suspends processing, remembering the
456 location execution state (including local variables and pending
Andrés Delfinod689f972018-06-09 22:43:45 -0300457 try-statements). When the *generator iterator* resumes, it picks up where
458 it left off (in contrast to functions which start fresh on every
Yury Selivanov5376ba92015-06-22 12:19:30 -0400459 invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000460
Guido van Rossumf10aa982007-08-17 18:30:38 +0000461 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000462
Guido van Rossumf10aa982007-08-17 18:30:38 +0000463 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000464 An expression that returns an iterator. It looks like a normal expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +0200465 followed by a :keyword:`!for` clause defining a loop variable, range,
466 and an optional :keyword:`!if` clause. The combined expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000467 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000468
Guido van Rossumf10aa982007-08-17 18:30:38 +0000469 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
470 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000471
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200472 generic function
473 A function composed of multiple functions implementing the same operation
474 for different types. Which implementation should be used during a call is
475 determined by the dispatch algorithm.
476
477 See also the :term:`single dispatch` glossary entry, the
478 :func:`functools.singledispatch` decorator, and :pep:`443`.
479
480
Guido van Rossumf10aa982007-08-17 18:30:38 +0000481 GIL
482 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000483
Guido van Rossumf10aa982007-08-17 18:30:38 +0000484 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000485 The mechanism used by the :term:`CPython` interpreter to assure that
486 only one thread executes Python :term:`bytecode` at a time.
487 This simplifies the CPython implementation by making the object model
488 (including critical built-in types such as :class:`dict`) implicitly
489 safe against concurrent access. Locking the entire interpreter
490 makes it easier for the interpreter to be multi-threaded, at the
491 expense of much of the parallelism afforded by multi-processor
492 machines.
493
494 However, some extension modules, either standard or third-party,
495 are designed so as to release the GIL when doing computationally-intensive
496 tasks such as compression or hashing. Also, the GIL is always released
497 when doing I/O.
498
499 Past efforts to create a "free-threaded" interpreter (one which locks
500 shared data at a much finer granularity) have not been successful
501 because performance suffered in the common single-processor case. It
502 is believed that overcoming this performance issue would make the
503 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000504
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800505
506 hash-based pyc
INADA Naoki40a536b2018-03-28 22:07:57 +0900507 A bytecode cache file that uses the hash rather than the last-modified
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800508 time of the corresponding source file to determine its validity. See
509 :ref:`pyc-invalidation`.
510
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000511 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000512 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000513 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000514 other objects (it needs an :meth:`__eq__` method). Hashable objects which
515 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000516
517 Hashability makes an object usable as a dictionary key and a set member,
518 because these data structures use the hash value internally.
519
Raymond Hettingercc1c5822019-05-27 10:21:31 -0700520 Most of Python's immutable built-in objects are hashable; mutable
521 containers (such as lists or dictionaries) are not; immutable
522 containers (such as tuples and frozensets) are only hashable if
523 their elements are hashable. Objects which are
csabella64c887a2017-04-01 22:50:47 -0400524 instances of user-defined classes are hashable by default. They all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200525 compare unequal (except with themselves), and their hash value is derived
526 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000527
Guido van Rossumf10aa982007-08-17 18:30:38 +0000528 IDLE
529 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000530 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000531 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000532
Guido van Rossumf10aa982007-08-17 18:30:38 +0000533 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000534 An object with a fixed value. Immutable objects include numbers, strings and
535 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000536 be created if a different value has to be stored. They play an important
537 role in places where a constant hash value is needed, for example as a key
538 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000539
Barry Warsawdadebab2012-07-31 16:03:09 -0400540 import path
541 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000542 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400543 import, this list of locations usually comes from :data:`sys.path`, but
544 for subpackages it may also come from the parent package's ``__path__``
545 attribute.
546
Barry Warsawd7d21942012-07-29 16:36:17 -0400547 importing
548 The process by which Python code in one module is made available to
549 Python code in another module.
550
Brett Cannon51d4aab2009-01-25 04:21:39 +0000551 importer
552 An object that both finds and loads a module; both a
553 :term:`finder` and :term:`loader` object.
554
Guido van Rossumf10aa982007-08-17 18:30:38 +0000555 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000556 Python has an interactive interpreter which means you can enter
557 statements and expressions at the interpreter prompt, immediately
558 execute them and see their results. Just launch ``python`` with no
559 arguments (possibly by selecting it from your computer's main
560 menu). It is a very powerful way to test out new ideas or inspect
561 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000562
Guido van Rossumf10aa982007-08-17 18:30:38 +0000563 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000564 Python is an interpreted language, as opposed to a compiled one,
565 though the distinction can be blurry because of the presence of the
566 bytecode compiler. This means that source files can be run directly
567 without explicitly creating an executable which is then run.
568 Interpreted languages typically have a shorter development/debug cycle
569 than compiled ones, though their programs generally also run more
570 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000571
Antoine Pitrou5db1bb82014-12-07 01:28:27 +0100572 interpreter shutdown
573 When asked to shut down, the Python interpreter enters a special phase
574 where it gradually releases all allocated resources, such as modules
575 and various critical internal structures. It also makes several calls
576 to the :term:`garbage collector <garbage collection>`. This can trigger
577 the execution of code in user-defined destructors or weakref callbacks.
578 Code executed during the shutdown phase can encounter various
579 exceptions as the resources it relies on may not function anymore
580 (common examples are library modules or the warnings machinery).
581
582 The main reason for interpreter shutdown is that the ``__main__`` module
583 or the script being run has finished executing.
584
Guido van Rossumf10aa982007-08-17 18:30:38 +0000585 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200586 An object capable of returning its members one at a time. Examples of
587 iterables include all sequence types (such as :class:`list`, :class:`str`,
588 and :class:`tuple`) and some non-sequence types like :class:`dict`,
589 :term:`file objects <file object>`, and objects of any classes you define
Raymond Hettinger0bf287b2017-09-25 00:52:06 -0700590 with an :meth:`__iter__` method or with a :meth:`__getitem__` method
Victor Stinner8f881902020-08-19 19:25:22 +0200591 that implements :term:`Sequence <sequence>` semantics.
Raymond Hettinger0bf287b2017-09-25 00:52:06 -0700592
593 Iterables can be
Ezio Melottid581fff2013-01-02 22:29:09 +0200594 used in a :keyword:`for` loop and in many other places where a sequence is
595 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
596 as an argument to the built-in function :func:`iter`, it returns an
597 iterator for the object. This iterator is good for one pass over the set
598 of values. When using iterables, it is usually not necessary to call
599 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000600 statement does that automatically for you, creating a temporary unnamed
601 variable to hold the iterator for the duration of the loop. See also
602 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000603
Guido van Rossumf10aa982007-08-17 18:30:38 +0000604 iterator
605 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300606 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000607 :func:`next`) return successive items in the stream. When no more data
608 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000609 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000610 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
611 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000612 object itself so every iterator is also iterable and may be used in most
613 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000614 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000615 :class:`list`) produces a fresh new iterator each time you pass it to the
616 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
617 with an iterator will just return the same exhausted iterator object used
618 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000619
Georg Brandl9afde1c2007-11-01 20:32:30 +0000620 More information can be found in :ref:`typeiter`.
621
Georg Brandlc275e152010-11-05 07:10:41 +0000622 key function
623 A key function or collation function is a callable that returns a value
624 used for sorting or ordering. For example, :func:`locale.strxfrm` is
625 used to produce a sort key that is aware of locale specific sort
626 conventions.
627
628 A number of tools in Python accept key functions to control how elements
629 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700630 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
631 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
632 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000633
634 There are several ways to create a key function. For example. the
635 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700636 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000637 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200638 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000639 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
640 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
641 <sortinghowto>` for examples of how to create and use key functions.
642
Christian Heimesd8654cf2007-12-02 15:22:16 +0000643 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800644 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000645
646 lambda
647 An anonymous inline function consisting of a single :term:`expression`
648 which is evaluated when the function is called. The syntax to create
Andrés Delfino268cc7c2018-05-22 02:57:45 -0300649 a lambda function is ``lambda [parameters]: expression``
Christian Heimesd8654cf2007-12-02 15:22:16 +0000650
Guido van Rossumf10aa982007-08-17 18:30:38 +0000651 LBYL
652 Look before you leap. This coding style explicitly tests for
653 pre-conditions before making calls or lookups. This style contrasts with
654 the :term:`EAFP` approach and is characterized by the presence of many
655 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000656
Raymond Hettinger09f44142010-12-17 20:19:50 +0000657 In a multi-threaded environment, the LBYL approach can risk introducing a
658 race condition between "the looking" and "the leaping". For example, the
659 code, ``if key in mapping: return mapping[key]`` can fail if another
660 thread removes *key* from *mapping* after the test, but before the lookup.
661 This issue can be solved with locks or by using the EAFP approach.
662
Benjamin Peterson5478b472008-09-17 22:25:09 +0000663 list
664 A built-in Python :term:`sequence`. Despite its name it is more akin
665 to an array in other languages than to a linked list since access to
Andrés Delfino7469ff52018-06-15 23:42:09 -0300666 elements is O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000667
Guido van Rossumf10aa982007-08-17 18:30:38 +0000668 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000669 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000670 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000671 range(256) if x % 2 == 0]`` generates a list of strings containing
672 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
673 clause is optional. If omitted, all elements in ``range(256)`` are
674 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000675
Brett Cannon51d4aab2009-01-25 04:21:39 +0000676 loader
677 An object that loads a module. It must define a method named
678 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000679 :term:`finder`. See :pep:`302` for details and
680 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000681
Andre Delfinof7606102019-03-26 22:21:27 -0300682 magic method
683 .. index:: pair: magic; method
684
685 An informal synonym for :term:`special method`.
686
Guido van Rossumf10aa982007-08-17 18:30:38 +0000687 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000688 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200689 methods specified in the :class:`~collections.abc.Mapping` or
690 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200691 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
692 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000693 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000694
Barry Warsawd7d21942012-07-29 16:36:17 -0400695 meta path finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800696 A :term:`finder` returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400697 finders are related to, but different from :term:`path entry finders
698 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400699
Brett Cannonccddbb12015-12-04 15:46:21 -0800700 See :class:`importlib.abc.MetaPathFinder` for the methods that meta path
701 finders implement.
702
Guido van Rossumf10aa982007-08-17 18:30:38 +0000703 metaclass
704 The class of a class. Class definitions create a class name, a class
705 dictionary, and a list of base classes. The metaclass is responsible for
706 taking those three arguments and creating the class. Most object oriented
707 programming languages provide a default implementation. What makes Python
708 special is that it is possible to create custom metaclasses. Most users
709 never need this tool, but when the need arises, metaclasses can provide
710 powerful, elegant solutions. They have been used for logging attribute
711 access, adding thread-safety, tracking object creation, implementing
712 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000713
714 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000715
716 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000717 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000718 of an instance of that class, the method will get the instance object as
719 its first :term:`argument` (which is usually called ``self``).
720 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000721
Michael Foord95fc51d2010-11-20 15:07:30 +0000722 method resolution order
723 Method Resolution Order is the order in which base classes are searched
724 for a member during lookup. See `The Python 2.3 Method Resolution Order
Senthil Kumaran3858a1c2016-01-09 22:33:54 -0800725 <https://www.python.org/download/releases/2.3/mro/>`_ for details of the
726 algorithm used by the Python interpreter since the 2.3 release.
Michael Foord95fc51d2010-11-20 15:07:30 +0000727
Barry Warsawd7d21942012-07-29 16:36:17 -0400728 module
729 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400730 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400731 into Python by the process of :term:`importing`.
732
Georg Brandlbcce1252013-10-08 08:06:18 +0200733 See also :term:`package`.
734
Eric Snowca2d8542013-12-16 23:06:52 -0700735 module spec
736 A namespace containing the import-related information used to load a
Brett Cannonccddbb12015-12-04 15:46:21 -0800737 module. An instance of :class:`importlib.machinery.ModuleSpec`.
Eric Snowca2d8542013-12-16 23:06:52 -0700738
Michael Foord95fc51d2010-11-20 15:07:30 +0000739 MRO
740 See :term:`method resolution order`.
741
Guido van Rossumf10aa982007-08-17 18:30:38 +0000742 mutable
743 Mutable objects can change their value but keep their :func:`id`. See
744 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000745
746 named tuple
Raymond Hettinger71170742019-09-11 07:17:32 -0700747 The term "named tuple" applies to any type or class that inherits from
748 tuple and whose indexable elements are also accessible using named
749 attributes. The type or class may have other features as well.
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000750
Raymond Hettinger71170742019-09-11 07:17:32 -0700751 Several built-in types are named tuples, including the values returned
752 by :func:`time.localtime` and :func:`os.stat`. Another example is
753 :data:`sys.float_info`::
754
755 >>> sys.float_info[1] # indexed access
756 1024
757 >>> sys.float_info.max_exp # named field access
758 1024
759 >>> isinstance(sys.float_info, tuple) # kind of tuple
760 True
761
762 Some named tuples are built-in types (such as the above examples).
763 Alternatively, a named tuple can be created from a regular class
764 definition that inherits from :class:`tuple` and that defines named
Raymond Hettinger4210ad52019-09-12 07:56:28 -0700765 fields. Such a class can be written by hand or it can be created with
Raymond Hettinger71170742019-09-11 07:17:32 -0700766 the factory function :func:`collections.namedtuple`. The latter
767 technique also adds some extra methods that may not be found in
768 hand-written or built-in named tuples.
Georg Brandl48310cd2009-01-03 21:18:54 +0000769
Guido van Rossumf10aa982007-08-17 18:30:38 +0000770 namespace
771 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000772 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000773 as nested namespaces in objects (in methods). Namespaces support
774 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300775 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
776 their namespaces. Namespaces also aid readability and maintainability by
777 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200778 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000779 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000780 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000781
Barry Warsawd7d21942012-07-29 16:36:17 -0400782 namespace package
783 A :pep:`420` :term:`package` which serves only as a container for
784 subpackages. Namespace packages may have no physical representation,
785 and specifically are not like a :term:`regular package` because they
786 have no ``__init__.py`` file.
787
Georg Brandlbcce1252013-10-08 08:06:18 +0200788 See also :term:`module`.
789
Guido van Rossumf10aa982007-08-17 18:30:38 +0000790 nested scope
791 The ability to refer to a variable in an enclosing definition. For
792 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000793 variables in the outer function. Note that nested scopes by default work
794 only for reference and not for assignment. Local variables both read and
795 write in the innermost scope. Likewise, global variables read and write
796 to the global namespace. The :keyword:`nonlocal` allows writing to outer
797 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000798
Guido van Rossumf10aa982007-08-17 18:30:38 +0000799 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000800 Old name for the flavor of classes now used for all class objects. In
801 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300802 versatile features like :attr:`~object.__slots__`, descriptors,
803 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000804
Benjamin Peterson5478b472008-09-17 22:25:09 +0000805 object
806 Any data with state (attributes or value) and defined behavior
807 (methods). Also the ultimate base class of any :term:`new-style
808 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000809
Barry Warsawd7d21942012-07-29 16:36:17 -0400810 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200811 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400812 subpackages. Technically, a package is a Python module with an
813 ``__path__`` attribute.
814
Georg Brandlbcce1252013-10-08 08:06:18 +0200815 See also :term:`regular package` and :term:`namespace package`.
816
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800817 parameter
818 A named entity in a :term:`function` (or method) definition that
819 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600820 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800821
822 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
823 either :term:`positionally <argument>` or as a :term:`keyword argument
824 <argument>`. This is the default kind of parameter, for example *foo*
825 and *bar* in the following::
826
827 def func(foo, bar=None): ...
828
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +0300829 .. _positional-only_parameter:
830
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800831 * :dfn:`positional-only`: specifies an argument that can be supplied only
Pablo Galindo9a669d52020-01-08 13:00:14 +0000832 by position. Positional-only parameters can be defined by including a
833 ``/`` character in the parameter list of the function definition after
834 them, for example *posonly1* and *posonly2* in the following::
835
836 def func(posonly1, posonly2, /, positional_or_keyword): ...
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800837
Zachary Waree1391a02013-11-22 13:58:34 -0600838 .. _keyword-only_parameter:
839
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800840 * :dfn:`keyword-only`: specifies an argument that can be supplied only
841 by keyword. Keyword-only parameters can be defined by including a
842 single var-positional parameter or bare ``*`` in the parameter list
843 of the function definition before them, for example *kw_only1* and
844 *kw_only2* in the following::
845
846 def func(arg, *, kw_only1, kw_only2): ...
847
848 * :dfn:`var-positional`: specifies that an arbitrary sequence of
849 positional arguments can be provided (in addition to any positional
850 arguments already accepted by other parameters). Such a parameter can
851 be defined by prepending the parameter name with ``*``, for example
852 *args* in the following::
853
854 def func(*args, **kwargs): ...
855
856 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
857 can be provided (in addition to any keyword arguments already accepted
858 by other parameters). Such a parameter can be defined by prepending
859 the parameter name with ``**``, for example *kwargs* in the example
860 above.
861
862 Parameters can specify both optional and required arguments, as well as
863 default values for some optional arguments.
864
865 See also the :term:`argument` glossary entry, the FAQ question on
866 :ref:`the difference between arguments and parameters
867 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
868 :ref:`function` section, and :pep:`362`.
869
Barry Warsawdadebab2012-07-31 16:03:09 -0400870 path entry
871 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000872 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400873
874 path entry finder
875 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
876 (i.e. a :term:`path entry hook`) which knows how to locate modules given
877 a :term:`path entry`.
878
Brett Cannonccddbb12015-12-04 15:46:21 -0800879 See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
880 finders implement.
881
Barry Warsawdadebab2012-07-31 16:03:09 -0400882 path entry hook
883 A callable on the :data:`sys.path_hook` list which returns a :term:`path
884 entry finder` if it knows how to find modules on a specific :term:`path
885 entry`.
886
Nick Coghlan1685db02012-08-20 13:49:08 +1000887 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400888 One of the default :term:`meta path finders <meta path finder>` which
889 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400890
Brett Cannonc28592b2016-06-24 12:21:47 -0700891 path-like object
892 An object representing a file system path. A path-like object is either
893 a :class:`str` or :class:`bytes` object representing a path, or an object
894 implementing the :class:`os.PathLike` protocol. An object that supports
895 the :class:`os.PathLike` protocol can be converted to a :class:`str` or
896 :class:`bytes` file system path by calling the :func:`os.fspath` function;
897 :func:`os.fsdecode` and :func:`os.fsencode` can be used to guarantee a
898 :class:`str` or :class:`bytes` result instead, respectively. Introduced
899 by :pep:`519`.
900
Andrés Delfinod5f14422018-05-17 04:51:50 -0300901 PEP
902 Python Enhancement Proposal. A PEP is a design document
903 providing information to the Python community, or describing a new
904 feature for Python or its processes or environment. PEPs should
905 provide a concise technical specification and a rationale for proposed
906 features.
907
908 PEPs are intended to be the primary mechanisms for proposing major new
909 features, for collecting community input on an issue, and for documenting
910 the design decisions that have gone into Python. The PEP author is
911 responsible for building consensus within the community and documenting
912 dissenting opinions.
913
914 See :pep:`1`.
915
Barry Warsawd7d21942012-07-29 16:36:17 -0400916 portion
917 A set of files in a single directory (possibly stored in a zip file)
918 that contribute to a namespace package, as defined in :pep:`420`.
919
Christian Heimesd8654cf2007-12-02 15:22:16 +0000920 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800921 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000922
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000923 provisional API
924 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400925 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000926 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300927 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000928 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300929 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000930 fundamental flaws are uncovered that were missed prior to the inclusion
931 of the API.
932
933 Even for provisional APIs, backwards incompatible changes are seen as
934 a "solution of last resort" - every attempt will still be made to find
935 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300936
Barry Warsawd7d21942012-07-29 16:36:17 -0400937 This process allows the standard library to continue to evolve over
938 time, without locking in problematic design errors for extended periods
939 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300940
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000941 provisional package
942 See :term:`provisional API`.
943
Guido van Rossumf10aa982007-08-17 18:30:38 +0000944 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400945 Nickname for the Python 3.x release line (coined long ago when the
946 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000947 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000948
Christian Heimesd8654cf2007-12-02 15:22:16 +0000949 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000950 An idea or piece of code which closely follows the most common idioms
951 of the Python language, rather than implementing code using concepts
952 common to other languages. For example, a common idiom in Python is
953 to loop over all elements of an iterable using a :keyword:`for`
954 statement. Many other languages don't have this type of construct, so
955 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000956
Christian Heimesd8654cf2007-12-02 15:22:16 +0000957 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000958 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000959
960 As opposed to the cleaner, Pythonic method::
961
962 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000963 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000964
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100965 qualified name
966 A dotted name showing the "path" from a module's global scope to a
967 class, function or method defined in that module, as defined in
968 :pep:`3155`. For top-level functions and classes, the qualified name
969 is the same as the object's name::
970
971 >>> class C:
972 ... class D:
973 ... def meth(self):
974 ... pass
975 ...
976 >>> C.__qualname__
977 'C'
978 >>> C.D.__qualname__
979 'C.D'
980 >>> C.D.meth.__qualname__
981 'C.D.meth'
982
Barry Warsawd7d21942012-07-29 16:36:17 -0400983 When used to refer to modules, the *fully qualified name* means the
984 entire dotted path to the module, including any parent packages,
985 e.g. ``email.mime.text``::
986
987 >>> import email.mime.text
988 >>> email.mime.text.__name__
989 'email.mime.text'
990
Guido van Rossumf10aa982007-08-17 18:30:38 +0000991 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000992 The number of references to an object. When the reference count of an
993 object drops to zero, it is deallocated. Reference counting is
994 generally not visible to Python code, but it is a key element of the
995 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000996 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000997 reference count for a particular object.
998
Barry Warsawd7d21942012-07-29 16:36:17 -0400999 regular package
1000 A traditional :term:`package`, such as a directory containing an
1001 ``__init__.py`` file.
1002
Georg Brandlbcce1252013-10-08 08:06:18 +02001003 See also :term:`namespace package`.
1004
Guido van Rossumf10aa982007-08-17 18:30:38 +00001005 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +00001006 A declaration inside a class that saves memory by pre-declaring space for
1007 instance attributes and eliminating instance dictionaries. Though
1008 popular, the technique is somewhat tricky to get right and is best
1009 reserved for rare cases where there are large numbers of instances in a
1010 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +00001011
Guido van Rossumf10aa982007-08-17 18:30:38 +00001012 sequence
1013 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +00001014 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +03001015 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +00001016 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +00001017 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +00001018 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
1019 mapping rather than a sequence because the lookups use arbitrary
1020 :term:`immutable` keys rather than integers.
1021
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -05001022 The :class:`collections.abc.Sequence` abstract base class
1023 defines a much richer interface that goes beyond just
1024 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
1025 :meth:`index`, :meth:`__contains__`, and
1026 :meth:`__reversed__`. Types that implement this expanded
1027 interface can be registered explicitly using
Miss Skeleton (bot)c2c44772020-10-24 17:33:01 -07001028 :func:`~abc.ABCMeta.register`.
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -05001029
Łukasz Langafdcf2b72013-06-07 22:54:03 +02001030 single dispatch
1031 A form of :term:`generic function` dispatch where the implementation is
1032 chosen based on the type of a single argument.
1033
Christian Heimesd8654cf2007-12-02 15:22:16 +00001034 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +00001035 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +00001036 created using the subscript notation, ``[]`` with colons between numbers
1037 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +00001038 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001039
Georg Brandlaf265f42008-12-07 15:06:20 +00001040 special method
Andre Delfinof7606102019-03-26 22:21:27 -03001041 .. index:: pair: special; method
1042
Georg Brandlaf265f42008-12-07 15:06:20 +00001043 A method that is called implicitly by Python to execute a certain
1044 operation on a type, such as addition. Such methods have names starting
1045 and ending with double underscores. Special methods are documented in
1046 :ref:`specialnames`.
1047
Christian Heimesd8654cf2007-12-02 15:22:16 +00001048 statement
1049 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +02001050 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +00001051 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001052
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001053 text encoding
1054 A codec which encodes Unicode strings to bytes.
1055
Antoine Pitroudd799d22013-12-05 23:46:32 +01001056 text file
1057 A :term:`file object` able to read and write :class:`str` objects.
1058 Often, a text file actually accesses a byte-oriented datastream
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001059 and handles the :term:`text encoding` automatically.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +02001060 Examples of text files are files opened in text mode (``'r'`` or ``'w'``),
1061 :data:`sys.stdin`, :data:`sys.stdout`, and instances of
1062 :class:`io.StringIO`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001063
Andrés Delfino0c4be822018-05-20 12:12:50 -03001064 See also :term:`binary file` for a file object able to read and write
1065 :term:`bytes-like objects <bytes-like object>`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001066
Benjamin Peterson5478b472008-09-17 22:25:09 +00001067 triple-quoted string
1068 A string which is bound by three instances of either a quotation mark
1069 (") or an apostrophe ('). While they don't provide any functionality
1070 not available with single-quoted strings, they are useful for a number
1071 of reasons. They allow you to include unescaped single and double
1072 quotes within a string and they can span multiple lines without the
1073 use of the continuation character, making them especially useful when
1074 writing docstrings.
1075
Guido van Rossumf10aa982007-08-17 18:30:38 +00001076 type
1077 The type of a Python object determines what kind of object it is; every
1078 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +03001079 :attr:`~instance.__class__` attribute or can be retrieved with
1080 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +00001081
Andrés Delfino6e33f812018-05-26 09:43:39 -03001082 type alias
1083 A synonym for a type, created by assigning the type to an identifier.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001084
Andrés Delfino6e33f812018-05-26 09:43:39 -03001085 Type aliases are useful for simplifying :term:`type hints <type hint>`.
1086 For example::
1087
Andrés Delfino6e33f812018-05-26 09:43:39 -03001088 def remove_gray_shades(
Miss Islington (bot)bdf46bc2020-09-27 12:42:29 -07001089 colors: list[tuple[int, int, int]]) -> list[tuple[int, int, int]]:
Andrés Delfino6e33f812018-05-26 09:43:39 -03001090 pass
1091
1092 could be made more readable like this::
1093
Miss Islington (bot)bdf46bc2020-09-27 12:42:29 -07001094 Color = tuple[int, int, int]
Andrés Delfino6e33f812018-05-26 09:43:39 -03001095
Miss Islington (bot)bdf46bc2020-09-27 12:42:29 -07001096 def remove_gray_shades(colors: list[Color]) -> list[Color]:
Andrés Delfino6e33f812018-05-26 09:43:39 -03001097 pass
1098
1099 See :mod:`typing` and :pep:`484`, which describe this functionality.
1100
1101 type hint
1102 An :term:`annotation` that specifies the expected type for a variable, a class
1103 attribute, or a function parameter or return value.
1104
1105 Type hints are optional and are not enforced by Python but
1106 they are useful to static type analysis tools, and aid IDEs with code
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001107 completion and refactoring.
1108
Andrés Delfino6e33f812018-05-26 09:43:39 -03001109 Type hints of global variables, class attributes, and functions,
1110 but not local variables, can be accessed using
1111 :func:`typing.get_type_hints`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001112
Andrés Delfino6e33f812018-05-26 09:43:39 -03001113 See :mod:`typing` and :pep:`484`, which describe this functionality.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001114
R David Murray1b00f252012-08-15 10:43:58 -04001115 universal newlines
1116 A manner of interpreting text streams in which all of the following are
1117 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
1118 the Windows convention ``'\r\n'``, and the old Macintosh convention
1119 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -04001120 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -04001121
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001122 variable annotation
Andrés Delfino6e33f812018-05-26 09:43:39 -03001123 An :term:`annotation` of a variable or a class attribute.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001124
Andrés Delfino6e33f812018-05-26 09:43:39 -03001125 When annotating a variable or a class attribute, assignment is optional::
1126
1127 class C:
1128 field: 'annotation'
1129
1130 Variable annotations are usually used for
1131 :term:`type hints <type hint>`: for example this variable is expected to take
1132 :class:`int` values::
Guido van Rossum95e4d582018-01-26 08:20:18 -08001133
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001134 count: int = 0
1135
Andrés Delfino6e33f812018-05-26 09:43:39 -03001136 Variable annotation syntax is explained in section :ref:`annassign`.
Andrés Delfinof2290fb2018-05-14 16:04:55 -03001137
Andrés Delfino6e33f812018-05-26 09:43:39 -03001138 See :term:`function annotation`, :pep:`484`
1139 and :pep:`526`, which describe this functionality.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001140
Nick Coghlan1d520962014-09-06 20:38:23 +10001141 virtual environment
1142 A cooperatively isolated runtime environment that allows Python users
1143 and applications to install and upgrade Python distribution packages
1144 without interfering with the behaviour of other Python applications
1145 running on the same system.
1146
Brett Cannon15552c32016-07-08 10:46:21 -07001147 See also :mod:`venv`.
Nick Coghlan1d520962014-09-06 20:38:23 +10001148
Benjamin Peterson5478b472008-09-17 22:25:09 +00001149 virtual machine
1150 A computer defined entirely in software. Python's virtual machine
1151 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +00001152
Guido van Rossumf10aa982007-08-17 18:30:38 +00001153 Zen of Python
1154 Listing of Python design principles and philosophies that are helpful in
1155 understanding and using the language. The listing can be found by typing
1156 "``import this``" at the interactive prompt.