glossary.rst 45.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
.. _glossary:

********
Glossary
********

.. if you add new entries, keep the alphabetical sorting!

.. glossary::

   ``>>>``
12 13
      The default Python prompt of the interactive shell.  Often seen for code
      examples which can be executed interactively in the interpreter.
14

15
   ``...``
16 17 18
      The default Python prompt of the interactive shell when entering code for
      an indented code block or within a pair of matching left and right
      delimiters (parentheses, square brackets or curly braces).
19

20 21
   2to3
      A tool that tries to convert Python 2.x code to Python 3.x code by
Georg Brandl's avatar
Georg Brandl committed
22
      handling most of the incompatibilities which can be detected by parsing the
23 24 25 26 27 28
      source and traversing the parse tree.

      2to3 is available in the standard library as :mod:`lib2to3`; a standalone
      entry point is provided as :file:`Tools/scripts/2to3`.  See
      :ref:`2to3-reference`.

Georg Brandl's avatar
Georg Brandl committed
29
   abstract base class
30
      Abstract base classes complement :term:`duck-typing` by
31
      providing a way to define interfaces when other techniques like
32
      :func:`hasattr` would be clumsy or subtly wrong (for example with
33 34 35 36
      :ref:`magic methods <special-lookup>`).  ABCs introduce virtual
      subclasses, which are classes that don't inherit from a class but are
      still recognized by :func:`isinstance` and :func:`issubclass`; see the
      :mod:`abc` module documentation.  Python comes with many built-in ABCs for
37
      data structures (in the :mod:`collections.abc` module), numbers (in the
38 39 40
      :mod:`numbers` module), streams (in the :mod:`io` module), import finders
      and loaders (in the :mod:`importlib.abc` module).  You can create your own
      ABCs with the :mod:`abc` module.
Benjamin Peterson's avatar
Benjamin Peterson committed
41

42
   argument
43
      A value passed to a :term:`function` (or :term:`method`) when calling the
44
      function.  There are two kinds of argument:
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

      * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
        ``name=``) in a function call or passed as a value in a dictionary
        preceded by ``**``.  For example, ``3`` and ``5`` are both keyword
        arguments in the following calls to :func:`complex`::

           complex(real=3, imag=5)
           complex(**{'real': 3, 'imag': 5})

      * :dfn:`positional argument`: an argument that is not a keyword argument.
        Positional arguments can appear at the beginning of an argument list
        and/or be passed as elements of an :term:`iterable` preceded by ``*``.
        For example, ``3`` and ``5`` are both positional arguments in the
        following calls::

           complex(3, 5)
           complex(*(3, 5))
62

63 64 65 66 67 68 69 70
      Arguments are assigned to the named local variables in a function body.
      See the :ref:`calls` section for the rules governing this assignment.
      Syntactically, any expression can be used to represent an argument; the
      evaluated value is assigned to the local variable.

      See also the :term:`parameter` glossary entry, the FAQ question on
      :ref:`the difference between arguments and parameters
      <faq-argument-vs-parameter>`, and :pep:`362`.
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
   asynchronous context manager
      An object which controls the environment seen in an
      :keyword:`async with` statement by defining :meth:`__aenter__` and
      :meth:`__aexit__` methods.  Introduced by :pep:`492`.

   asynchronous iterable
      An object, that can be used in an :keyword:`async for` statement.
      Must return an :term:`awaitable` from its :meth:`__aiter__` method,
      which should in turn be resolved in an :term:`asynchronous iterator`
      object.  Introduced by :pep:`492`.

   asynchronous iterator
      An object that implements :meth:`__aiter__` and :meth:`__anext__`
      methods, that must return :term:`awaitable` objects.
      :keyword:`async for` resolves awaitable returned from asynchronous
      iterator's :meth:`__anext__` method until it raises
      :exc:`StopAsyncIteration` exception.  Introduced by :pep:`492`.

90 91 92 93
   attribute
      A value associated with an object which is referenced by name using
      dotted expressions.  For example, if an object *o* has an attribute
      *a* it would be referenced as *o.a*.
94

95 96 97 98 99
   awaitable
      An object that can be used in an :keyword:`await` expression.  Can be
      a :term:`coroutine` or an object with an :meth:`__await__` method.
      See also :pep:`492`.

100 101
   BDFL
      Benevolent Dictator For Life, a.k.a. `Guido van Rossum
102
      <https://www.python.org/~guido/>`_, Python's creator.
103

104 105 106 107 108 109 110
   binary file
      A :term:`file object` able to read and write
      :term:`bytes-like objects <bytes-like object>`.

      .. seealso::
         A :term:`text file` reads and writes :class:`str` objects.

111
   bytes-like object
112 113 114 115
      An object that supports the :ref:`bufferobjects` and can
      export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,
      :class:`bytearray`, and :class:`array.array` objects, as well as many
      common :class:`memoryview` objects.  Bytes-like objects can
116 117 118 119 120 121 122 123 124 125 126
      be used for various operations that work with binary data; these include
      compression, saving to a binary file, and sending over a socket.

      Some operations need the binary data to be mutable.  The documentation
      often refers to these as "read-write bytes-like objects".  Example
      mutable buffer objects include :class:`bytearray` and a
      :class:`memoryview` of a :class:`bytearray`.
      Other operations require the binary data to be stored in
      immutable objects ("read-only bytes-like objects"); examples
      of these include :class:`bytes` and a :class:`memoryview`
      of a :class:`bytes` object.
127

128 129
   bytecode
      Python source code is compiled into bytecode, the internal representation
130 131 132 133 134 135 136 137
      of a Python program in the CPython interpreter.  The bytecode is also
      cached in ``.pyc`` and ``.pyo`` files so that executing the same file is
      faster the second time (recompilation from source to bytecode can be
      avoided).  This "intermediate language" is said to run on a
      :term:`virtual machine` that executes the machine code corresponding to
      each bytecode. Do note that bytecodes are not expected to work between
      different Python virtual machines, nor to be stable between Python
      releases.
138

139 140 141
      A list of bytecode instructions can be found in the documentation for
      :ref:`the dis module <bytecodes>`.

142 143 144 145
   class
      A template for creating user-defined objects. Class definitions
      normally contain method definitions which operate on instances of the
      class.
146

147 148 149 150 151 152
   coercion
      The implicit conversion of an instance of one type to another during an
      operation which involves two arguments of the same type.  For example,
      ``int(3.15)`` converts the floating point number to the integer ``3``, but
      in ``3+4.5``, each argument is of a different type (one int, one float),
      and both must be converted to the same type before they can be added or it
153
      will raise a ``TypeError``.  Without coercion, all arguments of even
154 155
      compatible types would have to be normalized to the same value by the
      programmer, e.g., ``float(3)+4.5`` rather than just ``3+4.5``.
156

157 158 159 160 161
   complex number
      An extension of the familiar real number system in which all numbers are
      expressed as a sum of a real part and an imaginary part.  Imaginary
      numbers are real multiples of the imaginary unit (the square root of
      ``-1``), often written ``i`` in mathematics or ``j`` in
162
      engineering.  Python has built-in support for complex numbers, which are
163 164 165 166 167
      written with this latter notation; the imaginary part is written with a
      ``j`` suffix, e.g., ``3+1j``.  To get access to complex equivalents of the
      :mod:`math` module, use :mod:`cmath`.  Use of complex numbers is a fairly
      advanced mathematical feature.  If you're not aware of a need for them,
      it's almost certain you can safely ignore them.
168

169
   context manager
170
      An object which controls the environment seen in a :keyword:`with`
171 172 173
      statement by defining :meth:`__enter__` and :meth:`__exit__` methods.
      See :pep:`343`.

174 175 176 177 178 179 180 181 182 183 184 185
   contiguous
      .. index:: C-contiguous, Fortran contiguous

      A buffer is considered contiguous exactly if it is either
      *C-contiguous* or *Fortran contiguous*.  Zero-dimensional buffers are
      C and Fortran contiguous.  In one-dimensional arrays, the items
      must be layed out in memory next to each other, in order of
      increasing indexes starting from zero.  In multidimensional
      C-contiguous arrays, the last index varies the fastest when
      visiting items in order of memory address.  However, in
      Fortran contiguous arrays, the first index varies the fastest.

186 187
   coroutine
      Coroutines is a more generalized form of subroutines. Subroutines are
188 189 190 191 192 193 194 195 196 197 198
      entered at one point and exited at another point.  Coroutines can be
      entered, exited, and resumed at many different points.  They can be
      implemented with the :keyword:`async def` statement.  See also
      :pep:`492`.

   coroutine function
      A function which returns a :term:`coroutine` object.  A coroutine
      function may be defined with the :keyword:`async def` statement,
      and may contain :keyword:`await`, :keyword:`async for`, and
      :keyword:`async with` keywords.  These were introduced
      by :pep:`492`.
199

200
   CPython
201
      The canonical implementation of the Python programming language, as
202
      distributed on `python.org <https://www.python.org>`_.  The term "CPython"
203 204
      is used when necessary to distinguish this implementation from others
      such as Jython or IronPython.
205

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
   decorator
      A function returning another function, usually applied as a function
      transformation using the ``@wrapper`` syntax.  Common examples for
      decorators are :func:`classmethod` and :func:`staticmethod`.

      The decorator syntax is merely syntactic sugar, the following two
      function definitions are semantically equivalent::

         def f(...):
             ...
         f = staticmethod(f)

         @staticmethod
         def f(...):
             ...

Georg Brandl's avatar
Georg Brandl committed
222 223 224
      The same concept exists for classes, but is less commonly used there.  See
      the documentation for :ref:`function definitions <function>` and
      :ref:`class definitions <class>` for more about decorators.
225

226
   descriptor
227
      Any object which defines the methods :meth:`__get__`, :meth:`__set__`, or
Georg Brandl's avatar
Georg Brandl committed
228
      :meth:`__delete__`.  When a class attribute is a descriptor, its special
229 230 231 232 233 234 235 236 237
      binding behavior is triggered upon attribute lookup.  Normally, using
      *a.b* to get, set or delete an attribute looks up the object named *b* in
      the class dictionary for *a*, but if *b* is a descriptor, the respective
      descriptor method gets called.  Understanding descriptors is a key to a
      deep understanding of Python because they are the basis for many features
      including functions, methods, properties, class methods, static methods,
      and reference to super classes.

      For more information about descriptors' methods, see :ref:`descriptors`.
238

239
   dictionary
240 241 242
      An associative array, where arbitrary keys are mapped to values.  The
      keys can be any object with :meth:`__hash__` and :meth:`__eq__` methods.
      Called a hash in Perl.
Georg Brandl's avatar
Georg Brandl committed
243

244 245 246 247 248 249 250 251
   dictionary view
      The objects returned from :meth:`dict.keys`, :meth:`dict.values`, and
      :meth:`dict.items` are called dictionary views. They provide a dynamic
      view on the dictionarys entries, which means that when the dictionary
      changes, the view reflects these changes. To force the
      dictionary view to become a full list use ``list(dictview)``.  See
      :ref:`dict-views`.

Georg Brandl's avatar
Georg Brandl committed
252
   docstring
253 254 255 256 257
      A string literal which appears as the first expression in a class,
      function or module.  While ignored when the suite is executed, it is
      recognized by the compiler and put into the :attr:`__doc__` attribute
      of the enclosing class, function or module.  Since it is available via
      introspection, it is the canonical place for documentation of the
Georg Brandl's avatar
Georg Brandl committed
258
      object.
259 260

   duck-typing
261 262 263
      A programming style which does not look at an object's type to determine
      if it has the right interface; instead, the method or attribute is simply
      called or used ("If it looks like a duck and quacks like a duck, it
264 265 266
      must be a duck.")  By emphasizing interfaces rather than specific types,
      well-designed code improves its flexibility by allowing polymorphic
      substitution.  Duck-typing avoids tests using :func:`type` or
267
      :func:`isinstance`.  (Note, however, that duck-typing can be complemented
268 269
      with :term:`abstract base classes <abstract base class>`.)  Instead, it
      typically employs :func:`hasattr` tests or :term:`EAFP` programming.
270

271 272 273 274 275
   EAFP
      Easier to ask for forgiveness than permission.  This common Python coding
      style assumes the existence of valid keys or attributes and catches
      exceptions if the assumption proves false.  This clean and fast style is
      characterized by the presence of many :keyword:`try` and :keyword:`except`
276
      statements.  The technique contrasts with the :term:`LBYL` style
277
      common to many other languages such as C.
278

279 280
   expression
      A piece of syntax which can be evaluated to some value.  In other words,
281 282 283 284 285 286
      an expression is an accumulation of expression elements like literals,
      names, attribute access, operators or function calls which all return a
      value.  In contrast to many other languages, not all language constructs
      are expressions.  There are also :term:`statement`\s which cannot be used
      as expressions, such as :keyword:`if`.  Assignments are also statements,
      not expressions.
287

288
   extension module
Georg Brandl's avatar
Georg Brandl committed
289 290
      A module written in C or C++, using Python's C API to interact with the
      core and with user code.
291

292 293
   file object
      An object exposing a file-oriented API (with methods such as
Georg Brandl's avatar
Georg Brandl committed
294 295
      :meth:`read()` or :meth:`write()`) to an underlying resource.  Depending
      on the way it was created, a file object can mediate access to a real
Eli Bendersky's avatar
Eli Bendersky committed
296
      on-disk file or to another type of storage or communication device
Georg Brandl's avatar
Georg Brandl committed
297 298 299 300
      (for example standard input/output, in-memory buffers, sockets, pipes,
      etc.).  File objects are also called :dfn:`file-like objects` or
      :dfn:`streams`.

301 302 303 304 305
      There are actually three categories of file objects: raw
      :term:`binary files <binary file>`, buffered
      :term:`binary files <binary file>` and :term:`text files <text file>`.
      Their interfaces are defined in the :mod:`io` module.  The canonical
      way to create a file object is by using the :func:`open` function.
306 307 308 309

   file-like object
      A synonym for :term:`file object`.

310
   finder
311 312 313 314 315 316 317 318
      An object that tries to find the :term:`loader` for a module that is
      being imported.

      Since Python 3.3, there are two types of finder: :term:`meta path finders
      <meta path finder>` for use with :data:`sys.meta_path`, and :term:`path
      entry finders <path entry finder>` for use with :data:`sys.path_hooks`.

      See :pep:`302`, :pep:`420` and :pep:`451` for much more detail.
319

320
   floor division
Raymond Hettinger's avatar
Raymond Hettinger committed
321 322 323 324 325
      Mathematical division that rounds down to nearest integer.  The floor
      division operator is ``//``.  For example, the expression ``11 // 4``
      evaluates to ``2`` in contrast to the ``2.75`` returned by float true
      division.  Note that ``(-11) // 4`` is ``-3`` because that is ``-2.75``
      rounded *downward*. See :pep:`238`.
326

327 328
   function
      A series of statements which returns some value to a caller. It can also
329 330 331
      be passed zero or more :term:`arguments <argument>` which may be used in
      the execution of the body. See also :term:`parameter`, :term:`method`,
      and the :ref:`function` section.
332

333 334 335 336 337 338 339 340 341 342
   function annotation
      An arbitrary metadata value associated with a function parameter or return
      value. Its syntax is explained in section :ref:`function`.  Annotations
      may be accessed via the :attr:`__annotations__` special attribute of a
      function object.

      Python itself does not assign any particular meaning to function
      annotations. They are intended to be interpreted by third-party libraries
      or tools.  See :pep:`3107`, which describes some of their potential uses.

343
   __future__
Raymond Hettinger's avatar
Raymond Hettinger committed
344
      A pseudo-module which programmers can use to enable new language features
345 346 347 348 349
      which are not compatible with the current interpreter.

      By importing the :mod:`__future__` module and evaluating its variables,
      you can see when a new feature was first added to the language and when it
      becomes the default::
350

351 352 353 354 355 356 357 358
         >>> import __future__
         >>> __future__.division
         _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)

   garbage collection
      The process of freeing memory when it is not used anymore.  Python
      performs garbage collection via reference counting and a cyclic garbage
      collector that is able to detect and break reference cycles.
359

Benjamin Peterson's avatar
Benjamin Peterson committed
360 361
      .. index:: single: generator

362
   generator
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
      A function which returns a :term:`generator iterator`.  It looks like a
      normal function except that it contains :keyword:`yield` expressions
      for producing a series of values usable in a for-loop or that can be
      retrieved one at a time with the :func:`next` function.

      Usually refers to a generator function, but may refer to a
      *generator iterator* in some contexts.  In cases where the intended
      meaning isn't clear, using the full terms avoids ambiguity.

   generator iterator
      An object created by a :term:`generator` function.

      Each :keyword:`yield` temporarily suspends processing, remembering the
      location execution state (including local variables and pending
      try-statements).  When the *generator iterator* resumes, it picks-up where
      it left-off (in contrast to functions which start fresh on every
      invocation).
380

381
      .. index:: single: generator expression
382

383
   generator expression
Benjamin Peterson's avatar
Benjamin Peterson committed
384
      An expression that returns an iterator.  It looks like a normal expression
385 386 387
      followed by a :keyword:`for` expression defining a loop variable, range,
      and an optional :keyword:`if` expression.  The combined expression
      generates values for an enclosing function::
388

389 390
         >>> sum(i*i for i in range(10))         # sum of squares 0, 1, 4, ... 81
         285
391

392 393 394 395 396 397 398 399 400
   generic function
      A function composed of multiple functions implementing the same operation
      for different types. Which implementation should be used during a call is
      determined by the dispatch algorithm.

      See also the :term:`single dispatch` glossary entry, the
      :func:`functools.singledispatch` decorator, and :pep:`443`.


401 402
   GIL
      See :term:`global interpreter lock`.
403

404
   global interpreter lock
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
      The mechanism used by the :term:`CPython` interpreter to assure that
      only one thread executes Python :term:`bytecode` at a time.
      This simplifies the CPython implementation by making the object model
      (including critical built-in types such as :class:`dict`) implicitly
      safe against concurrent access.  Locking the entire interpreter
      makes it easier for the interpreter to be multi-threaded, at the
      expense of much of the parallelism afforded by multi-processor
      machines.

      However, some extension modules, either standard or third-party,
      are designed so as to release the GIL when doing computationally-intensive
      tasks such as compression or hashing.  Also, the GIL is always released
      when doing I/O.

      Past efforts to create a "free-threaded" interpreter (one which locks
      shared data at a much finer granularity) have not been successful
      because performance suffered in the common single-processor case. It
      is believed that overcoming this performance issue would make the
      implementation much more complicated and therefore costlier to maintain.
424 425

   hashable
426
      An object is *hashable* if it has a hash value which never changes during
427
      its lifetime (it needs a :meth:`__hash__` method), and can be compared to
428 429
      other objects (it needs an :meth:`__eq__` method).  Hashable objects which
      compare equal must have the same hash value.
430 431 432 433

      Hashability makes an object usable as a dictionary key and a set member,
      because these data structures use the hash value internally.

434 435
      All of Python's immutable built-in objects are hashable, while no mutable
      containers (such as lists or dictionaries) are.  Objects which are
436
      instances of user-defined classes are hashable by default; they all
437 438
      compare unequal (except with themselves), and their hash value is derived
      from their :func:`id`.
439

440 441
   IDLE
      An Integrated Development Environment for Python.  IDLE is a basic editor
442
      and interpreter environment which ships with the standard distribution of
Raymond Hettinger's avatar
Raymond Hettinger committed
443
      Python.
444

445
   immutable
446 447
      An object with a fixed value.  Immutable objects include numbers, strings and
      tuples.  Such an object cannot be altered.  A new object has to
448 449 450
      be created if a different value has to be stored.  They play an important
      role in places where a constant hash value is needed, for example as a key
      in a dictionary.
451

452 453
   import path
      A list of locations (or :term:`path entries <path entry>`) that are
454
      searched by the :term:`path based finder` for modules to import. During
455 456 457 458
      import, this list of locations usually comes from :data:`sys.path`, but
      for subpackages it may also come from the parent package's ``__path__``
      attribute.

459 460 461 462
   importing
      The process by which Python code in one module is made available to
      Python code in another module.

463 464 465 466
   importer
      An object that both finds and loads a module; both a
      :term:`finder` and :term:`loader` object.

467
   interactive
468 469 470 471 472 473
      Python has an interactive interpreter which means you can enter
      statements and expressions at the interpreter prompt, immediately
      execute them and see their results.  Just launch ``python`` with no
      arguments (possibly by selecting it from your computer's main
      menu). It is a very powerful way to test out new ideas or inspect
      modules and packages (remember ``help(x)``).
474

475
   interpreted
476 477 478 479 480 481 482
      Python is an interpreted language, as opposed to a compiled one,
      though the distinction can be blurry because of the presence of the
      bytecode compiler.  This means that source files can be run directly
      without explicitly creating an executable which is then run.
      Interpreted languages typically have a shorter development/debug cycle
      than compiled ones, though their programs generally also run more
      slowly.  See also :term:`interactive`.
483

484 485 486 487 488 489 490 491 492 493 494 495 496
   interpreter shutdown
      When asked to shut down, the Python interpreter enters a special phase
      where it gradually releases all allocated resources, such as modules
      and various critical internal structures.  It also makes several calls
      to the :term:`garbage collector <garbage collection>`. This can trigger
      the execution of code in user-defined destructors or weakref callbacks.
      Code executed during the shutdown phase can encounter various
      exceptions as the resources it relies on may not function anymore
      (common examples are library modules or the warnings machinery).

      The main reason for interpreter shutdown is that the ``__main__`` module
      or the script being run has finished executing.

497
   iterable
498 499 500 501 502 503 504 505 506 507 508
      An object capable of returning its members one at a time. Examples of
      iterables include all sequence types (such as :class:`list`, :class:`str`,
      and :class:`tuple`) and some non-sequence types like :class:`dict`,
      :term:`file objects <file object>`, and objects of any classes you define
      with an :meth:`__iter__` or :meth:`__getitem__` method.  Iterables can be
      used in a :keyword:`for` loop and in many other places where a sequence is
      needed (:func:`zip`, :func:`map`, ...).  When an iterable object is passed
      as an argument to the built-in function :func:`iter`, it returns an
      iterator for the object.  This iterator is good for one pass over the set
      of values.  When using iterables, it is usually not necessary to call
      :func:`iter` or deal with iterator objects yourself.  The ``for``
509 510 511
      statement does that automatically for you, creating a temporary unnamed
      variable to hold the iterator for the duration of the loop.  See also
      :term:`iterator`, :term:`sequence`, and :term:`generator`.
512

513 514
   iterator
      An object representing a stream of data.  Repeated calls to the iterator's
515
      :meth:`~iterator.__next__` method (or passing it to the built-in function
516 517
      :func:`next`) return successive items in the stream.  When no more data
      are available a :exc:`StopIteration` exception is raised instead.  At this
518
      point, the iterator object is exhausted and any further calls to its
519 520
      :meth:`__next__` method just raise :exc:`StopIteration` again.  Iterators
      are required to have an :meth:`__iter__` method that returns the iterator
521 522
      object itself so every iterator is also iterable and may be used in most
      places where other iterables are accepted.  One notable exception is code
523
      which attempts multiple iteration passes.  A container object (such as a
524 525 526 527
      :class:`list`) produces a fresh new iterator each time you pass it to the
      :func:`iter` function or use it in a :keyword:`for` loop.  Attempting this
      with an iterator will just return the same exhausted iterator object used
      in the previous iteration pass, making it appear like an empty container.
528

529 530
      More information can be found in :ref:`typeiter`.

531 532 533 534 535 536 537 538
   key function
      A key function or collation function is a callable that returns a value
      used for sorting or ordering.  For example, :func:`locale.strxfrm` is
      used to produce a sort key that is aware of locale specific sort
      conventions.

      A number of tools in Python accept key functions to control how elements
      are ordered or grouped.  They include :func:`min`, :func:`max`,
539 540 541
      :func:`sorted`, :meth:`list.sort`, :func:`heapq.merge`,
      :func:`heapq.nsmallest`, :func:`heapq.nlargest`, and
      :func:`itertools.groupby`.
542 543 544

      There are several ways to create a key function.  For example. the
      :meth:`str.lower` method can serve as a key function for case insensitive
545
      sorts.  Alternatively, a key function can be built from a
546
      :keyword:`lambda` expression such as ``lambda r: (r[0], r[2])``.  Also,
547
      the :mod:`operator` module provides three key function constructors:
548 549 550 551
      :func:`~operator.attrgetter`, :func:`~operator.itemgetter`, and
      :func:`~operator.methodcaller`.  See the :ref:`Sorting HOW TO
      <sortinghowto>` for examples of how to create and use key functions.

552
   keyword argument
553
      See :term:`argument`.
554 555 556 557 558 559

   lambda
      An anonymous inline function consisting of a single :term:`expression`
      which is evaluated when the function is called.  The syntax to create
      a lambda function is ``lambda [arguments]: expression``

560 561 562 563 564
   LBYL
      Look before you leap.  This coding style explicitly tests for
      pre-conditions before making calls or lookups.  This style contrasts with
      the :term:`EAFP` approach and is characterized by the presence of many
      :keyword:`if` statements.
565

566 567 568 569 570 571
      In a multi-threaded environment, the LBYL approach can risk introducing a
      race condition between "the looking" and "the leaping".  For example, the
      code, ``if key in mapping: return mapping[key]`` can fail if another
      thread removes *key* from *mapping* after the test, but before the lookup.
      This issue can be solved with locks or by using the EAFP approach.

572 573 574 575
   list
      A built-in Python :term:`sequence`.  Despite its name it is more akin
      to an array in other languages than to a linked list since access to
      elements are O(1).
576

577
   list comprehension
578
      A compact way to process all or part of the elements in a sequence and
579
      return a list with the results.  ``result = ['{:#04x}'.format(x) for x in
580 581 582 583
      range(256) if x % 2 == 0]`` generates a list of strings containing
      even hex numbers (0x..) in the range from 0 to 255. The :keyword:`if`
      clause is optional.  If omitted, all elements in ``range(256)`` are
      processed.
584

585 586 587
   loader
      An object that loads a module. It must define a method named
      :meth:`load_module`. A loader is typically returned by a
588 589
      :term:`finder`. See :pep:`302` for details and
      :class:`importlib.abc.Loader` for an :term:`abstract base class`.
590

591
   mapping
592
      A container object that supports arbitrary key lookups and implements the
593 594
      methods specified in the :class:`~collections.abc.Mapping` or
      :class:`~collections.abc.MutableMapping`
595 596
      :ref:`abstract base classes <collections-abstract-base-classes>`.  Examples
      include :class:`dict`, :class:`collections.defaultdict`,
597
      :class:`collections.OrderedDict` and :class:`collections.Counter`.
598

599
   meta path finder
600
      A :term:`finder` returned by a search of :data:`sys.meta_path`.  Meta path
601 602
      finders are related to, but different from :term:`path entry finders
      <path entry finder>`.
603

604 605 606
      See :class:`importlib.abc.MetaPathFinder` for the methods that meta path
      finders implement.

607 608 609 610 611 612 613 614 615 616
   metaclass
      The class of a class.  Class definitions create a class name, a class
      dictionary, and a list of base classes.  The metaclass is responsible for
      taking those three arguments and creating the class.  Most object oriented
      programming languages provide a default implementation.  What makes Python
      special is that it is possible to create custom metaclasses.  Most users
      never need this tool, but when the need arises, metaclasses can provide
      powerful, elegant solutions.  They have been used for logging attribute
      access, adding thread-safety, tracking object creation, implementing
      singletons, and many other tasks.
617 618

      More information can be found in :ref:`metaclasses`.
619 620

   method
621
      A function which is defined inside a class body.  If called as an attribute
622 623 624
      of an instance of that class, the method will get the instance object as
      its first :term:`argument` (which is usually called ``self``).
      See :term:`function` and :term:`nested scope`.
625

626 627 628
   method resolution order
      Method Resolution Order is the order in which base classes are searched
      for a member during lookup. See `The Python 2.3 Method Resolution Order
629 630
      <https://www.python.org/download/releases/2.3/mro/>`_ for details of the
      algorithm used by the Python interpreter since the 2.3 release.
631

632 633
   module
      An object that serves as an organizational unit of Python code.  Modules
634
      have a namespace containing arbitrary Python objects.  Modules are loaded
635 636
      into Python by the process of :term:`importing`.

637 638
      See also :term:`package`.

639 640
   module spec
      A namespace containing the import-related information used to load a
641
      module. An instance of :class:`importlib.machinery.ModuleSpec`.
642

643 644 645
   MRO
      See :term:`method resolution order`.

646 647 648
   mutable
      Mutable objects can change their value but keep their :func:`id`.  See
      also :term:`immutable`.
649 650

   named tuple
Raymond Hettinger's avatar
Raymond Hettinger committed
651
      Any tuple-like class whose indexable elements are also accessible using
652 653 654 655 656 657 658 659 660 661
      named attributes (for example, :func:`time.localtime` returns a
      tuple-like object where the *year* is accessible either with an
      index such as ``t[0]`` or with a named attribute like ``t.tm_year``).

      A named tuple can be a built-in type such as :class:`time.struct_time`,
      or it can be created with a regular class definition.  A full featured
      named tuple can also be created with the factory function
      :func:`collections.namedtuple`.  The latter approach automatically
      provides extra features such as a self-documenting representation like
      ``Employee(name='jones', title='programmer')``.
662

663 664
   namespace
      The place where a variable is stored.  Namespaces are implemented as
665
      dictionaries.  There are the local, global and built-in namespaces as well
666 667
      as nested namespaces in objects (in methods).  Namespaces support
      modularity by preventing naming conflicts.  For instance, the functions
668 669 670
      :func:`builtins.open <.open>` and :func:`os.open` are distinguished by
      their namespaces.  Namespaces also aid readability and maintainability by
      making it clear which module implements a function.  For instance, writing
671
      :func:`random.seed` or :func:`itertools.islice` makes it clear that those
672
      functions are implemented by the :mod:`random` and :mod:`itertools`
673
      modules, respectively.
674

675 676 677 678 679 680
   namespace package
      A :pep:`420` :term:`package` which serves only as a container for
      subpackages.  Namespace packages may have no physical representation,
      and specifically are not like a :term:`regular package` because they
      have no ``__init__.py`` file.

681 682
      See also :term:`module`.

683 684 685
   nested scope
      The ability to refer to a variable in an enclosing definition.  For
      instance, a function defined inside another function can refer to
686 687 688 689 690
      variables in the outer function.  Note that nested scopes by default work
      only for reference and not for assignment.  Local variables both read and
      write in the innermost scope.  Likewise, global variables read and write
      to the global namespace.  The :keyword:`nonlocal` allows writing to outer
      scopes.
691

692
   new-style class
Georg Brandl's avatar
Georg Brandl committed
693 694
      Old name for the flavor of classes now used for all class objects.  In
      earlier Python versions, only new-style classes could use Python's newer,
695 696
      versatile features like :attr:`~object.__slots__`, descriptors,
      properties, :meth:`__getattribute__`, class methods, and static methods.
697

698 699 700 701
   object
      Any data with state (attributes or value) and defined behavior
      (methods).  Also the ultimate base class of any :term:`new-style
      class`.
702

703
   package
704
      A Python :term:`module` which can contain submodules or recursively,
705 706 707
      subpackages.  Technically, a package is a Python module with an
      ``__path__`` attribute.

708 709
      See also :term:`regular package` and :term:`namespace package`.

710 711 712
   parameter
      A named entity in a :term:`function` (or method) definition that
      specifies an :term:`argument` (or in some cases, arguments) that the
713
      function can accept.  There are five kinds of parameter:
714 715 716 717 718 719 720 721 722 723 724 725 726

      * :dfn:`positional-or-keyword`: specifies an argument that can be passed
        either :term:`positionally <argument>` or as a :term:`keyword argument
        <argument>`.  This is the default kind of parameter, for example *foo*
        and *bar* in the following::

           def func(foo, bar=None): ...

      * :dfn:`positional-only`: specifies an argument that can be supplied only
        by position.  Python has no syntax for defining positional-only
        parameters.  However, some built-in functions have positional-only
        parameters (e.g. :func:`abs`).

727 728
      .. _keyword-only_parameter:

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
      * :dfn:`keyword-only`: specifies an argument that can be supplied only
        by keyword.  Keyword-only parameters can be defined by including a
        single var-positional parameter or bare ``*`` in the parameter list
        of the function definition before them, for example *kw_only1* and
        *kw_only2* in the following::

           def func(arg, *, kw_only1, kw_only2): ...

      * :dfn:`var-positional`: specifies that an arbitrary sequence of
        positional arguments can be provided (in addition to any positional
        arguments already accepted by other parameters).  Such a parameter can
        be defined by prepending the parameter name with ``*``, for example
        *args* in the following::

           def func(*args, **kwargs): ...

      * :dfn:`var-keyword`: specifies that arbitrarily many keyword arguments
        can be provided (in addition to any keyword arguments already accepted
        by other parameters).  Such a parameter can be defined by prepending
        the parameter name with ``**``, for example *kwargs* in the example
        above.

      Parameters can specify both optional and required arguments, as well as
      default values for some optional arguments.

      See also the :term:`argument` glossary entry, the FAQ question on
      :ref:`the difference between arguments and parameters
      <faq-argument-vs-parameter>`, the :class:`inspect.Parameter` class, the
      :ref:`function` section, and :pep:`362`.

759 760
   path entry
      A single location on the :term:`import path` which the :term:`path
761
      based finder` consults to find modules for importing.
762 763 764 765 766 767

   path entry finder
      A :term:`finder` returned by a callable on :data:`sys.path_hooks`
      (i.e. a :term:`path entry hook`) which knows how to locate modules given
      a :term:`path entry`.

768 769 770
      See :class:`importlib.abc.PathEntryFinder` for the methods that path entry
      finders implement.

771 772 773 774 775
   path entry hook
      A callable on the :data:`sys.path_hook` list which returns a :term:`path
      entry finder` if it knows how to find modules on a specific :term:`path
      entry`.

776
   path based finder
777 778
      One of the default :term:`meta path finders <meta path finder>` which
      searches an :term:`import path` for modules.
779 780 781 782 783

   portion
      A set of files in a single directory (possibly stored in a zip file)
      that contribute to a namespace package, as defined in :pep:`420`.

784
   positional argument
785
      See :term:`argument`.
786

787 788
   provisional API
      A provisional API is one which has been deliberately excluded from
789
      the standard library's backwards compatibility guarantees.  While major
790
      changes to such interfaces are not expected, as long as they are marked
791
      provisional, backwards incompatible changes (up to and including removal
792
      of the interface) may occur if deemed necessary by core developers.  Such
793
      changes will not be made gratuitously -- they will occur only if serious
794 795 796 797 798 799
      fundamental flaws are uncovered that were missed prior to the inclusion
      of the API.

      Even for provisional APIs, backwards incompatible changes are seen as
      a "solution of last resort" - every attempt will still be made to find
      a backwards compatible resolution to any identified problems.
800

801 802 803
      This process allows the standard library to continue to evolve over
      time, without locking in problematic design errors for extended periods
      of time.  See :pep:`411` for more details.
804

805 806 807
   provisional package
      See :term:`provisional API`.

808
   Python 3000
809 810
      Nickname for the Python 3.x release line (coined long ago when the
      release of version 3 was something in the distant future.)  This is also
811
      abbreviated "Py3k".
812

813
   Pythonic
814 815 816 817 818 819
      An idea or piece of code which closely follows the most common idioms
      of the Python language, rather than implementing code using concepts
      common to other languages.  For example, a common idiom in Python is
      to loop over all elements of an iterable using a :keyword:`for`
      statement.  Many other languages don't have this type of construct, so
      people unfamiliar with Python sometimes use a numerical counter instead::
820

821
          for i in range(len(food)):
822
              print(food[i])
823 824 825 826

      As opposed to the cleaner, Pythonic method::

         for piece in food:
827
             print(piece)
828

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
   qualified name
      A dotted name showing the "path" from a module's global scope to a
      class, function or method defined in that module, as defined in
      :pep:`3155`.  For top-level functions and classes, the qualified name
      is the same as the object's name::

         >>> class C:
         ...     class D:
         ...         def meth(self):
         ...             pass
         ...
         >>> C.__qualname__
         'C'
         >>> C.D.__qualname__
         'C.D'
         >>> C.D.meth.__qualname__
         'C.D.meth'

847 848 849 850 851 852 853 854
      When used to refer to modules, the *fully qualified name* means the
      entire dotted path to the module, including any parent packages,
      e.g. ``email.mime.text``::

         >>> import email.mime.text
         >>> email.mime.text.__name__
         'email.mime.text'

855
   reference count
856 857 858 859
      The number of references to an object.  When the reference count of an
      object drops to zero, it is deallocated.  Reference counting is
      generally not visible to Python code, but it is a key element of the
      :term:`CPython` implementation.  The :mod:`sys` module defines a
860
      :func:`~sys.getrefcount` function that programmers can call to return the
861 862
      reference count for a particular object.

863 864 865 866
   regular package
      A traditional :term:`package`, such as a directory containing an
      ``__init__.py`` file.

867 868
      See also :term:`namespace package`.

869
   __slots__
Georg Brandl's avatar
Georg Brandl committed
870 871 872 873 874
      A declaration inside a class that saves memory by pre-declaring space for
      instance attributes and eliminating instance dictionaries.  Though
      popular, the technique is somewhat tricky to get right and is best
      reserved for rare cases where there are large numbers of instances in a
      memory-critical application.
875

876 877
   sequence
      An :term:`iterable` which supports efficient element access using integer
878
      indices via the :meth:`__getitem__` special method and defines a
Andrew Svetlov's avatar
Andrew Svetlov committed
879
      :meth:`__len__` method that returns the length of the sequence.
880
      Some built-in sequence types are :class:`list`, :class:`str`,
881
      :class:`tuple`, and :class:`bytes`. Note that :class:`dict` also
882 883 884 885
      supports :meth:`__getitem__` and :meth:`__len__`, but is considered a
      mapping rather than a sequence because the lookups use arbitrary
      :term:`immutable` keys rather than integers.

886 887 888 889 890 891 892 893
      The :class:`collections.abc.Sequence` abstract base class
      defines a much richer interface that goes beyond just
      :meth:`__getitem__` and :meth:`__len__`, adding :meth:`count`,
      :meth:`index`, :meth:`__contains__`, and
      :meth:`__reversed__`. Types that implement this expanded
      interface can be registered explicitly using
      :func:`~abc.register`.

894 895 896 897
   single dispatch
      A form of :term:`generic function` dispatch where the implementation is
      chosen based on the type of a single argument.

898
   slice
Georg Brandl's avatar
Georg Brandl committed
899
      An object usually containing a portion of a :term:`sequence`.  A slice is
900 901
      created using the subscript notation, ``[]`` with colons between numbers
      when several are given, such as in ``variable_name[1:3:5]``.  The bracket
902
      (subscript) notation uses :class:`slice` objects internally.
903

Georg Brandl's avatar
Georg Brandl committed
904 905 906 907 908 909
   special method
      A method that is called implicitly by Python to execute a certain
      operation on a type, such as addition.  Such methods have names starting
      and ending with double underscores.  Special methods are documented in
      :ref:`specialnames`.

910 911
   statement
      A statement is part of a suite (a "block" of code).  A statement is either
912
      an :term:`expression` or one of several constructs with a keyword, such
913
      as :keyword:`if`, :keyword:`while` or :keyword:`for`.
914

915
   struct sequence
Florent Xicluna's avatar
Florent Xicluna committed
916
      A tuple with named elements. Struct sequences expose an interface similar
917 918 919 920 921 922
      to :term:`named tuple` in that elements can either be accessed either by
      index or as an attribute. However, they do not have any of the named tuple
      methods like :meth:`~collections.somenamedtuple._make` or
      :meth:`~collections.somenamedtuple._asdict`. Examples of struct sequences
      include :data:`sys.float_info` and the return value of :func:`os.stat`.

923 924 925
   text encoding
      A codec which encodes Unicode strings to bytes.

926 927 928
   text file
      A :term:`file object` able to read and write :class:`str` objects.
      Often, a text file actually accesses a byte-oriented datastream
929
      and handles the :term:`text encoding` automatically.
930 931 932 933

      .. seealso::
         A :term:`binary file` reads and write :class:`bytes` objects.

934 935 936 937 938 939 940 941 942
   triple-quoted string
      A string which is bound by three instances of either a quotation mark
      (") or an apostrophe (').  While they don't provide any functionality
      not available with single-quoted strings, they are useful for a number
      of reasons.  They allow you to include unescaped single and double
      quotes within a string and they can span multiple lines without the
      use of the continuation character, making them especially useful when
      writing docstrings.

943 944 945
   type
      The type of a Python object determines what kind of object it is; every
      object has a type.  An object's type is accessible as its
946 947
      :attr:`~instance.__class__` attribute or can be retrieved with
      ``type(obj)``.
948

949 950 951 952 953
   universal newlines
      A manner of interpreting text streams in which all of the following are
      recognized as ending a line: the Unix end-of-line convention ``'\n'``,
      the Windows convention ``'\r\n'``, and the old Macintosh convention
      ``'\r'``.  See :pep:`278` and :pep:`3116`, as well as
954
      :func:`bytes.splitlines` for an additional use.
955

956 957 958 959 960 961
   virtual environment
      A cooperatively isolated runtime environment that allows Python users
      and applications to install and upgrade Python distribution packages
      without interfering with the behaviour of other Python applications
      running on the same system.

962
      See also :ref:`scripts-pyvenv`.
963

964 965 966
   virtual machine
      A computer defined entirely in software.  Python's virtual machine
      executes the :term:`bytecode` emitted by the bytecode compiler.
967

968 969 970 971
   Zen of Python
      Listing of Python design principles and philosophies that are helpful in
      understanding and using the language.  The listing can be found by typing
      "``import this``" at the interactive prompt.