blob: 988842aefc0d67e1f3f23bcf290810e25b4c4bb9 [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
17 an indented code block or within a pair of matching left and right
18 delimiters (parentheses, square brackets or curly braces).
Christian Heimesd8654cf2007-12-02 15:22:16 +000019
Benjamin Petersond6313712008-07-31 16:23:04 +000020 2to3
21 A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl6faee4e2010-09-21 14:48:28 +000022 handling most of the incompatibilities which can be detected by parsing the
Benjamin Petersond6313712008-07-31 16:23:04 +000023 source and traversing the parse tree.
24
25 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
26 entry point is provided as :file:`Tools/scripts/2to3`. See
27 :ref:`2to3-reference`.
28
Georg Brandl86b2fb92008-07-16 03:43:04 +000029 abstract base class
Éric Araujofa088db2011-06-04 18:42:38 +020030 Abstract base classes complement :term:`duck-typing` by
Georg Brandl22b34312009-07-26 14:54:51 +000031 providing a way to define interfaces when other techniques like
Éric Araujofa088db2011-06-04 18:42:38 +020032 :func:`hasattr` would be clumsy or subtly wrong (for example with
Éric Araujo04ac59a2011-08-19 09:07:46 +020033 :ref:`magic methods <special-lookup>`). ABCs introduce virtual
34 subclasses, which are classes that don't inherit from a class but are
35 still recognized by :func:`isinstance` and :func:`issubclass`; see the
36 :mod:`abc` module documentation. Python comes with many built-in ABCs for
Éric Araujo459b4522011-06-04 21:16:42 +020037 data structures (in the :mod:`collections.abc` module), numbers (in the
Éric Araujofa088db2011-06-04 18:42:38 +020038 :mod:`numbers` module), streams (in the :mod:`io` module), import finders
39 and loaders (in the :mod:`importlib.abc` module). You can create your own
40 ABCs with the :mod:`abc` module.
Benjamin Peterson41181742008-07-02 20:22:54 +000041
Andrés Delfinoe69657d2018-05-26 14:17:33 -030042 annotation
43 A label associated with a variable, a class
44 attribute or a function parameter or return value,
45 used by convention as a :term:`type hint`.
46
47 Annotations of local variables cannot be accessed at runtime, but
48 annotations of global variables, class attributes, and functions
49 are stored in the :attr:`__annotations__`
50 special attribute of modules, classes, and functions,
51 respectively.
52
53 See :term:`variable annotation`, :term:`function annotation`, :pep:`484`
54 and :pep:`526`, which describe this functionality.
55
Christian Heimesd8654cf2007-12-02 15:22:16 +000056 argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080057 A value passed to a :term:`function` (or :term:`method`) when calling the
Zachary Waree1391a02013-11-22 13:58:34 -060058 function. There are two kinds of argument:
Christian Heimesd8654cf2007-12-02 15:22:16 +000059
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080060 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
61 ``name=``) in a function call or passed as a value in a dictionary
62 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
63 arguments in the following calls to :func:`complex`::
64
65 complex(real=3, imag=5)
66 complex(**{'real': 3, 'imag': 5})
67
68 * :dfn:`positional argument`: an argument that is not a keyword argument.
69 Positional arguments can appear at the beginning of an argument list
70 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
71 For example, ``3`` and ``5`` are both positional arguments in the
72 following calls::
73
74 complex(3, 5)
75 complex(*(3, 5))
76
77 Arguments are assigned to the named local variables in a function body.
78 See the :ref:`calls` section for the rules governing this assignment.
79 Syntactically, any expression can be used to represent an argument; the
80 evaluated value is assigned to the local variable.
81
82 See also the :term:`parameter` glossary entry, the FAQ question on
83 :ref:`the difference between arguments and parameters
84 <faq-argument-vs-parameter>`, and :pep:`362`.
Benjamin Peterson5478b472008-09-17 22:25:09 +000085
Yury Selivanovf3e40fa2015-05-21 11:50:30 -040086 asynchronous context manager
87 An object which controls the environment seen in an
88 :keyword:`async with` statement by defining :meth:`__aenter__` and
89 :meth:`__aexit__` methods. Introduced by :pep:`492`.
90
Yury Selivanov03660042016-12-15 17:36:05 -050091 asynchronous generator
92 A function which returns an :term:`asynchronous generator iterator`. It
93 looks like a coroutine function defined with :keyword:`async def` except
94 that it contains :keyword:`yield` expressions for producing a series of
95 values usable in an :keyword:`async for` loop.
96
97 Usually refers to a asynchronous generator function, but may refer to an
98 *asynchronous generator iterator* in some contexts. In cases where the
99 intended meaning isn't clear, using the full terms avoids ambiguity.
100
101 An asynchronous generator function may contain :keyword:`await`
102 expressions as well as :keyword:`async for`, and :keyword:`async with`
103 statements.
104
105 asynchronous generator iterator
106 An object created by a :term:`asynchronous generator` function.
107
108 This is an :term:`asynchronous iterator` which when called using the
109 :meth:`__anext__` method returns an awaitable object which will execute
110 that the body of the asynchronous generator function until the
111 next :keyword:`yield` expression.
112
113 Each :keyword:`yield` temporarily suspends processing, remembering the
114 location execution state (including local variables and pending
115 try-statements). When the *asynchronous generator iterator* effectively
116 resumes with another awaitable returned by :meth:`__anext__`, it
Miss Islington (bot)08292002018-06-09 19:00:36 -0700117 picks up where it left off. See :pep:`492` and :pep:`525`.
Yury Selivanov03660042016-12-15 17:36:05 -0500118
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400119 asynchronous iterable
120 An object, that can be used in an :keyword:`async for` statement.
Berker Peksagaf511402016-06-11 22:40:41 +0300121 Must return an :term:`asynchronous iterator` from its
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400122 :meth:`__aiter__` method. Introduced by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400123
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400124 asynchronous iterator
125 An object that implements :meth:`__aiter__` and :meth:`__anext__`
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400126 methods. ``__anext__`` must return an :term:`awaitable` object.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400127 :keyword:`async for` resolves awaitable returned from asynchronous
128 iterator's :meth:`__anext__` method until it raises
129 :exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
130
Benjamin Peterson5478b472008-09-17 22:25:09 +0000131 attribute
132 A value associated with an object which is referenced by name using
133 dotted expressions. For example, if an object *o* has an attribute
134 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +0000135
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400136 awaitable
137 An object that can be used in an :keyword:`await` expression. Can be
138 a :term:`coroutine` or an object with an :meth:`__await__` method.
139 See also :pep:`492`.
140
Guido van Rossumf10aa982007-08-17 18:30:38 +0000141 BDFL
142 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Sanyam Khurana1b4587a2017-12-06 22:09:33 +0530143 <https://gvanrossum.github.io/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +0000144
Antoine Pitroudd799d22013-12-05 23:46:32 +0100145 binary file
146 A :term:`file object` able to read and write
147 :term:`bytes-like objects <bytes-like object>`.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +0200148 Examples of binary files are files opened in binary mode (``'rb'``,
149 ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer`,
150 :data:`sys.stdout.buffer`, and instances of :class:`io.BytesIO` and
151 :class:`gzip.GzipFile`.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100152
Miss Islington (bot)4ecdc112018-05-20 15:51:37 -0700153 See also :term:`text file` for a file object able to read and write
154 :class:`str` objects.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100155
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300156 bytes-like object
Stefan Krah70e543b2015-08-08 14:33:28 +0200157 An object that supports the :ref:`bufferobjects` and can
158 export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,
159 :class:`bytearray`, and :class:`array.array` objects, as well as many
160 common :class:`memoryview` objects. Bytes-like objects can
Larry Hastingsab792ac2015-04-13 11:30:56 -0400161 be used for various operations that work with binary data; these include
162 compression, saving to a binary file, and sending over a socket.
163
164 Some operations need the binary data to be mutable. The documentation
165 often refers to these as "read-write bytes-like objects". Example
166 mutable buffer objects include :class:`bytearray` and a
167 :class:`memoryview` of a :class:`bytearray`.
168 Other operations require the binary data to be stored in
169 immutable objects ("read-only bytes-like objects"); examples
170 of these include :class:`bytes` and a :class:`memoryview`
171 of a :class:`bytes` object.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300172
Georg Brandl9afde1c2007-11-01 20:32:30 +0000173 bytecode
174 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +0000175 of a Python program in the CPython interpreter. The bytecode is also
Xiang Zhang0710d752017-03-11 13:02:52 +0800176 cached in ``.pyc`` files so that executing the same file is
Brett Cannon8315fd12010-07-02 22:03:00 +0000177 faster the second time (recompilation from source to bytecode can be
178 avoided). This "intermediate language" is said to run on a
179 :term:`virtual machine` that executes the machine code corresponding to
180 each bytecode. Do note that bytecodes are not expected to work between
181 different Python virtual machines, nor to be stable between Python
182 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000183
Georg Brandl2cb72d32010-07-03 10:26:54 +0000184 A list of bytecode instructions can be found in the documentation for
185 :ref:`the dis module <bytecodes>`.
186
Benjamin Peterson5478b472008-09-17 22:25:09 +0000187 class
188 A template for creating user-defined objects. Class definitions
189 normally contain method definitions which operate on instances of the
190 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000191
Andrés Delfinoe69657d2018-05-26 14:17:33 -0300192 class variable
193 A variable defined in a class and intended to be modified only at
194 class level (i.e., not in an instance of the class).
195
Benjamin Peterson5478b472008-09-17 22:25:09 +0000196 coercion
197 The implicit conversion of an instance of one type to another during an
198 operation which involves two arguments of the same type. For example,
199 ``int(3.15)`` converts the floating point number to the integer ``3``, but
200 in ``3+4.5``, each argument is of a different type (one int, one float),
201 and both must be converted to the same type before they can be added or it
Benjamin Peterson2d718222008-11-21 00:25:02 +0000202 will raise a ``TypeError``. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000203 compatible types would have to be normalized to the same value by the
204 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000205
Guido van Rossumf10aa982007-08-17 18:30:38 +0000206 complex number
207 An extension of the familiar real number system in which all numbers are
208 expressed as a sum of a real part and an imaginary part. Imaginary
209 numbers are real multiples of the imaginary unit (the square root of
210 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000211 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000212 written with this latter notation; the imaginary part is written with a
213 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
214 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
215 advanced mathematical feature. If you're not aware of a need for them,
216 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000217
Christian Heimes895627f2007-12-08 17:28:33 +0000218 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000219 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000220 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
221 See :pep:`343`.
222
Stefan Krah70e543b2015-08-08 14:33:28 +0200223 contiguous
224 .. index:: C-contiguous, Fortran contiguous
225
226 A buffer is considered contiguous exactly if it is either
227 *C-contiguous* or *Fortran contiguous*. Zero-dimensional buffers are
228 C and Fortran contiguous. In one-dimensional arrays, the items
Martin Panter46f50722016-05-26 05:35:26 +0000229 must be laid out in memory next to each other, in order of
Stefan Krah70e543b2015-08-08 14:33:28 +0200230 increasing indexes starting from zero. In multidimensional
231 C-contiguous arrays, the last index varies the fastest when
232 visiting items in order of memory address. However, in
233 Fortran contiguous arrays, the first index varies the fastest.
234
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400235 coroutine
236 Coroutines is a more generalized form of subroutines. Subroutines are
Yury Selivanov66f88282015-06-24 11:04:15 -0400237 entered at one point and exited at another point. Coroutines can be
238 entered, exited, and resumed at many different points. They can be
239 implemented with the :keyword:`async def` statement. See also
240 :pep:`492`.
241
242 coroutine function
243 A function which returns a :term:`coroutine` object. A coroutine
244 function may be defined with the :keyword:`async def` statement,
245 and may contain :keyword:`await`, :keyword:`async for`, and
246 :keyword:`async with` keywords. These were introduced
247 by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400248
Benjamin Peterson5478b472008-09-17 22:25:09 +0000249 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000250 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100251 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000252 is used when necessary to distinguish this implementation from others
253 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000254
Christian Heimesd8654cf2007-12-02 15:22:16 +0000255 decorator
256 A function returning another function, usually applied as a function
257 transformation using the ``@wrapper`` syntax. Common examples for
258 decorators are :func:`classmethod` and :func:`staticmethod`.
259
260 The decorator syntax is merely syntactic sugar, the following two
261 function definitions are semantically equivalent::
262
263 def f(...):
264 ...
265 f = staticmethod(f)
266
267 @staticmethod
268 def f(...):
269 ...
270
Georg Brandlaf265f42008-12-07 15:06:20 +0000271 The same concept exists for classes, but is less commonly used there. See
272 the documentation for :ref:`function definitions <function>` and
273 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000274
Guido van Rossumf10aa982007-08-17 18:30:38 +0000275 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000276 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000277 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000278 binding behavior is triggered upon attribute lookup. Normally, using
279 *a.b* to get, set or delete an attribute looks up the object named *b* in
280 the class dictionary for *a*, but if *b* is a descriptor, the respective
281 descriptor method gets called. Understanding descriptors is a key to a
282 deep understanding of Python because they are the basis for many features
283 including functions, methods, properties, class methods, static methods,
284 and reference to super classes.
285
286 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000287
Guido van Rossumf10aa982007-08-17 18:30:38 +0000288 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700289 An associative array, where arbitrary keys are mapped to values. The
290 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
291 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000292
Martin Panter85b8f452015-10-07 09:56:46 +0000293 dictionary view
294 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
295 :meth:`dict.items` are called dictionary views. They provide a dynamic
296 view on the dictionary’s entries, which means that when the dictionary
297 changes, the view reflects these changes. To force the
298 dictionary view to become a full list use ``list(dictview)``. See
299 :ref:`dict-views`.
300
Georg Brandl3dbca812008-07-23 16:10:53 +0000301 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000302 A string literal which appears as the first expression in a class,
303 function or module. While ignored when the suite is executed, it is
304 recognized by the compiler and put into the :attr:`__doc__` attribute
305 of the enclosing class, function or module. Since it is available via
306 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000307 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000308
309 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000310 A programming style which does not look at an object's type to determine
311 if it has the right interface; instead, the method or attribute is simply
312 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000313 must be a duck.") By emphasizing interfaces rather than specific types,
314 well-designed code improves its flexibility by allowing polymorphic
315 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000316 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200317 with :term:`abstract base classes <abstract base class>`.) Instead, it
318 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000319
Guido van Rossumf10aa982007-08-17 18:30:38 +0000320 EAFP
321 Easier to ask for forgiveness than permission. This common Python coding
322 style assumes the existence of valid keys or attributes and catches
323 exceptions if the assumption proves false. This clean and fast style is
324 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000325 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000326 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000327
Christian Heimesd8654cf2007-12-02 15:22:16 +0000328 expression
329 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000330 an expression is an accumulation of expression elements like literals,
331 names, attribute access, operators or function calls which all return a
332 value. In contrast to many other languages, not all language constructs
333 are expressions. There are also :term:`statement`\s which cannot be used
334 as expressions, such as :keyword:`if`. Assignments are also statements,
335 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000336
Guido van Rossumf10aa982007-08-17 18:30:38 +0000337 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000338 A module written in C or C++, using Python's C API to interact with the
339 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000340
Mariatta33db0682017-03-30 12:12:18 -0700341 f-string
342 String literals prefixed with ``'f'`` or ``'F'`` are commonly called
343 "f-strings" which is short for
344 :ref:`formatted string literals <f-strings>`. See also :pep:`498`.
345
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000346 file object
347 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000348 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
349 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300350 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000351 (for example standard input/output, in-memory buffers, sockets, pipes,
352 etc.). File objects are also called :dfn:`file-like objects` or
353 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000354
Antoine Pitroudd799d22013-12-05 23:46:32 +0100355 There are actually three categories of file objects: raw
356 :term:`binary files <binary file>`, buffered
357 :term:`binary files <binary file>` and :term:`text files <text file>`.
358 Their interfaces are defined in the :mod:`io` module. The canonical
359 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000360
361 file-like object
362 A synonym for :term:`file object`.
363
Brett Cannon51d4aab2009-01-25 04:21:39 +0000364 finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800365 An object that tries to find the :term:`loader` for a module that is
366 being imported.
367
368 Since Python 3.3, there are two types of finder: :term:`meta path finders
369 <meta path finder>` for use with :data:`sys.meta_path`, and :term:`path
370 entry finders <path entry finder>` for use with :data:`sys.path_hooks`.
371
372 See :pep:`302`, :pep:`420` and :pep:`451` for much more detail.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000373
Benjamin Peterson2d718222008-11-21 00:25:02 +0000374 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000375 Mathematical division that rounds down to nearest integer. The floor
376 division operator is ``//``. For example, the expression ``11 // 4``
377 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
378 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
379 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000380
Christian Heimesd8654cf2007-12-02 15:22:16 +0000381 function
382 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800383 be passed zero or more :term:`arguments <argument>` which may be used in
384 the execution of the body. See also :term:`parameter`, :term:`method`,
385 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000386
R David Murray25cd0912013-05-06 12:58:16 -0400387 function annotation
Andrés Delfinoe69657d2018-05-26 14:17:33 -0300388 An :term:`annotation` of a function parameter or return value.
R David Murray25cd0912013-05-06 12:58:16 -0400389
Andrés Delfinoe69657d2018-05-26 14:17:33 -0300390 Function annotations are usually used for
391 :term:`type hints <type hint>`: for example this function is expected to take two
392 :class:`int` arguments and is also expected to have an :class:`int`
393 return value::
Guido van Rossum95e4d582018-01-26 08:20:18 -0800394
Andrés Delfinoe69657d2018-05-26 14:17:33 -0300395 def sum_two_numbers(a: int, b: int) -> int:
396 return a + b
397
398 Function annotation syntax is explained in section :ref:`function`.
399
400 See :term:`variable annotation` and :pep:`484`,
401 which describe this functionality.
R David Murray25cd0912013-05-06 12:58:16 -0400402
Guido van Rossumf10aa982007-08-17 18:30:38 +0000403 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000404 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000405 which are not compatible with the current interpreter.
406
407 By importing the :mod:`__future__` module and evaluating its variables,
408 you can see when a new feature was first added to the language and when it
409 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000410
Guido van Rossumf10aa982007-08-17 18:30:38 +0000411 >>> import __future__
412 >>> __future__.division
413 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
414
415 garbage collection
416 The process of freeing memory when it is not used anymore. Python
417 performs garbage collection via reference counting and a cyclic garbage
Antoine Pitrou4b965932017-12-19 19:48:45 +0100418 collector that is able to detect and break reference cycles. The
419 garbage collector can be controlled using the :mod:`gc` module.
Georg Brandl48310cd2009-01-03 21:18:54 +0000420
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000421 .. index:: single: generator
422
Guido van Rossumf10aa982007-08-17 18:30:38 +0000423 generator
Yury Selivanov5376ba92015-06-22 12:19:30 -0400424 A function which returns a :term:`generator iterator`. It looks like a
425 normal function except that it contains :keyword:`yield` expressions
426 for producing a series of values usable in a for-loop or that can be
427 retrieved one at a time with the :func:`next` function.
428
429 Usually refers to a generator function, but may refer to a
430 *generator iterator* in some contexts. In cases where the intended
431 meaning isn't clear, using the full terms avoids ambiguity.
432
433 generator iterator
434 An object created by a :term:`generator` function.
435
436 Each :keyword:`yield` temporarily suspends processing, remembering the
437 location execution state (including local variables and pending
Miss Islington (bot)08292002018-06-09 19:00:36 -0700438 try-statements). When the *generator iterator* resumes, it picks up where
439 it left off (in contrast to functions which start fresh on every
Yury Selivanov5376ba92015-06-22 12:19:30 -0400440 invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000441
Guido van Rossumf10aa982007-08-17 18:30:38 +0000442 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000443
Guido van Rossumf10aa982007-08-17 18:30:38 +0000444 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000445 An expression that returns an iterator. It looks like a normal expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000446 followed by a :keyword:`for` expression defining a loop variable, range,
447 and an optional :keyword:`if` expression. The combined expression
448 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000449
Guido van Rossumf10aa982007-08-17 18:30:38 +0000450 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
451 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000452
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200453 generic function
454 A function composed of multiple functions implementing the same operation
455 for different types. Which implementation should be used during a call is
456 determined by the dispatch algorithm.
457
458 See also the :term:`single dispatch` glossary entry, the
459 :func:`functools.singledispatch` decorator, and :pep:`443`.
460
461
Guido van Rossumf10aa982007-08-17 18:30:38 +0000462 GIL
463 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000464
Guido van Rossumf10aa982007-08-17 18:30:38 +0000465 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000466 The mechanism used by the :term:`CPython` interpreter to assure that
467 only one thread executes Python :term:`bytecode` at a time.
468 This simplifies the CPython implementation by making the object model
469 (including critical built-in types such as :class:`dict`) implicitly
470 safe against concurrent access. Locking the entire interpreter
471 makes it easier for the interpreter to be multi-threaded, at the
472 expense of much of the parallelism afforded by multi-processor
473 machines.
474
475 However, some extension modules, either standard or third-party,
476 are designed so as to release the GIL when doing computationally-intensive
477 tasks such as compression or hashing. Also, the GIL is always released
478 when doing I/O.
479
480 Past efforts to create a "free-threaded" interpreter (one which locks
481 shared data at a much finer granularity) have not been successful
482 because performance suffered in the common single-processor case. It
483 is believed that overcoming this performance issue would make the
484 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000485
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800486
487 hash-based pyc
Miss Islington (bot)6cb556f2018-03-28 06:23:32 -0700488 A bytecode cache file that uses the hash rather than the last-modified
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800489 time of the corresponding source file to determine its validity. See
490 :ref:`pyc-invalidation`.
491
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000492 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000493 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000494 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000495 other objects (it needs an :meth:`__eq__` method). Hashable objects which
496 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000497
498 Hashability makes an object usable as a dictionary key and a set member,
499 because these data structures use the hash value internally.
500
csabella64c887a2017-04-01 22:50:47 -0400501 All of Python's immutable built-in objects are hashable; mutable
502 containers (such as lists or dictionaries) are not. Objects which are
503 instances of user-defined classes are hashable by default. They all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200504 compare unequal (except with themselves), and their hash value is derived
505 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000506
Guido van Rossumf10aa982007-08-17 18:30:38 +0000507 IDLE
508 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000509 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000510 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000511
Guido van Rossumf10aa982007-08-17 18:30:38 +0000512 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000513 An object with a fixed value. Immutable objects include numbers, strings and
514 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000515 be created if a different value has to be stored. They play an important
516 role in places where a constant hash value is needed, for example as a key
517 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000518
Barry Warsawdadebab2012-07-31 16:03:09 -0400519 import path
520 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000521 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400522 import, this list of locations usually comes from :data:`sys.path`, but
523 for subpackages it may also come from the parent package's ``__path__``
524 attribute.
525
Barry Warsawd7d21942012-07-29 16:36:17 -0400526 importing
527 The process by which Python code in one module is made available to
528 Python code in another module.
529
Brett Cannon51d4aab2009-01-25 04:21:39 +0000530 importer
531 An object that both finds and loads a module; both a
532 :term:`finder` and :term:`loader` object.
533
Guido van Rossumf10aa982007-08-17 18:30:38 +0000534 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000535 Python has an interactive interpreter which means you can enter
536 statements and expressions at the interpreter prompt, immediately
537 execute them and see their results. Just launch ``python`` with no
538 arguments (possibly by selecting it from your computer's main
539 menu). It is a very powerful way to test out new ideas or inspect
540 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000541
Guido van Rossumf10aa982007-08-17 18:30:38 +0000542 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000543 Python is an interpreted language, as opposed to a compiled one,
544 though the distinction can be blurry because of the presence of the
545 bytecode compiler. This means that source files can be run directly
546 without explicitly creating an executable which is then run.
547 Interpreted languages typically have a shorter development/debug cycle
548 than compiled ones, though their programs generally also run more
549 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000550
Antoine Pitrou5db1bb82014-12-07 01:28:27 +0100551 interpreter shutdown
552 When asked to shut down, the Python interpreter enters a special phase
553 where it gradually releases all allocated resources, such as modules
554 and various critical internal structures. It also makes several calls
555 to the :term:`garbage collector <garbage collection>`. This can trigger
556 the execution of code in user-defined destructors or weakref callbacks.
557 Code executed during the shutdown phase can encounter various
558 exceptions as the resources it relies on may not function anymore
559 (common examples are library modules or the warnings machinery).
560
561 The main reason for interpreter shutdown is that the ``__main__`` module
562 or the script being run has finished executing.
563
Guido van Rossumf10aa982007-08-17 18:30:38 +0000564 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200565 An object capable of returning its members one at a time. Examples of
566 iterables include all sequence types (such as :class:`list`, :class:`str`,
567 and :class:`tuple`) and some non-sequence types like :class:`dict`,
568 :term:`file objects <file object>`, and objects of any classes you define
Raymond Hettinger0bf287b2017-09-25 00:52:06 -0700569 with an :meth:`__iter__` method or with a :meth:`__getitem__` method
570 that implements :term:`Sequence` semantics.
571
572 Iterables can be
Ezio Melottid581fff2013-01-02 22:29:09 +0200573 used in a :keyword:`for` loop and in many other places where a sequence is
574 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
575 as an argument to the built-in function :func:`iter`, it returns an
576 iterator for the object. This iterator is good for one pass over the set
577 of values. When using iterables, it is usually not necessary to call
578 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000579 statement does that automatically for you, creating a temporary unnamed
580 variable to hold the iterator for the duration of the loop. See also
581 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000582
Guido van Rossumf10aa982007-08-17 18:30:38 +0000583 iterator
584 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300585 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000586 :func:`next`) return successive items in the stream. When no more data
587 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000588 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000589 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
590 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000591 object itself so every iterator is also iterable and may be used in most
592 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000593 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000594 :class:`list`) produces a fresh new iterator each time you pass it to the
595 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
596 with an iterator will just return the same exhausted iterator object used
597 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000598
Georg Brandl9afde1c2007-11-01 20:32:30 +0000599 More information can be found in :ref:`typeiter`.
600
Georg Brandlc275e152010-11-05 07:10:41 +0000601 key function
602 A key function or collation function is a callable that returns a value
603 used for sorting or ordering. For example, :func:`locale.strxfrm` is
604 used to produce a sort key that is aware of locale specific sort
605 conventions.
606
607 A number of tools in Python accept key functions to control how elements
608 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700609 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
610 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
611 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000612
613 There are several ways to create a key function. For example. the
614 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700615 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000616 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200617 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000618 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
619 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
620 <sortinghowto>` for examples of how to create and use key functions.
621
Christian Heimesd8654cf2007-12-02 15:22:16 +0000622 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800623 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000624
625 lambda
626 An anonymous inline function consisting of a single :term:`expression`
627 which is evaluated when the function is called. The syntax to create
Miss Islington (bot)d9055f82018-05-22 01:07:28 -0700628 a lambda function is ``lambda [parameters]: expression``
Christian Heimesd8654cf2007-12-02 15:22:16 +0000629
Guido van Rossumf10aa982007-08-17 18:30:38 +0000630 LBYL
631 Look before you leap. This coding style explicitly tests for
632 pre-conditions before making calls or lookups. This style contrasts with
633 the :term:`EAFP` approach and is characterized by the presence of many
634 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000635
Raymond Hettinger09f44142010-12-17 20:19:50 +0000636 In a multi-threaded environment, the LBYL approach can risk introducing a
637 race condition between "the looking" and "the leaping". For example, the
638 code, ``if key in mapping: return mapping[key]`` can fail if another
639 thread removes *key* from *mapping* after the test, but before the lookup.
640 This issue can be solved with locks or by using the EAFP approach.
641
Benjamin Peterson5478b472008-09-17 22:25:09 +0000642 list
643 A built-in Python :term:`sequence`. Despite its name it is more akin
644 to an array in other languages than to a linked list since access to
645 elements are O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000646
Guido van Rossumf10aa982007-08-17 18:30:38 +0000647 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000648 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000649 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000650 range(256) if x % 2 == 0]`` generates a list of strings containing
651 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
652 clause is optional. If omitted, all elements in ``range(256)`` are
653 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000654
Brett Cannon51d4aab2009-01-25 04:21:39 +0000655 loader
656 An object that loads a module. It must define a method named
657 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000658 :term:`finder`. See :pep:`302` for details and
659 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000660
Guido van Rossumf10aa982007-08-17 18:30:38 +0000661 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000662 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200663 methods specified in the :class:`~collections.abc.Mapping` or
664 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200665 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
666 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000667 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000668
Barry Warsawd7d21942012-07-29 16:36:17 -0400669 meta path finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800670 A :term:`finder` returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400671 finders are related to, but different from :term:`path entry finders
672 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400673
Brett Cannonccddbb12015-12-04 15:46:21 -0800674 See :class:`importlib.abc.MetaPathFinder` for the methods that meta path
675 finders implement.
676
Guido van Rossumf10aa982007-08-17 18:30:38 +0000677 metaclass
678 The class of a class. Class definitions create a class name, a class
679 dictionary, and a list of base classes. The metaclass is responsible for
680 taking those three arguments and creating the class. Most object oriented
681 programming languages provide a default implementation. What makes Python
682 special is that it is possible to create custom metaclasses. Most users
683 never need this tool, but when the need arises, metaclasses can provide
684 powerful, elegant solutions. They have been used for logging attribute
685 access, adding thread-safety, tracking object creation, implementing
686 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000687
688 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000689
690 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000691 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000692 of an instance of that class, the method will get the instance object as
693 its first :term:`argument` (which is usually called ``self``).
694 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000695
Michael Foord95fc51d2010-11-20 15:07:30 +0000696 method resolution order
697 Method Resolution Order is the order in which base classes are searched
698 for a member during lookup. See `The Python 2.3 Method Resolution Order
Senthil Kumaran3858a1c2016-01-09 22:33:54 -0800699 <https://www.python.org/download/releases/2.3/mro/>`_ for details of the
700 algorithm used by the Python interpreter since the 2.3 release.
Michael Foord95fc51d2010-11-20 15:07:30 +0000701
Barry Warsawd7d21942012-07-29 16:36:17 -0400702 module
703 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400704 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400705 into Python by the process of :term:`importing`.
706
Georg Brandlbcce1252013-10-08 08:06:18 +0200707 See also :term:`package`.
708
Eric Snowca2d8542013-12-16 23:06:52 -0700709 module spec
710 A namespace containing the import-related information used to load a
Brett Cannonccddbb12015-12-04 15:46:21 -0800711 module. An instance of :class:`importlib.machinery.ModuleSpec`.
Eric Snowca2d8542013-12-16 23:06:52 -0700712
Michael Foord95fc51d2010-11-20 15:07:30 +0000713 MRO
714 See :term:`method resolution order`.
715
Guido van Rossumf10aa982007-08-17 18:30:38 +0000716 mutable
717 Mutable objects can change their value but keep their :func:`id`. See
718 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000719
720 named tuple
Raymond Hettingerd04fa312009-02-04 19:45:13 +0000721 Any tuple-like class whose indexable elements are also accessible using
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000722 named attributes (for example, :func:`time.localtime` returns a
723 tuple-like object where the *year* is accessible either with an
724 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
725
726 A named tuple can be a built-in type such as :class:`time.struct_time`,
727 or it can be created with a regular class definition. A full featured
728 named tuple can also be created with the factory function
729 :func:`collections.namedtuple`. The latter approach automatically
730 provides extra features such as a self-documenting representation like
731 ``Employee(name='jones', title='programmer')``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000732
Guido van Rossumf10aa982007-08-17 18:30:38 +0000733 namespace
734 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000735 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000736 as nested namespaces in objects (in methods). Namespaces support
737 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300738 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
739 their namespaces. Namespaces also aid readability and maintainability by
740 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200741 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000742 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000743 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000744
Barry Warsawd7d21942012-07-29 16:36:17 -0400745 namespace package
746 A :pep:`420` :term:`package` which serves only as a container for
747 subpackages. Namespace packages may have no physical representation,
748 and specifically are not like a :term:`regular package` because they
749 have no ``__init__.py`` file.
750
Georg Brandlbcce1252013-10-08 08:06:18 +0200751 See also :term:`module`.
752
Guido van Rossumf10aa982007-08-17 18:30:38 +0000753 nested scope
754 The ability to refer to a variable in an enclosing definition. For
755 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000756 variables in the outer function. Note that nested scopes by default work
757 only for reference and not for assignment. Local variables both read and
758 write in the innermost scope. Likewise, global variables read and write
759 to the global namespace. The :keyword:`nonlocal` allows writing to outer
760 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000761
Guido van Rossumf10aa982007-08-17 18:30:38 +0000762 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000763 Old name for the flavor of classes now used for all class objects. In
764 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300765 versatile features like :attr:`~object.__slots__`, descriptors,
766 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000767
Benjamin Peterson5478b472008-09-17 22:25:09 +0000768 object
769 Any data with state (attributes or value) and defined behavior
770 (methods). Also the ultimate base class of any :term:`new-style
771 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000772
Barry Warsawd7d21942012-07-29 16:36:17 -0400773 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200774 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400775 subpackages. Technically, a package is a Python module with an
776 ``__path__`` attribute.
777
Georg Brandlbcce1252013-10-08 08:06:18 +0200778 See also :term:`regular package` and :term:`namespace package`.
779
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800780 parameter
781 A named entity in a :term:`function` (or method) definition that
782 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600783 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800784
785 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
786 either :term:`positionally <argument>` or as a :term:`keyword argument
787 <argument>`. This is the default kind of parameter, for example *foo*
788 and *bar* in the following::
789
790 def func(foo, bar=None): ...
791
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +0300792 .. _positional-only_parameter:
793
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800794 * :dfn:`positional-only`: specifies an argument that can be supplied only
795 by position. Python has no syntax for defining positional-only
796 parameters. However, some built-in functions have positional-only
797 parameters (e.g. :func:`abs`).
798
Zachary Waree1391a02013-11-22 13:58:34 -0600799 .. _keyword-only_parameter:
800
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800801 * :dfn:`keyword-only`: specifies an argument that can be supplied only
802 by keyword. Keyword-only parameters can be defined by including a
803 single var-positional parameter or bare ``*`` in the parameter list
804 of the function definition before them, for example *kw_only1* and
805 *kw_only2* in the following::
806
807 def func(arg, *, kw_only1, kw_only2): ...
808
809 * :dfn:`var-positional`: specifies that an arbitrary sequence of
810 positional arguments can be provided (in addition to any positional
811 arguments already accepted by other parameters). Such a parameter can
812 be defined by prepending the parameter name with ``*``, for example
813 *args* in the following::
814
815 def func(*args, **kwargs): ...
816
817 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
818 can be provided (in addition to any keyword arguments already accepted
819 by other parameters). Such a parameter can be defined by prepending
820 the parameter name with ``**``, for example *kwargs* in the example
821 above.
822
823 Parameters can specify both optional and required arguments, as well as
824 default values for some optional arguments.
825
826 See also the :term:`argument` glossary entry, the FAQ question on
827 :ref:`the difference between arguments and parameters
828 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
829 :ref:`function` section, and :pep:`362`.
830
Barry Warsawdadebab2012-07-31 16:03:09 -0400831 path entry
832 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000833 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400834
835 path entry finder
836 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
837 (i.e. a :term:`path entry hook`) which knows how to locate modules given
838 a :term:`path entry`.
839
Brett Cannonccddbb12015-12-04 15:46:21 -0800840 See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
841 finders implement.
842
Barry Warsawdadebab2012-07-31 16:03:09 -0400843 path entry hook
844 A callable on the :data:`sys.path_hook` list which returns a :term:`path
845 entry finder` if it knows how to find modules on a specific :term:`path
846 entry`.
847
Nick Coghlan1685db02012-08-20 13:49:08 +1000848 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400849 One of the default :term:`meta path finders <meta path finder>` which
850 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400851
Brett Cannonc28592b2016-06-24 12:21:47 -0700852 path-like object
853 An object representing a file system path. A path-like object is either
854 a :class:`str` or :class:`bytes` object representing a path, or an object
855 implementing the :class:`os.PathLike` protocol. An object that supports
856 the :class:`os.PathLike` protocol can be converted to a :class:`str` or
857 :class:`bytes` file system path by calling the :func:`os.fspath` function;
858 :func:`os.fsdecode` and :func:`os.fsencode` can be used to guarantee a
859 :class:`str` or :class:`bytes` result instead, respectively. Introduced
860 by :pep:`519`.
861
Andrés Delfinoa3a554a2018-05-18 20:44:18 -0300862 PEP
863 Python Enhancement Proposal. A PEP is a design document
864 providing information to the Python community, or describing a new
865 feature for Python or its processes or environment. PEPs should
866 provide a concise technical specification and a rationale for proposed
867 features.
868
869 PEPs are intended to be the primary mechanisms for proposing major new
870 features, for collecting community input on an issue, and for documenting
871 the design decisions that have gone into Python. The PEP author is
872 responsible for building consensus within the community and documenting
873 dissenting opinions.
874
875 See :pep:`1`.
876
Barry Warsawd7d21942012-07-29 16:36:17 -0400877 portion
878 A set of files in a single directory (possibly stored in a zip file)
879 that contribute to a namespace package, as defined in :pep:`420`.
880
Christian Heimesd8654cf2007-12-02 15:22:16 +0000881 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800882 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000883
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000884 provisional API
885 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400886 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000887 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300888 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000889 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300890 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000891 fundamental flaws are uncovered that were missed prior to the inclusion
892 of the API.
893
894 Even for provisional APIs, backwards incompatible changes are seen as
895 a "solution of last resort" - every attempt will still be made to find
896 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300897
Barry Warsawd7d21942012-07-29 16:36:17 -0400898 This process allows the standard library to continue to evolve over
899 time, without locking in problematic design errors for extended periods
900 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300901
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000902 provisional package
903 See :term:`provisional API`.
904
Guido van Rossumf10aa982007-08-17 18:30:38 +0000905 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400906 Nickname for the Python 3.x release line (coined long ago when the
907 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000908 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000909
Christian Heimesd8654cf2007-12-02 15:22:16 +0000910 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000911 An idea or piece of code which closely follows the most common idioms
912 of the Python language, rather than implementing code using concepts
913 common to other languages. For example, a common idiom in Python is
914 to loop over all elements of an iterable using a :keyword:`for`
915 statement. Many other languages don't have this type of construct, so
916 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000917
Christian Heimesd8654cf2007-12-02 15:22:16 +0000918 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000919 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000920
921 As opposed to the cleaner, Pythonic method::
922
923 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000924 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000925
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100926 qualified name
927 A dotted name showing the "path" from a module's global scope to a
928 class, function or method defined in that module, as defined in
929 :pep:`3155`. For top-level functions and classes, the qualified name
930 is the same as the object's name::
931
932 >>> class C:
933 ... class D:
934 ... def meth(self):
935 ... pass
936 ...
937 >>> C.__qualname__
938 'C'
939 >>> C.D.__qualname__
940 'C.D'
941 >>> C.D.meth.__qualname__
942 'C.D.meth'
943
Barry Warsawd7d21942012-07-29 16:36:17 -0400944 When used to refer to modules, the *fully qualified name* means the
945 entire dotted path to the module, including any parent packages,
946 e.g. ``email.mime.text``::
947
948 >>> import email.mime.text
949 >>> email.mime.text.__name__
950 'email.mime.text'
951
Guido van Rossumf10aa982007-08-17 18:30:38 +0000952 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000953 The number of references to an object. When the reference count of an
954 object drops to zero, it is deallocated. Reference counting is
955 generally not visible to Python code, but it is a key element of the
956 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000957 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000958 reference count for a particular object.
959
Barry Warsawd7d21942012-07-29 16:36:17 -0400960 regular package
961 A traditional :term:`package`, such as a directory containing an
962 ``__init__.py`` file.
963
Georg Brandlbcce1252013-10-08 08:06:18 +0200964 See also :term:`namespace package`.
965
Guido van Rossumf10aa982007-08-17 18:30:38 +0000966 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +0000967 A declaration inside a class that saves memory by pre-declaring space for
968 instance attributes and eliminating instance dictionaries. Though
969 popular, the technique is somewhat tricky to get right and is best
970 reserved for rare cases where there are large numbers of instances in a
971 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +0000972
Guido van Rossumf10aa982007-08-17 18:30:38 +0000973 sequence
974 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +0000975 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +0300976 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000977 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +0000978 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +0000979 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
980 mapping rather than a sequence because the lookups use arbitrary
981 :term:`immutable` keys rather than integers.
982
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -0500983 The :class:`collections.abc.Sequence` abstract base class
984 defines a much richer interface that goes beyond just
985 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
986 :meth:`index`, :meth:`__contains__`, and
987 :meth:`__reversed__`. Types that implement this expanded
988 interface can be registered explicitly using
989 :func:`~abc.register`.
990
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200991 single dispatch
992 A form of :term:`generic function` dispatch where the implementation is
993 chosen based on the type of a single argument.
994
Christian Heimesd8654cf2007-12-02 15:22:16 +0000995 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +0000996 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +0000997 created using the subscript notation, ``[]`` with colons between numbers
998 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +0000999 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001000
Georg Brandlaf265f42008-12-07 15:06:20 +00001001 special method
1002 A method that is called implicitly by Python to execute a certain
1003 operation on a type, such as addition. Such methods have names starting
1004 and ending with double underscores. Special methods are documented in
1005 :ref:`specialnames`.
1006
Christian Heimesd8654cf2007-12-02 15:22:16 +00001007 statement
1008 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +02001009 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +00001010 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +00001011
Benjamin Peterson82f614b2011-04-20 18:27:32 -05001012 struct sequence
Florent Xiclunaf8240d62011-11-11 19:58:53 +01001013 A tuple with named elements. Struct sequences expose an interface similar
Benjamin Peterson82f614b2011-04-20 18:27:32 -05001014 to :term:`named tuple` in that elements can either be accessed either by
1015 index or as an attribute. However, they do not have any of the named tuple
1016 methods like :meth:`~collections.somenamedtuple._make` or
1017 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
1018 include :data:`sys.float_info` and the return value of :func:`os.stat`.
1019
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001020 text encoding
1021 A codec which encodes Unicode strings to bytes.
1022
Antoine Pitroudd799d22013-12-05 23:46:32 +01001023 text file
1024 A :term:`file object` able to read and write :class:`str` objects.
1025 Often, a text file actually accesses a byte-oriented datastream
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +10001026 and handles the :term:`text encoding` automatically.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +02001027 Examples of text files are files opened in text mode (``'r'`` or ``'w'``),
1028 :data:`sys.stdin`, :data:`sys.stdout`, and instances of
1029 :class:`io.StringIO`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001030
Miss Islington (bot)4ecdc112018-05-20 15:51:37 -07001031 See also :term:`binary file` for a file object able to read and write
1032 :term:`bytes-like objects <bytes-like object>`.
Antoine Pitroudd799d22013-12-05 23:46:32 +01001033
Benjamin Peterson5478b472008-09-17 22:25:09 +00001034 triple-quoted string
1035 A string which is bound by three instances of either a quotation mark
1036 (") or an apostrophe ('). While they don't provide any functionality
1037 not available with single-quoted strings, they are useful for a number
1038 of reasons. They allow you to include unescaped single and double
1039 quotes within a string and they can span multiple lines without the
1040 use of the continuation character, making them especially useful when
1041 writing docstrings.
1042
Guido van Rossumf10aa982007-08-17 18:30:38 +00001043 type
1044 The type of a Python object determines what kind of object it is; every
1045 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +03001046 :attr:`~instance.__class__` attribute or can be retrieved with
1047 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +00001048
Andrés Delfinoe69657d2018-05-26 14:17:33 -03001049 type alias
1050 A synonym for a type, created by assigning the type to an identifier.
1051
1052 Type aliases are useful for simplifying :term:`type hints <type hint>`.
1053 For example::
1054
1055 from typing import List, Tuple
1056
1057 def remove_gray_shades(
1058 colors: List[Tuple[int, int, int]]) -> List[Tuple[int, int, int]]:
1059 pass
1060
1061 could be made more readable like this::
1062
1063 from typing import List, Tuple
1064
1065 Color = Tuple[int, int, int]
1066
1067 def remove_gray_shades(colors: List[Color]) -> List[Color]:
1068 pass
1069
1070 See :mod:`typing` and :pep:`484`, which describe this functionality.
1071
1072 type hint
1073 An :term:`annotation` that specifies the expected type for a variable, a class
1074 attribute, or a function parameter or return value.
1075
1076 Type hints are optional and are not enforced by Python but
1077 they are useful to static type analysis tools, and aid IDEs with code
1078 completion and refactoring.
1079
1080 Type hints of global variables, class attributes, and functions,
1081 but not local variables, can be accessed using
1082 :func:`typing.get_type_hints`.
1083
1084 See :mod:`typing` and :pep:`484`, which describe this functionality.
1085
R David Murray1b00f252012-08-15 10:43:58 -04001086 universal newlines
1087 A manner of interpreting text streams in which all of the following are
1088 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
1089 the Windows convention ``'\r\n'``, and the old Macintosh convention
1090 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -04001091 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -04001092
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001093 variable annotation
Andrés Delfinoe69657d2018-05-26 14:17:33 -03001094 An :term:`annotation` of a variable or a class attribute.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001095
Andrés Delfinoe69657d2018-05-26 14:17:33 -03001096 When annotating a variable or a class attribute, assignment is optional::
Guido van Rossum95e4d582018-01-26 08:20:18 -08001097
Andrés Delfinoe69657d2018-05-26 14:17:33 -03001098 class C:
1099 field: 'annotation'
1100
1101 Variable annotations are usually used for
1102 :term:`type hints <type hint>`: for example this variable is expected to take
1103 :class:`int` values::
1104
1105 count: int = 0
1106
1107 Variable annotation syntax is explained in section :ref:`annassign`.
1108
1109 See :term:`function annotation`, :pep:`484`
1110 and :pep:`526`, which describe this functionality.
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001111
Nick Coghlan1d520962014-09-06 20:38:23 +10001112 virtual environment
1113 A cooperatively isolated runtime environment that allows Python users
1114 and applications to install and upgrade Python distribution packages
1115 without interfering with the behaviour of other Python applications
1116 running on the same system.
1117
Brett Cannon15552c32016-07-08 10:46:21 -07001118 See also :mod:`venv`.
Nick Coghlan1d520962014-09-06 20:38:23 +10001119
Benjamin Peterson5478b472008-09-17 22:25:09 +00001120 virtual machine
1121 A computer defined entirely in software. Python's virtual machine
1122 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +00001123
Guido van Rossumf10aa982007-08-17 18:30:38 +00001124 Zen of Python
1125 Listing of Python design principles and philosophies that are helpful in
1126 understanding and using the language. The listing can be found by typing
1127 "``import this``" at the interactive prompt.