blob: e875e1fc8a0d34981a7d3eccf8618e4c770a4ec7 [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
Christian Heimesd8654cf2007-12-02 15:22:16 +000042 argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080043 A value passed to a :term:`function` (or :term:`method`) when calling the
Zachary Waree1391a02013-11-22 13:58:34 -060044 function. There are two kinds of argument:
Christian Heimesd8654cf2007-12-02 15:22:16 +000045
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080046 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
47 ``name=``) in a function call or passed as a value in a dictionary
48 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
49 arguments in the following calls to :func:`complex`::
50
51 complex(real=3, imag=5)
52 complex(**{'real': 3, 'imag': 5})
53
54 * :dfn:`positional argument`: an argument that is not a keyword argument.
55 Positional arguments can appear at the beginning of an argument list
56 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
57 For example, ``3`` and ``5`` are both positional arguments in the
58 following calls::
59
60 complex(3, 5)
61 complex(*(3, 5))
62
63 Arguments are assigned to the named local variables in a function body.
64 See the :ref:`calls` section for the rules governing this assignment.
65 Syntactically, any expression can be used to represent an argument; the
66 evaluated value is assigned to the local variable.
67
68 See also the :term:`parameter` glossary entry, the FAQ question on
69 :ref:`the difference between arguments and parameters
70 <faq-argument-vs-parameter>`, and :pep:`362`.
Benjamin Peterson5478b472008-09-17 22:25:09 +000071
Yury Selivanovf3e40fa2015-05-21 11:50:30 -040072 asynchronous context manager
73 An object which controls the environment seen in an
74 :keyword:`async with` statement by defining :meth:`__aenter__` and
75 :meth:`__aexit__` methods. Introduced by :pep:`492`.
76
Yury Selivanov03660042016-12-15 17:36:05 -050077 asynchronous generator
78 A function which returns an :term:`asynchronous generator iterator`. It
79 looks like a coroutine function defined with :keyword:`async def` except
80 that it contains :keyword:`yield` expressions for producing a series of
81 values usable in an :keyword:`async for` loop.
82
83 Usually refers to a asynchronous generator function, but may refer to an
84 *asynchronous generator iterator* in some contexts. In cases where the
85 intended meaning isn't clear, using the full terms avoids ambiguity.
86
87 An asynchronous generator function may contain :keyword:`await`
88 expressions as well as :keyword:`async for`, and :keyword:`async with`
89 statements.
90
91 asynchronous generator iterator
92 An object created by a :term:`asynchronous generator` function.
93
94 This is an :term:`asynchronous iterator` which when called using the
95 :meth:`__anext__` method returns an awaitable object which will execute
96 that the body of the asynchronous generator function until the
97 next :keyword:`yield` expression.
98
99 Each :keyword:`yield` temporarily suspends processing, remembering the
100 location execution state (including local variables and pending
101 try-statements). When the *asynchronous generator iterator* effectively
102 resumes with another awaitable returned by :meth:`__anext__`, it
103 picks-up where it left-off. See :pep:`492` and :pep:`525`.
104
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400105 asynchronous iterable
106 An object, that can be used in an :keyword:`async for` statement.
Berker Peksagaf511402016-06-11 22:40:41 +0300107 Must return an :term:`asynchronous iterator` from its
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400108 :meth:`__aiter__` method. Introduced by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400109
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400110 asynchronous iterator
111 An object that implements :meth:`__aiter__` and :meth:`__anext__`
Yury Selivanova6f6edb2016-06-09 15:08:31 -0400112 methods. ``__anext__`` must return an :term:`awaitable` object.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400113 :keyword:`async for` resolves awaitable returned from asynchronous
114 iterator's :meth:`__anext__` method until it raises
115 :exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
116
Benjamin Peterson5478b472008-09-17 22:25:09 +0000117 attribute
118 A value associated with an object which is referenced by name using
119 dotted expressions. For example, if an object *o* has an attribute
120 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +0000121
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400122 awaitable
123 An object that can be used in an :keyword:`await` expression. Can be
124 a :term:`coroutine` or an object with an :meth:`__await__` method.
125 See also :pep:`492`.
126
Guido van Rossumf10aa982007-08-17 18:30:38 +0000127 BDFL
128 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Sanyam Khurana1b4587a2017-12-06 22:09:33 +0530129 <https://gvanrossum.github.io/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +0000130
Antoine Pitroudd799d22013-12-05 23:46:32 +0100131 binary file
132 A :term:`file object` able to read and write
133 :term:`bytes-like objects <bytes-like object>`.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +0200134 Examples of binary files are files opened in binary mode (``'rb'``,
135 ``'wb'`` or ``'rb+'``), :data:`sys.stdin.buffer`,
136 :data:`sys.stdout.buffer`, and instances of :class:`io.BytesIO` and
137 :class:`gzip.GzipFile`.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100138
139 .. seealso::
140 A :term:`text file` reads and writes :class:`str` objects.
141
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300142 bytes-like object
Stefan Krah70e543b2015-08-08 14:33:28 +0200143 An object that supports the :ref:`bufferobjects` and can
144 export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,
145 :class:`bytearray`, and :class:`array.array` objects, as well as many
146 common :class:`memoryview` objects. Bytes-like objects can
Larry Hastingsab792ac2015-04-13 11:30:56 -0400147 be used for various operations that work with binary data; these include
148 compression, saving to a binary file, and sending over a socket.
149
150 Some operations need the binary data to be mutable. The documentation
151 often refers to these as "read-write bytes-like objects". Example
152 mutable buffer objects include :class:`bytearray` and a
153 :class:`memoryview` of a :class:`bytearray`.
154 Other operations require the binary data to be stored in
155 immutable objects ("read-only bytes-like objects"); examples
156 of these include :class:`bytes` and a :class:`memoryview`
157 of a :class:`bytes` object.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300158
Georg Brandl9afde1c2007-11-01 20:32:30 +0000159 bytecode
160 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +0000161 of a Python program in the CPython interpreter. The bytecode is also
Xiang Zhang0710d752017-03-11 13:02:52 +0800162 cached in ``.pyc`` files so that executing the same file is
Brett Cannon8315fd12010-07-02 22:03:00 +0000163 faster the second time (recompilation from source to bytecode can be
164 avoided). This "intermediate language" is said to run on a
165 :term:`virtual machine` that executes the machine code corresponding to
166 each bytecode. Do note that bytecodes are not expected to work between
167 different Python virtual machines, nor to be stable between Python
168 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000169
Georg Brandl2cb72d32010-07-03 10:26:54 +0000170 A list of bytecode instructions can be found in the documentation for
171 :ref:`the dis module <bytecodes>`.
172
Benjamin Peterson5478b472008-09-17 22:25:09 +0000173 class
174 A template for creating user-defined objects. Class definitions
175 normally contain method definitions which operate on instances of the
176 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000177
Benjamin Peterson5478b472008-09-17 22:25:09 +0000178 coercion
179 The implicit conversion of an instance of one type to another during an
180 operation which involves two arguments of the same type. For example,
181 ``int(3.15)`` converts the floating point number to the integer ``3``, but
182 in ``3+4.5``, each argument is of a different type (one int, one float),
183 and both must be converted to the same type before they can be added or it
Benjamin Peterson2d718222008-11-21 00:25:02 +0000184 will raise a ``TypeError``. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000185 compatible types would have to be normalized to the same value by the
186 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000187
Guido van Rossumf10aa982007-08-17 18:30:38 +0000188 complex number
189 An extension of the familiar real number system in which all numbers are
190 expressed as a sum of a real part and an imaginary part. Imaginary
191 numbers are real multiples of the imaginary unit (the square root of
192 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000193 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000194 written with this latter notation; the imaginary part is written with a
195 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
196 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
197 advanced mathematical feature. If you're not aware of a need for them,
198 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000199
Christian Heimes895627f2007-12-08 17:28:33 +0000200 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000201 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000202 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
203 See :pep:`343`.
204
Stefan Krah70e543b2015-08-08 14:33:28 +0200205 contiguous
206 .. index:: C-contiguous, Fortran contiguous
207
208 A buffer is considered contiguous exactly if it is either
209 *C-contiguous* or *Fortran contiguous*. Zero-dimensional buffers are
210 C and Fortran contiguous. In one-dimensional arrays, the items
Martin Panter46f50722016-05-26 05:35:26 +0000211 must be laid out in memory next to each other, in order of
Stefan Krah70e543b2015-08-08 14:33:28 +0200212 increasing indexes starting from zero. In multidimensional
213 C-contiguous arrays, the last index varies the fastest when
214 visiting items in order of memory address. However, in
215 Fortran contiguous arrays, the first index varies the fastest.
216
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400217 coroutine
218 Coroutines is a more generalized form of subroutines. Subroutines are
Yury Selivanov66f88282015-06-24 11:04:15 -0400219 entered at one point and exited at another point. Coroutines can be
220 entered, exited, and resumed at many different points. They can be
221 implemented with the :keyword:`async def` statement. See also
222 :pep:`492`.
223
224 coroutine function
225 A function which returns a :term:`coroutine` object. A coroutine
226 function may be defined with the :keyword:`async def` statement,
227 and may contain :keyword:`await`, :keyword:`async for`, and
228 :keyword:`async with` keywords. These were introduced
229 by :pep:`492`.
Yury Selivanovf3e40fa2015-05-21 11:50:30 -0400230
Benjamin Peterson5478b472008-09-17 22:25:09 +0000231 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000232 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100233 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000234 is used when necessary to distinguish this implementation from others
235 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000236
Christian Heimesd8654cf2007-12-02 15:22:16 +0000237 decorator
238 A function returning another function, usually applied as a function
239 transformation using the ``@wrapper`` syntax. Common examples for
240 decorators are :func:`classmethod` and :func:`staticmethod`.
241
242 The decorator syntax is merely syntactic sugar, the following two
243 function definitions are semantically equivalent::
244
245 def f(...):
246 ...
247 f = staticmethod(f)
248
249 @staticmethod
250 def f(...):
251 ...
252
Georg Brandlaf265f42008-12-07 15:06:20 +0000253 The same concept exists for classes, but is less commonly used there. See
254 the documentation for :ref:`function definitions <function>` and
255 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000256
Guido van Rossumf10aa982007-08-17 18:30:38 +0000257 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000258 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000259 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000260 binding behavior is triggered upon attribute lookup. Normally, using
261 *a.b* to get, set or delete an attribute looks up the object named *b* in
262 the class dictionary for *a*, but if *b* is a descriptor, the respective
263 descriptor method gets called. Understanding descriptors is a key to a
264 deep understanding of Python because they are the basis for many features
265 including functions, methods, properties, class methods, static methods,
266 and reference to super classes.
267
268 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000269
Guido van Rossumf10aa982007-08-17 18:30:38 +0000270 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700271 An associative array, where arbitrary keys are mapped to values. The
272 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
273 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000274
Martin Panter85b8f452015-10-07 09:56:46 +0000275 dictionary view
276 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
277 :meth:`dict.items` are called dictionary views. They provide a dynamic
278 view on the dictionary’s entries, which means that when the dictionary
279 changes, the view reflects these changes. To force the
280 dictionary view to become a full list use ``list(dictview)``. See
281 :ref:`dict-views`.
282
Georg Brandl3dbca812008-07-23 16:10:53 +0000283 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000284 A string literal which appears as the first expression in a class,
285 function or module. While ignored when the suite is executed, it is
286 recognized by the compiler and put into the :attr:`__doc__` attribute
287 of the enclosing class, function or module. Since it is available via
288 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000289 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000290
291 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000292 A programming style which does not look at an object's type to determine
293 if it has the right interface; instead, the method or attribute is simply
294 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000295 must be a duck.") By emphasizing interfaces rather than specific types,
296 well-designed code improves its flexibility by allowing polymorphic
297 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000298 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200299 with :term:`abstract base classes <abstract base class>`.) Instead, it
300 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000301
Guido van Rossumf10aa982007-08-17 18:30:38 +0000302 EAFP
303 Easier to ask for forgiveness than permission. This common Python coding
304 style assumes the existence of valid keys or attributes and catches
305 exceptions if the assumption proves false. This clean and fast style is
306 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000307 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000308 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000309
Christian Heimesd8654cf2007-12-02 15:22:16 +0000310 expression
311 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000312 an expression is an accumulation of expression elements like literals,
313 names, attribute access, operators or function calls which all return a
314 value. In contrast to many other languages, not all language constructs
315 are expressions. There are also :term:`statement`\s which cannot be used
316 as expressions, such as :keyword:`if`. Assignments are also statements,
317 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000318
Guido van Rossumf10aa982007-08-17 18:30:38 +0000319 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000320 A module written in C or C++, using Python's C API to interact with the
321 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000322
Mariatta33db0682017-03-30 12:12:18 -0700323 f-string
324 String literals prefixed with ``'f'`` or ``'F'`` are commonly called
325 "f-strings" which is short for
326 :ref:`formatted string literals <f-strings>`. See also :pep:`498`.
327
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000328 file object
329 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000330 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
331 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300332 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000333 (for example standard input/output, in-memory buffers, sockets, pipes,
334 etc.). File objects are also called :dfn:`file-like objects` or
335 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000336
Antoine Pitroudd799d22013-12-05 23:46:32 +0100337 There are actually three categories of file objects: raw
338 :term:`binary files <binary file>`, buffered
339 :term:`binary files <binary file>` and :term:`text files <text file>`.
340 Their interfaces are defined in the :mod:`io` module. The canonical
341 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000342
343 file-like object
344 A synonym for :term:`file object`.
345
Brett Cannon51d4aab2009-01-25 04:21:39 +0000346 finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800347 An object that tries to find the :term:`loader` for a module that is
348 being imported.
349
350 Since Python 3.3, there are two types of finder: :term:`meta path finders
351 <meta path finder>` for use with :data:`sys.meta_path`, and :term:`path
352 entry finders <path entry finder>` for use with :data:`sys.path_hooks`.
353
354 See :pep:`302`, :pep:`420` and :pep:`451` for much more detail.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000355
Benjamin Peterson2d718222008-11-21 00:25:02 +0000356 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000357 Mathematical division that rounds down to nearest integer. The floor
358 division operator is ``//``. For example, the expression ``11 // 4``
359 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
360 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
361 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000362
Christian Heimesd8654cf2007-12-02 15:22:16 +0000363 function
364 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800365 be passed zero or more :term:`arguments <argument>` which may be used in
366 the execution of the body. See also :term:`parameter`, :term:`method`,
367 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000368
R David Murray25cd0912013-05-06 12:58:16 -0400369 function annotation
370 An arbitrary metadata value associated with a function parameter or return
371 value. Its syntax is explained in section :ref:`function`. Annotations
372 may be accessed via the :attr:`__annotations__` special attribute of a
373 function object.
374
375 Python itself does not assign any particular meaning to function
376 annotations. They are intended to be interpreted by third-party libraries
377 or tools. See :pep:`3107`, which describes some of their potential uses.
378
Guido van Rossumf10aa982007-08-17 18:30:38 +0000379 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000380 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000381 which are not compatible with the current interpreter.
382
383 By importing the :mod:`__future__` module and evaluating its variables,
384 you can see when a new feature was first added to the language and when it
385 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000386
Guido van Rossumf10aa982007-08-17 18:30:38 +0000387 >>> import __future__
388 >>> __future__.division
389 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
390
391 garbage collection
392 The process of freeing memory when it is not used anymore. Python
393 performs garbage collection via reference counting and a cyclic garbage
394 collector that is able to detect and break reference cycles.
Georg Brandl48310cd2009-01-03 21:18:54 +0000395
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000396 .. index:: single: generator
397
Guido van Rossumf10aa982007-08-17 18:30:38 +0000398 generator
Yury Selivanov5376ba92015-06-22 12:19:30 -0400399 A function which returns a :term:`generator iterator`. It looks like a
400 normal function except that it contains :keyword:`yield` expressions
401 for producing a series of values usable in a for-loop or that can be
402 retrieved one at a time with the :func:`next` function.
403
404 Usually refers to a generator function, but may refer to a
405 *generator iterator* in some contexts. In cases where the intended
406 meaning isn't clear, using the full terms avoids ambiguity.
407
408 generator iterator
409 An object created by a :term:`generator` function.
410
411 Each :keyword:`yield` temporarily suspends processing, remembering the
412 location execution state (including local variables and pending
413 try-statements). When the *generator iterator* resumes, it picks-up where
414 it left-off (in contrast to functions which start fresh on every
415 invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000416
Guido van Rossumf10aa982007-08-17 18:30:38 +0000417 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000418
Guido van Rossumf10aa982007-08-17 18:30:38 +0000419 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000420 An expression that returns an iterator. It looks like a normal expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000421 followed by a :keyword:`for` expression defining a loop variable, range,
422 and an optional :keyword:`if` expression. The combined expression
423 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000424
Guido van Rossumf10aa982007-08-17 18:30:38 +0000425 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
426 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000427
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200428 generic function
429 A function composed of multiple functions implementing the same operation
430 for different types. Which implementation should be used during a call is
431 determined by the dispatch algorithm.
432
433 See also the :term:`single dispatch` glossary entry, the
434 :func:`functools.singledispatch` decorator, and :pep:`443`.
435
436
Guido van Rossumf10aa982007-08-17 18:30:38 +0000437 GIL
438 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000439
Guido van Rossumf10aa982007-08-17 18:30:38 +0000440 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000441 The mechanism used by the :term:`CPython` interpreter to assure that
442 only one thread executes Python :term:`bytecode` at a time.
443 This simplifies the CPython implementation by making the object model
444 (including critical built-in types such as :class:`dict`) implicitly
445 safe against concurrent access. Locking the entire interpreter
446 makes it easier for the interpreter to be multi-threaded, at the
447 expense of much of the parallelism afforded by multi-processor
448 machines.
449
450 However, some extension modules, either standard or third-party,
451 are designed so as to release the GIL when doing computationally-intensive
452 tasks such as compression or hashing. Also, the GIL is always released
453 when doing I/O.
454
455 Past efforts to create a "free-threaded" interpreter (one which locks
456 shared data at a much finer granularity) have not been successful
457 because performance suffered in the common single-processor case. It
458 is believed that overcoming this performance issue would make the
459 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000460
Benjamin Peterson42aa93b2017-12-09 10:26:52 -0800461
462 hash-based pyc
463 A bytecode cache file that uses the the hash rather than the last-modified
464 time of the corresponding source file to determine its validity. See
465 :ref:`pyc-invalidation`.
466
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000467 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000468 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000469 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000470 other objects (it needs an :meth:`__eq__` method). Hashable objects which
471 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000472
473 Hashability makes an object usable as a dictionary key and a set member,
474 because these data structures use the hash value internally.
475
csabella64c887a2017-04-01 22:50:47 -0400476 All of Python's immutable built-in objects are hashable; mutable
477 containers (such as lists or dictionaries) are not. Objects which are
478 instances of user-defined classes are hashable by default. They all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200479 compare unequal (except with themselves), and their hash value is derived
480 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000481
Guido van Rossumf10aa982007-08-17 18:30:38 +0000482 IDLE
483 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000484 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000485 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000486
Guido van Rossumf10aa982007-08-17 18:30:38 +0000487 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000488 An object with a fixed value. Immutable objects include numbers, strings and
489 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000490 be created if a different value has to be stored. They play an important
491 role in places where a constant hash value is needed, for example as a key
492 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000493
Barry Warsawdadebab2012-07-31 16:03:09 -0400494 import path
495 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000496 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400497 import, this list of locations usually comes from :data:`sys.path`, but
498 for subpackages it may also come from the parent package's ``__path__``
499 attribute.
500
Barry Warsawd7d21942012-07-29 16:36:17 -0400501 importing
502 The process by which Python code in one module is made available to
503 Python code in another module.
504
Brett Cannon51d4aab2009-01-25 04:21:39 +0000505 importer
506 An object that both finds and loads a module; both a
507 :term:`finder` and :term:`loader` object.
508
Guido van Rossumf10aa982007-08-17 18:30:38 +0000509 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000510 Python has an interactive interpreter which means you can enter
511 statements and expressions at the interpreter prompt, immediately
512 execute them and see their results. Just launch ``python`` with no
513 arguments (possibly by selecting it from your computer's main
514 menu). It is a very powerful way to test out new ideas or inspect
515 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000516
Guido van Rossumf10aa982007-08-17 18:30:38 +0000517 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000518 Python is an interpreted language, as opposed to a compiled one,
519 though the distinction can be blurry because of the presence of the
520 bytecode compiler. This means that source files can be run directly
521 without explicitly creating an executable which is then run.
522 Interpreted languages typically have a shorter development/debug cycle
523 than compiled ones, though their programs generally also run more
524 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000525
Antoine Pitrou5db1bb82014-12-07 01:28:27 +0100526 interpreter shutdown
527 When asked to shut down, the Python interpreter enters a special phase
528 where it gradually releases all allocated resources, such as modules
529 and various critical internal structures. It also makes several calls
530 to the :term:`garbage collector <garbage collection>`. This can trigger
531 the execution of code in user-defined destructors or weakref callbacks.
532 Code executed during the shutdown phase can encounter various
533 exceptions as the resources it relies on may not function anymore
534 (common examples are library modules or the warnings machinery).
535
536 The main reason for interpreter shutdown is that the ``__main__`` module
537 or the script being run has finished executing.
538
Guido van Rossumf10aa982007-08-17 18:30:38 +0000539 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200540 An object capable of returning its members one at a time. Examples of
541 iterables include all sequence types (such as :class:`list`, :class:`str`,
542 and :class:`tuple`) and some non-sequence types like :class:`dict`,
543 :term:`file objects <file object>`, and objects of any classes you define
Raymond Hettinger0bf287b2017-09-25 00:52:06 -0700544 with an :meth:`__iter__` method or with a :meth:`__getitem__` method
545 that implements :term:`Sequence` semantics.
546
547 Iterables can be
Ezio Melottid581fff2013-01-02 22:29:09 +0200548 used in a :keyword:`for` loop and in many other places where a sequence is
549 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
550 as an argument to the built-in function :func:`iter`, it returns an
551 iterator for the object. This iterator is good for one pass over the set
552 of values. When using iterables, it is usually not necessary to call
553 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000554 statement does that automatically for you, creating a temporary unnamed
555 variable to hold the iterator for the duration of the loop. See also
556 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000557
Guido van Rossumf10aa982007-08-17 18:30:38 +0000558 iterator
559 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300560 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000561 :func:`next`) return successive items in the stream. When no more data
562 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000563 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000564 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
565 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000566 object itself so every iterator is also iterable and may be used in most
567 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000568 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000569 :class:`list`) produces a fresh new iterator each time you pass it to the
570 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
571 with an iterator will just return the same exhausted iterator object used
572 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000573
Georg Brandl9afde1c2007-11-01 20:32:30 +0000574 More information can be found in :ref:`typeiter`.
575
Georg Brandlc275e152010-11-05 07:10:41 +0000576 key function
577 A key function or collation function is a callable that returns a value
578 used for sorting or ordering. For example, :func:`locale.strxfrm` is
579 used to produce a sort key that is aware of locale specific sort
580 conventions.
581
582 A number of tools in Python accept key functions to control how elements
583 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700584 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
585 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
586 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000587
588 There are several ways to create a key function. For example. the
589 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700590 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000591 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200592 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000593 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
594 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
595 <sortinghowto>` for examples of how to create and use key functions.
596
Christian Heimesd8654cf2007-12-02 15:22:16 +0000597 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800598 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000599
600 lambda
601 An anonymous inline function consisting of a single :term:`expression`
602 which is evaluated when the function is called. The syntax to create
603 a lambda function is ``lambda [arguments]: expression``
604
Guido van Rossumf10aa982007-08-17 18:30:38 +0000605 LBYL
606 Look before you leap. This coding style explicitly tests for
607 pre-conditions before making calls or lookups. This style contrasts with
608 the :term:`EAFP` approach and is characterized by the presence of many
609 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000610
Raymond Hettinger09f44142010-12-17 20:19:50 +0000611 In a multi-threaded environment, the LBYL approach can risk introducing a
612 race condition between "the looking" and "the leaping". For example, the
613 code, ``if key in mapping: return mapping[key]`` can fail if another
614 thread removes *key* from *mapping* after the test, but before the lookup.
615 This issue can be solved with locks or by using the EAFP approach.
616
Benjamin Peterson5478b472008-09-17 22:25:09 +0000617 list
618 A built-in Python :term:`sequence`. Despite its name it is more akin
619 to an array in other languages than to a linked list since access to
620 elements are O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000621
Guido van Rossumf10aa982007-08-17 18:30:38 +0000622 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000623 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000624 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000625 range(256) if x % 2 == 0]`` generates a list of strings containing
626 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
627 clause is optional. If omitted, all elements in ``range(256)`` are
628 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000629
Brett Cannon51d4aab2009-01-25 04:21:39 +0000630 loader
631 An object that loads a module. It must define a method named
632 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000633 :term:`finder`. See :pep:`302` for details and
634 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000635
Guido van Rossumf10aa982007-08-17 18:30:38 +0000636 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000637 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200638 methods specified in the :class:`~collections.abc.Mapping` or
639 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200640 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
641 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000642 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000643
Barry Warsawd7d21942012-07-29 16:36:17 -0400644 meta path finder
Brett Cannonccddbb12015-12-04 15:46:21 -0800645 A :term:`finder` returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400646 finders are related to, but different from :term:`path entry finders
647 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400648
Brett Cannonccddbb12015-12-04 15:46:21 -0800649 See :class:`importlib.abc.MetaPathFinder` for the methods that meta path
650 finders implement.
651
Guido van Rossumf10aa982007-08-17 18:30:38 +0000652 metaclass
653 The class of a class. Class definitions create a class name, a class
654 dictionary, and a list of base classes. The metaclass is responsible for
655 taking those three arguments and creating the class. Most object oriented
656 programming languages provide a default implementation. What makes Python
657 special is that it is possible to create custom metaclasses. Most users
658 never need this tool, but when the need arises, metaclasses can provide
659 powerful, elegant solutions. They have been used for logging attribute
660 access, adding thread-safety, tracking object creation, implementing
661 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000662
663 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000664
665 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000666 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000667 of an instance of that class, the method will get the instance object as
668 its first :term:`argument` (which is usually called ``self``).
669 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000670
Michael Foord95fc51d2010-11-20 15:07:30 +0000671 method resolution order
672 Method Resolution Order is the order in which base classes are searched
673 for a member during lookup. See `The Python 2.3 Method Resolution Order
Senthil Kumaran3858a1c2016-01-09 22:33:54 -0800674 <https://www.python.org/download/releases/2.3/mro/>`_ for details of the
675 algorithm used by the Python interpreter since the 2.3 release.
Michael Foord95fc51d2010-11-20 15:07:30 +0000676
Barry Warsawd7d21942012-07-29 16:36:17 -0400677 module
678 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400679 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400680 into Python by the process of :term:`importing`.
681
Georg Brandlbcce1252013-10-08 08:06:18 +0200682 See also :term:`package`.
683
Eric Snowca2d8542013-12-16 23:06:52 -0700684 module spec
685 A namespace containing the import-related information used to load a
Brett Cannonccddbb12015-12-04 15:46:21 -0800686 module. An instance of :class:`importlib.machinery.ModuleSpec`.
Eric Snowca2d8542013-12-16 23:06:52 -0700687
Michael Foord95fc51d2010-11-20 15:07:30 +0000688 MRO
689 See :term:`method resolution order`.
690
Guido van Rossumf10aa982007-08-17 18:30:38 +0000691 mutable
692 Mutable objects can change their value but keep their :func:`id`. See
693 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000694
695 named tuple
Raymond Hettingerd04fa312009-02-04 19:45:13 +0000696 Any tuple-like class whose indexable elements are also accessible using
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000697 named attributes (for example, :func:`time.localtime` returns a
698 tuple-like object where the *year* is accessible either with an
699 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
700
701 A named tuple can be a built-in type such as :class:`time.struct_time`,
702 or it can be created with a regular class definition. A full featured
703 named tuple can also be created with the factory function
704 :func:`collections.namedtuple`. The latter approach automatically
705 provides extra features such as a self-documenting representation like
706 ``Employee(name='jones', title='programmer')``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000707
Guido van Rossumf10aa982007-08-17 18:30:38 +0000708 namespace
709 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000710 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000711 as nested namespaces in objects (in methods). Namespaces support
712 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300713 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
714 their namespaces. Namespaces also aid readability and maintainability by
715 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200716 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000717 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000718 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000719
Barry Warsawd7d21942012-07-29 16:36:17 -0400720 namespace package
721 A :pep:`420` :term:`package` which serves only as a container for
722 subpackages. Namespace packages may have no physical representation,
723 and specifically are not like a :term:`regular package` because they
724 have no ``__init__.py`` file.
725
Georg Brandlbcce1252013-10-08 08:06:18 +0200726 See also :term:`module`.
727
Guido van Rossumf10aa982007-08-17 18:30:38 +0000728 nested scope
729 The ability to refer to a variable in an enclosing definition. For
730 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000731 variables in the outer function. Note that nested scopes by default work
732 only for reference and not for assignment. Local variables both read and
733 write in the innermost scope. Likewise, global variables read and write
734 to the global namespace. The :keyword:`nonlocal` allows writing to outer
735 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000736
Guido van Rossumf10aa982007-08-17 18:30:38 +0000737 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000738 Old name for the flavor of classes now used for all class objects. In
739 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300740 versatile features like :attr:`~object.__slots__`, descriptors,
741 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000742
Benjamin Peterson5478b472008-09-17 22:25:09 +0000743 object
744 Any data with state (attributes or value) and defined behavior
745 (methods). Also the ultimate base class of any :term:`new-style
746 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000747
Barry Warsawd7d21942012-07-29 16:36:17 -0400748 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200749 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400750 subpackages. Technically, a package is a Python module with an
751 ``__path__`` attribute.
752
Georg Brandlbcce1252013-10-08 08:06:18 +0200753 See also :term:`regular package` and :term:`namespace package`.
754
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800755 parameter
756 A named entity in a :term:`function` (or method) definition that
757 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600758 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800759
760 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
761 either :term:`positionally <argument>` or as a :term:`keyword argument
762 <argument>`. This is the default kind of parameter, for example *foo*
763 and *bar* in the following::
764
765 def func(foo, bar=None): ...
766
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +0300767 .. _positional-only_parameter:
768
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800769 * :dfn:`positional-only`: specifies an argument that can be supplied only
770 by position. Python has no syntax for defining positional-only
771 parameters. However, some built-in functions have positional-only
772 parameters (e.g. :func:`abs`).
773
Zachary Waree1391a02013-11-22 13:58:34 -0600774 .. _keyword-only_parameter:
775
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800776 * :dfn:`keyword-only`: specifies an argument that can be supplied only
777 by keyword. Keyword-only parameters can be defined by including a
778 single var-positional parameter or bare ``*`` in the parameter list
779 of the function definition before them, for example *kw_only1* and
780 *kw_only2* in the following::
781
782 def func(arg, *, kw_only1, kw_only2): ...
783
784 * :dfn:`var-positional`: specifies that an arbitrary sequence of
785 positional arguments can be provided (in addition to any positional
786 arguments already accepted by other parameters). Such a parameter can
787 be defined by prepending the parameter name with ``*``, for example
788 *args* in the following::
789
790 def func(*args, **kwargs): ...
791
792 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
793 can be provided (in addition to any keyword arguments already accepted
794 by other parameters). Such a parameter can be defined by prepending
795 the parameter name with ``**``, for example *kwargs* in the example
796 above.
797
798 Parameters can specify both optional and required arguments, as well as
799 default values for some optional arguments.
800
801 See also the :term:`argument` glossary entry, the FAQ question on
802 :ref:`the difference between arguments and parameters
803 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
804 :ref:`function` section, and :pep:`362`.
805
Barry Warsawdadebab2012-07-31 16:03:09 -0400806 path entry
807 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000808 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400809
810 path entry finder
811 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
812 (i.e. a :term:`path entry hook`) which knows how to locate modules given
813 a :term:`path entry`.
814
Brett Cannonccddbb12015-12-04 15:46:21 -0800815 See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
816 finders implement.
817
Barry Warsawdadebab2012-07-31 16:03:09 -0400818 path entry hook
819 A callable on the :data:`sys.path_hook` list which returns a :term:`path
820 entry finder` if it knows how to find modules on a specific :term:`path
821 entry`.
822
Nick Coghlan1685db02012-08-20 13:49:08 +1000823 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400824 One of the default :term:`meta path finders <meta path finder>` which
825 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400826
Brett Cannonc28592b2016-06-24 12:21:47 -0700827 path-like object
828 An object representing a file system path. A path-like object is either
829 a :class:`str` or :class:`bytes` object representing a path, or an object
830 implementing the :class:`os.PathLike` protocol. An object that supports
831 the :class:`os.PathLike` protocol can be converted to a :class:`str` or
832 :class:`bytes` file system path by calling the :func:`os.fspath` function;
833 :func:`os.fsdecode` and :func:`os.fsencode` can be used to guarantee a
834 :class:`str` or :class:`bytes` result instead, respectively. Introduced
835 by :pep:`519`.
836
Barry Warsawd7d21942012-07-29 16:36:17 -0400837 portion
838 A set of files in a single directory (possibly stored in a zip file)
839 that contribute to a namespace package, as defined in :pep:`420`.
840
Christian Heimesd8654cf2007-12-02 15:22:16 +0000841 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800842 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000843
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000844 provisional API
845 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400846 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000847 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300848 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000849 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300850 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000851 fundamental flaws are uncovered that were missed prior to the inclusion
852 of the API.
853
854 Even for provisional APIs, backwards incompatible changes are seen as
855 a "solution of last resort" - every attempt will still be made to find
856 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300857
Barry Warsawd7d21942012-07-29 16:36:17 -0400858 This process allows the standard library to continue to evolve over
859 time, without locking in problematic design errors for extended periods
860 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300861
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000862 provisional package
863 See :term:`provisional API`.
864
Guido van Rossumf10aa982007-08-17 18:30:38 +0000865 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400866 Nickname for the Python 3.x release line (coined long ago when the
867 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000868 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000869
Christian Heimesd8654cf2007-12-02 15:22:16 +0000870 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000871 An idea or piece of code which closely follows the most common idioms
872 of the Python language, rather than implementing code using concepts
873 common to other languages. For example, a common idiom in Python is
874 to loop over all elements of an iterable using a :keyword:`for`
875 statement. Many other languages don't have this type of construct, so
876 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000877
Christian Heimesd8654cf2007-12-02 15:22:16 +0000878 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000879 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000880
881 As opposed to the cleaner, Pythonic method::
882
883 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000884 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000885
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100886 qualified name
887 A dotted name showing the "path" from a module's global scope to a
888 class, function or method defined in that module, as defined in
889 :pep:`3155`. For top-level functions and classes, the qualified name
890 is the same as the object's name::
891
892 >>> class C:
893 ... class D:
894 ... def meth(self):
895 ... pass
896 ...
897 >>> C.__qualname__
898 'C'
899 >>> C.D.__qualname__
900 'C.D'
901 >>> C.D.meth.__qualname__
902 'C.D.meth'
903
Barry Warsawd7d21942012-07-29 16:36:17 -0400904 When used to refer to modules, the *fully qualified name* means the
905 entire dotted path to the module, including any parent packages,
906 e.g. ``email.mime.text``::
907
908 >>> import email.mime.text
909 >>> email.mime.text.__name__
910 'email.mime.text'
911
Guido van Rossumf10aa982007-08-17 18:30:38 +0000912 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000913 The number of references to an object. When the reference count of an
914 object drops to zero, it is deallocated. Reference counting is
915 generally not visible to Python code, but it is a key element of the
916 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000917 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000918 reference count for a particular object.
919
Barry Warsawd7d21942012-07-29 16:36:17 -0400920 regular package
921 A traditional :term:`package`, such as a directory containing an
922 ``__init__.py`` file.
923
Georg Brandlbcce1252013-10-08 08:06:18 +0200924 See also :term:`namespace package`.
925
Guido van Rossumf10aa982007-08-17 18:30:38 +0000926 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +0000927 A declaration inside a class that saves memory by pre-declaring space for
928 instance attributes and eliminating instance dictionaries. Though
929 popular, the technique is somewhat tricky to get right and is best
930 reserved for rare cases where there are large numbers of instances in a
931 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +0000932
Guido van Rossumf10aa982007-08-17 18:30:38 +0000933 sequence
934 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +0000935 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +0300936 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000937 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +0000938 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +0000939 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
940 mapping rather than a sequence because the lookups use arbitrary
941 :term:`immutable` keys rather than integers.
942
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -0500943 The :class:`collections.abc.Sequence` abstract base class
944 defines a much richer interface that goes beyond just
945 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
946 :meth:`index`, :meth:`__contains__`, and
947 :meth:`__reversed__`. Types that implement this expanded
948 interface can be registered explicitly using
949 :func:`~abc.register`.
950
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200951 single dispatch
952 A form of :term:`generic function` dispatch where the implementation is
953 chosen based on the type of a single argument.
954
Christian Heimesd8654cf2007-12-02 15:22:16 +0000955 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +0000956 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +0000957 created using the subscript notation, ``[]`` with colons between numbers
958 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +0000959 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000960
Georg Brandlaf265f42008-12-07 15:06:20 +0000961 special method
962 A method that is called implicitly by Python to execute a certain
963 operation on a type, such as addition. Such methods have names starting
964 and ending with double underscores. Special methods are documented in
965 :ref:`specialnames`.
966
Christian Heimesd8654cf2007-12-02 15:22:16 +0000967 statement
968 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +0200969 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +0000970 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000971
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500972 struct sequence
Florent Xiclunaf8240d62011-11-11 19:58:53 +0100973 A tuple with named elements. Struct sequences expose an interface similar
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500974 to :term:`named tuple` in that elements can either be accessed either by
975 index or as an attribute. However, they do not have any of the named tuple
976 methods like :meth:`~collections.somenamedtuple._make` or
977 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
978 include :data:`sys.float_info` and the return value of :func:`os.stat`.
979
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +1000980 text encoding
981 A codec which encodes Unicode strings to bytes.
982
Antoine Pitroudd799d22013-12-05 23:46:32 +0100983 text file
984 A :term:`file object` able to read and write :class:`str` objects.
985 Often, a text file actually accesses a byte-oriented datastream
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +1000986 and handles the :term:`text encoding` automatically.
Serhiy Storchakac611a5b2017-03-12 08:53:22 +0200987 Examples of text files are files opened in text mode (``'r'`` or ``'w'``),
988 :data:`sys.stdin`, :data:`sys.stdout`, and instances of
989 :class:`io.StringIO`.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100990
991 .. seealso::
992 A :term:`binary file` reads and write :class:`bytes` objects.
993
Benjamin Peterson5478b472008-09-17 22:25:09 +0000994 triple-quoted string
995 A string which is bound by three instances of either a quotation mark
996 (") or an apostrophe ('). While they don't provide any functionality
997 not available with single-quoted strings, they are useful for a number
998 of reasons. They allow you to include unescaped single and double
999 quotes within a string and they can span multiple lines without the
1000 use of the continuation character, making them especially useful when
1001 writing docstrings.
1002
Guido van Rossumf10aa982007-08-17 18:30:38 +00001003 type
1004 The type of a Python object determines what kind of object it is; every
1005 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +03001006 :attr:`~instance.__class__` attribute or can be retrieved with
1007 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +00001008
R David Murray1b00f252012-08-15 10:43:58 -04001009 universal newlines
1010 A manner of interpreting text streams in which all of the following are
1011 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
1012 the Windows convention ``'\r\n'``, and the old Macintosh convention
1013 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -04001014 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -04001015
Yury Selivanovf8cb8a12016-09-08 20:50:03 -07001016 variable annotation
1017 A type metadata value associated with a module global variable or
1018 a class attribute. Its syntax is explained in section :ref:`annassign`.
1019 Annotations are stored in the :attr:`__annotations__` special
1020 attribute of a class or module object and can be accessed using
1021 :func:`typing.get_type_hints`.
1022
1023 Python itself does not assign any particular meaning to variable
1024 annotations. They are intended to be interpreted by third-party libraries
1025 or type checking tools. See :pep:`526`, :pep:`484` which describe
1026 some of their potential uses.
1027
Nick Coghlan1d520962014-09-06 20:38:23 +10001028 virtual environment
1029 A cooperatively isolated runtime environment that allows Python users
1030 and applications to install and upgrade Python distribution packages
1031 without interfering with the behaviour of other Python applications
1032 running on the same system.
1033
Brett Cannon15552c32016-07-08 10:46:21 -07001034 See also :mod:`venv`.
Nick Coghlan1d520962014-09-06 20:38:23 +10001035
Benjamin Peterson5478b472008-09-17 22:25:09 +00001036 virtual machine
1037 A computer defined entirely in software. Python's virtual machine
1038 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +00001039
Guido van Rossumf10aa982007-08-17 18:30:38 +00001040 Zen of Python
1041 Listing of Python design principles and philosophies that are helpful in
1042 understanding and using the language. The listing can be found by typing
1043 "``import this``" at the interactive prompt.