blob: 92877bd896a2f16d09b15a26df9d1a790894b428 [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
72 attribute
73 A value associated with an object which is referenced by name using
74 dotted expressions. For example, if an object *o* has an attribute
75 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +000076
Guido van Rossumf10aa982007-08-17 18:30:38 +000077 BDFL
78 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Georg Brandle73778c2014-10-29 08:36:35 +010079 <https://www.python.org/~guido/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +000080
Antoine Pitroudd799d22013-12-05 23:46:32 +010081 binary file
82 A :term:`file object` able to read and write
83 :term:`bytes-like objects <bytes-like object>`.
84
85 .. seealso::
86 A :term:`text file` reads and writes :class:`str` objects.
87
Ezio Melottiaa54e2f2013-04-30 23:33:31 +030088 bytes-like object
Antoine Pitrou5de183a2013-05-04 20:18:34 +020089 An object that supports the :ref:`bufferobjects`, like :class:`bytes`,
90 :class:`bytearray` or :class:`memoryview`. Bytes-like objects can
91 be used for various operations that expect binary data, such as
92 compression, saving to a binary file or sending over a socket.
93 Some operations need the binary data to be mutable, in which case
94 not all bytes-like objects can apply.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +030095
Georg Brandl9afde1c2007-11-01 20:32:30 +000096 bytecode
97 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +000098 of a Python program in the CPython interpreter. The bytecode is also
99 cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
100 faster the second time (recompilation from source to bytecode can be
101 avoided). This "intermediate language" is said to run on a
102 :term:`virtual machine` that executes the machine code corresponding to
103 each bytecode. Do note that bytecodes are not expected to work between
104 different Python virtual machines, nor to be stable between Python
105 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000106
Georg Brandl2cb72d32010-07-03 10:26:54 +0000107 A list of bytecode instructions can be found in the documentation for
108 :ref:`the dis module <bytecodes>`.
109
Benjamin Peterson5478b472008-09-17 22:25:09 +0000110 class
111 A template for creating user-defined objects. Class definitions
112 normally contain method definitions which operate on instances of the
113 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000114
Benjamin Peterson5478b472008-09-17 22:25:09 +0000115 coercion
116 The implicit conversion of an instance of one type to another during an
117 operation which involves two arguments of the same type. For example,
118 ``int(3.15)`` converts the floating point number to the integer ``3``, but
119 in ``3+4.5``, each argument is of a different type (one int, one float),
120 and both must be converted to the same type before they can be added or it
Benjamin Peterson2d718222008-11-21 00:25:02 +0000121 will raise a ``TypeError``. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000122 compatible types would have to be normalized to the same value by the
123 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000124
Guido van Rossumf10aa982007-08-17 18:30:38 +0000125 complex number
126 An extension of the familiar real number system in which all numbers are
127 expressed as a sum of a real part and an imaginary part. Imaginary
128 numbers are real multiples of the imaginary unit (the square root of
129 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000130 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000131 written with this latter notation; the imaginary part is written with a
132 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
133 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
134 advanced mathematical feature. If you're not aware of a need for them,
135 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000136
Christian Heimes895627f2007-12-08 17:28:33 +0000137 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000138 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000139 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
140 See :pep:`343`.
141
Benjamin Peterson5478b472008-09-17 22:25:09 +0000142 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000143 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100144 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000145 is used when necessary to distinguish this implementation from others
146 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000147
Christian Heimesd8654cf2007-12-02 15:22:16 +0000148 decorator
149 A function returning another function, usually applied as a function
150 transformation using the ``@wrapper`` syntax. Common examples for
151 decorators are :func:`classmethod` and :func:`staticmethod`.
152
153 The decorator syntax is merely syntactic sugar, the following two
154 function definitions are semantically equivalent::
155
156 def f(...):
157 ...
158 f = staticmethod(f)
159
160 @staticmethod
161 def f(...):
162 ...
163
Georg Brandlaf265f42008-12-07 15:06:20 +0000164 The same concept exists for classes, but is less commonly used there. See
165 the documentation for :ref:`function definitions <function>` and
166 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000167
Guido van Rossumf10aa982007-08-17 18:30:38 +0000168 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000169 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000170 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000171 binding behavior is triggered upon attribute lookup. Normally, using
172 *a.b* to get, set or delete an attribute looks up the object named *b* in
173 the class dictionary for *a*, but if *b* is a descriptor, the respective
174 descriptor method gets called. Understanding descriptors is a key to a
175 deep understanding of Python because they are the basis for many features
176 including functions, methods, properties, class methods, static methods,
177 and reference to super classes.
178
179 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000180
Guido van Rossumf10aa982007-08-17 18:30:38 +0000181 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700182 An associative array, where arbitrary keys are mapped to values. The
183 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
184 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000185
186 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000187 A string literal which appears as the first expression in a class,
188 function or module. While ignored when the suite is executed, it is
189 recognized by the compiler and put into the :attr:`__doc__` attribute
190 of the enclosing class, function or module. Since it is available via
191 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000192 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000193
194 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000195 A programming style which does not look at an object's type to determine
196 if it has the right interface; instead, the method or attribute is simply
197 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000198 must be a duck.") By emphasizing interfaces rather than specific types,
199 well-designed code improves its flexibility by allowing polymorphic
200 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000201 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200202 with :term:`abstract base classes <abstract base class>`.) Instead, it
203 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000204
Guido van Rossumf10aa982007-08-17 18:30:38 +0000205 EAFP
206 Easier to ask for forgiveness than permission. This common Python coding
207 style assumes the existence of valid keys or attributes and catches
208 exceptions if the assumption proves false. This clean and fast style is
209 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000210 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000211 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000212
Christian Heimesd8654cf2007-12-02 15:22:16 +0000213 expression
214 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000215 an expression is an accumulation of expression elements like literals,
216 names, attribute access, operators or function calls which all return a
217 value. In contrast to many other languages, not all language constructs
218 are expressions. There are also :term:`statement`\s which cannot be used
219 as expressions, such as :keyword:`if`. Assignments are also statements,
220 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000221
Guido van Rossumf10aa982007-08-17 18:30:38 +0000222 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000223 A module written in C or C++, using Python's C API to interact with the
224 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000225
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000226 file object
227 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000228 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
229 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300230 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000231 (for example standard input/output, in-memory buffers, sockets, pipes,
232 etc.). File objects are also called :dfn:`file-like objects` or
233 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000234
Antoine Pitroudd799d22013-12-05 23:46:32 +0100235 There are actually three categories of file objects: raw
236 :term:`binary files <binary file>`, buffered
237 :term:`binary files <binary file>` and :term:`text files <text file>`.
238 Their interfaces are defined in the :mod:`io` module. The canonical
239 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000240
241 file-like object
242 A synonym for :term:`file object`.
243
Brett Cannon51d4aab2009-01-25 04:21:39 +0000244 finder
245 An object that tries to find the :term:`loader` for a module. It must
Barry Warsawd7d21942012-07-29 16:36:17 -0400246 implement either a method named :meth:`find_loader` or a method named
247 :meth:`find_module`. See :pep:`302` and :pep:`420` for details and
248 :class:`importlib.abc.Finder` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000249
Benjamin Peterson2d718222008-11-21 00:25:02 +0000250 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000251 Mathematical division that rounds down to nearest integer. The floor
252 division operator is ``//``. For example, the expression ``11 // 4``
253 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
254 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
255 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000256
Christian Heimesd8654cf2007-12-02 15:22:16 +0000257 function
258 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800259 be passed zero or more :term:`arguments <argument>` which may be used in
260 the execution of the body. See also :term:`parameter`, :term:`method`,
261 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000262
R David Murray25cd0912013-05-06 12:58:16 -0400263 function annotation
264 An arbitrary metadata value associated with a function parameter or return
265 value. Its syntax is explained in section :ref:`function`. Annotations
266 may be accessed via the :attr:`__annotations__` special attribute of a
267 function object.
268
269 Python itself does not assign any particular meaning to function
270 annotations. They are intended to be interpreted by third-party libraries
271 or tools. See :pep:`3107`, which describes some of their potential uses.
272
Guido van Rossumf10aa982007-08-17 18:30:38 +0000273 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000274 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000275 which are not compatible with the current interpreter.
276
277 By importing the :mod:`__future__` module and evaluating its variables,
278 you can see when a new feature was first added to the language and when it
279 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000280
Guido van Rossumf10aa982007-08-17 18:30:38 +0000281 >>> import __future__
282 >>> __future__.division
283 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
284
285 garbage collection
286 The process of freeing memory when it is not used anymore. Python
287 performs garbage collection via reference counting and a cyclic garbage
288 collector that is able to detect and break reference cycles.
Georg Brandl48310cd2009-01-03 21:18:54 +0000289
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000290 .. index:: single: generator
291
Guido van Rossumf10aa982007-08-17 18:30:38 +0000292 generator
Benjamin Peterson5478b472008-09-17 22:25:09 +0000293 A function which returns an iterator. It looks like a normal function
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000294 except that it contains :keyword:`yield` statements for producing a series
295 a values usable in a for-loop or that can be retrieved one at a time with
296 the :func:`next` function. Each :keyword:`yield` temporarily suspends
297 processing, remembering the location execution state (including local
298 variables and pending try-statements). When the generator resumes, it
299 picks-up where it left-off (in contrast to functions which start fresh on
Éric Araujoe0854f92011-05-27 04:36:52 +0200300 every invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000301
Guido van Rossumf10aa982007-08-17 18:30:38 +0000302 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000303
Guido van Rossumf10aa982007-08-17 18:30:38 +0000304 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000305 An expression that returns an iterator. It looks like a normal expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000306 followed by a :keyword:`for` expression defining a loop variable, range,
307 and an optional :keyword:`if` expression. The combined expression
308 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000309
Guido van Rossumf10aa982007-08-17 18:30:38 +0000310 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
311 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000312
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200313 generic function
314 A function composed of multiple functions implementing the same operation
315 for different types. Which implementation should be used during a call is
316 determined by the dispatch algorithm.
317
318 See also the :term:`single dispatch` glossary entry, the
319 :func:`functools.singledispatch` decorator, and :pep:`443`.
320
321
Guido van Rossumf10aa982007-08-17 18:30:38 +0000322 GIL
323 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000324
Guido van Rossumf10aa982007-08-17 18:30:38 +0000325 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000326 The mechanism used by the :term:`CPython` interpreter to assure that
327 only one thread executes Python :term:`bytecode` at a time.
328 This simplifies the CPython implementation by making the object model
329 (including critical built-in types such as :class:`dict`) implicitly
330 safe against concurrent access. Locking the entire interpreter
331 makes it easier for the interpreter to be multi-threaded, at the
332 expense of much of the parallelism afforded by multi-processor
333 machines.
334
335 However, some extension modules, either standard or third-party,
336 are designed so as to release the GIL when doing computationally-intensive
337 tasks such as compression or hashing. Also, the GIL is always released
338 when doing I/O.
339
340 Past efforts to create a "free-threaded" interpreter (one which locks
341 shared data at a much finer granularity) have not been successful
342 because performance suffered in the common single-processor case. It
343 is believed that overcoming this performance issue would make the
344 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000345
346 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000347 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000348 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000349 other objects (it needs an :meth:`__eq__` method). Hashable objects which
350 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000351
352 Hashability makes an object usable as a dictionary key and a set member,
353 because these data structures use the hash value internally.
354
Benjamin Peterson5478b472008-09-17 22:25:09 +0000355 All of Python's immutable built-in objects are hashable, while no mutable
356 containers (such as lists or dictionaries) are. Objects which are
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000357 instances of user-defined classes are hashable by default; they all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200358 compare unequal (except with themselves), and their hash value is derived
359 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000360
Guido van Rossumf10aa982007-08-17 18:30:38 +0000361 IDLE
362 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000363 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000364 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000365
Guido van Rossumf10aa982007-08-17 18:30:38 +0000366 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000367 An object with a fixed value. Immutable objects include numbers, strings and
368 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000369 be created if a different value has to be stored. They play an important
370 role in places where a constant hash value is needed, for example as a key
371 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000372
Barry Warsawdadebab2012-07-31 16:03:09 -0400373 import path
374 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000375 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400376 import, this list of locations usually comes from :data:`sys.path`, but
377 for subpackages it may also come from the parent package's ``__path__``
378 attribute.
379
Barry Warsawd7d21942012-07-29 16:36:17 -0400380 importing
381 The process by which Python code in one module is made available to
382 Python code in another module.
383
Brett Cannon51d4aab2009-01-25 04:21:39 +0000384 importer
385 An object that both finds and loads a module; both a
386 :term:`finder` and :term:`loader` object.
387
Guido van Rossumf10aa982007-08-17 18:30:38 +0000388 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000389 Python has an interactive interpreter which means you can enter
390 statements and expressions at the interpreter prompt, immediately
391 execute them and see their results. Just launch ``python`` with no
392 arguments (possibly by selecting it from your computer's main
393 menu). It is a very powerful way to test out new ideas or inspect
394 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000395
Guido van Rossumf10aa982007-08-17 18:30:38 +0000396 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000397 Python is an interpreted language, as opposed to a compiled one,
398 though the distinction can be blurry because of the presence of the
399 bytecode compiler. This means that source files can be run directly
400 without explicitly creating an executable which is then run.
401 Interpreted languages typically have a shorter development/debug cycle
402 than compiled ones, though their programs generally also run more
403 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000404
Guido van Rossumf10aa982007-08-17 18:30:38 +0000405 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200406 An object capable of returning its members one at a time. Examples of
407 iterables include all sequence types (such as :class:`list`, :class:`str`,
408 and :class:`tuple`) and some non-sequence types like :class:`dict`,
409 :term:`file objects <file object>`, and objects of any classes you define
410 with an :meth:`__iter__` or :meth:`__getitem__` method. Iterables can be
411 used in a :keyword:`for` loop and in many other places where a sequence is
412 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
413 as an argument to the built-in function :func:`iter`, it returns an
414 iterator for the object. This iterator is good for one pass over the set
415 of values. When using iterables, it is usually not necessary to call
416 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000417 statement does that automatically for you, creating a temporary unnamed
418 variable to hold the iterator for the duration of the loop. See also
419 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000420
Guido van Rossumf10aa982007-08-17 18:30:38 +0000421 iterator
422 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300423 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000424 :func:`next`) return successive items in the stream. When no more data
425 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000426 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000427 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
428 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000429 object itself so every iterator is also iterable and may be used in most
430 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000431 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000432 :class:`list`) produces a fresh new iterator each time you pass it to the
433 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
434 with an iterator will just return the same exhausted iterator object used
435 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000436
Georg Brandl9afde1c2007-11-01 20:32:30 +0000437 More information can be found in :ref:`typeiter`.
438
Georg Brandlc275e152010-11-05 07:10:41 +0000439 key function
440 A key function or collation function is a callable that returns a value
441 used for sorting or ordering. For example, :func:`locale.strxfrm` is
442 used to produce a sort key that is aware of locale specific sort
443 conventions.
444
445 A number of tools in Python accept key functions to control how elements
446 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700447 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
448 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
449 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000450
451 There are several ways to create a key function. For example. the
452 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700453 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000454 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200455 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000456 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
457 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
458 <sortinghowto>` for examples of how to create and use key functions.
459
Christian Heimesd8654cf2007-12-02 15:22:16 +0000460 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800461 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000462
463 lambda
464 An anonymous inline function consisting of a single :term:`expression`
465 which is evaluated when the function is called. The syntax to create
466 a lambda function is ``lambda [arguments]: expression``
467
Guido van Rossumf10aa982007-08-17 18:30:38 +0000468 LBYL
469 Look before you leap. This coding style explicitly tests for
470 pre-conditions before making calls or lookups. This style contrasts with
471 the :term:`EAFP` approach and is characterized by the presence of many
472 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000473
Raymond Hettinger09f44142010-12-17 20:19:50 +0000474 In a multi-threaded environment, the LBYL approach can risk introducing a
475 race condition between "the looking" and "the leaping". For example, the
476 code, ``if key in mapping: return mapping[key]`` can fail if another
477 thread removes *key* from *mapping* after the test, but before the lookup.
478 This issue can be solved with locks or by using the EAFP approach.
479
Benjamin Peterson5478b472008-09-17 22:25:09 +0000480 list
481 A built-in Python :term:`sequence`. Despite its name it is more akin
482 to an array in other languages than to a linked list since access to
483 elements are O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000484
Guido van Rossumf10aa982007-08-17 18:30:38 +0000485 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000486 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000487 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000488 range(256) if x % 2 == 0]`` generates a list of strings containing
489 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
490 clause is optional. If omitted, all elements in ``range(256)`` are
491 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000492
Brett Cannon51d4aab2009-01-25 04:21:39 +0000493 loader
494 An object that loads a module. It must define a method named
495 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000496 :term:`finder`. See :pep:`302` for details and
497 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000498
Guido van Rossumf10aa982007-08-17 18:30:38 +0000499 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000500 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200501 methods specified in the :class:`~collections.abc.Mapping` or
502 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200503 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
504 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000505 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000506
Barry Warsawd7d21942012-07-29 16:36:17 -0400507 meta path finder
508 A finder returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400509 finders are related to, but different from :term:`path entry finders
510 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400511
Guido van Rossumf10aa982007-08-17 18:30:38 +0000512 metaclass
513 The class of a class. Class definitions create a class name, a class
514 dictionary, and a list of base classes. The metaclass is responsible for
515 taking those three arguments and creating the class. Most object oriented
516 programming languages provide a default implementation. What makes Python
517 special is that it is possible to create custom metaclasses. Most users
518 never need this tool, but when the need arises, metaclasses can provide
519 powerful, elegant solutions. They have been used for logging attribute
520 access, adding thread-safety, tracking object creation, implementing
521 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000522
523 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000524
525 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000526 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000527 of an instance of that class, the method will get the instance object as
528 its first :term:`argument` (which is usually called ``self``).
529 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000530
Michael Foord95fc51d2010-11-20 15:07:30 +0000531 method resolution order
532 Method Resolution Order is the order in which base classes are searched
533 for a member during lookup. See `The Python 2.3 Method Resolution Order
Georg Brandle73778c2014-10-29 08:36:35 +0100534 <https://www.python.org/download/releases/2.3/mro/>`_.
Michael Foord95fc51d2010-11-20 15:07:30 +0000535
Barry Warsawd7d21942012-07-29 16:36:17 -0400536 module
537 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400538 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400539 into Python by the process of :term:`importing`.
540
Georg Brandlbcce1252013-10-08 08:06:18 +0200541 See also :term:`package`.
542
Eric Snowca2d8542013-12-16 23:06:52 -0700543 module spec
544 A namespace containing the import-related information used to load a
545 module.
546
Michael Foord95fc51d2010-11-20 15:07:30 +0000547 MRO
548 See :term:`method resolution order`.
549
Guido van Rossumf10aa982007-08-17 18:30:38 +0000550 mutable
551 Mutable objects can change their value but keep their :func:`id`. See
552 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000553
554 named tuple
Raymond Hettingerd04fa312009-02-04 19:45:13 +0000555 Any tuple-like class whose indexable elements are also accessible using
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000556 named attributes (for example, :func:`time.localtime` returns a
557 tuple-like object where the *year* is accessible either with an
558 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
559
560 A named tuple can be a built-in type such as :class:`time.struct_time`,
561 or it can be created with a regular class definition. A full featured
562 named tuple can also be created with the factory function
563 :func:`collections.namedtuple`. The latter approach automatically
564 provides extra features such as a self-documenting representation like
565 ``Employee(name='jones', title='programmer')``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000566
Guido van Rossumf10aa982007-08-17 18:30:38 +0000567 namespace
568 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000569 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000570 as nested namespaces in objects (in methods). Namespaces support
571 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300572 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
573 their namespaces. Namespaces also aid readability and maintainability by
574 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200575 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000576 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000577 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000578
Barry Warsawd7d21942012-07-29 16:36:17 -0400579 namespace package
580 A :pep:`420` :term:`package` which serves only as a container for
581 subpackages. Namespace packages may have no physical representation,
582 and specifically are not like a :term:`regular package` because they
583 have no ``__init__.py`` file.
584
Georg Brandlbcce1252013-10-08 08:06:18 +0200585 See also :term:`module`.
586
Guido van Rossumf10aa982007-08-17 18:30:38 +0000587 nested scope
588 The ability to refer to a variable in an enclosing definition. For
589 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000590 variables in the outer function. Note that nested scopes by default work
591 only for reference and not for assignment. Local variables both read and
592 write in the innermost scope. Likewise, global variables read and write
593 to the global namespace. The :keyword:`nonlocal` allows writing to outer
594 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000595
Guido van Rossumf10aa982007-08-17 18:30:38 +0000596 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000597 Old name for the flavor of classes now used for all class objects. In
598 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300599 versatile features like :attr:`~object.__slots__`, descriptors,
600 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000601
Benjamin Peterson5478b472008-09-17 22:25:09 +0000602 object
603 Any data with state (attributes or value) and defined behavior
604 (methods). Also the ultimate base class of any :term:`new-style
605 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000606
Barry Warsawd7d21942012-07-29 16:36:17 -0400607 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200608 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400609 subpackages. Technically, a package is a Python module with an
610 ``__path__`` attribute.
611
Georg Brandlbcce1252013-10-08 08:06:18 +0200612 See also :term:`regular package` and :term:`namespace package`.
613
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800614 parameter
615 A named entity in a :term:`function` (or method) definition that
616 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600617 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800618
619 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
620 either :term:`positionally <argument>` or as a :term:`keyword argument
621 <argument>`. This is the default kind of parameter, for example *foo*
622 and *bar* in the following::
623
624 def func(foo, bar=None): ...
625
626 * :dfn:`positional-only`: specifies an argument that can be supplied only
627 by position. Python has no syntax for defining positional-only
628 parameters. However, some built-in functions have positional-only
629 parameters (e.g. :func:`abs`).
630
Zachary Waree1391a02013-11-22 13:58:34 -0600631 .. _keyword-only_parameter:
632
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800633 * :dfn:`keyword-only`: specifies an argument that can be supplied only
634 by keyword. Keyword-only parameters can be defined by including a
635 single var-positional parameter or bare ``*`` in the parameter list
636 of the function definition before them, for example *kw_only1* and
637 *kw_only2* in the following::
638
639 def func(arg, *, kw_only1, kw_only2): ...
640
641 * :dfn:`var-positional`: specifies that an arbitrary sequence of
642 positional arguments can be provided (in addition to any positional
643 arguments already accepted by other parameters). Such a parameter can
644 be defined by prepending the parameter name with ``*``, for example
645 *args* in the following::
646
647 def func(*args, **kwargs): ...
648
649 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
650 can be provided (in addition to any keyword arguments already accepted
651 by other parameters). Such a parameter can be defined by prepending
652 the parameter name with ``**``, for example *kwargs* in the example
653 above.
654
655 Parameters can specify both optional and required arguments, as well as
656 default values for some optional arguments.
657
658 See also the :term:`argument` glossary entry, the FAQ question on
659 :ref:`the difference between arguments and parameters
660 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
661 :ref:`function` section, and :pep:`362`.
662
Barry Warsawdadebab2012-07-31 16:03:09 -0400663 path entry
664 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000665 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400666
667 path entry finder
668 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
669 (i.e. a :term:`path entry hook`) which knows how to locate modules given
670 a :term:`path entry`.
671
672 path entry hook
673 A callable on the :data:`sys.path_hook` list which returns a :term:`path
674 entry finder` if it knows how to find modules on a specific :term:`path
675 entry`.
676
Nick Coghlan1685db02012-08-20 13:49:08 +1000677 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400678 One of the default :term:`meta path finders <meta path finder>` which
679 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400680
681 portion
682 A set of files in a single directory (possibly stored in a zip file)
683 that contribute to a namespace package, as defined in :pep:`420`.
684
Christian Heimesd8654cf2007-12-02 15:22:16 +0000685 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800686 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000687
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000688 provisional API
689 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400690 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000691 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300692 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000693 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300694 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000695 fundamental flaws are uncovered that were missed prior to the inclusion
696 of the API.
697
698 Even for provisional APIs, backwards incompatible changes are seen as
699 a "solution of last resort" - every attempt will still be made to find
700 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300701
Barry Warsawd7d21942012-07-29 16:36:17 -0400702 This process allows the standard library to continue to evolve over
703 time, without locking in problematic design errors for extended periods
704 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300705
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000706 provisional package
707 See :term:`provisional API`.
708
Guido van Rossumf10aa982007-08-17 18:30:38 +0000709 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400710 Nickname for the Python 3.x release line (coined long ago when the
711 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000712 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000713
Christian Heimesd8654cf2007-12-02 15:22:16 +0000714 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000715 An idea or piece of code which closely follows the most common idioms
716 of the Python language, rather than implementing code using concepts
717 common to other languages. For example, a common idiom in Python is
718 to loop over all elements of an iterable using a :keyword:`for`
719 statement. Many other languages don't have this type of construct, so
720 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000721
Christian Heimesd8654cf2007-12-02 15:22:16 +0000722 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000723 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000724
725 As opposed to the cleaner, Pythonic method::
726
727 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000728 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000729
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100730 qualified name
731 A dotted name showing the "path" from a module's global scope to a
732 class, function or method defined in that module, as defined in
733 :pep:`3155`. For top-level functions and classes, the qualified name
734 is the same as the object's name::
735
736 >>> class C:
737 ... class D:
738 ... def meth(self):
739 ... pass
740 ...
741 >>> C.__qualname__
742 'C'
743 >>> C.D.__qualname__
744 'C.D'
745 >>> C.D.meth.__qualname__
746 'C.D.meth'
747
Barry Warsawd7d21942012-07-29 16:36:17 -0400748 When used to refer to modules, the *fully qualified name* means the
749 entire dotted path to the module, including any parent packages,
750 e.g. ``email.mime.text``::
751
752 >>> import email.mime.text
753 >>> email.mime.text.__name__
754 'email.mime.text'
755
Guido van Rossumf10aa982007-08-17 18:30:38 +0000756 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000757 The number of references to an object. When the reference count of an
758 object drops to zero, it is deallocated. Reference counting is
759 generally not visible to Python code, but it is a key element of the
760 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000761 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000762 reference count for a particular object.
763
Barry Warsawd7d21942012-07-29 16:36:17 -0400764 regular package
765 A traditional :term:`package`, such as a directory containing an
766 ``__init__.py`` file.
767
Georg Brandlbcce1252013-10-08 08:06:18 +0200768 See also :term:`namespace package`.
769
Guido van Rossumf10aa982007-08-17 18:30:38 +0000770 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +0000771 A declaration inside a class that saves memory by pre-declaring space for
772 instance attributes and eliminating instance dictionaries. Though
773 popular, the technique is somewhat tricky to get right and is best
774 reserved for rare cases where there are large numbers of instances in a
775 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +0000776
Guido van Rossumf10aa982007-08-17 18:30:38 +0000777 sequence
778 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +0000779 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +0300780 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000781 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +0000782 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +0000783 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
784 mapping rather than a sequence because the lookups use arbitrary
785 :term:`immutable` keys rather than integers.
786
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -0500787 The :class:`collections.abc.Sequence` abstract base class
788 defines a much richer interface that goes beyond just
789 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
790 :meth:`index`, :meth:`__contains__`, and
791 :meth:`__reversed__`. Types that implement this expanded
792 interface can be registered explicitly using
793 :func:`~abc.register`.
794
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200795 single dispatch
796 A form of :term:`generic function` dispatch where the implementation is
797 chosen based on the type of a single argument.
798
Christian Heimesd8654cf2007-12-02 15:22:16 +0000799 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +0000800 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +0000801 created using the subscript notation, ``[]`` with colons between numbers
802 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +0000803 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000804
Georg Brandlaf265f42008-12-07 15:06:20 +0000805 special method
806 A method that is called implicitly by Python to execute a certain
807 operation on a type, such as addition. Such methods have names starting
808 and ending with double underscores. Special methods are documented in
809 :ref:`specialnames`.
810
Christian Heimesd8654cf2007-12-02 15:22:16 +0000811 statement
812 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +0200813 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +0000814 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000815
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500816 struct sequence
Florent Xiclunaf8240d62011-11-11 19:58:53 +0100817 A tuple with named elements. Struct sequences expose an interface similar
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500818 to :term:`named tuple` in that elements can either be accessed either by
819 index or as an attribute. However, they do not have any of the named tuple
820 methods like :meth:`~collections.somenamedtuple._make` or
821 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
822 include :data:`sys.float_info` and the return value of :func:`os.stat`.
823
Antoine Pitroudd799d22013-12-05 23:46:32 +0100824 text file
825 A :term:`file object` able to read and write :class:`str` objects.
826 Often, a text file actually accesses a byte-oriented datastream
827 and handles the text encoding automatically.
828
829 .. seealso::
830 A :term:`binary file` reads and write :class:`bytes` objects.
831
Benjamin Peterson5478b472008-09-17 22:25:09 +0000832 triple-quoted string
833 A string which is bound by three instances of either a quotation mark
834 (") or an apostrophe ('). While they don't provide any functionality
835 not available with single-quoted strings, they are useful for a number
836 of reasons. They allow you to include unescaped single and double
837 quotes within a string and they can span multiple lines without the
838 use of the continuation character, making them especially useful when
839 writing docstrings.
840
Guido van Rossumf10aa982007-08-17 18:30:38 +0000841 type
842 The type of a Python object determines what kind of object it is; every
843 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300844 :attr:`~instance.__class__` attribute or can be retrieved with
845 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000846
R David Murray1b00f252012-08-15 10:43:58 -0400847 universal newlines
848 A manner of interpreting text streams in which all of the following are
849 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
850 the Windows convention ``'\r\n'``, and the old Macintosh convention
851 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -0400852 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -0400853
Benjamin Peterson656aa282008-11-21 23:22:00 +0000854 view
Ezio Melotti619de8f2009-06-25 18:39:31 +0000855 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
Benjamin Peterson656aa282008-11-21 23:22:00 +0000856 :meth:`dict.items` are called dictionary views. They are lazy sequences
857 that will see changes in the underlying dictionary. To force the
858 dictionary view to become a full list use ``list(dictview)``. See
859 :ref:`dict-views`.
860
Nick Coghlan1d520962014-09-06 20:38:23 +1000861 virtual environment
862 A cooperatively isolated runtime environment that allows Python users
863 and applications to install and upgrade Python distribution packages
864 without interfering with the behaviour of other Python applications
865 running on the same system.
866
867 See also :ref:`scripts-pyvenv`
868
Benjamin Peterson5478b472008-09-17 22:25:09 +0000869 virtual machine
870 A computer defined entirely in software. Python's virtual machine
871 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +0000872
Guido van Rossumf10aa982007-08-17 18:30:38 +0000873 Zen of Python
874 Listing of Python design principles and philosophies that are helpful in
875 understanding and using the language. The listing can be found by typing
876 "``import this``" at the interactive prompt.