blob: 3af49fd0297c5e64c108d6c57c27a3b2d630d843 [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
Ezio Melotti1c0d8a72013-04-30 23:33:31 +030080 bytes-like object
Ezio Melotti71c1cff2013-05-01 14:13:05 +030081 An object that supports the :ref:`buffer protocol <bufferobjects>`,
Antoine Pitroua09657e2013-05-04 20:18:34 +020082 like :class:`str`, :class:`bytearray` or :class:`memoryview`.
83 Bytes-like objects can be used for various operations that expect
84 binary data, such as compression, saving to a binary file or sending
85 over a socket. Some operations need the binary data to be mutable,
86 in which case not all bytes-like objects can apply.
Ezio Melotti1c0d8a72013-04-30 23:33:31 +030087
Georg Brandl63fa1682007-10-21 10:24:20 +000088 bytecode
89 Python source code is compiled into bytecode, the internal representation
Éric Araujoa8f66dd2011-08-19 01:27:00 +020090 of a Python program in the CPython interpreter. The bytecode is also
91 cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
92 faster the second time (recompilation from source to bytecode can be
93 avoided). This "intermediate language" is said to run on a
94 :term:`virtual machine` that executes the machine code corresponding to
95 each bytecode. Do note that bytecodes are not expected to work between
96 different Python virtual machines, nor to be stable between Python
97 releases.
Skip Montanaro9feab312008-09-15 02:19:53 +000098
Georg Brandl2b4eda42010-07-03 10:25:54 +000099 A list of bytecode instructions can be found in the documentation for
100 :ref:`the dis module <bytecodes>`.
101
Skip Montanaro9feab312008-09-15 02:19:53 +0000102 class
103 A template for creating user-defined objects. Class definitions
104 normally contain method definitions which operate on instances of the
105 class.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000106
Georg Brandl437e6a32007-08-17 06:27:11 +0000107 classic class
108 Any class which does not inherit from :class:`object`. See
Ezio Melotti510ff542012-05-03 19:21:40 +0300109 :term:`new-style class`. Classic classes have been removed in Python 3.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000110
Georg Brandl437e6a32007-08-17 06:27:11 +0000111 coercion
112 The implicit conversion of an instance of one type to another during an
113 operation which involves two arguments of the same type. For example,
114 ``int(3.15)`` converts the floating point number to the integer ``3``, but
115 in ``3+4.5``, each argument is of a different type (one int, one float),
116 and both must be converted to the same type before they can be added or it
117 will raise a ``TypeError``. Coercion between two operands can be
Georg Brandld7d4fd72009-07-26 14:37:28 +0000118 performed with the ``coerce`` built-in function; thus, ``3+4.5`` is
Georg Brandl437e6a32007-08-17 06:27:11 +0000119 equivalent to calling ``operator.add(*coerce(3, 4.5))`` and results in
120 ``operator.add(3.0, 4.5)``. Without coercion, all arguments of even
121 compatible types would have to be normalized to the same value by the
122 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000123
Georg Brandl437e6a32007-08-17 06:27:11 +0000124 complex number
125 An extension of the familiar real number system in which all numbers are
126 expressed as a sum of a real part and an imaginary part. Imaginary
127 numbers are real multiples of the imaginary unit (the square root of
128 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandld7d4fd72009-07-26 14:37:28 +0000129 engineering. Python has built-in support for complex numbers, which are
Georg Brandl437e6a32007-08-17 06:27:11 +0000130 written with this latter notation; the imaginary part is written with a
131 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
132 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
133 advanced mathematical feature. If you're not aware of a need for them,
134 it's almost certain you can safely ignore them.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000135
Skip Montanaroffe455c2007-12-08 15:23:31 +0000136 context manager
Skip Montanarof02c5f32008-09-15 02:03:05 +0000137 An object which controls the environment seen in a :keyword:`with`
Skip Montanaroffe455c2007-12-08 15:23:31 +0000138 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
139 See :pep:`343`.
140
Skip Montanarof02c5f32008-09-15 02:03:05 +0000141 CPython
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000142 The canonical implementation of the Python programming language, as
143 distributed on `python.org <http://python.org>`_. The term "CPython"
144 is used when necessary to distinguish this implementation from others
145 such as Jython or IronPython.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000146
Georg Brandl584265b2007-12-02 14:58:50 +0000147 decorator
148 A function returning another function, usually applied as a function
149 transformation using the ``@wrapper`` syntax. Common examples for
150 decorators are :func:`classmethod` and :func:`staticmethod`.
151
152 The decorator syntax is merely syntactic sugar, the following two
153 function definitions are semantically equivalent::
154
155 def f(...):
156 ...
157 f = staticmethod(f)
158
159 @staticmethod
160 def f(...):
161 ...
162
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200163 The same concept exists for classes, but is less commonly used there. See
164 the documentation for :ref:`function definitions <function>` and
165 :ref:`class definitions <class>` for more about decorators.
Georg Brandl5066c0c2008-12-05 18:00:06 +0000166
Georg Brandl437e6a32007-08-17 06:27:11 +0000167 descriptor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000168 Any *new-style* object which defines the methods :meth:`__get__`,
Georg Brandl5e52db02007-10-21 10:45:46 +0000169 :meth:`__set__`, or :meth:`__delete__`. When a class attribute is a
Georg Brandl437e6a32007-08-17 06:27:11 +0000170 descriptor, its special binding behavior is triggered upon attribute
Georg Brandl5e52db02007-10-21 10:45:46 +0000171 lookup. Normally, using *a.b* to get, set or delete an attribute looks up
172 the object named *b* in the class dictionary for *a*, but if *b* is a
173 descriptor, the respective descriptor method gets called. Understanding
174 descriptors is a key to a deep understanding of Python because they are
175 the basis for many features including functions, methods, properties,
176 class methods, static methods, and reference to super classes.
177
178 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000179
Georg Brandl437e6a32007-08-17 06:27:11 +0000180 dictionary
Senthil Kumaranc768d4c2012-03-12 10:05:04 -0700181 An associative array, where arbitrary keys are mapped to values. The
182 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
183 Called a hash in Perl.
Georg Brandle64f7382008-07-20 11:50:29 +0000184
185 docstring
Skip Montanarof02c5f32008-09-15 02:03:05 +0000186 A string literal which appears as the first expression in a class,
187 function or module. While ignored when the suite is executed, it is
188 recognized by the compiler and put into the :attr:`__doc__` attribute
189 of the enclosing class, function or module. Since it is available via
190 introspection, it is the canonical place for documentation of the
Georg Brandle64f7382008-07-20 11:50:29 +0000191 object.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000192
193 duck-typing
Georg Brandle85e1ae2010-10-06 09:17:24 +0000194 A programming style which does not look at an object's type to determine
195 if it has the right interface; instead, the method or attribute is simply
196 called or used ("If it looks like a duck and quacks like a duck, it
Georg Brandl437e6a32007-08-17 06:27:11 +0000197 must be a duck.") By emphasizing interfaces rather than specific types,
198 well-designed code improves its flexibility by allowing polymorphic
199 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl04eba2c2010-07-11 08:56:18 +0000200 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200201 with :term:`abstract base classes <abstract base class>`.) Instead, it
202 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000203
Georg Brandl437e6a32007-08-17 06:27:11 +0000204 EAFP
205 Easier to ask for forgiveness than permission. This common Python coding
206 style assumes the existence of valid keys or attributes and catches
207 exceptions if the assumption proves false. This clean and fast style is
208 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000209 statements. The technique contrasts with the :term:`LBYL` style
Skip Montanarof02c5f32008-09-15 02:03:05 +0000210 common to many other languages such as C.
Georg Brandl437e6a32007-08-17 06:27:11 +0000211
Georg Brandl584265b2007-12-02 14:58:50 +0000212 expression
213 A piece of syntax which can be evaluated to some value. In other words,
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200214 an expression is an accumulation of expression elements like literals,
215 names, attribute access, operators or function calls which all return a
216 value. In contrast to many other languages, not all language constructs
217 are expressions. There are also :term:`statement`\s which cannot be used
218 as expressions, such as :keyword:`print` or :keyword:`if`. Assignments
219 are also statements, not expressions.
Georg Brandl584265b2007-12-02 14:58:50 +0000220
Georg Brandl437e6a32007-08-17 06:27:11 +0000221 extension module
Georg Brandl28dadd92011-02-25 10:50:32 +0000222 A module written in C or C++, using Python's C API to interact with the
223 core and with user code.
Georg Brandl584265b2007-12-02 14:58:50 +0000224
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200225 file object
226 An object exposing a file-oriented API (with methods such as
227 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
228 on the way it was created, a file object can mediate access to a real
Sandro Tosifd4c4b12012-06-02 23:40:59 +0200229 on-disk file or to another type of storage or communication device
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200230 (for example standard input/output, in-memory buffers, sockets, pipes,
231 etc.). File objects are also called :dfn:`file-like objects` or
232 :dfn:`streams`.
233
234 There are actually three categories of file objects: raw binary files,
235 buffered binary files and text files. Their interfaces are defined in the
236 :mod:`io` module. The canonical way to create a file object is by using
237 the :func:`open` function.
238
239 file-like object
240 A synonym for :term:`file object`.
241
Georg Brandl624f3372009-03-31 16:11:45 +0000242 finder
243 An object that tries to find the :term:`loader` for a module. It must
244 implement a method named :meth:`find_module`. See :pep:`302` for
245 details.
246
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000247 floor division
248 Mathematical division that rounds down to nearest integer. The floor
249 division operator is ``//``. For example, the expression ``11 // 4``
250 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
251 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
252 rounded *downward*. See :pep:`238`.
253
Georg Brandl584265b2007-12-02 14:58:50 +0000254 function
255 A series of statements which returns some value to a caller. It can also
Chris Jerdonekcf4710c2012-12-25 14:50:21 -0800256 be passed zero or more :term:`arguments <argument>` which may be used in
257 the execution of the body. See also :term:`parameter`, :term:`method`,
258 and the :ref:`function` section.
Georg Brandl584265b2007-12-02 14:58:50 +0000259
Georg Brandl437e6a32007-08-17 06:27:11 +0000260 __future__
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000261 A pseudo-module which programmers can use to enable new language features
Georg Brandl437e6a32007-08-17 06:27:11 +0000262 which are not compatible with the current interpreter. For example, the
263 expression ``11/4`` currently evaluates to ``2``. If the module in which
264 it is executed had enabled *true division* by executing::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000265
Georg Brandl437e6a32007-08-17 06:27:11 +0000266 from __future__ import division
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000267
Georg Brandl437e6a32007-08-17 06:27:11 +0000268 the expression ``11/4`` would evaluate to ``2.75``. By importing the
269 :mod:`__future__` module and evaluating its variables, you can see when a
270 new feature was first added to the language and when it will become the
271 default::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000272
Georg Brandl437e6a32007-08-17 06:27:11 +0000273 >>> import __future__
274 >>> __future__.division
275 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
276
277 garbage collection
278 The process of freeing memory when it is not used anymore. Python
279 performs garbage collection via reference counting and a cyclic garbage
280 collector that is able to detect and break reference cycles.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000281
Georg Brandlea2d3892010-04-02 09:11:49 +0000282 .. index:: single: generator
283
Georg Brandl437e6a32007-08-17 06:27:11 +0000284 generator
Skip Montanarof02c5f32008-09-15 02:03:05 +0000285 A function which returns an iterator. It looks like a normal function
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000286 except that it contains :keyword:`yield` statements for producing a series
287 a values usable in a for-loop or that can be retrieved one at a time with
288 the :func:`next` function. Each :keyword:`yield` temporarily suspends
289 processing, remembering the location execution state (including local
290 variables and pending try-statements). When the generator resumes, it
291 picks-up where it left-off (in contrast to functions which start fresh on
292 every invocation).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000293
Georg Brandl437e6a32007-08-17 06:27:11 +0000294 .. index:: single: generator expression
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000295
Georg Brandl437e6a32007-08-17 06:27:11 +0000296 generator expression
Georg Brandlea2d3892010-04-02 09:11:49 +0000297 An expression that returns an iterator. It looks like a normal expression
Georg Brandl437e6a32007-08-17 06:27:11 +0000298 followed by a :keyword:`for` expression defining a loop variable, range,
299 and an optional :keyword:`if` expression. The combined expression
300 generates values for an enclosing function::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000301
Georg Brandl437e6a32007-08-17 06:27:11 +0000302 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
303 285
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000304
Georg Brandl437e6a32007-08-17 06:27:11 +0000305 GIL
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000306 See :term:`global interpreter lock`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000307
Georg Brandl437e6a32007-08-17 06:27:11 +0000308 global interpreter lock
Antoine Pitrou9f41bb32011-01-06 16:35:14 +0000309 The mechanism used by the :term:`CPython` interpreter to assure that
310 only one thread executes Python :term:`bytecode` at a time.
311 This simplifies the CPython implementation by making the object model
312 (including critical built-in types such as :class:`dict`) implicitly
313 safe against concurrent access. Locking the entire interpreter
314 makes it easier for the interpreter to be multi-threaded, at the
315 expense of much of the parallelism afforded by multi-processor
316 machines.
317
318 However, some extension modules, either standard or third-party,
319 are designed so as to release the GIL when doing computationally-intensive
320 tasks such as compression or hashing. Also, the GIL is always released
321 when doing I/O.
322
323 Past efforts to create a "free-threaded" interpreter (one which locks
324 shared data at a much finer granularity) have not been successful
325 because performance suffered in the common single-processor case. It
326 is believed that overcoming this performance issue would make the
327 implementation much more complicated and therefore costlier to maintain.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000328
329 hashable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000330 An object is *hashable* if it has a hash value which never changes during
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000331 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
332 other objects (it needs an :meth:`__eq__` or :meth:`__cmp__` method).
Skip Montanarof02c5f32008-09-15 02:03:05 +0000333 Hashable objects which compare equal must have the same hash value.
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000334
335 Hashability makes an object usable as a dictionary key and a set member,
336 because these data structures use the hash value internally.
337
Skip Montanarof02c5f32008-09-15 02:03:05 +0000338 All of Python's immutable built-in objects are hashable, while no mutable
339 containers (such as lists or dictionaries) are. Objects which are
Georg Brandl7c3e79f2007-11-02 20:06:17 +0000340 instances of user-defined classes are hashable by default; they all
Ezio Melotti139e4452013-02-01 05:18:44 +0200341 compare unequal (except with themselves), and their hash value is their
342 :func:`id`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000343
Georg Brandl437e6a32007-08-17 06:27:11 +0000344 IDLE
345 An Integrated Development Environment for Python. IDLE is a basic editor
Skip Montanarof02c5f32008-09-15 02:03:05 +0000346 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf1b678d2010-09-01 22:25:41 +0000347 Python.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000348
Georg Brandl437e6a32007-08-17 06:27:11 +0000349 immutable
Skip Montanarof02c5f32008-09-15 02:03:05 +0000350 An object with a fixed value. Immutable objects include numbers, strings and
351 tuples. Such an object cannot be altered. A new object has to
Georg Brandl437e6a32007-08-17 06:27:11 +0000352 be created if a different value has to be stored. They play an important
353 role in places where a constant hash value is needed, for example as a key
354 in a dictionary.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000355
Georg Brandl437e6a32007-08-17 06:27:11 +0000356 integer division
357 Mathematical division discarding any remainder. For example, the
358 expression ``11/4`` currently evaluates to ``2`` in contrast to the
359 ``2.75`` returned by float division. Also called *floor division*.
360 When dividing two integers the outcome will always be another integer
361 (having the floor function applied to it). However, if one of the operands
362 is another numeric type (such as a :class:`float`), the result will be
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000363 coerced (see :term:`coercion`) to a common type. For example, an integer
Georg Brandl437e6a32007-08-17 06:27:11 +0000364 divided by a float will result in a float value, possibly with a decimal
365 fraction. Integer division can be forced by using the ``//`` operator
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000366 instead of the ``/`` operator. See also :term:`__future__`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000367
Georg Brandl624f3372009-03-31 16:11:45 +0000368 importer
369 An object that both finds and loads a module; both a
370 :term:`finder` and :term:`loader` object.
371
Georg Brandl437e6a32007-08-17 06:27:11 +0000372 interactive
Skip Montanarof02c5f32008-09-15 02:03:05 +0000373 Python has an interactive interpreter which means you can enter
374 statements and expressions at the interpreter prompt, immediately
375 execute them and see their results. Just launch ``python`` with no
376 arguments (possibly by selecting it from your computer's main
377 menu). It is a very powerful way to test out new ideas or inspect
378 modules and packages (remember ``help(x)``).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000379
Georg Brandl437e6a32007-08-17 06:27:11 +0000380 interpreted
Skip Montanarof02c5f32008-09-15 02:03:05 +0000381 Python is an interpreted language, as opposed to a compiled one,
382 though the distinction can be blurry because of the presence of the
383 bytecode compiler. This means that source files can be run directly
384 without explicitly creating an executable which is then run.
385 Interpreted languages typically have a shorter development/debug cycle
386 than compiled ones, though their programs generally also run more
387 slowly. See also :term:`interactive`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000388
Georg Brandl437e6a32007-08-17 06:27:11 +0000389 iterable
Chris Jerdonek717e50e2013-01-04 04:41:34 -0800390 An object capable of returning its members one at a time. Examples of
391 iterables include all sequence types (such as :class:`list`, :class:`str`,
392 and :class:`tuple`) and some non-sequence types like :class:`dict`
393 and :class:`file` and objects of any classes you define
394 with an :meth:`__iter__` or :meth:`__getitem__` method. Iterables can be
395 used in a :keyword:`for` loop and in many other places where a sequence is
396 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
397 as an argument to the built-in function :func:`iter`, it returns an
398 iterator for the object. This iterator is good for one pass over the set
399 of values. When using iterables, it is usually not necessary to call
400 :func:`iter` or deal with iterator objects yourself. The ``for``
Georg Brandl437e6a32007-08-17 06:27:11 +0000401 statement does that automatically for you, creating a temporary unnamed
402 variable to hold the iterator for the duration of the loop. See also
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000403 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000404
Georg Brandl437e6a32007-08-17 06:27:11 +0000405 iterator
406 An object representing a stream of data. Repeated calls to the iterator's
407 :meth:`next` method return successive items in the stream. When no more
Skip Montanarof02c5f32008-09-15 02:03:05 +0000408 data are available a :exc:`StopIteration` exception is raised instead. At
Georg Brandl437e6a32007-08-17 06:27:11 +0000409 this point, the iterator object is exhausted and any further calls to its
410 :meth:`next` method just raise :exc:`StopIteration` again. Iterators are
411 required to have an :meth:`__iter__` method that returns the iterator
412 object itself so every iterator is also iterable and may be used in most
413 places where other iterables are accepted. One notable exception is code
Skip Montanarof02c5f32008-09-15 02:03:05 +0000414 which attempts multiple iteration passes. A container object (such as a
Georg Brandl437e6a32007-08-17 06:27:11 +0000415 :class:`list`) produces a fresh new iterator each time you pass it to the
416 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
417 with an iterator will just return the same exhausted iterator object used
418 in the previous iteration pass, making it appear like an empty container.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000419
Georg Brandle7a09902007-10-21 12:10:28 +0000420 More information can be found in :ref:`typeiter`.
421
Georg Brandl3b85b9b2010-11-26 08:20:18 +0000422 key function
423 A key function or collation function is a callable that returns a value
424 used for sorting or ordering. For example, :func:`locale.strxfrm` is
425 used to produce a sort key that is aware of locale specific sort
426 conventions.
427
428 A number of tools in Python accept key functions to control how elements
429 are ordered or grouped. They include :func:`min`, :func:`max`,
430 :func:`sorted`, :meth:`list.sort`, :func:`heapq.nsmallest`,
431 :func:`heapq.nlargest`, and :func:`itertools.groupby`.
432
433 There are several ways to create a key function. For example. the
434 :meth:`str.lower` method can serve as a key function for case insensitive
435 sorts. Alternatively, an ad-hoc key function can be built from a
436 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosid987c022012-04-01 01:49:46 +0200437 the :mod:`operator` module provides three key function constructors:
Georg Brandl3b85b9b2010-11-26 08:20:18 +0000438 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
439 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
440 <sortinghowto>` for examples of how to create and use key functions.
441
Georg Brandl584265b2007-12-02 14:58:50 +0000442 keyword argument
Chris Jerdonek8da82682012-11-29 19:03:37 -0800443 See :term:`argument`.
Georg Brandl584265b2007-12-02 14:58:50 +0000444
445 lambda
446 An anonymous inline function consisting of a single :term:`expression`
447 which is evaluated when the function is called. The syntax to create
448 a lambda function is ``lambda [arguments]: expression``
449
Georg Brandl437e6a32007-08-17 06:27:11 +0000450 LBYL
451 Look before you leap. This coding style explicitly tests for
452 pre-conditions before making calls or lookups. This style contrasts with
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000453 the :term:`EAFP` approach and is characterized by the presence of many
Georg Brandl437e6a32007-08-17 06:27:11 +0000454 :keyword:`if` statements.
Skip Montanaro9feab312008-09-15 02:19:53 +0000455
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200456 In a multi-threaded environment, the LBYL approach can risk introducing a
457 race condition between "the looking" and "the leaping". For example, the
458 code, ``if key in mapping: return mapping[key]`` can fail if another
459 thread removes *key* from *mapping* after the test, but before the lookup.
460 This issue can be solved with locks or by using the EAFP approach.
461
Skip Montanaro9feab312008-09-15 02:19:53 +0000462 list
463 A built-in Python :term:`sequence`. Despite its name it is more akin
464 to an array in other languages than to a linked list since access to
465 elements are O(1).
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000466
Georg Brandl437e6a32007-08-17 06:27:11 +0000467 list comprehension
Skip Montanarof02c5f32008-09-15 02:03:05 +0000468 A compact way to process all or part of the elements in a sequence and
Georg Brandl437e6a32007-08-17 06:27:11 +0000469 return a list with the results. ``result = ["0x%02x" % x for x in
Skip Montanarof02c5f32008-09-15 02:03:05 +0000470 range(256) if x % 2 == 0]`` generates a list of strings containing
471 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
472 clause is optional. If omitted, all elements in ``range(256)`` are
473 processed.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000474
Georg Brandl624f3372009-03-31 16:11:45 +0000475 loader
476 An object that loads a module. It must define a method named
477 :meth:`load_module`. A loader is typically returned by a
478 :term:`finder`. See :pep:`302` for details.
479
Georg Brandl437e6a32007-08-17 06:27:11 +0000480 mapping
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000481 A container object that supports arbitrary key lookups and implements the
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200482 methods specified in the :class:`~collections.Mapping` or
483 :class:`~collections.MutableMapping`
Éric Araujo8fde9502011-07-29 11:34:17 +0200484 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
485 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingerc4c52dd2011-01-08 23:50:39 +0000486 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000487
Georg Brandl437e6a32007-08-17 06:27:11 +0000488 metaclass
489 The class of a class. Class definitions create a class name, a class
490 dictionary, and a list of base classes. The metaclass is responsible for
491 taking those three arguments and creating the class. Most object oriented
492 programming languages provide a default implementation. What makes Python
493 special is that it is possible to create custom metaclasses. Most users
494 never need this tool, but when the need arises, metaclasses can provide
495 powerful, elegant solutions. They have been used for logging attribute
496 access, adding thread-safety, tracking object creation, implementing
497 singletons, and many other tasks.
Georg Brandla7395032007-10-21 12:15:05 +0000498
499 More information can be found in :ref:`metaclasses`.
Georg Brandl584265b2007-12-02 14:58:50 +0000500
501 method
Skip Montanarof02c5f32008-09-15 02:03:05 +0000502 A function which is defined inside a class body. If called as an attribute
Georg Brandl584265b2007-12-02 14:58:50 +0000503 of an instance of that class, the method will get the instance object as
504 its first :term:`argument` (which is usually called ``self``).
505 See :term:`function` and :term:`nested scope`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000506
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200507 method resolution order
508 Method Resolution Order is the order in which base classes are searched
509 for a member during lookup. See `The Python 2.3 Method Resolution Order
510 <http://www.python.org/download/releases/2.3/mro/>`_.
511
512 MRO
513 See :term:`method resolution order`.
514
Georg Brandl437e6a32007-08-17 06:27:11 +0000515 mutable
516 Mutable objects can change their value but keep their :func:`id`. See
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000517 also :term:`immutable`.
Georg Brandle3c3db52008-01-11 09:55:53 +0000518
519 named tuple
Raymond Hettingeraff711d2009-02-04 19:25:17 +0000520 Any tuple-like class whose indexable elements are also accessible using
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000521 named attributes (for example, :func:`time.localtime` returns a
Raymond Hettinger8bdd0442008-01-13 06:18:07 +0000522 tuple-like object where the *year* is accessible either with an
Raymond Hettingerc20ed512008-01-13 06:15:15 +0000523 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
524
525 A named tuple can be a built-in type such as :class:`time.struct_time`,
526 or it can be created with a regular class definition. A full featured
527 named tuple can also be created with the factory function
528 :func:`collections.namedtuple`. The latter approach automatically
529 provides extra features such as a self-documenting representation like
530 ``Employee(name='jones', title='programmer')``.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000531
Georg Brandl437e6a32007-08-17 06:27:11 +0000532 namespace
533 The place where a variable is stored. Namespaces are implemented as
Georg Brandld7d4fd72009-07-26 14:37:28 +0000534 dictionaries. There are the local, global and built-in namespaces as well
Georg Brandl437e6a32007-08-17 06:27:11 +0000535 as nested namespaces in objects (in methods). Namespaces support
536 modularity by preventing naming conflicts. For instance, the functions
537 :func:`__builtin__.open` and :func:`os.open` are distinguished by their
538 namespaces. Namespaces also aid readability and maintainability by making
539 it clear which module implements a function. For instance, writing
540 :func:`random.seed` or :func:`itertools.izip` makes it clear that those
541 functions are implemented by the :mod:`random` and :mod:`itertools`
Skip Montanarof02c5f32008-09-15 02:03:05 +0000542 modules, respectively.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000543
Georg Brandl437e6a32007-08-17 06:27:11 +0000544 nested scope
545 The ability to refer to a variable in an enclosing definition. For
546 instance, a function defined inside another function can refer to
Sandro Tosi03c61102012-01-17 18:32:02 +0100547 variables in the outer function. Note that nested scopes work only for
548 reference and not for assignment which will always write to the innermost
549 scope. In contrast, local variables both read and write in the innermost
550 scope. Likewise, global variables read and write to the global namespace.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000551
Georg Brandl437e6a32007-08-17 06:27:11 +0000552 new-style class
Skip Montanarof02c5f32008-09-15 02:03:05 +0000553 Any class which inherits from :class:`object`. This includes all built-in
Georg Brandl437e6a32007-08-17 06:27:11 +0000554 types like :class:`list` and :class:`dict`. Only new-style classes can
555 use Python's newer, versatile features like :attr:`__slots__`,
Skip Montanarof02c5f32008-09-15 02:03:05 +0000556 descriptors, properties, and :meth:`__getattribute__`.
Georg Brandla7395032007-10-21 12:15:05 +0000557
558 More information can be found in :ref:`newstyle`.
Skip Montanaro9feab312008-09-15 02:19:53 +0000559
560 object
561 Any data with state (attributes or value) and defined behavior
562 (methods). Also the ultimate base class of any :term:`new-style
563 class`.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000564
Chris Jerdonek8da82682012-11-29 19:03:37 -0800565 parameter
566 A named entity in a :term:`function` (or method) definition that
567 specifies an :term:`argument` (or in some cases, arguments) that the
568 function can accept. There are four types of parameters:
569
570 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
571 either :term:`positionally <argument>` or as a :term:`keyword argument
572 <argument>`. This is the default kind of parameter, for example *foo*
573 and *bar* in the following::
574
575 def func(foo, bar=None): ...
576
577 * :dfn:`positional-only`: specifies an argument that can be supplied only
578 by position. Python has no syntax for defining positional-only
579 parameters. However, some built-in functions have positional-only
580 parameters (e.g. :func:`abs`).
581
582 * :dfn:`var-positional`: specifies that an arbitrary sequence of
583 positional arguments can be provided (in addition to any positional
584 arguments already accepted by other parameters). Such a parameter can
585 be defined by prepending the parameter name with ``*``, for example
586 *args* in the following::
587
588 def func(*args, **kwargs): ...
589
590 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
591 can be provided (in addition to any keyword arguments already accepted
592 by other parameters). Such a parameter can be defined by prepending
593 the parameter name with ``**``, for example *kwargs* in the example
594 above.
595
596 Parameters can specify both optional and required arguments, as well as
597 default values for some optional arguments.
598
599 See also the :term:`argument` glossary entry, the FAQ question on
600 :ref:`the difference between arguments and parameters
601 <faq-argument-vs-parameter>`, and the :ref:`function` section.
602
Georg Brandl584265b2007-12-02 14:58:50 +0000603 positional argument
Chris Jerdonek8da82682012-11-29 19:03:37 -0800604 See :term:`argument`.
Georg Brandl584265b2007-12-02 14:58:50 +0000605
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000606 Python 3000
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200607 Nickname for the Python 3.x release line (coined long ago when the release
608 of version 3 was something in the distant future.) This is also
609 abbreviated "Py3k".
Georg Brandl437e6a32007-08-17 06:27:11 +0000610
Georg Brandl584265b2007-12-02 14:58:50 +0000611 Pythonic
Skip Montanarof02c5f32008-09-15 02:03:05 +0000612 An idea or piece of code which closely follows the most common idioms
613 of the Python language, rather than implementing code using concepts
614 common to other languages. For example, a common idiom in Python is
615 to loop over all elements of an iterable using a :keyword:`for`
616 statement. Many other languages don't have this type of construct, so
617 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000618
Georg Brandl584265b2007-12-02 14:58:50 +0000619 for i in range(len(food)):
620 print food[i]
621
622 As opposed to the cleaner, Pythonic method::
623
624 for piece in food:
625 print piece
626
Georg Brandl437e6a32007-08-17 06:27:11 +0000627 reference count
Skip Montanarof02c5f32008-09-15 02:03:05 +0000628 The number of references to an object. When the reference count of an
629 object drops to zero, it is deallocated. Reference counting is
630 generally not visible to Python code, but it is a key element of the
631 :term:`CPython` implementation. The :mod:`sys` module defines a
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200632 :func:`~sys.getrefcount` function that programmers can call to return the
Skip Montanarof02c5f32008-09-15 02:03:05 +0000633 reference count for a particular object.
634
Georg Brandl437e6a32007-08-17 06:27:11 +0000635 __slots__
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000636 A declaration inside a :term:`new-style class` that saves memory by
Georg Brandl437e6a32007-08-17 06:27:11 +0000637 pre-declaring space for instance attributes and eliminating instance
638 dictionaries. Though popular, the technique is somewhat tricky to get
639 right and is best reserved for rare cases where there are large numbers of
640 instances in a memory-critical application.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000641
Georg Brandl437e6a32007-08-17 06:27:11 +0000642 sequence
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000643 An :term:`iterable` which supports efficient element access using integer
Skip Montanarof02c5f32008-09-15 02:03:05 +0000644 indices via the :meth:`__getitem__` special method and defines a
645 :meth:`len` method that returns the length of the sequence.
Georg Brandl437e6a32007-08-17 06:27:11 +0000646 Some built-in sequence types are :class:`list`, :class:`str`,
647 :class:`tuple`, and :class:`unicode`. Note that :class:`dict` also
648 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
649 mapping rather than a sequence because the lookups use arbitrary
Georg Brandl6c82b6c2007-08-17 16:54:59 +0000650 :term:`immutable` keys rather than integers.
Georg Brandl437e6a32007-08-17 06:27:11 +0000651
Georg Brandl584265b2007-12-02 14:58:50 +0000652 slice
Georg Brandl968a3e52007-12-02 18:17:50 +0000653 An object usually containing a portion of a :term:`sequence`. A slice is
Georg Brandl584265b2007-12-02 14:58:50 +0000654 created using the subscript notation, ``[]`` with colons between numbers
655 when several are given, such as in ``variable_name[1:3:5]``. The bracket
656 (subscript) notation uses :class:`slice` objects internally (or in older
657 versions, :meth:`__getslice__` and :meth:`__setslice__`).
658
Georg Brandl9a053732008-12-05 15:29:39 +0000659 special method
660 A method that is called implicitly by Python to execute a certain
661 operation on a type, such as addition. Such methods have names starting
662 and ending with double underscores. Special methods are documented in
663 :ref:`specialnames`.
664
Georg Brandl584265b2007-12-02 14:58:50 +0000665 statement
666 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandlbcc55d62013-10-06 11:57:13 +0200667 an :term:`expression` or one of several constructs with a keyword, such
Éric Araujoa8f66dd2011-08-19 01:27:00 +0200668 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
669
670 struct sequence
671 A tuple with named elements. Struct sequences expose an interface similiar
672 to :term:`named tuple` in that elements can either be accessed either by
673 index or as an attribute. However, they do not have any of the named tuple
674 methods like :meth:`~collections.somenamedtuple._make` or
675 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
676 include :data:`sys.float_info` and the return value of :func:`os.stat`.
Georg Brandl584265b2007-12-02 14:58:50 +0000677
Skip Montanaro9feab312008-09-15 02:19:53 +0000678 triple-quoted string
679 A string which is bound by three instances of either a quotation mark
680 (") or an apostrophe ('). While they don't provide any functionality
681 not available with single-quoted strings, they are useful for a number
682 of reasons. They allow you to include unescaped single and double
683 quotes within a string and they can span multiple lines without the
684 use of the continuation character, making them especially useful when
685 writing docstrings.
686
Georg Brandl437e6a32007-08-17 06:27:11 +0000687 type
688 The type of a Python object determines what kind of object it is; every
689 object has a type. An object's type is accessible as its
690 :attr:`__class__` attribute or can be retrieved with ``type(obj)``.
Skip Montanarof02c5f32008-09-15 02:03:05 +0000691
R David Murray5618aaa2012-08-15 11:15:39 -0400692 universal newlines
693 A manner of interpreting text streams in which all of the following are
694 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
695 the Windows convention ``'\r\n'``, and the old Macintosh convention
696 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
697 :func:`str.splitlines` for an additional use.
698
Alexandre Vassalotti69eb5162010-01-11 23:17:10 +0000699 view
700 The objects returned from :meth:`dict.viewkeys`, :meth:`dict.viewvalues`,
701 and :meth:`dict.viewitems` are called dictionary views. They are lazy
702 sequences that will see changes in the underlying dictionary. To force
703 the dictionary view to become a full list use ``list(dictview)``. See
704 :ref:`dict-views`.
705
Skip Montanarof02c5f32008-09-15 02:03:05 +0000706 virtual machine
707 A computer defined entirely in software. Python's virtual machine
708 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandlc62ef8b2009-01-03 20:55:06 +0000709
Georg Brandl437e6a32007-08-17 06:27:11 +0000710 Zen of Python
711 Listing of Python design principles and philosophies that are helpful in
712 understanding and using the language. The listing can be found by typing
713 "``import this``" at the interactive prompt.