blob: 392a60cd94c11682bd63207f765d71944a477810 [file] [log] [blame]
Georg Brandl437e6a32007-08-17 06:27:11 +00001.. _glossary:
2
3********
4Glossary
5********
6
7.. if you add new entries, keep the alphabetical sorting!
8
9.. glossary::
10
11 ``>>>``
Skip Montanarof02c5f32008-09-15 02:03:05 +000012 The default Python prompt of the interactive shell. Often seen for code
13 examples which can be executed interactively in the interpreter.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000014
Georg Brandl437e6a32007-08-17 06:27:11 +000015 ``...``
Skip Montanarof02c5f32008-09-15 02:03:05 +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).
Georg Brandl584265b2007-12-02 14:58:50 +000019
Georg Brandl5a42ca62008-05-20 07:20:12 +000020 2to3
21 A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl09302282010-10-06 09:32:48 +000022 handling most of the incompatibilities which can be detected by parsing the
Georg Brandl5a42ca62008-05-20 07:20:12 +000023 source and traversing the parse tree.
24
25 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
Benjamin Peterson40202212008-07-24 02:45:37 +000026 entry point is provided as :file:`Tools/scripts/2to3`. See
27 :ref:`2to3-reference`.
Georg Brandl5a42ca62008-05-20 07:20:12 +000028
Benjamin Peterson9385b9d2008-07-03 12:57:35 +000029 abstract base class
Éric Araujo8fde9502011-07-29 11:34:17 +020030 Abstract base classes complement :term:`duck-typing` by
Georg Brandld7d4fd72009-07-26 14:37:28 +000031 providing a way to define interfaces when other techniques like
Éric Araujo8fde9502011-07-29 11:34:17 +020032 :func:`hasattr` would be clumsy or subtly wrong (for example with
Éric Araujoe0054c52011-08-19 09:15:47 +020033 :ref:`magic methods <new-style-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
Georg Brandld7d4fd72009-07-26 14:37:28 +000037 data structures (in the :mod:`collections` module), numbers (in the
38 :mod:`numbers` module), and streams (in the :mod:`io` module). You can
Éric Araujo8fde9502011-07-29 11:34:17 +020039 create your own ABCs with the :mod:`abc` module.
Benjamin Petersonaac51b82008-07-01 23:33:06 +000040
Georg Brandl584265b2007-12-02 14:58:50 +000041 argument
Chris Jerdonek8da82682012-11-29 19:03:37 -080042 A value passed to a :term:`function` (or :term:`method`) when calling the
43 function. There are two types of arguments:
Georg Brandl584265b2007-12-02 14:58:50 +000044
Chris Jerdonek8da82682012-11-29 19:03:37 -080045 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
46 ``name=``) in a function call or passed as a value in a dictionary
47 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
48 arguments in the following calls to :func:`complex`::
49
50 complex(real=3, imag=5)
51 complex(**{'real': 3, 'imag': 5})
52
53 * :dfn:`positional argument`: an argument that is not a keyword argument.
54 Positional arguments can appear at the beginning of an argument list
55 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
56 For example, ``3`` and ``5`` are both positional arguments in the
57 following calls::
58
59 complex(3, 5)
60 complex(*(3, 5))
61
62 Arguments are assigned to the named local variables in a function body.
63 See the :ref:`calls` section for the rules governing this assignment.
64 Syntactically, any expression can be used to represent an argument; the
65 evaluated value is assigned to the local variable.
66
67 See also the :term:`parameter` glossary entry and the FAQ question on
68 :ref:`the difference between arguments and parameters
69 <faq-argument-vs-parameter>`.
Skip Montanaro9feab312008-09-15 02:19:53 +000070
71 attribute
72 A value associated with an object which is referenced by name using
73 dotted expressions. For example, if an object *o* has an attribute
74 *a* it would be referenced as *o.a*.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000075
Georg Brandl437e6a32007-08-17 06:27:11 +000076 BDFL
77 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
78 <http://www.python.org/~guido/>`_, Python's creator.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000079
Georg Brandl63fa1682007-10-21 10:24:20 +000080 bytecode
81 Python source code is compiled into bytecode, the internal representation
Éric Araujoa8f66dd2011-08-19 01:27:00 +020082 of a Python program in the CPython interpreter. The bytecode is also
83 cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
84 faster the second time (recompilation from source to bytecode can be
85 avoided). This "intermediate language" is said to run on a
86 :term:`virtual machine` that executes the machine code corresponding to
87 each bytecode. Do note that bytecodes are not expected to work between
88 different Python virtual machines, nor to be stable between Python
89 releases.
Skip Montanaro9feab312008-09-15 02:19:53 +000090
Georg Brandl2b4eda42010-07-03 10:25:54 +000091 A list of bytecode instructions can be found in the documentation for
92 :ref:`the dis module <bytecodes>`.
93
Skip Montanaro9feab312008-09-15 02:19:53 +000094 class
95 A template for creating user-defined objects. Class definitions
96 normally contain method definitions which operate on instances of the
97 class.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000098
Georg Brandl437e6a32007-08-17 06:27:11 +000099 classic class
100 Any class which does not inherit from :class:`object`. See
Ezio Melotti510ff542012-05-03 19:21:40 +0300101 :term:`new-style class`. Classic classes have been removed in Python 3.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000102
Georg Brandl437e6a32007-08-17 06:27:11 +0000103 coercion
104 The implicit conversion of an instance of one type to another during an
105 operation which involves two arguments of the same type. For example,
106 ``int(3.15)`` converts the floating point number to the integer ``3``, but
107 in ``3+4.5``, each argument is of a different type (one int, one float),
108 and both must be converted to the same type before they can be added or it
109 will raise a ``TypeError``. Coercion between two operands can be
Georg Brandld7d4fd72009-07-26 14:37:28 +0000110 performed with the ``coerce`` built-in function; thus, ``3+4.5`` is
Georg Brandl437e6a32007-08-17 06:27:11 +0000111 equivalent to calling ``operator.add(*coerce(3, 4.5))`` and results in
112 ``operator.add(3.0, 4.5)``. Without coercion, all arguments of even
113 compatible types would have to be normalized to the same value by the
114 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000115
Georg Brandl437e6a32007-08-17 06:27:11 +0000116 complex number
117 An extension of the familiar real number system in which all numbers are
118 expressed as a sum of a real part and an imaginary part. Imaginary
119 numbers are real multiples of the imaginary unit (the square root of
120 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandld7d4fd72009-07-26 14:37:28 +0000121 engineering. Python has built-in support for complex numbers, which are
Georg Brandl437e6a32007-08-17 06:27:11 +0000122 written with this latter notation; the imaginary part is written with a
123 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
124 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
125 advanced mathematical feature. If you're not aware of a need for them,
126 it's almost certain you can safely ignore them.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000127
Skip Montanaroffe455c2007-12-08 15:23:31 +0000128 context manager
Skip Montanarof02c5f32008-09-15 02:03:05 +0000129 An object which controls the environment seen in a :keyword:`with`
Skip Montanaroffe455c2007-12-08 15:23:31 +0000130 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
131 See :pep:`343`.
132
Skip Montanarof02c5f32008-09-15 02:03:05 +0000133 CPython
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000134 The canonical implementation of the Python programming language, as
135 distributed on `python.org <http://python.org>`_. The term "CPython"
136 is used when necessary to distinguish this implementation from others
137 such as Jython or IronPython.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000138
Georg Brandl584265b2007-12-02 14:58:50 +0000139 decorator
140 A function returning another function, usually applied as a function
141 transformation using the ``@wrapper`` syntax. Common examples for
142 decorators are :func:`classmethod` and :func:`staticmethod`.
143
144 The decorator syntax is merely syntactic sugar, the following two
145 function definitions are semantically equivalent::
146
147 def f(...):
148 ...
149 f = staticmethod(f)
150
151 @staticmethod
152 def f(...):
153 ...
154
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200155 The same concept exists for classes, but is less commonly used there. See
156 the documentation for :ref:`function definitions <function>` and
157 :ref:`class definitions <class>` for more about decorators.
Georg Brandl5066c0c2008-12-05 18:00:06 +0000158
Georg Brandl437e6a32007-08-17 06:27:11 +0000159 descriptor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000160 Any *new-style* object which defines the methods :meth:`__get__`,
Georg Brandl5e52db02007-10-21 10:45:46 +0000161 :meth:`__set__`, or :meth:`__delete__`. When a class attribute is a
Georg Brandl437e6a32007-08-17 06:27:11 +0000162 descriptor, its special binding behavior is triggered upon attribute
Georg Brandl5e52db02007-10-21 10:45:46 +0000163 lookup. Normally, using *a.b* to get, set or delete an attribute looks up
164 the object named *b* in the class dictionary for *a*, but if *b* is a
165 descriptor, the respective descriptor method gets called. Understanding
166 descriptors is a key to a deep understanding of Python because they are
167 the basis for many features including functions, methods, properties,
168 class methods, static methods, and reference to super classes.
169
170 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000171
Georg Brandl437e6a32007-08-17 06:27:11 +0000172 dictionary
Senthil Kumaranc768d4c2012-03-12 10:05:04 -0700173 An associative array, where arbitrary keys are mapped to values. The
174 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
175 Called a hash in Perl.
Georg Brandle64f7382008-07-20 11:50:29 +0000176
177 docstring
Skip Montanarof02c5f32008-09-15 02:03:05 +0000178 A string literal which appears as the first expression in a class,
179 function or module. While ignored when the suite is executed, it is
180 recognized by the compiler and put into the :attr:`__doc__` attribute
181 of the enclosing class, function or module. Since it is available via
182 introspection, it is the canonical place for documentation of the
Georg Brandle64f7382008-07-20 11:50:29 +0000183 object.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000184
185 duck-typing
Georg Brandle85e1ae2010-10-06 09:17:24 +0000186 A programming style which does not look at an object's type to determine
187 if it has the right interface; instead, the method or attribute is simply
188 called or used ("If it looks like a duck and quacks like a duck, it
Georg Brandl437e6a32007-08-17 06:27:11 +0000189 must be a duck.") By emphasizing interfaces rather than specific types,
190 well-designed code improves its flexibility by allowing polymorphic
191 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl04eba2c2010-07-11 08:56:18 +0000192 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200193 with :term:`abstract base classes <abstract base class>`.) Instead, it
194 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000195
Georg Brandl437e6a32007-08-17 06:27:11 +0000196 EAFP
197 Easier to ask for forgiveness than permission. This common Python coding
198 style assumes the existence of valid keys or attributes and catches
199 exceptions if the assumption proves false. This clean and fast style is
200 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000201 statements. The technique contrasts with the :term:`LBYL` style
Skip Montanarof02c5f32008-09-15 02:03:05 +0000202 common to many other languages such as C.
Georg Brandl437e6a32007-08-17 06:27:11 +0000203
Georg Brandl584265b2007-12-02 14:58:50 +0000204 expression
205 A piece of syntax which can be evaluated to some value. In other words,
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200206 an expression is an accumulation of expression elements like literals,
207 names, attribute access, operators or function calls which all return a
208 value. In contrast to many other languages, not all language constructs
209 are expressions. There are also :term:`statement`\s which cannot be used
210 as expressions, such as :keyword:`print` or :keyword:`if`. Assignments
211 are also statements, not expressions.
Georg Brandl584265b2007-12-02 14:58:50 +0000212
Georg Brandl437e6a32007-08-17 06:27:11 +0000213 extension module
Georg Brandl28dadd92011-02-25 10:50:32 +0000214 A module written in C or C++, using Python's C API to interact with the
215 core and with user code.
Georg Brandl584265b2007-12-02 14:58:50 +0000216
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200217 file object
218 An object exposing a file-oriented API (with methods such as
219 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
220 on the way it was created, a file object can mediate access to a real
Sandro Tosifd4c4b12012-06-02 23:40:59 +0200221 on-disk file or to another type of storage or communication device
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200222 (for example standard input/output, in-memory buffers, sockets, pipes,
223 etc.). File objects are also called :dfn:`file-like objects` or
224 :dfn:`streams`.
225
226 There are actually three categories of file objects: raw binary files,
227 buffered binary files and text files. Their interfaces are defined in the
228 :mod:`io` module. The canonical way to create a file object is by using
229 the :func:`open` function.
230
231 file-like object
232 A synonym for :term:`file object`.
233
Georg Brandl624f3372009-03-31 16:11:45 +0000234 finder
235 An object that tries to find the :term:`loader` for a module. It must
236 implement a method named :meth:`find_module`. See :pep:`302` for
237 details.
238
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000239 floor division
240 Mathematical division that rounds down to nearest integer. The floor
241 division operator is ``//``. For example, the expression ``11 // 4``
242 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
243 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
244 rounded *downward*. See :pep:`238`.
245
Georg Brandl584265b2007-12-02 14:58:50 +0000246 function
247 A series of statements which returns some value to a caller. It can also
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800248 be passed zero or more :term:`arguments <argument>` which may be used in
249 the execution of the body. See also :term:`parameter`, :term:`method`,
250 and the :ref:`function` section.
Georg Brandl584265b2007-12-02 14:58:50 +0000251
Georg Brandl437e6a32007-08-17 06:27:11 +0000252 __future__
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000253 A pseudo-module which programmers can use to enable new language features
Georg Brandl437e6a32007-08-17 06:27:11 +0000254 which are not compatible with the current interpreter. For example, the
255 expression ``11/4`` currently evaluates to ``2``. If the module in which
256 it is executed had enabled *true division* by executing::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000257
Georg Brandl437e6a32007-08-17 06:27:11 +0000258 from __future__ import division
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000259
Georg Brandl437e6a32007-08-17 06:27:11 +0000260 the expression ``11/4`` would evaluate to ``2.75``. By importing the
261 :mod:`__future__` module and evaluating its variables, you can see when a
262 new feature was first added to the language and when it will become the
263 default::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000264
Georg Brandl437e6a32007-08-17 06:27:11 +0000265 >>> import __future__
266 >>> __future__.division
267 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
268
269 garbage collection
270 The process of freeing memory when it is not used anymore. Python
271 performs garbage collection via reference counting and a cyclic garbage
272 collector that is able to detect and break reference cycles.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000273
Georg Brandlea2d3892010-04-02 09:11:49 +0000274 .. index:: single: generator
275
Georg Brandl437e6a32007-08-17 06:27:11 +0000276 generator
Skip Montanarof02c5f32008-09-15 02:03:05 +0000277 A function which returns an iterator. It looks like a normal function
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000278 except that it contains :keyword:`yield` statements for producing a series
279 a values usable in a for-loop or that can be retrieved one at a time with
280 the :func:`next` function. Each :keyword:`yield` temporarily suspends
281 processing, remembering the location execution state (including local
282 variables and pending try-statements). When the generator resumes, it
283 picks-up where it left-off (in contrast to functions which start fresh on
284 every invocation).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000285
Georg Brandl437e6a32007-08-17 06:27:11 +0000286 .. index:: single: generator expression
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000287
Georg Brandl437e6a32007-08-17 06:27:11 +0000288 generator expression
Georg Brandlea2d3892010-04-02 09:11:49 +0000289 An expression that returns an iterator. It looks like a normal expression
Georg Brandl437e6a32007-08-17 06:27:11 +0000290 followed by a :keyword:`for` expression defining a loop variable, range,
291 and an optional :keyword:`if` expression. The combined expression
292 generates values for an enclosing function::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000293
Georg Brandl437e6a32007-08-17 06:27:11 +0000294 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
295 285
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000296
Georg Brandl437e6a32007-08-17 06:27:11 +0000297 GIL
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000298 See :term:`global interpreter lock`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000299
Georg Brandl437e6a32007-08-17 06:27:11 +0000300 global interpreter lock
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000301 The mechanism used by the :term:`CPython` interpreter to assure that
302 only one thread executes Python :term:`bytecode` at a time.
303 This simplifies the CPython implementation by making the object model
304 (including critical built-in types such as :class:`dict`) implicitly
305 safe against concurrent access. Locking the entire interpreter
306 makes it easier for the interpreter to be multi-threaded, at the
307 expense of much of the parallelism afforded by multi-processor
308 machines.
309
310 However, some extension modules, either standard or third-party,
311 are designed so as to release the GIL when doing computationally-intensive
312 tasks such as compression or hashing. Also, the GIL is always released
313 when doing I/O.
314
315 Past efforts to create a "free-threaded" interpreter (one which locks
316 shared data at a much finer granularity) have not been successful
317 because performance suffered in the common single-processor case. It
318 is believed that overcoming this performance issue would make the
319 implementation much more complicated and therefore costlier to maintain.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000320
321 hashable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000322 An object is *hashable* if it has a hash value which never changes during
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000323 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
324 other objects (it needs an :meth:`__eq__` or :meth:`__cmp__` method).
Skip Montanarof02c5f32008-09-15 02:03:05 +0000325 Hashable objects which compare equal must have the same hash value.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000326
327 Hashability makes an object usable as a dictionary key and a set member,
328 because these data structures use the hash value internally.
329
Skip Montanarof02c5f32008-09-15 02:03:05 +0000330 All of Python's immutable built-in objects are hashable, while no mutable
331 containers (such as lists or dictionaries) are. Objects which are
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000332 instances of user-defined classes are hashable by default; they all
333 compare unequal, and their hash value is their :func:`id`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000334
Georg Brandl437e6a32007-08-17 06:27:11 +0000335 IDLE
336 An Integrated Development Environment for Python. IDLE is a basic editor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000337 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000338 Python.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000339
Georg Brandl437e6a32007-08-17 06:27:11 +0000340 immutable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000341 An object with a fixed value. Immutable objects include numbers, strings and
342 tuples. Such an object cannot be altered. A new object has to
Georg Brandl437e6a32007-08-17 06:27:11 +0000343 be created if a different value has to be stored. They play an important
344 role in places where a constant hash value is needed, for example as a key
345 in a dictionary.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000346
Georg Brandl437e6a32007-08-17 06:27:11 +0000347 integer division
348 Mathematical division discarding any remainder. For example, the
349 expression ``11/4`` currently evaluates to ``2`` in contrast to the
350 ``2.75`` returned by float division. Also called *floor division*.
351 When dividing two integers the outcome will always be another integer
352 (having the floor function applied to it). However, if one of the operands
353 is another numeric type (such as a :class:`float`), the result will be
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000354 coerced (see :term:`coercion`) to a common type. For example, an integer
Georg Brandl437e6a32007-08-17 06:27:11 +0000355 divided by a float will result in a float value, possibly with a decimal
356 fraction. Integer division can be forced by using the ``//`` operator
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000357 instead of the ``/`` operator. See also :term:`__future__`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000358
Georg Brandl624f3372009-03-31 16:11:45 +0000359 importer
360 An object that both finds and loads a module; both a
361 :term:`finder` and :term:`loader` object.
362
Georg Brandl437e6a32007-08-17 06:27:11 +0000363 interactive
Skip Montanarof02c5f32008-09-15 02:03:05 +0000364 Python has an interactive interpreter which means you can enter
365 statements and expressions at the interpreter prompt, immediately
366 execute them and see their results. Just launch ``python`` with no
367 arguments (possibly by selecting it from your computer's main
368 menu). It is a very powerful way to test out new ideas or inspect
369 modules and packages (remember ``help(x)``).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000370
Georg Brandl437e6a32007-08-17 06:27:11 +0000371 interpreted
Skip Montanarof02c5f32008-09-15 02:03:05 +0000372 Python is an interpreted language, as opposed to a compiled one,
373 though the distinction can be blurry because of the presence of the
374 bytecode compiler. This means that source files can be run directly
375 without explicitly creating an executable which is then run.
376 Interpreted languages typically have a shorter development/debug cycle
377 than compiled ones, though their programs generally also run more
378 slowly. See also :term:`interactive`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000379
Georg Brandl437e6a32007-08-17 06:27:11 +0000380 iterable
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200381 An object capable of returning its members one at a
Georg Brandl437e6a32007-08-17 06:27:11 +0000382 time. Examples of iterables include all sequence types (such as
383 :class:`list`, :class:`str`, and :class:`tuple`) and some non-sequence
384 types like :class:`dict` and :class:`file` and objects of any classes you
385 define with an :meth:`__iter__` or :meth:`__getitem__` method. Iterables
386 can be used in a :keyword:`for` loop and in many other places where a
387 sequence is needed (:func:`zip`, :func:`map`, ...). When an iterable
Georg Brandld7d4fd72009-07-26 14:37:28 +0000388 object is passed as an argument to the built-in function :func:`iter`, it
Georg Brandl437e6a32007-08-17 06:27:11 +0000389 returns an iterator for the object. This iterator is good for one pass
390 over the set of values. When using iterables, it is usually not necessary
391 to call :func:`iter` or deal with iterator objects yourself. The ``for``
392 statement does that automatically for you, creating a temporary unnamed
393 variable to hold the iterator for the duration of the loop. See also
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000394 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000395
Georg Brandl437e6a32007-08-17 06:27:11 +0000396 iterator
397 An object representing a stream of data. Repeated calls to the iterator's
398 :meth:`next` method return successive items in the stream. When no more
Skip Montanarof02c5f32008-09-15 02:03:05 +0000399 data are available a :exc:`StopIteration` exception is raised instead. At
Georg Brandl437e6a32007-08-17 06:27:11 +0000400 this point, the iterator object is exhausted and any further calls to its
401 :meth:`next` method just raise :exc:`StopIteration` again. Iterators are
402 required to have an :meth:`__iter__` method that returns the iterator
403 object itself so every iterator is also iterable and may be used in most
404 places where other iterables are accepted. One notable exception is code
Skip Montanarof02c5f32008-09-15 02:03:05 +0000405 which attempts multiple iteration passes. A container object (such as a
Georg Brandl437e6a32007-08-17 06:27:11 +0000406 :class:`list`) produces a fresh new iterator each time you pass it to the
407 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
408 with an iterator will just return the same exhausted iterator object used
409 in the previous iteration pass, making it appear like an empty container.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000410
Georg Brandle7a09902007-10-21 12:10:28 +0000411 More information can be found in :ref:`typeiter`.
412
Georg Brandl3b85b9b2010-11-26 08:20:18 +0000413 key function
414 A key function or collation function is a callable that returns a value
415 used for sorting or ordering. For example, :func:`locale.strxfrm` is
416 used to produce a sort key that is aware of locale specific sort
417 conventions.
418
419 A number of tools in Python accept key functions to control how elements
420 are ordered or grouped. They include :func:`min`, :func:`max`,
421 :func:`sorted`, :meth:`list.sort`, :func:`heapq.nsmallest`,
422 :func:`heapq.nlargest`, and :func:`itertools.groupby`.
423
424 There are several ways to create a key function. For example. the
425 :meth:`str.lower` method can serve as a key function for case insensitive
426 sorts. Alternatively, an ad-hoc key function can be built from a
427 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosid987c022012-04-01 01:49:46 +0200428 the :mod:`operator` module provides three key function constructors:
Georg Brandl3b85b9b2010-11-26 08:20:18 +0000429 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
430 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
431 <sortinghowto>` for examples of how to create and use key functions.
432
Georg Brandl584265b2007-12-02 14:58:50 +0000433 keyword argument
Chris Jerdonek8da82682012-11-29 19:03:37 -0800434 See :term:`argument`.
Georg Brandl584265b2007-12-02 14:58:50 +0000435
436 lambda
437 An anonymous inline function consisting of a single :term:`expression`
438 which is evaluated when the function is called. The syntax to create
439 a lambda function is ``lambda [arguments]: expression``
440
Georg Brandl437e6a32007-08-17 06:27:11 +0000441 LBYL
442 Look before you leap. This coding style explicitly tests for
443 pre-conditions before making calls or lookups. This style contrasts with
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000444 the :term:`EAFP` approach and is characterized by the presence of many
Georg Brandl437e6a32007-08-17 06:27:11 +0000445 :keyword:`if` statements.
Skip Montanaro9feab312008-09-15 02:19:53 +0000446
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200447 In a multi-threaded environment, the LBYL approach can risk introducing a
448 race condition between "the looking" and "the leaping". For example, the
449 code, ``if key in mapping: return mapping[key]`` can fail if another
450 thread removes *key* from *mapping* after the test, but before the lookup.
451 This issue can be solved with locks or by using the EAFP approach.
452
Skip Montanaro9feab312008-09-15 02:19:53 +0000453 list
454 A built-in Python :term:`sequence`. Despite its name it is more akin
455 to an array in other languages than to a linked list since access to
456 elements are O(1).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000457
Georg Brandl437e6a32007-08-17 06:27:11 +0000458 list comprehension
Skip Montanarof02c5f32008-09-15 02:03:05 +0000459 A compact way to process all or part of the elements in a sequence and
Georg Brandl437e6a32007-08-17 06:27:11 +0000460 return a list with the results. ``result = ["0x%02x" % x for x in
Skip Montanarof02c5f32008-09-15 02:03:05 +0000461 range(256) if x % 2 == 0]`` generates a list of strings containing
462 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
463 clause is optional. If omitted, all elements in ``range(256)`` are
464 processed.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000465
Georg Brandl624f3372009-03-31 16:11:45 +0000466 loader
467 An object that loads a module. It must define a method named
468 :meth:`load_module`. A loader is typically returned by a
469 :term:`finder`. See :pep:`302` for details.
470
Georg Brandl437e6a32007-08-17 06:27:11 +0000471 mapping
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000472 A container object that supports arbitrary key lookups and implements the
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200473 methods specified in the :class:`~collections.Mapping` or
474 :class:`~collections.MutableMapping`
Éric Araujo8fde9502011-07-29 11:34:17 +0200475 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
476 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000477 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000478
Georg Brandl437e6a32007-08-17 06:27:11 +0000479 metaclass
480 The class of a class. Class definitions create a class name, a class
481 dictionary, and a list of base classes. The metaclass is responsible for
482 taking those three arguments and creating the class. Most object oriented
483 programming languages provide a default implementation. What makes Python
484 special is that it is possible to create custom metaclasses. Most users
485 never need this tool, but when the need arises, metaclasses can provide
486 powerful, elegant solutions. They have been used for logging attribute
487 access, adding thread-safety, tracking object creation, implementing
488 singletons, and many other tasks.
Georg Brandla7395032007-10-21 12:15:05 +0000489
490 More information can be found in :ref:`metaclasses`.
Georg Brandl584265b2007-12-02 14:58:50 +0000491
492 method
Skip Montanarof02c5f32008-09-15 02:03:05 +0000493 A function which is defined inside a class body. If called as an attribute
Georg Brandl584265b2007-12-02 14:58:50 +0000494 of an instance of that class, the method will get the instance object as
495 its first :term:`argument` (which is usually called ``self``).
496 See :term:`function` and :term:`nested scope`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000497
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200498 method resolution order
499 Method Resolution Order is the order in which base classes are searched
500 for a member during lookup. See `The Python 2.3 Method Resolution Order
501 <http://www.python.org/download/releases/2.3/mro/>`_.
502
503 MRO
504 See :term:`method resolution order`.
505
Georg Brandl437e6a32007-08-17 06:27:11 +0000506 mutable
507 Mutable objects can change their value but keep their :func:`id`. See
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000508 also :term:`immutable`.
Georg Brandle3c3db52008-01-11 09:55:53 +0000509
510 named tuple
Raymond Hettingeraff711d2009-02-04 19:25:17 +0000511 Any tuple-like class whose indexable elements are also accessible using
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000512 named attributes (for example, :func:`time.localtime` returns a
Raymond Hettinger8bdd0442008-01-13 06:18:07 +0000513 tuple-like object where the *year* is accessible either with an
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000514 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
515
516 A named tuple can be a built-in type such as :class:`time.struct_time`,
517 or it can be created with a regular class definition. A full featured
518 named tuple can also be created with the factory function
519 :func:`collections.namedtuple`. The latter approach automatically
520 provides extra features such as a self-documenting representation like
521 ``Employee(name='jones', title='programmer')``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000522
Georg Brandl437e6a32007-08-17 06:27:11 +0000523 namespace
524 The place where a variable is stored. Namespaces are implemented as
Georg Brandld7d4fd72009-07-26 14:37:28 +0000525 dictionaries. There are the local, global and built-in namespaces as well
Georg Brandl437e6a32007-08-17 06:27:11 +0000526 as nested namespaces in objects (in methods). Namespaces support
527 modularity by preventing naming conflicts. For instance, the functions
528 :func:`__builtin__.open` and :func:`os.open` are distinguished by their
529 namespaces. Namespaces also aid readability and maintainability by making
530 it clear which module implements a function. For instance, writing
531 :func:`random.seed` or :func:`itertools.izip` makes it clear that those
532 functions are implemented by the :mod:`random` and :mod:`itertools`
Skip Montanarof02c5f32008-09-15 02:03:05 +0000533 modules, respectively.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000534
Georg Brandl437e6a32007-08-17 06:27:11 +0000535 nested scope
536 The ability to refer to a variable in an enclosing definition. For
537 instance, a function defined inside another function can refer to
Sandro Tosi03c61102012-01-17 18:32:02 +0100538 variables in the outer function. Note that nested scopes work only for
539 reference and not for assignment which will always write to the innermost
540 scope. In contrast, local variables both read and write in the innermost
541 scope. Likewise, global variables read and write to the global namespace.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000542
Georg Brandl437e6a32007-08-17 06:27:11 +0000543 new-style class
Skip Montanarof02c5f32008-09-15 02:03:05 +0000544 Any class which inherits from :class:`object`. This includes all built-in
Georg Brandl437e6a32007-08-17 06:27:11 +0000545 types like :class:`list` and :class:`dict`. Only new-style classes can
546 use Python's newer, versatile features like :attr:`__slots__`,
Skip Montanarof02c5f32008-09-15 02:03:05 +0000547 descriptors, properties, and :meth:`__getattribute__`.
Georg Brandla7395032007-10-21 12:15:05 +0000548
549 More information can be found in :ref:`newstyle`.
Skip Montanaro9feab312008-09-15 02:19:53 +0000550
551 object
552 Any data with state (attributes or value) and defined behavior
553 (methods). Also the ultimate base class of any :term:`new-style
554 class`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000555
Chris Jerdonek8da82682012-11-29 19:03:37 -0800556 parameter
557 A named entity in a :term:`function` (or method) definition that
558 specifies an :term:`argument` (or in some cases, arguments) that the
559 function can accept. There are four types of parameters:
560
561 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
562 either :term:`positionally <argument>` or as a :term:`keyword argument
563 <argument>`. This is the default kind of parameter, for example *foo*
564 and *bar* in the following::
565
566 def func(foo, bar=None): ...
567
568 * :dfn:`positional-only`: specifies an argument that can be supplied only
569 by position. Python has no syntax for defining positional-only
570 parameters. However, some built-in functions have positional-only
571 parameters (e.g. :func:`abs`).
572
573 * :dfn:`var-positional`: specifies that an arbitrary sequence of
574 positional arguments can be provided (in addition to any positional
575 arguments already accepted by other parameters). Such a parameter can
576 be defined by prepending the parameter name with ``*``, for example
577 *args* in the following::
578
579 def func(*args, **kwargs): ...
580
581 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
582 can be provided (in addition to any keyword arguments already accepted
583 by other parameters). Such a parameter can be defined by prepending
584 the parameter name with ``**``, for example *kwargs* in the example
585 above.
586
587 Parameters can specify both optional and required arguments, as well as
588 default values for some optional arguments.
589
590 See also the :term:`argument` glossary entry, the FAQ question on
591 :ref:`the difference between arguments and parameters
592 <faq-argument-vs-parameter>`, and the :ref:`function` section.
593
Georg Brandl584265b2007-12-02 14:58:50 +0000594 positional argument
Chris Jerdonek8da82682012-11-29 19:03:37 -0800595 See :term:`argument`.
Georg Brandl584265b2007-12-02 14:58:50 +0000596
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000597 Python 3000
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200598 Nickname for the Python 3.x release line (coined long ago when the release
599 of version 3 was something in the distant future.) This is also
600 abbreviated "Py3k".
Georg Brandl437e6a32007-08-17 06:27:11 +0000601
Georg Brandl584265b2007-12-02 14:58:50 +0000602 Pythonic
Skip Montanarof02c5f32008-09-15 02:03:05 +0000603 An idea or piece of code which closely follows the most common idioms
604 of the Python language, rather than implementing code using concepts
605 common to other languages. For example, a common idiom in Python is
606 to loop over all elements of an iterable using a :keyword:`for`
607 statement. Many other languages don't have this type of construct, so
608 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000609
Georg Brandl584265b2007-12-02 14:58:50 +0000610 for i in range(len(food)):
611 print food[i]
612
613 As opposed to the cleaner, Pythonic method::
614
615 for piece in food:
616 print piece
617
Georg Brandl437e6a32007-08-17 06:27:11 +0000618 reference count
Skip Montanarof02c5f32008-09-15 02:03:05 +0000619 The number of references to an object. When the reference count of an
620 object drops to zero, it is deallocated. Reference counting is
621 generally not visible to Python code, but it is a key element of the
622 :term:`CPython` implementation. The :mod:`sys` module defines a
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200623 :func:`~sys.getrefcount` function that programmers can call to return the
Skip Montanarof02c5f32008-09-15 02:03:05 +0000624 reference count for a particular object.
625
Georg Brandl437e6a32007-08-17 06:27:11 +0000626 __slots__
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000627 A declaration inside a :term:`new-style class` that saves memory by
Georg Brandl437e6a32007-08-17 06:27:11 +0000628 pre-declaring space for instance attributes and eliminating instance
629 dictionaries. Though popular, the technique is somewhat tricky to get
630 right and is best reserved for rare cases where there are large numbers of
631 instances in a memory-critical application.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000632
Georg Brandl437e6a32007-08-17 06:27:11 +0000633 sequence
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000634 An :term:`iterable` which supports efficient element access using integer
Skip Montanarof02c5f32008-09-15 02:03:05 +0000635 indices via the :meth:`__getitem__` special method and defines a
636 :meth:`len` method that returns the length of the sequence.
Georg Brandl437e6a32007-08-17 06:27:11 +0000637 Some built-in sequence types are :class:`list`, :class:`str`,
638 :class:`tuple`, and :class:`unicode`. Note that :class:`dict` also
639 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
640 mapping rather than a sequence because the lookups use arbitrary
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000641 :term:`immutable` keys rather than integers.
Georg Brandl437e6a32007-08-17 06:27:11 +0000642
Georg Brandl584265b2007-12-02 14:58:50 +0000643 slice
Georg Brandl968a3e52007-12-02 18:17:50 +0000644 An object usually containing a portion of a :term:`sequence`. A slice is
Georg Brandl584265b2007-12-02 14:58:50 +0000645 created using the subscript notation, ``[]`` with colons between numbers
646 when several are given, such as in ``variable_name[1:3:5]``. The bracket
647 (subscript) notation uses :class:`slice` objects internally (or in older
648 versions, :meth:`__getslice__` and :meth:`__setslice__`).
649
Georg Brandl9a053732008-12-05 15:29:39 +0000650 special method
651 A method that is called implicitly by Python to execute a certain
652 operation on a type, such as addition. Such methods have names starting
653 and ending with double underscores. Special methods are documented in
654 :ref:`specialnames`.
655
Georg Brandl584265b2007-12-02 14:58:50 +0000656 statement
657 A statement is part of a suite (a "block" of code). A statement is either
658 an :term:`expression` or a one of several constructs with a keyword, such
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200659 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
660
661 struct sequence
662 A tuple with named elements. Struct sequences expose an interface similiar
663 to :term:`named tuple` in that elements can either be accessed either by
664 index or as an attribute. However, they do not have any of the named tuple
665 methods like :meth:`~collections.somenamedtuple._make` or
666 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
667 include :data:`sys.float_info` and the return value of :func:`os.stat`.
Georg Brandl584265b2007-12-02 14:58:50 +0000668
Skip Montanaro9feab312008-09-15 02:19:53 +0000669 triple-quoted string
670 A string which is bound by three instances of either a quotation mark
671 (") or an apostrophe ('). While they don't provide any functionality
672 not available with single-quoted strings, they are useful for a number
673 of reasons. They allow you to include unescaped single and double
674 quotes within a string and they can span multiple lines without the
675 use of the continuation character, making them especially useful when
676 writing docstrings.
677
Georg Brandl437e6a32007-08-17 06:27:11 +0000678 type
679 The type of a Python object determines what kind of object it is; every
680 object has a type. An object's type is accessible as its
681 :attr:`__class__` attribute or can be retrieved with ``type(obj)``.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000682
R David Murray5618aaa2012-08-15 11:15:39 -0400683 universal newlines
684 A manner of interpreting text streams in which all of the following are
685 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
686 the Windows convention ``'\r\n'``, and the old Macintosh convention
687 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
688 :func:`str.splitlines` for an additional use.
689
Alexandre Vassalotti69eb5162010-01-11 23:17:10 +0000690 view
691 The objects returned from :meth:`dict.viewkeys`, :meth:`dict.viewvalues`,
692 and :meth:`dict.viewitems` are called dictionary views. They are lazy
693 sequences that will see changes in the underlying dictionary. To force
694 the dictionary view to become a full list use ``list(dictview)``. See
695 :ref:`dict-views`.
696
Skip Montanarof02c5f32008-09-15 02:03:05 +0000697 virtual machine
698 A computer defined entirely in software. Python's virtual machine
699 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000700
Georg Brandl437e6a32007-08-17 06:27:11 +0000701 Zen of Python
702 Listing of Python design principles and philosophies that are helpful in
703 understanding and using the language. The listing can be found by typing
704 "``import this``" at the interactive prompt.