blob: 57c6ddd72523cb5a2ca9c879c089feb6701c1be8 [file] [log] [blame]
Guido van Rossumf10aa982007-08-17 18:30:38 +00001.. _glossary:
2
3********
4Glossary
5********
6
7.. if you add new entries, keep the alphabetical sorting!
8
9.. glossary::
10
11 ``>>>``
Benjamin Peterson5478b472008-09-17 22:25:09 +000012 The default Python prompt of the interactive shell. Often seen for code
13 examples which can be executed interactively in the interpreter.
Georg Brandl48310cd2009-01-03 21:18:54 +000014
Guido van Rossumf10aa982007-08-17 18:30:38 +000015 ``...``
Benjamin Peterson5478b472008-09-17 22:25:09 +000016 The default Python prompt of the interactive shell when entering code for
17 an indented code block or within a pair of matching left and right
18 delimiters (parentheses, square brackets or curly braces).
Christian Heimesd8654cf2007-12-02 15:22:16 +000019
Benjamin Petersond6313712008-07-31 16:23:04 +000020 2to3
21 A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl6faee4e2010-09-21 14:48:28 +000022 handling most of the incompatibilities which can be detected by parsing the
Benjamin Petersond6313712008-07-31 16:23:04 +000023 source and traversing the parse tree.
24
25 2to3 is available in the standard library as :mod:`lib2to3`; a standalone
26 entry point is provided as :file:`Tools/scripts/2to3`. See
27 :ref:`2to3-reference`.
28
Georg Brandl86b2fb92008-07-16 03:43:04 +000029 abstract base class
Éric Araujofa088db2011-06-04 18:42:38 +020030 Abstract base classes complement :term:`duck-typing` by
Georg Brandl22b34312009-07-26 14:54:51 +000031 providing a way to define interfaces when other techniques like
Éric Araujofa088db2011-06-04 18:42:38 +020032 :func:`hasattr` would be clumsy or subtly wrong (for example with
Éric Araujo04ac59a2011-08-19 09:07:46 +020033 :ref:`magic methods <special-lookup>`). ABCs introduce virtual
34 subclasses, which are classes that don't inherit from a class but are
35 still recognized by :func:`isinstance` and :func:`issubclass`; see the
36 :mod:`abc` module documentation. Python comes with many built-in ABCs for
Éric Araujo459b4522011-06-04 21:16:42 +020037 data structures (in the :mod:`collections.abc` module), numbers (in the
Éric Araujofa088db2011-06-04 18:42:38 +020038 :mod:`numbers` module), streams (in the :mod:`io` module), import finders
39 and loaders (in the :mod:`importlib.abc` module). You can create your own
40 ABCs with the :mod:`abc` module.
Benjamin Peterson41181742008-07-02 20:22:54 +000041
Christian Heimesd8654cf2007-12-02 15:22:16 +000042 argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080043 A value passed to a :term:`function` (or :term:`method`) when calling the
Zachary Waree1391a02013-11-22 13:58:34 -060044 function. There are two kinds of argument:
Christian Heimesd8654cf2007-12-02 15:22:16 +000045
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -080046 * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
47 ``name=``) in a function call or passed as a value in a dictionary
48 preceded by ``**``. For example, ``3`` and ``5`` are both keyword
49 arguments in the following calls to :func:`complex`::
50
51 complex(real=3, imag=5)
52 complex(**{'real': 3, 'imag': 5})
53
54 * :dfn:`positional argument`: an argument that is not a keyword argument.
55 Positional arguments can appear at the beginning of an argument list
56 and/or be passed as elements of an :term:`iterable` preceded by ``*``.
57 For example, ``3`` and ``5`` are both positional arguments in the
58 following calls::
59
60 complex(3, 5)
61 complex(*(3, 5))
62
63 Arguments are assigned to the named local variables in a function body.
64 See the :ref:`calls` section for the rules governing this assignment.
65 Syntactically, any expression can be used to represent an argument; the
66 evaluated value is assigned to the local variable.
67
68 See also the :term:`parameter` glossary entry, the FAQ question on
69 :ref:`the difference between arguments and parameters
70 <faq-argument-vs-parameter>`, and :pep:`362`.
Benjamin Peterson5478b472008-09-17 22:25:09 +000071
72 attribute
73 A value associated with an object which is referenced by name using
74 dotted expressions. For example, if an object *o* has an attribute
75 *a* it would be referenced as *o.a*.
Georg Brandl48310cd2009-01-03 21:18:54 +000076
Guido van Rossumf10aa982007-08-17 18:30:38 +000077 BDFL
78 Benevolent Dictator For Life, a.k.a. `Guido van Rossum
Georg Brandle73778c2014-10-29 08:36:35 +010079 <https://www.python.org/~guido/>`_, Python's creator.
Georg Brandl48310cd2009-01-03 21:18:54 +000080
Antoine Pitroudd799d22013-12-05 23:46:32 +010081 binary file
82 A :term:`file object` able to read and write
83 :term:`bytes-like objects <bytes-like object>`.
84
85 .. seealso::
86 A :term:`text file` reads and writes :class:`str` objects.
87
Ezio Melottiaa54e2f2013-04-30 23:33:31 +030088 bytes-like object
Antoine Pitrou5de183a2013-05-04 20:18:34 +020089 An object that supports the :ref:`bufferobjects`, like :class:`bytes`,
90 :class:`bytearray` or :class:`memoryview`. Bytes-like objects can
Larry Hastingsab792ac2015-04-13 11:30:56 -040091 be used for various operations that work with binary data; these include
92 compression, saving to a binary file, and sending over a socket.
93
94 Some operations need the binary data to be mutable. The documentation
95 often refers to these as "read-write bytes-like objects". Example
96 mutable buffer objects include :class:`bytearray` and a
97 :class:`memoryview` of a :class:`bytearray`.
98 Other operations require the binary data to be stored in
99 immutable objects ("read-only bytes-like objects"); examples
100 of these include :class:`bytes` and a :class:`memoryview`
101 of a :class:`bytes` object.
Ezio Melottiaa54e2f2013-04-30 23:33:31 +0300102
Georg Brandl9afde1c2007-11-01 20:32:30 +0000103 bytecode
104 Python source code is compiled into bytecode, the internal representation
Brett Cannon8315fd12010-07-02 22:03:00 +0000105 of a Python program in the CPython interpreter. The bytecode is also
106 cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
107 faster the second time (recompilation from source to bytecode can be
108 avoided). This "intermediate language" is said to run on a
109 :term:`virtual machine` that executes the machine code corresponding to
110 each bytecode. Do note that bytecodes are not expected to work between
111 different Python virtual machines, nor to be stable between Python
112 releases.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000113
Georg Brandl2cb72d32010-07-03 10:26:54 +0000114 A list of bytecode instructions can be found in the documentation for
115 :ref:`the dis module <bytecodes>`.
116
Benjamin Peterson5478b472008-09-17 22:25:09 +0000117 class
118 A template for creating user-defined objects. Class definitions
119 normally contain method definitions which operate on instances of the
120 class.
Georg Brandl48310cd2009-01-03 21:18:54 +0000121
Benjamin Peterson5478b472008-09-17 22:25:09 +0000122 coercion
123 The implicit conversion of an instance of one type to another during an
124 operation which involves two arguments of the same type. For example,
125 ``int(3.15)`` converts the floating point number to the integer ``3``, but
126 in ``3+4.5``, each argument is of a different type (one int, one float),
127 and both must be converted to the same type before they can be added or it
Benjamin Peterson2d718222008-11-21 00:25:02 +0000128 will raise a ``TypeError``. Without coercion, all arguments of even
Benjamin Peterson5478b472008-09-17 22:25:09 +0000129 compatible types would have to be normalized to the same value by the
130 programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000131
Guido van Rossumf10aa982007-08-17 18:30:38 +0000132 complex number
133 An extension of the familiar real number system in which all numbers are
134 expressed as a sum of a real part and an imaginary part. Imaginary
135 numbers are real multiples of the imaginary unit (the square root of
136 ``-1``), often written ``i`` in mathematics or ``j`` in
Georg Brandl22b34312009-07-26 14:54:51 +0000137 engineering. Python has built-in support for complex numbers, which are
Guido van Rossumf10aa982007-08-17 18:30:38 +0000138 written with this latter notation; the imaginary part is written with a
139 ``j`` suffix, e.g., ``3+1j``. To get access to complex equivalents of the
140 :mod:`math` module, use :mod:`cmath`. Use of complex numbers is a fairly
141 advanced mathematical feature. If you're not aware of a need for them,
142 it's almost certain you can safely ignore them.
Georg Brandl48310cd2009-01-03 21:18:54 +0000143
Christian Heimes895627f2007-12-08 17:28:33 +0000144 context manager
Benjamin Peterson5478b472008-09-17 22:25:09 +0000145 An object which controls the environment seen in a :keyword:`with`
Christian Heimes895627f2007-12-08 17:28:33 +0000146 statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
147 See :pep:`343`.
148
Benjamin Peterson5478b472008-09-17 22:25:09 +0000149 CPython
Antoine Pitrou00342812011-01-06 16:31:28 +0000150 The canonical implementation of the Python programming language, as
Georg Brandle73778c2014-10-29 08:36:35 +0100151 distributed on `python.org <https://www.python.org>`_. The term "CPython"
Antoine Pitrou00342812011-01-06 16:31:28 +0000152 is used when necessary to distinguish this implementation from others
153 such as Jython or IronPython.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000154
Christian Heimesd8654cf2007-12-02 15:22:16 +0000155 decorator
156 A function returning another function, usually applied as a function
157 transformation using the ``@wrapper`` syntax. Common examples for
158 decorators are :func:`classmethod` and :func:`staticmethod`.
159
160 The decorator syntax is merely syntactic sugar, the following two
161 function definitions are semantically equivalent::
162
163 def f(...):
164 ...
165 f = staticmethod(f)
166
167 @staticmethod
168 def f(...):
169 ...
170
Georg Brandlaf265f42008-12-07 15:06:20 +0000171 The same concept exists for classes, but is less commonly used there. See
172 the documentation for :ref:`function definitions <function>` and
173 :ref:`class definitions <class>` for more about decorators.
Georg Brandla09ca382007-12-02 18:20:12 +0000174
Guido van Rossumf10aa982007-08-17 18:30:38 +0000175 descriptor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000176 Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl85eb8c12007-08-31 16:33:38 +0000177 :meth:`__delete__`. When a class attribute is a descriptor, its special
Georg Brandl9afde1c2007-11-01 20:32:30 +0000178 binding behavior is triggered upon attribute lookup. Normally, using
179 *a.b* to get, set or delete an attribute looks up the object named *b* in
180 the class dictionary for *a*, but if *b* is a descriptor, the respective
181 descriptor method gets called. Understanding descriptors is a key to a
182 deep understanding of Python because they are the basis for many features
183 including functions, methods, properties, class methods, static methods,
184 and reference to super classes.
185
186 For more information about descriptors' methods, see :ref:`descriptors`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000187
Guido van Rossumf10aa982007-08-17 18:30:38 +0000188 dictionary
Senthil Kumaran6080db72012-03-12 10:05:34 -0700189 An associative array, where arbitrary keys are mapped to values. The
190 keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
191 Called a hash in Perl.
Georg Brandl3dbca812008-07-23 16:10:53 +0000192
193 docstring
Benjamin Peterson5478b472008-09-17 22:25:09 +0000194 A string literal which appears as the first expression in a class,
195 function or module. While ignored when the suite is executed, it is
196 recognized by the compiler and put into the :attr:`__doc__` attribute
197 of the enclosing class, function or module. Since it is available via
198 introspection, it is the canonical place for documentation of the
Georg Brandl3dbca812008-07-23 16:10:53 +0000199 object.
Georg Brandl48310cd2009-01-03 21:18:54 +0000200
201 duck-typing
Georg Brandl73b1c7b2010-07-10 10:39:57 +0000202 A programming style which does not look at an object's type to determine
203 if it has the right interface; instead, the method or attribute is simply
204 called or used ("If it looks like a duck and quacks like a duck, it
Guido van Rossumf10aa982007-08-17 18:30:38 +0000205 must be a duck.") By emphasizing interfaces rather than specific types,
206 well-designed code improves its flexibility by allowing polymorphic
207 substitution. Duck-typing avoids tests using :func:`type` or
Georg Brandl8a1c2542010-07-11 08:36:20 +0000208 :func:`isinstance`. (Note, however, that duck-typing can be complemented
Éric Araujo0519b092011-08-19 00:39:19 +0200209 with :term:`abstract base classes <abstract base class>`.) Instead, it
210 typically employs :func:`hasattr` tests or :term:`EAFP` programming.
Georg Brandl48310cd2009-01-03 21:18:54 +0000211
Guido van Rossumf10aa982007-08-17 18:30:38 +0000212 EAFP
213 Easier to ask for forgiveness than permission. This common Python coding
214 style assumes the existence of valid keys or attributes and catches
215 exceptions if the assumption proves false. This clean and fast style is
216 characterized by the presence of many :keyword:`try` and :keyword:`except`
Georg Brandl48310cd2009-01-03 21:18:54 +0000217 statements. The technique contrasts with the :term:`LBYL` style
Benjamin Peterson5478b472008-09-17 22:25:09 +0000218 common to many other languages such as C.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000219
Christian Heimesd8654cf2007-12-02 15:22:16 +0000220 expression
221 A piece of syntax which can be evaluated to some value. In other words,
Benjamin Peterson5478b472008-09-17 22:25:09 +0000222 an expression is an accumulation of expression elements like literals,
223 names, attribute access, operators or function calls which all return a
224 value. In contrast to many other languages, not all language constructs
225 are expressions. There are also :term:`statement`\s which cannot be used
226 as expressions, such as :keyword:`if`. Assignments are also statements,
227 not expressions.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000228
Guido van Rossumf10aa982007-08-17 18:30:38 +0000229 extension module
Georg Brandl9d9848e2010-12-28 11:48:53 +0000230 A module written in C or C++, using Python's C API to interact with the
231 core and with user code.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000232
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000233 file object
234 An object exposing a file-oriented API (with methods such as
Georg Brandl9d9848e2010-12-28 11:48:53 +0000235 :meth:`read()` or :meth:`write()`) to an underlying resource. Depending
236 on the way it was created, a file object can mediate access to a real
Eli Benderskydbaedb82012-03-30 11:02:05 +0300237 on-disk file or to another type of storage or communication device
Georg Brandl9d9848e2010-12-28 11:48:53 +0000238 (for example standard input/output, in-memory buffers, sockets, pipes,
239 etc.). File objects are also called :dfn:`file-like objects` or
240 :dfn:`streams`.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000241
Antoine Pitroudd799d22013-12-05 23:46:32 +0100242 There are actually three categories of file objects: raw
243 :term:`binary files <binary file>`, buffered
244 :term:`binary files <binary file>` and :term:`text files <text file>`.
245 Their interfaces are defined in the :mod:`io` module. The canonical
246 way to create a file object is by using the :func:`open` function.
Antoine Pitrou0b65b0f2010-09-15 09:58:26 +0000247
248 file-like object
249 A synonym for :term:`file object`.
250
Brett Cannon51d4aab2009-01-25 04:21:39 +0000251 finder
252 An object that tries to find the :term:`loader` for a module. It must
Barry Warsawd7d21942012-07-29 16:36:17 -0400253 implement either a method named :meth:`find_loader` or a method named
254 :meth:`find_module`. See :pep:`302` and :pep:`420` for details and
255 :class:`importlib.abc.Finder` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000256
Benjamin Peterson2d718222008-11-21 00:25:02 +0000257 floor division
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000258 Mathematical division that rounds down to nearest integer. The floor
259 division operator is ``//``. For example, the expression ``11 // 4``
260 evaluates to ``2`` in contrast to the ``2.75`` returned by float true
261 division. Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
262 rounded *downward*. See :pep:`238`.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000263
Christian Heimesd8654cf2007-12-02 15:22:16 +0000264 function
265 A series of statements which returns some value to a caller. It can also
Chris Jerdonekb4309942012-12-25 14:54:44 -0800266 be passed zero or more :term:`arguments <argument>` which may be used in
267 the execution of the body. See also :term:`parameter`, :term:`method`,
268 and the :ref:`function` section.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000269
R David Murray25cd0912013-05-06 12:58:16 -0400270 function annotation
271 An arbitrary metadata value associated with a function parameter or return
272 value. Its syntax is explained in section :ref:`function`. Annotations
273 may be accessed via the :attr:`__annotations__` special attribute of a
274 function object.
275
276 Python itself does not assign any particular meaning to function
277 annotations. They are intended to be interpreted by third-party libraries
278 or tools. See :pep:`3107`, which describes some of their potential uses.
279
Guido van Rossumf10aa982007-08-17 18:30:38 +0000280 __future__
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000281 A pseudo-module which programmers can use to enable new language features
Benjamin Peterson2d718222008-11-21 00:25:02 +0000282 which are not compatible with the current interpreter.
283
284 By importing the :mod:`__future__` module and evaluating its variables,
285 you can see when a new feature was first added to the language and when it
286 becomes the default::
Georg Brandl48310cd2009-01-03 21:18:54 +0000287
Guido van Rossumf10aa982007-08-17 18:30:38 +0000288 >>> import __future__
289 >>> __future__.division
290 _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
291
292 garbage collection
293 The process of freeing memory when it is not used anymore. Python
294 performs garbage collection via reference counting and a cyclic garbage
295 collector that is able to detect and break reference cycles.
Georg Brandl48310cd2009-01-03 21:18:54 +0000296
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000297 .. index:: single: generator
298
Guido van Rossumf10aa982007-08-17 18:30:38 +0000299 generator
Benjamin Peterson5478b472008-09-17 22:25:09 +0000300 A function which returns an iterator. It looks like a normal function
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000301 except that it contains :keyword:`yield` statements for producing a series
Georg Brandlcaa12da2015-01-15 08:16:01 +0100302 of values usable in a for-loop or that can be retrieved one at a time with
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000303 the :func:`next` function. Each :keyword:`yield` temporarily suspends
304 processing, remembering the location execution state (including local
305 variables and pending try-statements). When the generator resumes, it
306 picks-up where it left-off (in contrast to functions which start fresh on
Éric Araujoe0854f92011-05-27 04:36:52 +0200307 every invocation).
Georg Brandl48310cd2009-01-03 21:18:54 +0000308
Guido van Rossumf10aa982007-08-17 18:30:38 +0000309 .. index:: single: generator expression
Georg Brandl48310cd2009-01-03 21:18:54 +0000310
Guido van Rossumf10aa982007-08-17 18:30:38 +0000311 generator expression
Benjamin Peterson08bf91c2010-04-11 16:12:57 +0000312 An expression that returns an iterator. It looks like a normal expression
Guido van Rossumf10aa982007-08-17 18:30:38 +0000313 followed by a :keyword:`for` expression defining a loop variable, range,
314 and an optional :keyword:`if` expression. The combined expression
315 generates values for an enclosing function::
Georg Brandl48310cd2009-01-03 21:18:54 +0000316
Guido van Rossumf10aa982007-08-17 18:30:38 +0000317 >>> sum(i*i for i in range(10)) # sum of squares 0, 1, 4, ... 81
318 285
Georg Brandl48310cd2009-01-03 21:18:54 +0000319
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200320 generic function
321 A function composed of multiple functions implementing the same operation
322 for different types. Which implementation should be used during a call is
323 determined by the dispatch algorithm.
324
325 See also the :term:`single dispatch` glossary entry, the
326 :func:`functools.singledispatch` decorator, and :pep:`443`.
327
328
Guido van Rossumf10aa982007-08-17 18:30:38 +0000329 GIL
330 See :term:`global interpreter lock`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000331
Guido van Rossumf10aa982007-08-17 18:30:38 +0000332 global interpreter lock
Antoine Pitrou00342812011-01-06 16:31:28 +0000333 The mechanism used by the :term:`CPython` interpreter to assure that
334 only one thread executes Python :term:`bytecode` at a time.
335 This simplifies the CPython implementation by making the object model
336 (including critical built-in types such as :class:`dict`) implicitly
337 safe against concurrent access. Locking the entire interpreter
338 makes it easier for the interpreter to be multi-threaded, at the
339 expense of much of the parallelism afforded by multi-processor
340 machines.
341
342 However, some extension modules, either standard or third-party,
343 are designed so as to release the GIL when doing computationally-intensive
344 tasks such as compression or hashing. Also, the GIL is always released
345 when doing I/O.
346
347 Past efforts to create a "free-threaded" interpreter (one which locks
348 shared data at a much finer granularity) have not been successful
349 because performance suffered in the common single-processor case. It
350 is believed that overcoming this performance issue would make the
351 implementation much more complicated and therefore costlier to maintain.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000352
353 hashable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000354 An object is *hashable* if it has a hash value which never changes during
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000355 its lifetime (it needs a :meth:`__hash__` method), and can be compared to
Georg Brandl05f5ab72008-09-24 09:11:47 +0000356 other objects (it needs an :meth:`__eq__` method). Hashable objects which
357 compare equal must have the same hash value.
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000358
359 Hashability makes an object usable as a dictionary key and a set member,
360 because these data structures use the hash value internally.
361
Benjamin Peterson5478b472008-09-17 22:25:09 +0000362 All of Python's immutable built-in objects are hashable, while no mutable
363 containers (such as lists or dictionaries) are. Objects which are
Guido van Rossum2cc30da2007-11-02 23:46:40 +0000364 instances of user-defined classes are hashable by default; they all
Georg Brandl4dd27a32014-10-06 16:45:23 +0200365 compare unequal (except with themselves), and their hash value is derived
366 from their :func:`id`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000367
Guido van Rossumf10aa982007-08-17 18:30:38 +0000368 IDLE
369 An Integrated Development Environment for Python. IDLE is a basic editor
Benjamin Peterson5478b472008-09-17 22:25:09 +0000370 and interpreter environment which ships with the standard distribution of
Raymond Hettingerf37ca3c2010-09-01 22:11:53 +0000371 Python.
Georg Brandl48310cd2009-01-03 21:18:54 +0000372
Guido van Rossumf10aa982007-08-17 18:30:38 +0000373 immutable
Benjamin Peterson5478b472008-09-17 22:25:09 +0000374 An object with a fixed value. Immutable objects include numbers, strings and
375 tuples. Such an object cannot be altered. A new object has to
Guido van Rossumf10aa982007-08-17 18:30:38 +0000376 be created if a different value has to be stored. They play an important
377 role in places where a constant hash value is needed, for example as a key
378 in a dictionary.
Benjamin Peterson2d718222008-11-21 00:25:02 +0000379
Barry Warsawdadebab2012-07-31 16:03:09 -0400380 import path
381 A list of locations (or :term:`path entries <path entry>`) that are
Nick Coghlan1685db02012-08-20 13:49:08 +1000382 searched by the :term:`path based finder` for modules to import. During
Barry Warsawdadebab2012-07-31 16:03:09 -0400383 import, this list of locations usually comes from :data:`sys.path`, but
384 for subpackages it may also come from the parent package's ``__path__``
385 attribute.
386
Barry Warsawd7d21942012-07-29 16:36:17 -0400387 importing
388 The process by which Python code in one module is made available to
389 Python code in another module.
390
Brett Cannon51d4aab2009-01-25 04:21:39 +0000391 importer
392 An object that both finds and loads a module; both a
393 :term:`finder` and :term:`loader` object.
394
Guido van Rossumf10aa982007-08-17 18:30:38 +0000395 interactive
Benjamin Peterson5478b472008-09-17 22:25:09 +0000396 Python has an interactive interpreter which means you can enter
397 statements and expressions at the interpreter prompt, immediately
398 execute them and see their results. Just launch ``python`` with no
399 arguments (possibly by selecting it from your computer's main
400 menu). It is a very powerful way to test out new ideas or inspect
401 modules and packages (remember ``help(x)``).
Georg Brandl48310cd2009-01-03 21:18:54 +0000402
Guido van Rossumf10aa982007-08-17 18:30:38 +0000403 interpreted
Benjamin Peterson5478b472008-09-17 22:25:09 +0000404 Python is an interpreted language, as opposed to a compiled one,
405 though the distinction can be blurry because of the presence of the
406 bytecode compiler. This means that source files can be run directly
407 without explicitly creating an executable which is then run.
408 Interpreted languages typically have a shorter development/debug cycle
409 than compiled ones, though their programs generally also run more
410 slowly. See also :term:`interactive`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000411
Antoine Pitrou5db1bb82014-12-07 01:28:27 +0100412 interpreter shutdown
413 When asked to shut down, the Python interpreter enters a special phase
414 where it gradually releases all allocated resources, such as modules
415 and various critical internal structures. It also makes several calls
416 to the :term:`garbage collector <garbage collection>`. This can trigger
417 the execution of code in user-defined destructors or weakref callbacks.
418 Code executed during the shutdown phase can encounter various
419 exceptions as the resources it relies on may not function anymore
420 (common examples are library modules or the warnings machinery).
421
422 The main reason for interpreter shutdown is that the ``__main__`` module
423 or the script being run has finished executing.
424
Guido van Rossumf10aa982007-08-17 18:30:38 +0000425 iterable
Ezio Melottid581fff2013-01-02 22:29:09 +0200426 An object capable of returning its members one at a time. Examples of
427 iterables include all sequence types (such as :class:`list`, :class:`str`,
428 and :class:`tuple`) and some non-sequence types like :class:`dict`,
429 :term:`file objects <file object>`, and objects of any classes you define
430 with an :meth:`__iter__` or :meth:`__getitem__` method. Iterables can be
431 used in a :keyword:`for` loop and in many other places where a sequence is
432 needed (:func:`zip`, :func:`map`, ...). When an iterable object is passed
433 as an argument to the built-in function :func:`iter`, it returns an
434 iterator for the object. This iterator is good for one pass over the set
435 of values. When using iterables, it is usually not necessary to call
436 :func:`iter` or deal with iterator objects yourself. The ``for``
Guido van Rossumf10aa982007-08-17 18:30:38 +0000437 statement does that automatically for you, creating a temporary unnamed
438 variable to hold the iterator for the duration of the loop. See also
439 :term:`iterator`, :term:`sequence`, and :term:`generator`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000440
Guido van Rossumf10aa982007-08-17 18:30:38 +0000441 iterator
442 An object representing a stream of data. Repeated calls to the iterator's
Ezio Melotti7fa82222012-10-12 13:42:08 +0300443 :meth:`~iterator.__next__` method (or passing it to the built-in function
Georg Brandlb30f3302011-01-06 09:23:56 +0000444 :func:`next`) return successive items in the stream. When no more data
445 are available a :exc:`StopIteration` exception is raised instead. At this
Benjamin Petersone7c78b22008-07-03 20:28:26 +0000446 point, the iterator object is exhausted and any further calls to its
Georg Brandlb30f3302011-01-06 09:23:56 +0000447 :meth:`__next__` method just raise :exc:`StopIteration` again. Iterators
448 are required to have an :meth:`__iter__` method that returns the iterator
Guido van Rossumf10aa982007-08-17 18:30:38 +0000449 object itself so every iterator is also iterable and may be used in most
450 places where other iterables are accepted. One notable exception is code
Benjamin Peterson5478b472008-09-17 22:25:09 +0000451 which attempts multiple iteration passes. A container object (such as a
Guido van Rossumf10aa982007-08-17 18:30:38 +0000452 :class:`list`) produces a fresh new iterator each time you pass it to the
453 :func:`iter` function or use it in a :keyword:`for` loop. Attempting this
454 with an iterator will just return the same exhausted iterator object used
455 in the previous iteration pass, making it appear like an empty container.
Georg Brandl48310cd2009-01-03 21:18:54 +0000456
Georg Brandl9afde1c2007-11-01 20:32:30 +0000457 More information can be found in :ref:`typeiter`.
458
Georg Brandlc275e152010-11-05 07:10:41 +0000459 key function
460 A key function or collation function is a callable that returns a value
461 used for sorting or ordering. For example, :func:`locale.strxfrm` is
462 used to produce a sort key that is aware of locale specific sort
463 conventions.
464
465 A number of tools in Python accept key functions to control how elements
466 are ordered or grouped. They include :func:`min`, :func:`max`,
Raymond Hettinger35db4392014-05-30 02:28:36 -0700467 :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
468 :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
469 :func:`itertools.groupby`.
Georg Brandlc275e152010-11-05 07:10:41 +0000470
471 There are several ways to create a key function. For example. the
472 :meth:`str.lower` method can serve as a key function for case insensitive
Raymond Hettinger35db4392014-05-30 02:28:36 -0700473 sorts. Alternatively, a key function can be built from a
Georg Brandlc275e152010-11-05 07:10:41 +0000474 :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``. Also,
Sandro Tosi165a2c22012-04-01 01:50:00 +0200475 the :mod:`operator` module provides three key function constructors:
Georg Brandlc275e152010-11-05 07:10:41 +0000476 :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
477 :func:`~operator.methodcaller`. See the :ref:`Sorting HOW TO
478 <sortinghowto>` for examples of how to create and use key functions.
479
Christian Heimesd8654cf2007-12-02 15:22:16 +0000480 keyword argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800481 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000482
483 lambda
484 An anonymous inline function consisting of a single :term:`expression`
485 which is evaluated when the function is called. The syntax to create
486 a lambda function is ``lambda [arguments]: expression``
487
Guido van Rossumf10aa982007-08-17 18:30:38 +0000488 LBYL
489 Look before you leap. This coding style explicitly tests for
490 pre-conditions before making calls or lookups. This style contrasts with
491 the :term:`EAFP` approach and is characterized by the presence of many
492 :keyword:`if` statements.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000493
Raymond Hettinger09f44142010-12-17 20:19:50 +0000494 In a multi-threaded environment, the LBYL approach can risk introducing a
495 race condition between "the looking" and "the leaping". For example, the
496 code, ``if key in mapping: return mapping[key]`` can fail if another
497 thread removes *key* from *mapping* after the test, but before the lookup.
498 This issue can be solved with locks or by using the EAFP approach.
499
Benjamin Peterson5478b472008-09-17 22:25:09 +0000500 list
501 A built-in Python :term:`sequence`. Despite its name it is more akin
502 to an array in other languages than to a linked list since access to
503 elements are O(1).
Georg Brandl48310cd2009-01-03 21:18:54 +0000504
Guido van Rossumf10aa982007-08-17 18:30:38 +0000505 list comprehension
Benjamin Peterson5478b472008-09-17 22:25:09 +0000506 A compact way to process all or part of the elements in a sequence and
Georg Brandlede6c2a2010-01-05 10:22:04 +0000507 return a list with the results. ``result = ['{:#04x}'.format(x) for x in
Benjamin Peterson5478b472008-09-17 22:25:09 +0000508 range(256) if x % 2 == 0]`` generates a list of strings containing
509 even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
510 clause is optional. If omitted, all elements in ``range(256)`` are
511 processed.
Georg Brandl48310cd2009-01-03 21:18:54 +0000512
Brett Cannon51d4aab2009-01-25 04:21:39 +0000513 loader
514 An object that loads a module. It must define a method named
515 :meth:`load_module`. A loader is typically returned by a
Brett Cannone43b0602009-03-21 03:11:16 +0000516 :term:`finder`. See :pep:`302` for details and
517 :class:`importlib.abc.Loader` for an :term:`abstract base class`.
Brett Cannon51d4aab2009-01-25 04:21:39 +0000518
Guido van Rossumf10aa982007-08-17 18:30:38 +0000519 mapping
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000520 A container object that supports arbitrary key lookups and implements the
Éric Araujob8edbdf2011-09-01 05:57:12 +0200521 methods specified in the :class:`~collections.abc.Mapping` or
522 :class:`~collections.abc.MutableMapping`
Éric Araujofa088db2011-06-04 18:42:38 +0200523 :ref:`abstract base classes <collections-abstract-base-classes>`. Examples
524 include :class:`dict`, :class:`collections.defaultdict`,
Raymond Hettingere3ee66f2011-01-08 23:44:37 +0000525 :class:`collections.OrderedDict` and :class:`collections.Counter`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000526
Barry Warsawd7d21942012-07-29 16:36:17 -0400527 meta path finder
528 A finder returned by a search of :data:`sys.meta_path`. Meta path
Barry Warsawdadebab2012-07-31 16:03:09 -0400529 finders are related to, but different from :term:`path entry finders
530 <path entry finder>`.
Barry Warsawd7d21942012-07-29 16:36:17 -0400531
Guido van Rossumf10aa982007-08-17 18:30:38 +0000532 metaclass
533 The class of a class. Class definitions create a class name, a class
534 dictionary, and a list of base classes. The metaclass is responsible for
535 taking those three arguments and creating the class. Most object oriented
536 programming languages provide a default implementation. What makes Python
537 special is that it is possible to create custom metaclasses. Most users
538 never need this tool, but when the need arises, metaclasses can provide
539 powerful, elegant solutions. They have been used for logging attribute
540 access, adding thread-safety, tracking object creation, implementing
541 singletons, and many other tasks.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000542
543 More information can be found in :ref:`metaclasses`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000544
545 method
Benjamin Peterson5478b472008-09-17 22:25:09 +0000546 A function which is defined inside a class body. If called as an attribute
Christian Heimesd8654cf2007-12-02 15:22:16 +0000547 of an instance of that class, the method will get the instance object as
548 its first :term:`argument` (which is usually called ``self``).
549 See :term:`function` and :term:`nested scope`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000550
Michael Foord95fc51d2010-11-20 15:07:30 +0000551 method resolution order
552 Method Resolution Order is the order in which base classes are searched
553 for a member during lookup. See `The Python 2.3 Method Resolution Order
Georg Brandle73778c2014-10-29 08:36:35 +0100554 <https://www.python.org/download/releases/2.3/mro/>`_.
Michael Foord95fc51d2010-11-20 15:07:30 +0000555
Barry Warsawd7d21942012-07-29 16:36:17 -0400556 module
557 An object that serves as an organizational unit of Python code. Modules
Barry Warsawc1e721b2012-07-30 16:24:12 -0400558 have a namespace containing arbitrary Python objects. Modules are loaded
Barry Warsawd7d21942012-07-29 16:36:17 -0400559 into Python by the process of :term:`importing`.
560
Georg Brandlbcce1252013-10-08 08:06:18 +0200561 See also :term:`package`.
562
Eric Snowca2d8542013-12-16 23:06:52 -0700563 module spec
564 A namespace containing the import-related information used to load a
565 module.
566
Michael Foord95fc51d2010-11-20 15:07:30 +0000567 MRO
568 See :term:`method resolution order`.
569
Guido van Rossumf10aa982007-08-17 18:30:38 +0000570 mutable
571 Mutable objects can change their value but keep their :func:`id`. See
572 also :term:`immutable`.
Christian Heimes25bb7832008-01-11 16:17:00 +0000573
574 named tuple
Raymond Hettingerd04fa312009-02-04 19:45:13 +0000575 Any tuple-like class whose indexable elements are also accessible using
Christian Heimesd32ed6f2008-01-14 18:49:24 +0000576 named attributes (for example, :func:`time.localtime` returns a
577 tuple-like object where the *year* is accessible either with an
578 index such as ``t[0]`` or with a named attribute like ``t.tm_year``).
579
580 A named tuple can be a built-in type such as :class:`time.struct_time`,
581 or it can be created with a regular class definition. A full featured
582 named tuple can also be created with the factory function
583 :func:`collections.namedtuple`. The latter approach automatically
584 provides extra features such as a self-documenting representation like
585 ``Employee(name='jones', title='programmer')``.
Georg Brandl48310cd2009-01-03 21:18:54 +0000586
Guido van Rossumf10aa982007-08-17 18:30:38 +0000587 namespace
588 The place where a variable is stored. Namespaces are implemented as
Georg Brandl22b34312009-07-26 14:54:51 +0000589 dictionaries. There are the local, global and built-in namespaces as well
Guido van Rossumf10aa982007-08-17 18:30:38 +0000590 as nested namespaces in objects (in methods). Namespaces support
591 modularity by preventing naming conflicts. For instance, the functions
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300592 :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
593 their namespaces. Namespaces also aid readability and maintainability by
594 making it clear which module implements a function. For instance, writing
Éric Araujo7af8ebb2011-09-01 03:20:13 +0200595 :func:`random.seed` or :func:`itertools.islice` makes it clear that those
Guido van Rossumf10aa982007-08-17 18:30:38 +0000596 functions are implemented by the :mod:`random` and :mod:`itertools`
Benjamin Peterson5478b472008-09-17 22:25:09 +0000597 modules, respectively.
Georg Brandl48310cd2009-01-03 21:18:54 +0000598
Barry Warsawd7d21942012-07-29 16:36:17 -0400599 namespace package
600 A :pep:`420` :term:`package` which serves only as a container for
601 subpackages. Namespace packages may have no physical representation,
602 and specifically are not like a :term:`regular package` because they
603 have no ``__init__.py`` file.
604
Georg Brandlbcce1252013-10-08 08:06:18 +0200605 See also :term:`module`.
606
Guido van Rossumf10aa982007-08-17 18:30:38 +0000607 nested scope
608 The ability to refer to a variable in an enclosing definition. For
609 instance, a function defined inside another function can refer to
Benjamin Peterson927ccd22010-06-29 18:36:39 +0000610 variables in the outer function. Note that nested scopes by default work
611 only for reference and not for assignment. Local variables both read and
612 write in the innermost scope. Likewise, global variables read and write
613 to the global namespace. The :keyword:`nonlocal` allows writing to outer
614 scopes.
Georg Brandl48310cd2009-01-03 21:18:54 +0000615
Guido van Rossumf10aa982007-08-17 18:30:38 +0000616 new-style class
Georg Brandl85eb8c12007-08-31 16:33:38 +0000617 Old name for the flavor of classes now used for all class objects. In
618 earlier Python versions, only new-style classes could use Python's newer,
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300619 versatile features like :attr:`~object.__slots__`, descriptors,
620 properties, :meth:`__getattribute__`, class methods, and static methods.
Georg Brandl9afde1c2007-11-01 20:32:30 +0000621
Benjamin Peterson5478b472008-09-17 22:25:09 +0000622 object
623 Any data with state (attributes or value) and defined behavior
624 (methods). Also the ultimate base class of any :term:`new-style
625 class`.
Georg Brandl48310cd2009-01-03 21:18:54 +0000626
Barry Warsawd7d21942012-07-29 16:36:17 -0400627 package
Georg Brandlbcce1252013-10-08 08:06:18 +0200628 A Python :term:`module` which can contain submodules or recursively,
Barry Warsawd7d21942012-07-29 16:36:17 -0400629 subpackages. Technically, a package is a Python module with an
630 ``__path__`` attribute.
631
Georg Brandlbcce1252013-10-08 08:06:18 +0200632 See also :term:`regular package` and :term:`namespace package`.
633
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800634 parameter
635 A named entity in a :term:`function` (or method) definition that
636 specifies an :term:`argument` (or in some cases, arguments) that the
Zachary Waree1391a02013-11-22 13:58:34 -0600637 function can accept. There are five kinds of parameter:
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800638
639 * :dfn:`positional-or-keyword`: specifies an argument that can be passed
640 either :term:`positionally <argument>` or as a :term:`keyword argument
641 <argument>`. This is the default kind of parameter, for example *foo*
642 and *bar* in the following::
643
644 def func(foo, bar=None): ...
645
646 * :dfn:`positional-only`: specifies an argument that can be supplied only
647 by position. Python has no syntax for defining positional-only
648 parameters. However, some built-in functions have positional-only
649 parameters (e.g. :func:`abs`).
650
Zachary Waree1391a02013-11-22 13:58:34 -0600651 .. _keyword-only_parameter:
652
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800653 * :dfn:`keyword-only`: specifies an argument that can be supplied only
654 by keyword. Keyword-only parameters can be defined by including a
655 single var-positional parameter or bare ``*`` in the parameter list
656 of the function definition before them, for example *kw_only1* and
657 *kw_only2* in the following::
658
659 def func(arg, *, kw_only1, kw_only2): ...
660
661 * :dfn:`var-positional`: specifies that an arbitrary sequence of
662 positional arguments can be provided (in addition to any positional
663 arguments already accepted by other parameters). Such a parameter can
664 be defined by prepending the parameter name with ``*``, for example
665 *args* in the following::
666
667 def func(*args, **kwargs): ...
668
669 * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
670 can be provided (in addition to any keyword arguments already accepted
671 by other parameters). Such a parameter can be defined by prepending
672 the parameter name with ``**``, for example *kwargs* in the example
673 above.
674
675 Parameters can specify both optional and required arguments, as well as
676 default values for some optional arguments.
677
678 See also the :term:`argument` glossary entry, the FAQ question on
679 :ref:`the difference between arguments and parameters
680 <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
681 :ref:`function` section, and :pep:`362`.
682
Barry Warsawdadebab2012-07-31 16:03:09 -0400683 path entry
684 A single location on the :term:`import path` which the :term:`path
Nick Coghlan1685db02012-08-20 13:49:08 +1000685 based finder` consults to find modules for importing.
Barry Warsawdadebab2012-07-31 16:03:09 -0400686
687 path entry finder
688 A :term:`finder` returned by a callable on :data:`sys.path_hooks`
689 (i.e. a :term:`path entry hook`) which knows how to locate modules given
690 a :term:`path entry`.
691
692 path entry hook
693 A callable on the :data:`sys.path_hook` list which returns a :term:`path
694 entry finder` if it knows how to find modules on a specific :term:`path
695 entry`.
696
Nick Coghlan1685db02012-08-20 13:49:08 +1000697 path based finder
Barry Warsawdadebab2012-07-31 16:03:09 -0400698 One of the default :term:`meta path finders <meta path finder>` which
699 searches an :term:`import path` for modules.
Barry Warsawd7d21942012-07-29 16:36:17 -0400700
701 portion
702 A set of files in a single directory (possibly stored in a zip file)
703 that contribute to a namespace package, as defined in :pep:`420`.
704
Christian Heimesd8654cf2007-12-02 15:22:16 +0000705 positional argument
Chris Jerdonekc2a7fd62012-11-28 02:29:33 -0800706 See :term:`argument`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000707
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000708 provisional API
709 A provisional API is one which has been deliberately excluded from
Barry Warsawd7d21942012-07-29 16:36:17 -0400710 the standard library's backwards compatibility guarantees. While major
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000711 changes to such interfaces are not expected, as long as they are marked
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300712 provisional, backwards incompatible changes (up to and including removal
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000713 of the interface) may occur if deemed necessary by core developers. Such
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300714 changes will not be made gratuitously -- they will occur only if serious
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000715 fundamental flaws are uncovered that were missed prior to the inclusion
716 of the API.
717
718 Even for provisional APIs, backwards incompatible changes are seen as
719 a "solution of last resort" - every attempt will still be made to find
720 a backwards compatible resolution to any identified problems.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300721
Barry Warsawd7d21942012-07-29 16:36:17 -0400722 This process allows the standard library to continue to evolve over
723 time, without locking in problematic design errors for extended periods
724 of time. See :pep:`411` for more details.
Eli Bendersky6bdb6502012-03-30 10:52:25 +0300725
Nick Coghlan4dae27a2013-10-20 13:22:04 +1000726 provisional package
727 See :term:`provisional API`.
728
Guido van Rossumf10aa982007-08-17 18:30:38 +0000729 Python 3000
Barry Warsawd7d21942012-07-29 16:36:17 -0400730 Nickname for the Python 3.x release line (coined long ago when the
731 release of version 3 was something in the distant future.) This is also
Benjamin Peterson1e2f0502008-05-26 12:52:02 +0000732 abbreviated "Py3k".
Guido van Rossumf10aa982007-08-17 18:30:38 +0000733
Christian Heimesd8654cf2007-12-02 15:22:16 +0000734 Pythonic
Benjamin Peterson5478b472008-09-17 22:25:09 +0000735 An idea or piece of code which closely follows the most common idioms
736 of the Python language, rather than implementing code using concepts
737 common to other languages. For example, a common idiom in Python is
738 to loop over all elements of an iterable using a :keyword:`for`
739 statement. Many other languages don't have this type of construct, so
740 people unfamiliar with Python sometimes use a numerical counter instead::
Georg Brandl48310cd2009-01-03 21:18:54 +0000741
Christian Heimesd8654cf2007-12-02 15:22:16 +0000742 for i in range(len(food)):
Georg Brandla09ca382007-12-02 18:20:12 +0000743 print(food[i])
Christian Heimesd8654cf2007-12-02 15:22:16 +0000744
745 As opposed to the cleaner, Pythonic method::
746
747 for piece in food:
Georg Brandla09ca382007-12-02 18:20:12 +0000748 print(piece)
Christian Heimesd8654cf2007-12-02 15:22:16 +0000749
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100750 qualified name
751 A dotted name showing the "path" from a module's global scope to a
752 class, function or method defined in that module, as defined in
753 :pep:`3155`. For top-level functions and classes, the qualified name
754 is the same as the object's name::
755
756 >>> class C:
757 ... class D:
758 ... def meth(self):
759 ... pass
760 ...
761 >>> C.__qualname__
762 'C'
763 >>> C.D.__qualname__
764 'C.D'
765 >>> C.D.meth.__qualname__
766 'C.D.meth'
767
Barry Warsawd7d21942012-07-29 16:36:17 -0400768 When used to refer to modules, the *fully qualified name* means the
769 entire dotted path to the module, including any parent packages,
770 e.g. ``email.mime.text``::
771
772 >>> import email.mime.text
773 >>> email.mime.text.__name__
774 'email.mime.text'
775
Guido van Rossumf10aa982007-08-17 18:30:38 +0000776 reference count
Benjamin Peterson5478b472008-09-17 22:25:09 +0000777 The number of references to an object. When the reference count of an
778 object drops to zero, it is deallocated. Reference counting is
779 generally not visible to Python code, but it is a key element of the
780 :term:`CPython` implementation. The :mod:`sys` module defines a
Georg Brandlede6c2a2010-01-05 10:22:04 +0000781 :func:`~sys.getrefcount` function that programmers can call to return the
Benjamin Peterson5478b472008-09-17 22:25:09 +0000782 reference count for a particular object.
783
Barry Warsawd7d21942012-07-29 16:36:17 -0400784 regular package
785 A traditional :term:`package`, such as a directory containing an
786 ``__init__.py`` file.
787
Georg Brandlbcce1252013-10-08 08:06:18 +0200788 See also :term:`namespace package`.
789
Guido van Rossumf10aa982007-08-17 18:30:38 +0000790 __slots__
Georg Brandl85eb8c12007-08-31 16:33:38 +0000791 A declaration inside a class that saves memory by pre-declaring space for
792 instance attributes and eliminating instance dictionaries. Though
793 popular, the technique is somewhat tricky to get right and is best
794 reserved for rare cases where there are large numbers of instances in a
795 memory-critical application.
Georg Brandl48310cd2009-01-03 21:18:54 +0000796
Guido van Rossumf10aa982007-08-17 18:30:38 +0000797 sequence
798 An :term:`iterable` which supports efficient element access using integer
Benjamin Peterson5478b472008-09-17 22:25:09 +0000799 indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov8cf1cc42012-10-05 13:26:10 +0300800 :meth:`__len__` method that returns the length of the sequence.
Guido van Rossumf10aa982007-08-17 18:30:38 +0000801 Some built-in sequence types are :class:`list`, :class:`str`,
Georg Brandl2ae8ac22009-02-05 10:40:48 +0000802 :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
Guido van Rossumf10aa982007-08-17 18:30:38 +0000803 supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
804 mapping rather than a sequence because the lookups use arbitrary
805 :term:`immutable` keys rather than integers.
806
Andrew Kuchlingcb3ff442014-02-15 17:05:26 -0500807 The :class:`collections.abc.Sequence` abstract base class
808 defines a much richer interface that goes beyond just
809 :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
810 :meth:`index`, :meth:`__contains__`, and
811 :meth:`__reversed__`. Types that implement this expanded
812 interface can be registered explicitly using
813 :func:`~abc.register`.
814
Łukasz Langafdcf2b72013-06-07 22:54:03 +0200815 single dispatch
816 A form of :term:`generic function` dispatch where the implementation is
817 chosen based on the type of a single argument.
818
Christian Heimesd8654cf2007-12-02 15:22:16 +0000819 slice
Georg Brandlc6fe37b2007-12-03 21:07:25 +0000820 An object usually containing a portion of a :term:`sequence`. A slice is
Christian Heimesd8654cf2007-12-02 15:22:16 +0000821 created using the subscript notation, ``[]`` with colons between numbers
822 when several are given, such as in ``variable_name[1:3:5]``. The bracket
Georg Brandla09ca382007-12-02 18:20:12 +0000823 (subscript) notation uses :class:`slice` objects internally.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000824
Georg Brandlaf265f42008-12-07 15:06:20 +0000825 special method
826 A method that is called implicitly by Python to execute a certain
827 operation on a type, such as addition. Such methods have names starting
828 and ending with double underscores. Special methods are documented in
829 :ref:`specialnames`.
830
Christian Heimesd8654cf2007-12-02 15:22:16 +0000831 statement
832 A statement is part of a suite (a "block" of code). A statement is either
Georg Brandl60e602d2013-10-06 11:57:13 +0200833 an :term:`expression` or one of several constructs with a keyword, such
Georg Brandla09ca382007-12-02 18:20:12 +0000834 as :keyword:`if`, :keyword:`while` or :keyword:`for`.
Christian Heimesd8654cf2007-12-02 15:22:16 +0000835
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500836 struct sequence
Florent Xiclunaf8240d62011-11-11 19:58:53 +0100837 A tuple with named elements. Struct sequences expose an interface similar
Benjamin Peterson82f614b2011-04-20 18:27:32 -0500838 to :term:`named tuple` in that elements can either be accessed either by
839 index or as an attribute. However, they do not have any of the named tuple
840 methods like :meth:`~collections.somenamedtuple._make` or
841 :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
842 include :data:`sys.float_info` and the return value of :func:`os.stat`.
843
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +1000844 text encoding
845 A codec which encodes Unicode strings to bytes.
846
Antoine Pitroudd799d22013-12-05 23:46:32 +0100847 text file
848 A :term:`file object` able to read and write :class:`str` objects.
849 Often, a text file actually accesses a byte-oriented datastream
Nick Coghlanb9fdb7a2015-01-07 00:22:00 +1000850 and handles the :term:`text encoding` automatically.
Antoine Pitroudd799d22013-12-05 23:46:32 +0100851
852 .. seealso::
853 A :term:`binary file` reads and write :class:`bytes` objects.
854
Benjamin Peterson5478b472008-09-17 22:25:09 +0000855 triple-quoted string
856 A string which is bound by three instances of either a quotation mark
857 (") or an apostrophe ('). While they don't provide any functionality
858 not available with single-quoted strings, they are useful for a number
859 of reasons. They allow you to include unescaped single and double
860 quotes within a string and they can span multiple lines without the
861 use of the continuation character, making them especially useful when
862 writing docstrings.
863
Guido van Rossumf10aa982007-08-17 18:30:38 +0000864 type
865 The type of a Python object determines what kind of object it is; every
866 object has a type. An object's type is accessible as its
Serhiy Storchaka0d196ed2013-10-09 14:02:31 +0300867 :attr:`~instance.__class__` attribute or can be retrieved with
868 ``type(obj)``.
Benjamin Peterson5478b472008-09-17 22:25:09 +0000869
R David Murray1b00f252012-08-15 10:43:58 -0400870 universal newlines
871 A manner of interpreting text streams in which all of the following are
872 recognized as ending a line: the Unix end-of-line convention ``'\n'``,
873 the Windows convention ``'\r\n'``, and the old Macintosh convention
874 ``'\r'``. See :pep:`278` and :pep:`3116`, as well as
Terry Jan Reedy004e8702014-08-23 18:28:44 -0400875 :func:`bytes.splitlines` for an additional use.
R David Murray1b00f252012-08-15 10:43:58 -0400876
Benjamin Peterson656aa282008-11-21 23:22:00 +0000877 view
Ezio Melotti619de8f2009-06-25 18:39:31 +0000878 The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
Benjamin Peterson656aa282008-11-21 23:22:00 +0000879 :meth:`dict.items` are called dictionary views. They are lazy sequences
880 that will see changes in the underlying dictionary. To force the
881 dictionary view to become a full list use ``list(dictview)``. See
882 :ref:`dict-views`.
883
Nick Coghlan1d520962014-09-06 20:38:23 +1000884 virtual environment
885 A cooperatively isolated runtime environment that allows Python users
886 and applications to install and upgrade Python distribution packages
887 without interfering with the behaviour of other Python applications
888 running on the same system.
889
890 See also :ref:`scripts-pyvenv`
891
Benjamin Peterson5478b472008-09-17 22:25:09 +0000892 virtual machine
893 A computer defined entirely in software. Python's virtual machine
894 executes the :term:`bytecode` emitted by the bytecode compiler.
Georg Brandl48310cd2009-01-03 21:18:54 +0000895
Guido van Rossumf10aa982007-08-17 18:30:38 +0000896 Zen of Python
897 Listing of Python design principles and philosophies that are helpful in
898 understanding and using the language. The listing can be found by typing
899 "``import this``" at the interactive prompt.