blob: 41228cd0e093bce3dcbfecbff1a9fa9bab253d2b [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
33 :ref:`magic methods <new-style-special-lookup>`). Python comes with many built-in ABCs for
Georg Brandld7d4fd72009-07-26 14:37:28 +000034 data structures (in the :mod:`collections` module), numbers (in the
35 :mod:`numbers` module), and streams (in the :mod:`io` module). You can
Éric Araujo8fde9502011-07-29 11:34:17 +020036 create your own ABCs with the :mod:`abc` module.
Benjamin Petersonaac51b82008-07-01 23:33:06 +000037
Georg Brandl584265b2007-12-02 14:58:50 +000038 argument
Skip Montanarof02c5f32008-09-15 02:03:05 +000039 A value passed to a function or method, assigned to a named local
40 variable in the function body. A function or method may have both
41 positional arguments and keyword arguments in its definition.
42 Positional and keyword arguments may be variable-length: ``*`` accepts
43 or passes (if in the function definition or call) several positional
44 arguments in a list, while ``**`` does the same for keyword arguments
45 in a dictionary.
Georg Brandl584265b2007-12-02 14:58:50 +000046
47 Any expression may be used within the argument list, and the evaluated
48 value is passed to the local variable.
Skip Montanaro9feab312008-09-15 02:19:53 +000049
50 attribute
51 A value associated with an object which is referenced by name using
52 dotted expressions. For example, if an object *o* has an attribute
53 *a* it would be referenced as *o.a*.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000054
Georg Brandl437e6a32007-08-17 06:27:11 +000055 BDFL
56 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
57 <http://www.python.org/~guido/>`_, Python's creator.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000058
Georg Brandl63fa1682007-10-21 10:24:20 +000059 bytecode
60 Python source code is compiled into bytecode, the internal representation
Éric Araujoa8f66dd2011-08-19 01:27:00 +020061 of a Python program in the CPython interpreter. The bytecode is also
62 cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
63 faster the second time (recompilation from source to bytecode can be
64 avoided). This "intermediate language" is said to run on a
65 :term:`virtual machine` that executes the machine code corresponding to
66 each bytecode. Do note that bytecodes are not expected to work between
67 different Python virtual machines, nor to be stable between Python
68 releases.
Skip Montanaro9feab312008-09-15 02:19:53 +000069
Georg Brandl2b4eda42010-07-03 10:25:54 +000070 A list of bytecode instructions can be found in the documentation for
71 :ref:`the dis module <bytecodes>`.
72
Skip Montanaro9feab312008-09-15 02:19:53 +000073 class
74 A template for creating user-defined objects. Class definitions
75 normally contain method definitions which operate on instances of the
76 class.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000077
Georg Brandl437e6a32007-08-17 06:27:11 +000078 classic class
79 Any class which does not inherit from :class:`object`. See
Skip Montanarof02c5f32008-09-15 02:03:05 +000080 :term:`new-style class`. Classic classes will be removed in Python 3.0.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000081
Georg Brandl437e6a32007-08-17 06:27:11 +000082 coercion
83 The implicit conversion of an instance of one type to another during an
84 operation which involves two arguments of the same type. For example,
85 ``int(3.15)`` converts the floating point number to the integer ``3``, but
86 in ``3+4.5``, each argument is of a different type (one int, one float),
87 and both must be converted to the same type before they can be added or it
88 will raise a ``TypeError``. Coercion between two operands can be
Georg Brandld7d4fd72009-07-26 14:37:28 +000089 performed with the ``coerce`` built-in function; thus, ``3+4.5`` is
Georg Brandl437e6a32007-08-17 06:27:11 +000090 equivalent to calling ``operator.add(*coerce(3, 4.5))`` and results in
91 ``operator.add(3.0, 4.5)``. Without coercion, all arguments of even
92 compatible types would have to be normalized to the same value by the
93 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +000094
Georg Brandl437e6a32007-08-17 06:27:11 +000095 complex number
96 An extension of the familiar real number system in which all numbers are
97 expressed as a sum of a real part and an imaginary part. Imaginary
98 numbers are real multiples of the imaginary unit (the square root of
99 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandld7d4fd72009-07-26 14:37:28 +0000100 engineering. Python has built-in support for complex numbers, which are
Georg Brandl437e6a32007-08-17 06:27:11 +0000101 written with this latter notation; the imaginary part is written with a
102 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
103 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
104 advanced mathematical feature. If you're not aware of a need for them,
105 it's almost certain you can safely ignore them.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000106
Skip Montanaroffe455c2007-12-08 15:23:31 +0000107 context manager
Skip Montanarof02c5f32008-09-15 02:03:05 +0000108 An object which controls the environment seen in a :keyword:`with`
Skip Montanaroffe455c2007-12-08 15:23:31 +0000109 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
110 See :pep:`343`.
111
Skip Montanarof02c5f32008-09-15 02:03:05 +0000112 CPython
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000113 The canonical implementation of the Python programming language, as
114 distributed on `python.org <http://python.org>`_. The term "CPython"
115 is used when necessary to distinguish this implementation from others
116 such as Jython or IronPython.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000117
Georg Brandl584265b2007-12-02 14:58:50 +0000118 decorator
119 A function returning another function, usually applied as a function
120 transformation using the ``@wrapper`` syntax. Common examples for
121 decorators are :func:`classmethod` and :func:`staticmethod`.
122
123 The decorator syntax is merely syntactic sugar, the following two
124 function definitions are semantically equivalent::
125
126 def f(...):
127 ...
128 f = staticmethod(f)
129
130 @staticmethod
131 def f(...):
132 ...
133
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200134 The same concept exists for classes, but is less commonly used there. See
135 the documentation for :ref:`function definitions <function>` and
136 :ref:`class definitions <class>` for more about decorators.
Georg Brandl5066c0c2008-12-05 18:00:06 +0000137
Georg Brandl437e6a32007-08-17 06:27:11 +0000138 descriptor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000139 Any *new-style* object which defines the methods :meth:`__get__`,
Georg Brandl5e52db02007-10-21 10:45:46 +0000140 :meth:`__set__`, or :meth:`__delete__`. When a class attribute is a
Georg Brandl437e6a32007-08-17 06:27:11 +0000141 descriptor, its special binding behavior is triggered upon attribute
Georg Brandl5e52db02007-10-21 10:45:46 +0000142 lookup. Normally, using *a.b* to get, set or delete an attribute looks up
143 the object named *b* in the class dictionary for *a*, but if *b* is a
144 descriptor, the respective descriptor method gets called. Understanding
145 descriptors is a key to a deep understanding of Python because they are
146 the basis for many features including functions, methods, properties,
147 class methods, static methods, and reference to super classes.
148
149 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000150
Georg Brandl437e6a32007-08-17 06:27:11 +0000151 dictionary
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000152 An associative array, where arbitrary keys are mapped to values. The keys
153 can be any object with :meth:`__hash__` function and :meth:`__eq__`
154 methods. Called a hash in Perl.
Georg Brandle64f7382008-07-20 11:50:29 +0000155
156 docstring
Skip Montanarof02c5f32008-09-15 02:03:05 +0000157 A string literal which appears as the first expression in a class,
158 function or module. While ignored when the suite is executed, it is
159 recognized by the compiler and put into the :attr:`__doc__` attribute
160 of the enclosing class, function or module. Since it is available via
161 introspection, it is the canonical place for documentation of the
Georg Brandle64f7382008-07-20 11:50:29 +0000162 object.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000163
164 duck-typing
Georg Brandle85e1ae2010-10-06 09:17:24 +0000165 A programming style which does not look at an object's type to determine
166 if it has the right interface; instead, the method or attribute is simply
167 called or used ("If it looks like a duck and quacks like a duck, it
Georg Brandl437e6a32007-08-17 06:27:11 +0000168 must be a duck.") By emphasizing interfaces rather than specific types,
169 well-designed code improves its flexibility by allowing polymorphic
170 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl04eba2c2010-07-11 08:56:18 +0000171 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200172 with :term:`abstract base classes <abstract base class>`.) Instead, it
173 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000174
Georg Brandl437e6a32007-08-17 06:27:11 +0000175 EAFP
176 Easier to ask for forgiveness than permission. This common Python coding
177 style assumes the existence of valid keys or attributes and catches
178 exceptions if the assumption proves false. This clean and fast style is
179 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000180 statements. The technique contrasts with the :term:`LBYL` style
Skip Montanarof02c5f32008-09-15 02:03:05 +0000181 common to many other languages such as C.
Georg Brandl437e6a32007-08-17 06:27:11 +0000182
Georg Brandl584265b2007-12-02 14:58:50 +0000183 expression
184 A piece of syntax which can be evaluated to some value. In other words,
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200185 an expression is an accumulation of expression elements like literals,
186 names, attribute access, operators or function calls which all return a
187 value. In contrast to many other languages, not all language constructs
188 are expressions. There are also :term:`statement`\s which cannot be used
189 as expressions, such as :keyword:`print` or :keyword:`if`. Assignments
190 are also statements, not expressions.
Georg Brandl584265b2007-12-02 14:58:50 +0000191
Georg Brandl437e6a32007-08-17 06:27:11 +0000192 extension module
Georg Brandl28dadd92011-02-25 10:50:32 +0000193 A module written in C or C++, using Python's C API to interact with the
194 core and with user code.
Georg Brandl584265b2007-12-02 14:58:50 +0000195
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200196 file object
197 An object exposing a file-oriented API (with methods such as
198 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
199 on the way it was created, a file object can mediate access to a real
200 on-disk file or to another other type of storage or communication device
201 (for example standard input/output, in-memory buffers, sockets, pipes,
202 etc.). File objects are also called :dfn:`file-like objects` or
203 :dfn:`streams`.
204
205 There are actually three categories of file objects: raw binary files,
206 buffered binary files and text files. Their interfaces are defined in the
207 :mod:`io` module. The canonical way to create a file object is by using
208 the :func:`open` function.
209
210 file-like object
211 A synonym for :term:`file object`.
212
Georg Brandl624f3372009-03-31 16:11:45 +0000213 finder
214 An object that tries to find the :term:`loader` for a module. It must
215 implement a method named :meth:`find_module`. See :pep:`302` for
216 details.
217
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000218 floor division
219 Mathematical division that rounds down to nearest integer. The floor
220 division operator is ``//``. For example, the expression ``11 // 4``
221 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
222 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
223 rounded *downward*. See :pep:`238`.
224
Georg Brandl584265b2007-12-02 14:58:50 +0000225 function
226 A series of statements which returns some value to a caller. It can also
227 be passed zero or more arguments which may be used in the execution of
228 the body. See also :term:`argument` and :term:`method`.
229
Georg Brandl437e6a32007-08-17 06:27:11 +0000230 __future__
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000231 A pseudo-module which programmers can use to enable new language features
Georg Brandl437e6a32007-08-17 06:27:11 +0000232 which are not compatible with the current interpreter. For example, the
233 expression ``11/4`` currently evaluates to ``2``. If the module in which
234 it is executed had enabled *true division* by executing::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000235
Georg Brandl437e6a32007-08-17 06:27:11 +0000236 from __future__ import division
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000237
Georg Brandl437e6a32007-08-17 06:27:11 +0000238 the expression ``11/4`` would evaluate to ``2.75``. By importing the
239 :mod:`__future__` module and evaluating its variables, you can see when a
240 new feature was first added to the language and when it will become the
241 default::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000242
Georg Brandl437e6a32007-08-17 06:27:11 +0000243 >>> import __future__
244 >>> __future__.division
245 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
246
247 garbage collection
248 The process of freeing memory when it is not used anymore. Python
249 performs garbage collection via reference counting and a cyclic garbage
250 collector that is able to detect and break reference cycles.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000251
Georg Brandlea2d3892010-04-02 09:11:49 +0000252 .. index:: single: generator
253
Georg Brandl437e6a32007-08-17 06:27:11 +0000254 generator
Skip Montanarof02c5f32008-09-15 02:03:05 +0000255 A function which returns an iterator. It looks like a normal function
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000256 except that it contains :keyword:`yield` statements for producing a series
257 a values usable in a for-loop or that can be retrieved one at a time with
258 the :func:`next` function. Each :keyword:`yield` temporarily suspends
259 processing, remembering the location execution state (including local
260 variables and pending try-statements). When the generator resumes, it
261 picks-up where it left-off (in contrast to functions which start fresh on
262 every invocation).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000263
Georg Brandl437e6a32007-08-17 06:27:11 +0000264 .. index:: single: generator expression
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000265
Georg Brandl437e6a32007-08-17 06:27:11 +0000266 generator expression
Georg Brandlea2d3892010-04-02 09:11:49 +0000267 An expression that returns an iterator. It looks like a normal expression
Georg Brandl437e6a32007-08-17 06:27:11 +0000268 followed by a :keyword:`for` expression defining a loop variable, range,
269 and an optional :keyword:`if` expression. The combined expression
270 generates values for an enclosing function::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000271
Georg Brandl437e6a32007-08-17 06:27:11 +0000272 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
273 285
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000274
Georg Brandl437e6a32007-08-17 06:27:11 +0000275 GIL
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000276 See :term:`global interpreter lock`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000277
Georg Brandl437e6a32007-08-17 06:27:11 +0000278 global interpreter lock
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000279 The mechanism used by the :term:`CPython` interpreter to assure that
280 only one thread executes Python :term:`bytecode` at a time.
281 This simplifies the CPython implementation by making the object model
282 (including critical built-in types such as :class:`dict`) implicitly
283 safe against concurrent access. Locking the entire interpreter
284 makes it easier for the interpreter to be multi-threaded, at the
285 expense of much of the parallelism afforded by multi-processor
286 machines.
287
288 However, some extension modules, either standard or third-party,
289 are designed so as to release the GIL when doing computationally-intensive
290 tasks such as compression or hashing. Also, the GIL is always released
291 when doing I/O.
292
293 Past efforts to create a "free-threaded" interpreter (one which locks
294 shared data at a much finer granularity) have not been successful
295 because performance suffered in the common single-processor case. It
296 is believed that overcoming this performance issue would make the
297 implementation much more complicated and therefore costlier to maintain.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000298
299 hashable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000300 An object is *hashable* if it has a hash value which never changes during
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000301 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
302 other objects (it needs an :meth:`__eq__` or :meth:`__cmp__` method).
Skip Montanarof02c5f32008-09-15 02:03:05 +0000303 Hashable objects which compare equal must have the same hash value.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000304
305 Hashability makes an object usable as a dictionary key and a set member,
306 because these data structures use the hash value internally.
307
Skip Montanarof02c5f32008-09-15 02:03:05 +0000308 All of Python's immutable built-in objects are hashable, while no mutable
309 containers (such as lists or dictionaries) are. Objects which are
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000310 instances of user-defined classes are hashable by default; they all
311 compare unequal, and their hash value is their :func:`id`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000312
Georg Brandl437e6a32007-08-17 06:27:11 +0000313 IDLE
314 An Integrated Development Environment for Python. IDLE is a basic editor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000315 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000316 Python.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000317
Georg Brandl437e6a32007-08-17 06:27:11 +0000318 immutable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000319 An object with a fixed value. Immutable objects include numbers, strings and
320 tuples. Such an object cannot be altered. A new object has to
Georg Brandl437e6a32007-08-17 06:27:11 +0000321 be created if a different value has to be stored. They play an important
322 role in places where a constant hash value is needed, for example as a key
323 in a dictionary.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000324
Georg Brandl437e6a32007-08-17 06:27:11 +0000325 integer division
326 Mathematical division discarding any remainder. For example, the
327 expression ``11/4`` currently evaluates to ``2`` in contrast to the
328 ``2.75`` returned by float division. Also called *floor division*.
329 When dividing two integers the outcome will always be another integer
330 (having the floor function applied to it). However, if one of the operands
331 is another numeric type (such as a :class:`float`), the result will be
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000332 coerced (see :term:`coercion`) to a common type. For example, an integer
Georg Brandl437e6a32007-08-17 06:27:11 +0000333 divided by a float will result in a float value, possibly with a decimal
334 fraction. Integer division can be forced by using the ``//`` operator
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000335 instead of the ``/`` operator. See also :term:`__future__`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000336
Georg Brandl624f3372009-03-31 16:11:45 +0000337 importer
338 An object that both finds and loads a module; both a
339 :term:`finder` and :term:`loader` object.
340
Georg Brandl437e6a32007-08-17 06:27:11 +0000341 interactive
Skip Montanarof02c5f32008-09-15 02:03:05 +0000342 Python has an interactive interpreter which means you can enter
343 statements and expressions at the interpreter prompt, immediately
344 execute them and see their results. Just launch ``python`` with no
345 arguments (possibly by selecting it from your computer's main
346 menu). It is a very powerful way to test out new ideas or inspect
347 modules and packages (remember ``help(x)``).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000348
Georg Brandl437e6a32007-08-17 06:27:11 +0000349 interpreted
Skip Montanarof02c5f32008-09-15 02:03:05 +0000350 Python is an interpreted language, as opposed to a compiled one,
351 though the distinction can be blurry because of the presence of the
352 bytecode compiler. This means that source files can be run directly
353 without explicitly creating an executable which is then run.
354 Interpreted languages typically have a shorter development/debug cycle
355 than compiled ones, though their programs generally also run more
356 slowly. See also :term:`interactive`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000357
Georg Brandl437e6a32007-08-17 06:27:11 +0000358 iterable
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200359 An object capable of returning its members one at a
Georg Brandl437e6a32007-08-17 06:27:11 +0000360 time. Examples of iterables include all sequence types (such as
361 :class:`list`, :class:`str`, and :class:`tuple`) and some non-sequence
362 types like :class:`dict` and :class:`file` and objects of any classes you
363 define with an :meth:`__iter__` or :meth:`__getitem__` method. Iterables
364 can be used in a :keyword:`for` loop and in many other places where a
365 sequence is needed (:func:`zip`, :func:`map`, ...). When an iterable
Georg Brandld7d4fd72009-07-26 14:37:28 +0000366 object is passed as an argument to the built-in function :func:`iter`, it
Georg Brandl437e6a32007-08-17 06:27:11 +0000367 returns an iterator for the object. This iterator is good for one pass
368 over the set of values. When using iterables, it is usually not necessary
369 to call :func:`iter` or deal with iterator objects yourself. The ``for``
370 statement does that automatically for you, creating a temporary unnamed
371 variable to hold the iterator for the duration of the loop. See also
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000372 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000373
Georg Brandl437e6a32007-08-17 06:27:11 +0000374 iterator
375 An object representing a stream of data. Repeated calls to the iterator's
376 :meth:`next` method return successive items in the stream. When no more
Skip Montanarof02c5f32008-09-15 02:03:05 +0000377 data are available a :exc:`StopIteration` exception is raised instead. At
Georg Brandl437e6a32007-08-17 06:27:11 +0000378 this point, the iterator object is exhausted and any further calls to its
379 :meth:`next` method just raise :exc:`StopIteration` again. Iterators are
380 required to have an :meth:`__iter__` method that returns the iterator
381 object itself so every iterator is also iterable and may be used in most
382 places where other iterables are accepted. One notable exception is code
Skip Montanarof02c5f32008-09-15 02:03:05 +0000383 which attempts multiple iteration passes. A container object (such as a
Georg Brandl437e6a32007-08-17 06:27:11 +0000384 :class:`list`) produces a fresh new iterator each time you pass it to the
385 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
386 with an iterator will just return the same exhausted iterator object used
387 in the previous iteration pass, making it appear like an empty container.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000388
Georg Brandle7a09902007-10-21 12:10:28 +0000389 More information can be found in :ref:`typeiter`.
390
Georg Brandl3b85b9b2010-11-26 08:20:18 +0000391 key function
392 A key function or collation function is a callable that returns a value
393 used for sorting or ordering. For example, :func:`locale.strxfrm` is
394 used to produce a sort key that is aware of locale specific sort
395 conventions.
396
397 A number of tools in Python accept key functions to control how elements
398 are ordered or grouped. They include :func:`min`, :func:`max`,
399 :func:`sorted`, :meth:`list.sort`, :func:`heapq.nsmallest`,
400 :func:`heapq.nlargest`, and :func:`itertools.groupby`.
401
402 There are several ways to create a key function. For example. the
403 :meth:`str.lower` method can serve as a key function for case insensitive
404 sorts. Alternatively, an ad-hoc key function can be built from a
405 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
406 the :mod:`operator` module provides three key function constuctors:
407 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
408 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
409 <sortinghowto>` for examples of how to create and use key functions.
410
Georg Brandl584265b2007-12-02 14:58:50 +0000411 keyword argument
412 Arguments which are preceded with a ``variable_name=`` in the call.
413 The variable name designates the local name in the function to which the
414 value is assigned. ``**`` is used to accept or pass a dictionary of
415 keyword arguments. See :term:`argument`.
416
417 lambda
418 An anonymous inline function consisting of a single :term:`expression`
419 which is evaluated when the function is called. The syntax to create
420 a lambda function is ``lambda [arguments]: expression``
421
Georg Brandl437e6a32007-08-17 06:27:11 +0000422 LBYL
423 Look before you leap. This coding style explicitly tests for
424 pre-conditions before making calls or lookups. This style contrasts with
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000425 the :term:`EAFP` approach and is characterized by the presence of many
Georg Brandl437e6a32007-08-17 06:27:11 +0000426 :keyword:`if` statements.
Skip Montanaro9feab312008-09-15 02:19:53 +0000427
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200428 In a multi-threaded environment, the LBYL approach can risk introducing a
429 race condition between "the looking" and "the leaping". For example, the
430 code, ``if key in mapping: return mapping[key]`` can fail if another
431 thread removes *key* from *mapping* after the test, but before the lookup.
432 This issue can be solved with locks or by using the EAFP approach.
433
Skip Montanaro9feab312008-09-15 02:19:53 +0000434 list
435 A built-in Python :term:`sequence`. Despite its name it is more akin
436 to an array in other languages than to a linked list since access to
437 elements are O(1).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000438
Georg Brandl437e6a32007-08-17 06:27:11 +0000439 list comprehension
Skip Montanarof02c5f32008-09-15 02:03:05 +0000440 A compact way to process all or part of the elements in a sequence and
Georg Brandl437e6a32007-08-17 06:27:11 +0000441 return a list with the results. ``result = ["0x%02x" % x for x in
Skip Montanarof02c5f32008-09-15 02:03:05 +0000442 range(256) if x % 2 == 0]`` generates a list of strings containing
443 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
444 clause is optional. If omitted, all elements in ``range(256)`` are
445 processed.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000446
Georg Brandl624f3372009-03-31 16:11:45 +0000447 loader
448 An object that loads a module. It must define a method named
449 :meth:`load_module`. A loader is typically returned by a
450 :term:`finder`. See :pep:`302` for details.
451
Georg Brandl437e6a32007-08-17 06:27:11 +0000452 mapping
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000453 A container object that supports arbitrary key lookups and implements the
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200454 methods specified in the :class:`~collections.Mapping` or
455 :class:`~collections.MutableMapping`
Éric Araujo8fde9502011-07-29 11:34:17 +0200456 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
457 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000458 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000459
Georg Brandl437e6a32007-08-17 06:27:11 +0000460 metaclass
461 The class of a class. Class definitions create a class name, a class
462 dictionary, and a list of base classes. The metaclass is responsible for
463 taking those three arguments and creating the class. Most object oriented
464 programming languages provide a default implementation. What makes Python
465 special is that it is possible to create custom metaclasses. Most users
466 never need this tool, but when the need arises, metaclasses can provide
467 powerful, elegant solutions. They have been used for logging attribute
468 access, adding thread-safety, tracking object creation, implementing
469 singletons, and many other tasks.
Georg Brandla7395032007-10-21 12:15:05 +0000470
471 More information can be found in :ref:`metaclasses`.
Georg Brandl584265b2007-12-02 14:58:50 +0000472
473 method
Skip Montanarof02c5f32008-09-15 02:03:05 +0000474 A function which is defined inside a class body. If called as an attribute
Georg Brandl584265b2007-12-02 14:58:50 +0000475 of an instance of that class, the method will get the instance object as
476 its first :term:`argument` (which is usually called ``self``).
477 See :term:`function` and :term:`nested scope`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000478
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200479 method resolution order
480 Method Resolution Order is the order in which base classes are searched
481 for a member during lookup. See `The Python 2.3 Method Resolution Order
482 <http://www.python.org/download/releases/2.3/mro/>`_.
483
484 MRO
485 See :term:`method resolution order`.
486
Georg Brandl437e6a32007-08-17 06:27:11 +0000487 mutable
488 Mutable objects can change their value but keep their :func:`id`. See
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000489 also :term:`immutable`.
Georg Brandle3c3db52008-01-11 09:55:53 +0000490
491 named tuple
Raymond Hettingeraff711d2009-02-04 19:25:17 +0000492 Any tuple-like class whose indexable elements are also accessible using
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000493 named attributes (for example, :func:`time.localtime` returns a
Raymond Hettinger8bdd0442008-01-13 06:18:07 +0000494 tuple-like object where the *year* is accessible either with an
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000495 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
496
497 A named tuple can be a built-in type such as :class:`time.struct_time`,
498 or it can be created with a regular class definition. A full featured
499 named tuple can also be created with the factory function
500 :func:`collections.namedtuple`. The latter approach automatically
501 provides extra features such as a self-documenting representation like
502 ``Employee(name='jones', title='programmer')``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000503
Georg Brandl437e6a32007-08-17 06:27:11 +0000504 namespace
505 The place where a variable is stored. Namespaces are implemented as
Georg Brandld7d4fd72009-07-26 14:37:28 +0000506 dictionaries. There are the local, global and built-in namespaces as well
Georg Brandl437e6a32007-08-17 06:27:11 +0000507 as nested namespaces in objects (in methods). Namespaces support
508 modularity by preventing naming conflicts. For instance, the functions
509 :func:`__builtin__.open` and :func:`os.open` are distinguished by their
510 namespaces. Namespaces also aid readability and maintainability by making
511 it clear which module implements a function. For instance, writing
512 :func:`random.seed` or :func:`itertools.izip` makes it clear that those
513 functions are implemented by the :mod:`random` and :mod:`itertools`
Skip Montanarof02c5f32008-09-15 02:03:05 +0000514 modules, respectively.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000515
Georg Brandl437e6a32007-08-17 06:27:11 +0000516 nested scope
517 The ability to refer to a variable in an enclosing definition. For
518 instance, a function defined inside another function can refer to
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200519 variables in the outer function. Note that nested scopes by default work
520 only for reference and not for assignment. Local variables both read and
521 write in the innermost scope. Likewise, global variables read and write
522 to the global namespace. The :keyword:`nonlocal` allows writing to outer
523 scopes.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000524
Georg Brandl437e6a32007-08-17 06:27:11 +0000525 new-style class
Skip Montanarof02c5f32008-09-15 02:03:05 +0000526 Any class which inherits from :class:`object`. This includes all built-in
Georg Brandl437e6a32007-08-17 06:27:11 +0000527 types like :class:`list` and :class:`dict`. Only new-style classes can
528 use Python's newer, versatile features like :attr:`__slots__`,
Skip Montanarof02c5f32008-09-15 02:03:05 +0000529 descriptors, properties, and :meth:`__getattribute__`.
Georg Brandla7395032007-10-21 12:15:05 +0000530
531 More information can be found in :ref:`newstyle`.
Skip Montanaro9feab312008-09-15 02:19:53 +0000532
533 object
534 Any data with state (attributes or value) and defined behavior
535 (methods). Also the ultimate base class of any :term:`new-style
536 class`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000537
Georg Brandl584265b2007-12-02 14:58:50 +0000538 positional argument
539 The arguments assigned to local names inside a function or method,
540 determined by the order in which they were given in the call. ``*`` is
541 used to either accept multiple positional arguments (when in the
542 definition), or pass several arguments as a list to a function. See
543 :term:`argument`.
544
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000545 Python 3000
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200546 Nickname for the Python 3.x release line (coined long ago when the release
547 of version 3 was something in the distant future.) This is also
548 abbreviated "Py3k".
Georg Brandl437e6a32007-08-17 06:27:11 +0000549
Georg Brandl584265b2007-12-02 14:58:50 +0000550 Pythonic
Skip Montanarof02c5f32008-09-15 02:03:05 +0000551 An idea or piece of code which closely follows the most common idioms
552 of the Python language, rather than implementing code using concepts
553 common to other languages. For example, a common idiom in Python is
554 to loop over all elements of an iterable using a :keyword:`for`
555 statement. Many other languages don't have this type of construct, so
556 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000557
Georg Brandl584265b2007-12-02 14:58:50 +0000558 for i in range(len(food)):
559 print food[i]
560
561 As opposed to the cleaner, Pythonic method::
562
563 for piece in food:
564 print piece
565
Georg Brandl437e6a32007-08-17 06:27:11 +0000566 reference count
Skip Montanarof02c5f32008-09-15 02:03:05 +0000567 The number of references to an object. When the reference count of an
568 object drops to zero, it is deallocated. Reference counting is
569 generally not visible to Python code, but it is a key element of the
570 :term:`CPython` implementation. The :mod:`sys` module defines a
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200571 :func:`~sys.getrefcount` function that programmers can call to return the
Skip Montanarof02c5f32008-09-15 02:03:05 +0000572 reference count for a particular object.
573
Georg Brandl437e6a32007-08-17 06:27:11 +0000574 __slots__
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000575 A declaration inside a :term:`new-style class` that saves memory by
Georg Brandl437e6a32007-08-17 06:27:11 +0000576 pre-declaring space for instance attributes and eliminating instance
577 dictionaries. Though popular, the technique is somewhat tricky to get
578 right and is best reserved for rare cases where there are large numbers of
579 instances in a memory-critical application.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000580
Georg Brandl437e6a32007-08-17 06:27:11 +0000581 sequence
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000582 An :term:`iterable` which supports efficient element access using integer
Skip Montanarof02c5f32008-09-15 02:03:05 +0000583 indices via the :meth:`__getitem__` special method and defines a
584 :meth:`len` method that returns the length of the sequence.
Georg Brandl437e6a32007-08-17 06:27:11 +0000585 Some built-in sequence types are :class:`list`, :class:`str`,
586 :class:`tuple`, and :class:`unicode`. Note that :class:`dict` also
587 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
588 mapping rather than a sequence because the lookups use arbitrary
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000589 :term:`immutable` keys rather than integers.
Georg Brandl437e6a32007-08-17 06:27:11 +0000590
Georg Brandl584265b2007-12-02 14:58:50 +0000591 slice
Georg Brandl968a3e52007-12-02 18:17:50 +0000592 An object usually containing a portion of a :term:`sequence`. A slice is
Georg Brandl584265b2007-12-02 14:58:50 +0000593 created using the subscript notation, ``[]`` with colons between numbers
594 when several are given, such as in ``variable_name[1:3:5]``. The bracket
595 (subscript) notation uses :class:`slice` objects internally (or in older
596 versions, :meth:`__getslice__` and :meth:`__setslice__`).
597
Georg Brandl9a053732008-12-05 15:29:39 +0000598 special method
599 A method that is called implicitly by Python to execute a certain
600 operation on a type, such as addition. Such methods have names starting
601 and ending with double underscores. Special methods are documented in
602 :ref:`specialnames`.
603
Georg Brandl584265b2007-12-02 14:58:50 +0000604 statement
605 A statement is part of a suite (a "block" of code). A statement is either
606 an :term:`expression` or a one of several constructs with a keyword, such
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200607 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
608
609 struct sequence
610 A tuple with named elements. Struct sequences expose an interface similiar
611 to :term:`named tuple` in that elements can either be accessed either by
612 index or as an attribute. However, they do not have any of the named tuple
613 methods like :meth:`~collections.somenamedtuple._make` or
614 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
615 include :data:`sys.float_info` and the return value of :func:`os.stat`.
Georg Brandl584265b2007-12-02 14:58:50 +0000616
Skip Montanaro9feab312008-09-15 02:19:53 +0000617 triple-quoted string
618 A string which is bound by three instances of either a quotation mark
619 (") or an apostrophe ('). While they don't provide any functionality
620 not available with single-quoted strings, they are useful for a number
621 of reasons. They allow you to include unescaped single and double
622 quotes within a string and they can span multiple lines without the
623 use of the continuation character, making them especially useful when
624 writing docstrings.
625
Georg Brandl437e6a32007-08-17 06:27:11 +0000626 type
627 The type of a Python object determines what kind of object it is; every
628 object has a type. An object's type is accessible as its
629 :attr:`__class__` attribute or can be retrieved with ``type(obj)``.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000630
Alexandre Vassalotti69eb5162010-01-11 23:17:10 +0000631 view
632 The objects returned from :meth:`dict.viewkeys`, :meth:`dict.viewvalues`,
633 and :meth:`dict.viewitems` are called dictionary views. They are lazy
634 sequences that will see changes in the underlying dictionary. To force
635 the dictionary view to become a full list use ``list(dictview)``. See
636 :ref:`dict-views`.
637
Skip Montanarof02c5f32008-09-15 02:03:05 +0000638 virtual machine
639 A computer defined entirely in software. Python's virtual machine
640 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000641
Georg Brandl437e6a32007-08-17 06:27:11 +0000642 Zen of Python
643 Listing of Python design principles and philosophies that are helpful in
644 understanding and using the language. The listing can be found by typing
645 "``import this``" at the interactive prompt.