Glossary

>>>

The default Python prompt of theinteractive shell. Oftenseen for code examples which can be executed interactively in theinterpreter.

...

Can refer to:

  • The default Python prompt of theinteractive shell when entering thecode for an indented code block, when within a pair of matching left andright delimiters (parentheses, square brackets, curly braces or triplequotes), or after specifying a decorator.

  • TheEllipsis built-in constant.

abstract base class

Abstract base classes complementduck-typing byproviding a way to define interfaces when other techniques likehasattr() would be clumsy or subtly wrong (for example withmagic methods). ABCs introduce virtualsubclasses, which are classes that don’t inherit from a class but arestill recognized byisinstance() andissubclass(); see theabc module documentation. Python comes with many built-in ABCs fordata structures (in thecollections.abc module), numbers (in thenumbers module), streams (in theio module), import findersand loaders (in theimportlib.abc module). You can create your ownABCs with theabc module.

annotation

A label associated with a variable, a classattribute or a function parameter or return value,used by convention as atype hint.

Annotations of local variables cannot be accessed at runtime, butannotations of global variables, class attributes, and functionsare stored in the__annotations__special attribute of modules, classes, and functions,respectively.

Seevariable annotation,function annotation,PEP 484andPEP 526, which describe this functionality.Also seeAnnotations Best Practicesfor best practices on working with annotations.

argument

A value passed to afunction (ormethod) when calling thefunction. There are two kinds of argument:

  • keyword argument: an argument preceded by an identifier (e.g.name=) in a function call or passed as a value in a dictionarypreceded by**. For example,3 and5 are both keywordarguments in the following calls tocomplex():

    complex(real=3,imag=5)complex(**{'real':3,'imag':5})
  • positional argument: an argument that is not a keyword argument.Positional arguments can appear at the beginning of an argument listand/or be passed as elements of aniterable preceded by*.For example,3 and5 are both positional arguments in thefollowing calls:

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

Arguments are assigned to the named local variables in a function body.See theCalls section for the rules governing this assignment.Syntactically, any expression can be used to represent an argument; theevaluated value is assigned to the local variable.

See also theparameter glossary entry, the FAQ question onthe difference between arguments and parameters, andPEP 362.

asynchronous context manager

An object which controls the environment seen in anasyncwith statement by defining__aenter__() and__aexit__() methods. Introduced byPEP 492.

asynchronous generator

A function which returns anasynchronous generator iterator. Itlooks like a coroutine function defined withasyncdef exceptthat it containsyield expressions for producing a series ofvalues usable in anasyncfor loop.

Usually refers to an asynchronous generator function, but may refer to anasynchronous generator iterator in some contexts. In cases where theintended meaning isn’t clear, using the full terms avoids ambiguity.

An asynchronous generator function may containawaitexpressions as well asasyncfor, andasyncwithstatements.

asynchronous generator iterator

An object created by aasynchronous generator function.

This is anasynchronous iterator which when called using the__anext__() method returns an awaitable object which will executethe body of the asynchronous generator function until the nextyield expression.

Eachyield temporarily suspends processing, remembering theexecution state (including local variables and pendingtry-statements). When theasynchronous generator iterator effectivelyresumes with another awaitable returned by__anext__(), itpicks up where it left off. SeePEP 492 andPEP 525.

asynchronous iterable

An object, that can be used in anasyncfor statement.Must return anasynchronous iterator from its__aiter__() method. Introduced byPEP 492.

asynchronous iterator

An object that implements the__aiter__() and__anext__()methods.__anext__() must return anawaitable object.asyncfor resolves the awaitables returned by an asynchronousiterator’s__anext__() method until it raises aStopAsyncIteration exception. Introduced byPEP 492.

attribute

A value associated with an object which is usually referenced by nameusing dotted expressions.For example, if an objecto has an attributea it would be referenced aso.a.

It is possible to give an object an attribute whose name is not anidentifier as defined byIdentifiers and keywords, for example usingsetattr(), if the object allows it.Such an attribute will not be accessible using a dotted expression,and would instead need to be retrieved withgetattr().

awaitable

An object that can be used in anawait expression. Can beacoroutine or an object with an__await__() method.See alsoPEP 492.

BDFL

Benevolent Dictator For Life, a.k.a.Guido van Rossum, Python’s creator.

binary file

Afile object able to read and writebytes-like objects.Examples of binary files are files opened in binary mode ('rb','wb' or'rb+'),sys.stdin.buffer,sys.stdout.buffer, and instances ofio.BytesIO andgzip.GzipFile.

See alsotext file for a file object able to read and writestr objects.

borrowed reference

In Python’s C API, a borrowed reference is a reference to an object,where the code using the object does not own the reference.It becomes a danglingpointer if the object is destroyed. For example, a garbage collection canremove the laststrong reference to the object and so destroy it.

CallingPy_INCREF() on theborrowed reference isrecommended to convert it to astrong reference in-place, exceptwhen the object cannot be destroyed before the last usage of the borrowedreference. ThePy_NewRef() function can be used to create a newstrong reference.

bytes-like object

An object that supports theBuffer Protocol and canexport a C-contiguous buffer. This includes allbytes,bytearray, andarray.array objects, as well as manycommonmemoryview objects. Bytes-like objects canbe used for various operations that work with binary data; these includecompression, saving to a binary file, and sending over a socket.

Some operations need the binary data to be mutable. The documentationoften refers to these as “read-write bytes-like objects”. Examplemutable buffer objects includebytearray and amemoryview of abytearray.Other operations require the binary data to be stored inimmutable objects (“read-only bytes-like objects”); examplesof these includebytes and amemoryviewof abytes object.

bytecode

Python source code is compiled into bytecode, the internal representationof a Python program in the CPython interpreter. The bytecode is alsocached in.pyc files so that executing the same file isfaster the second time (recompilation from source to bytecode can beavoided). This “intermediate language” is said to run on avirtual machine that executes the machine code corresponding toeach bytecode. Do note that bytecodes are not expected to work betweendifferent Python virtual machines, nor to be stable between Pythonreleases.

A list of bytecode instructions can be found in the documentation forthe dis module.

callable

A callable is an object that can be called, possibly with a setof arguments (seeargument), with the following syntax:

callable(argument1,argument2,argumentN)

Afunction, and by extension amethod, is a callable.An instance of a class that implements the__call__()method is also a callable.

callback

A subroutine function which is passed as an argument to be executed atsome point in the future.

class

A template for creating user-defined objects. Class definitionsnormally contain method definitions which operate on instances of theclass.

class variable

A variable defined in a class and intended to be modified only atclass level (i.e., not in an instance of the class).

closure variable

Afree variable referenced from anested scope that is defined in an outerscope rather than being resolved at runtime from the globals or builtin namespaces.May be explicitly defined with thenonlocal keyword to allow write access,or implicitly defined if the variable is only being read.

For example, in theinner function in the following code, bothx andprint arefree variables, but onlyx is aclosure variable:

defouter():x=0definner():nonlocalxx+=1print(x)returninner

Due to thecodeobject.co_freevars attribute (which, despite its name, onlyincludes the names of closure variables rather than listing all referenced freevariables), the more generalfree variable term is sometimes used evenwhen the intended meaning is to refer specifically to closure variables.

complex number

An extension of the familiar real number system in which all numbers areexpressed as a sum of a real part and an imaginary part. Imaginarynumbers are real multiples of the imaginary unit (the square root of-1), often writteni in mathematics orj inengineering. Python has built-in support for complex numbers, which arewritten with this latter notation; the imaginary part is written with aj suffix, e.g.,3+1j. To get access to complex equivalents of themath module, usecmath. Use of complex numbers is a fairlyadvanced mathematical feature. If you’re not aware of a need for them,it’s almost certain you can safely ignore them.

context

This term has different meanings depending on where and how it is used.Some common meanings:

context management protocol

The__enter__() and__exit__() methods calledby thewith statement. SeePEP 343.

context manager

An object which implements thecontext management protocol andcontrols the environment seen in awith statement. SeePEP 343.

context variable

A variable whose value depends on which context is thecurrentcontext. Values are accessed viacontextvars.ContextVarobjects. Context variables are primarily used to isolate state betweenconcurrent asynchronous tasks.

contiguous

A buffer is considered contiguous exactly if it is eitherC-contiguous orFortran contiguous. Zero-dimensional buffers areC and Fortran contiguous. In one-dimensional arrays, the itemsmust be laid out in memory next to each other, in order ofincreasing indexes starting from zero. In multidimensionalC-contiguous arrays, the last index varies the fastest whenvisiting items in order of memory address. However, inFortran contiguous arrays, the first index varies the fastest.

coroutine

Coroutines are a more generalized form of subroutines. Subroutines areentered at one point and exited at another point. Coroutines can beentered, exited, and resumed at many different points. They can beimplemented with theasyncdef statement. See alsoPEP 492.

coroutine function

A function which returns acoroutine object. A coroutinefunction may be defined with theasyncdef statement,and may containawait,asyncfor, andasyncwith keywords. These were introducedbyPEP 492.

CPython

The canonical implementation of the Python programming language, asdistributed onpython.org. The term “CPython”is used when necessary to distinguish this implementation from otherssuch as Jython or IronPython.

current context

Thecontext (contextvars.Context object) that iscurrently used byContextVar objects to access (getor set) the values ofcontext variables. Eachthread has its own current context. Frameworks for executing asynchronoustasks (seeasyncio) associate each task with a context whichbecomes the current context whenever the task starts or resumes execution.

decorator

A function returning another function, usually applied as a functiontransformation using the@wrapper syntax. Common examples fordecorators areclassmethod() andstaticmethod().

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

deff(arg):...f=staticmethod(f)@staticmethoddeff(arg):...

The same concept exists for classes, but is less commonly used there. Seethe documentation forfunction definitions andclass definitions for more about decorators.

descriptor

Any object which defines the methods__get__(),__set__(), or__delete__().When a class attribute is a descriptor, its specialbinding behavior is triggered upon attribute lookup. Normally, usinga.b to get, set or delete an attribute looks up the object namedb inthe class dictionary fora, but ifb is a descriptor, the respectivedescriptor method gets called. Understanding descriptors is a key to adeep understanding of Python because they are the basis for many featuresincluding functions, methods, properties, class methods, static methods,and reference to super classes.

For more information about descriptors’ methods, seeImplementing Descriptorsor theDescriptor How To Guide.

dictionary

An associative array, where arbitrary keys are mapped to values. Thekeys can be any object with__hash__() and__eq__() methods.Called a hash in Perl.

dictionary comprehension

A compact way to process all or part of the elements in an iterable andreturn a dictionary with the results.results={n:n**2forninrange(10)} generates a dictionary containing keyn mapped tovaluen**2. SeeDisplays for lists, sets and dictionaries.

dictionary view

The objects returned fromdict.keys(),dict.values(), anddict.items() are called dictionary views. They provide a dynamicview on the dictionary’s entries, which means that when the dictionarychanges, the view reflects these changes. To force thedictionary view to become a full list uselist(dictview). SeeDictionary view objects.

docstring

A string literal which appears as the first expression in a class,function or module. While ignored when the suite is executed, it isrecognized by the compiler and put into the__doc__ attributeof the enclosing class, function or module. Since it is available viaintrospection, it is the canonical place for documentation of theobject.

duck-typing

A programming style which does not look at an object’s type to determineif it has the right interface; instead, the method or attribute is simplycalled or used (“If it looks like a duck and quacks like a duck, itmust be a duck.”) By emphasizing interfaces rather than specific types,well-designed code improves its flexibility by allowing polymorphicsubstitution. Duck-typing avoids tests usingtype() orisinstance(). (Note, however, that duck-typing can be complementedwithabstract base classes.) Instead, ittypically employshasattr() tests orEAFP programming.

EAFP

Easier to ask for forgiveness than permission. This common Python codingstyle assumes the existence of valid keys or attributes and catchesexceptions if the assumption proves false. This clean and fast style ischaracterized by the presence of manytry andexceptstatements. The technique contrasts with theLBYL stylecommon to many other languages such as C.

expression

A piece of syntax which can be evaluated to some value. In other words,an expression is an accumulation of expression elements like literals,names, attribute access, operators or function calls which all return avalue. In contrast to many other languages, not all language constructsare expressions. There are alsostatements which cannot be usedas expressions, such aswhile. Assignments are also statements,not expressions.

extension module

A module written in C or C++, using Python’s C API to interact with thecore and with user code.

f-string

String literals prefixed with'f' or'F' are commonly called“f-strings” which is short forformatted string literals. See alsoPEP 498.

file object

An object exposing a file-oriented API (with methods such asread() orwrite()) to an underlying resource. Dependingon the way it was created, a file object can mediate access to a realon-disk file or to another type of storage or communication device(for example standard input/output, in-memory buffers, sockets, pipes,etc.). File objects are also calledfile-like objects orstreams.

There are actually three categories of file objects: rawbinary files, bufferedbinary files andtext files.Their interfaces are defined in theio module. The canonicalway to create a file object is by using theopen() function.

file-like object

A synonym forfile object.

filesystem encoding and error handler

Encoding and error handler used by Python to decode bytes from theoperating system and encode Unicode to the operating system.

The filesystem encoding must guarantee to successfully decode all bytesbelow 128. If the file system encoding fails to provide this guarantee,API functions can raiseUnicodeError.

Thesys.getfilesystemencoding() andsys.getfilesystemencodeerrors() functions can be used to get thefilesystem encoding and error handler.

Thefilesystem encoding and error handler are configured atPython startup by thePyConfig_Read() function: seefilesystem_encoding andfilesystem_errors members ofPyConfig.

See also thelocale encoding.

finder

An object that tries to find theloader for a module that isbeing imported.

There are two types of finder:meta path finders for use withsys.meta_path, andpathentry finders for use withsys.path_hooks.

SeeFinders and loaders andimportlib for much more detail.

floor division

Mathematical division that rounds down to nearest integer. The floordivision operator is//. For example, the expression11//4evaluates to2 in contrast to the2.75 returned by float truedivision. Note that(-11)//4 is-3 because that is-2.75roundeddownward. SeePEP 238.

free threading

A threading model where multiple threads can run Python bytecodesimultaneously within the same interpreter. This is in contrast totheglobal interpreter lock which allows only one thread toexecute Python bytecode at a time. SeePEP 703.

free variable

Formally, as defined in thelanguage execution model, a freevariable is any variable used in a namespace which is not a local variable in thatnamespace. Seeclosure variable for an example.Pragmatically, due to the name of thecodeobject.co_freevars attribute,the term is also sometimes used as a synonym forclosure variable.

function

A series of statements which returns some value to a caller. It can alsobe passed zero or morearguments which may be used inthe execution of the body. See alsoparameter,method,and theFunction definitions section.

function annotation

Anannotation of a function parameter or return value.

Function annotations are usually used fortype hints: for example, this function is expected to take twoint arguments and is also expected to have anintreturn value:

defsum_two_numbers(a:int,b:int)->int:returna+b

Function annotation syntax is explained in sectionFunction definitions.

Seevariable annotation andPEP 484,which describe this functionality.Also seeAnnotations Best Practicesfor best practices on working with annotations.

__future__

Afuture statement,from__future__import<feature>,directs the compiler to compile the current module using syntax orsemantics that will become standard in a future release of Python.The__future__ module documents the possible values offeature. By importing this module and evaluating its variables,you can see when a new feature was first added to the language andwhen it will (or did) become the default:

>>>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. Pythonperforms garbage collection via reference counting and a cyclic garbagecollector that is able to detect and break reference cycles. Thegarbage collector can be controlled using thegc module.

generator

A function which returns agenerator iterator. It looks like anormal function except that it containsyield expressionsfor producing a series of values usable in a for-loop or that can beretrieved one at a time with thenext() function.

Usually refers to a generator function, but may refer to agenerator iterator in some contexts. In cases where the intendedmeaning isn’t clear, using the full terms avoids ambiguity.

generator iterator

An object created by agenerator function.

Eachyield temporarily suspends processing, remembering theexecution state (including local variables and pendingtry-statements). When thegenerator iterator resumes, it picks up whereit left off (in contrast to functions which start fresh on everyinvocation).

generator expression

Anexpression that returns aniterator. It looks like a normal expressionfollowed by afor clause defining a loop variable, range,and an optionalif clause. The combined expressiongenerates values for an enclosing function:

>>>sum(i*iforiinrange(10))# sum of squares 0, 1, 4, ... 81285
generic function

A function composed of multiple functions implementing the same operationfor different types. Which implementation should be used during a call isdetermined by the dispatch algorithm.

See also thesingle dispatch glossary entry, thefunctools.singledispatch() decorator, andPEP 443.

generic type

Atype that can be parameterized; typically acontainer class such aslist ordict. Used fortype hints andannotations.

For more details, seegeneric alias types,PEP 483,PEP 484,PEP 585, and thetyping module.

GIL

Seeglobal interpreter lock.

global interpreter lock

The mechanism used by theCPython interpreter to assure thatonly one thread executes Pythonbytecode at a time.This simplifies the CPython implementation by making the object model(including critical built-in types such asdict) implicitlysafe against concurrent access. Locking the entire interpretermakes it easier for the interpreter to be multi-threaded, at theexpense of much of the parallelism afforded by multi-processormachines.

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

As of Python 3.13, the GIL can be disabled using the--disable-gilbuild configuration. After building Python with this option, code must berun with-Xgil=0 or after setting thePYTHON_GIL=0environment variable. This feature enables improved performance formulti-threaded applications and makes it easier to use multi-core CPUsefficiently. For more details, seePEP 703.

hash-based pyc

A bytecode cache file that uses the hash rather than the last-modifiedtime of the corresponding source file to determine its validity. SeeCached bytecode invalidation.

hashable

An object ishashable if it has a hash value which never changes duringits lifetime (it needs a__hash__() method), and can becompared to other objects (it needs an__eq__() method).Hashable objects whichcompare equal must have the same hash value.

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

Most of Python’s immutable built-in objects are hashable; mutablecontainers (such as lists or dictionaries) are not; immutablecontainers (such as tuples and frozensets) are only hashable iftheir elements are hashable. Objects which areinstances of user-defined classes are hashable by default. They allcompare unequal (except with themselves), and their hash value is derivedfrom theirid().

IDLE

An Integrated Development and Learning Environment for Python.IDLE — Python editor and shell is a basic editor and interpreter environmentwhich ships with the standard distribution of Python.

immortal

Immortal objects are a CPython implementation detail introducedinPEP 683.

If an object is immortal, itsreference count is never modified,and therefore it is never deallocated while the interpreter is running.For example,True andNone are immortal in CPython.

immutable

An object with a fixed value. Immutable objects include numbers, strings andtuples. Such an object cannot be altered. A new object has tobe created if a different value has to be stored. They play an importantrole in places where a constant hash value is needed, for example as a keyin a dictionary.

import path

A list of locations (orpath entries) that aresearched by thepath based finder for modules to import. Duringimport, this list of locations usually comes fromsys.path, butfor subpackages it may also come from the parent package’s__path__attribute.

importing

The process by which Python code in one module is made available toPython code in another module.

importer

An object that both finds and loads a module; both afinder andloader object.

interactive

Python has an interactive interpreter which means you can enterstatements and expressions at the interpreter prompt, immediatelyexecute them and see their results. Just launchpython with noarguments (possibly by selecting it from your computer’s mainmenu). It is a very powerful way to test out new ideas or inspectmodules and packages (rememberhelp(x)). For more on interactivemode, seeInteractive Mode.

interpreted

Python is an interpreted language, as opposed to a compiled one,though the distinction can be blurry because of the presence of thebytecode compiler. This means that source files can be run directlywithout explicitly creating an executable which is then run.Interpreted languages typically have a shorter development/debug cyclethan compiled ones, though their programs generally also run moreslowly. See alsointeractive.

interpreter shutdown

When asked to shut down, the Python interpreter enters a special phasewhere it gradually releases all allocated resources, such as modulesand various critical internal structures. It also makes several callsto thegarbage collector. This can triggerthe execution of code in user-defined destructors or weakref callbacks.Code executed during the shutdown phase can encounter variousexceptions 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__ moduleor the script being run has finished executing.

iterable

An object capable of returning its members one at a time. Examples ofiterables include all sequence types (such aslist,str,andtuple) and some non-sequence types likedict,file objects, and objects of any classes you definewith an__iter__() method or with a__getitem__() methodthat implementssequence semantics.

Iterables can beused in afor loop and in many other places where a sequence isneeded (zip(),map(), …). When an iterable object is passedas an argument to the built-in functioniter(), it returns aniterator for the object. This iterator is good for one pass over the setof values. When using iterables, it is usually not necessary to calliter() or deal with iterator objects yourself. Theforstatement does that automatically for you, creating a temporary unnamedvariable to hold the iterator for the duration of the loop. See alsoiterator,sequence, andgenerator.

iterator

An object representing a stream of data. Repeated calls to the iterator’s__next__() method (or passing it to the built-in functionnext()) return successive items in the stream. When no more dataare available aStopIteration exception is raised instead. At thispoint, the iterator object is exhausted and any further calls to its__next__() method just raiseStopIteration again. Iteratorsare required to have an__iter__() method that returns the iteratorobject itself so every iterator is also iterable and may be used in mostplaces where other iterables are accepted. One notable exception is codewhich attempts multiple iteration passes. A container object (such as alist) produces a fresh new iterator each time you pass it to theiter() function or use it in afor loop. Attempting thiswith an iterator will just return the same exhausted iterator object usedin the previous iteration pass, making it appear like an empty container.

More information can be found inIterator Types.

CPython implementation detail: CPython does not consistently apply the requirement that an iteratordefine__iter__().And also please note that the free-threading CPython does not guaranteethe thread-safety of iterator operations.

key function

A key function or collation function is a callable that returns a valueused for sorting or ordering. For example,locale.strxfrm() isused to produce a sort key that is aware of locale specific sortconventions.

A number of tools in Python accept key functions to control how elementsare ordered or grouped. They includemin(),max(),sorted(),list.sort(),heapq.merge(),heapq.nsmallest(),heapq.nlargest(), anditertools.groupby().

There are several ways to create a key function. For example. thestr.lower() method can serve as a key function for case insensitivesorts. Alternatively, a key function can be built from alambda expression such aslambdar:(r[0],r[2]). Also,operator.attrgetter(),operator.itemgetter(), andoperator.methodcaller() are three key function constructors. See theSorting HOW TO for examples of how to create and use key functions.

keyword argument

Seeargument.

lambda

An anonymous inline function consisting of a singleexpressionwhich is evaluated when the function is called. The syntax to createa lambda function islambda[parameters]:expression

LBYL

Look before you leap. This coding style explicitly tests forpre-conditions before making calls or lookups. This style contrasts withtheEAFP approach and is characterized by the presence of manyif statements.

In a multi-threaded environment, the LBYL approach can risk introducing arace condition between “the looking” and “the leaping”. For example, thecode,ifkeyinmapping:returnmapping[key] can fail if anotherthread removeskey frommapping after the test, but before the lookup.This issue can be solved with locks or by using the EAFP approach.

lexical analyzer

Formal name for thetokenizer; seetoken.

list

A built-in Pythonsequence. Despite its name it is more akinto an array in other languages than to a linked list since access toelements isO(1).

list comprehension

A compact way to process all or part of the elements in a sequence andreturn a list with the results.result=['{:#04x}'.format(x)forxinrange(256)ifx%2==0] generates a list of strings containingeven hex numbers (0x..) in the range from 0 to 255. Theifclause is optional. If omitted, all elements inrange(256) areprocessed.

loader

An object that loads a module.It must define theexec_module() andcreate_module() methodsto implement theLoader interface.A loader is typically returned by afinder.See also:

locale encoding

On Unix, it is the encoding of the LC_CTYPE locale. It can be set withlocale.setlocale(locale.LC_CTYPE,new_locale).

On Windows, it is the ANSI code page (ex:"cp1252").

On Android and VxWorks, Python uses"utf-8" as the locale encoding.

locale.getencoding() can be used to get the locale encoding.

See also thefilesystem encoding and error handler.

magic method

An informal synonym forspecial method.

mapping

A container object that supports arbitrary key lookups and implements themethods specified in thecollections.abc.Mapping orcollections.abc.MutableMappingabstract base classes. Examplesincludedict,collections.defaultdict,collections.OrderedDict andcollections.Counter.

meta path finder

Afinder returned by a search ofsys.meta_path. Meta pathfinders are related to, but different frompath entry finders.

Seeimportlib.abc.MetaPathFinder for the methods that meta pathfinders implement.

metaclass

The class of a class. Class definitions create a class name, a classdictionary, and a list of base classes. The metaclass is responsible fortaking those three arguments and creating the class. Most object orientedprogramming languages provide a default implementation. What makes Pythonspecial is that it is possible to create custom metaclasses. Most usersnever need this tool, but when the need arises, metaclasses can providepowerful, elegant solutions. They have been used for logging attributeaccess, adding thread-safety, tracking object creation, implementingsingletons, and many other tasks.

More information can be found inMetaclasses.

method

A function which is defined inside a class body. If called as an attributeof an instance of that class, the method will get the instance object asits firstargument (which is usually calledself).Seefunction andnested scope.

method resolution order

Method Resolution Order is the order in which base classes are searchedfor a member during lookup. SeeThe Python 2.3 Method Resolution Order for details of thealgorithm used by the Python interpreter since the 2.3 release.

module

An object that serves as an organizational unit of Python code. Moduleshave a namespace containing arbitrary Python objects. Modules are loadedinto Python by the process ofimporting.

See alsopackage.

module spec

A namespace containing the import-related information used to load amodule. An instance ofimportlib.machinery.ModuleSpec.

See alsoModule specs.

MRO

Seemethod resolution order.

mutable

Mutable objects can change their value but keep theirid(). Seealsoimmutable.

named tuple

The term “named tuple” applies to any type or class that inherits fromtuple and whose indexable elements are also accessible using namedattributes. The type or class may have other features as well.

Several built-in types are named tuples, including the values returnedbytime.localtime() andos.stat(). Another example issys.float_info:

>>>sys.float_info[1]# indexed access1024>>>sys.float_info.max_exp# named field access1024>>>isinstance(sys.float_info,tuple)# kind of tupleTrue

Some named tuples are built-in types (such as the above examples).Alternatively, a named tuple can be created from a regular classdefinition that inherits fromtuple and that defines namedfields. Such a class can be written by hand, or it can be created byinheritingtyping.NamedTuple, or with the factory functioncollections.namedtuple(). The latter techniques also add someextra methods that may not be found in hand-written or built-in namedtuples.

namespace

The place where a variable is stored. Namespaces are implemented asdictionaries. There are the local, global and built-in namespaces as wellas nested namespaces in objects (in methods). Namespaces supportmodularity by preventing naming conflicts. For instance, the functionsbuiltins.open andos.open() are distinguished bytheir namespaces. Namespaces also aid readability and maintainability bymaking it clear which module implements a function. For instance, writingrandom.seed() oritertools.islice() makes it clear that thosefunctions are implemented by therandom anditertoolsmodules, respectively.

namespace package

Apackage which serves only as a container for subpackages.Namespace packages may have no physical representation,and specifically are not like aregular package because theyhave no__init__.py file.

Namespace packages allow several individually installable packages to have a common parent package.Otherwise, it is recommended to use aregular package.

For more information, seePEP 420 andNamespace packages.

See alsomodule.

nested scope

The ability to refer to a variable in an enclosing definition. Forinstance, a function defined inside another function can refer tovariables in the outer function. Note that nested scopes by default workonly for reference and not for assignment. Local variables both read andwrite in the innermost scope. Likewise, global variables read and writeto the global namespace. Thenonlocal allows writing to outerscopes.

new-style class

Old name for the flavor of classes now used for all class objects. Inearlier Python versions, only new-style classes could use Python’s newer,versatile features like__slots__, descriptors,properties,__getattribute__(), class methods, and staticmethods.

object

Any data with state (attributes or value) and defined behavior(methods). Also the ultimate base class of anynew-styleclass.

optimized scope

A scope where target local variable names are reliably known to thecompiler when the code is compiled, allowing optimization of read andwrite access to these names. The local namespaces for functions,generators, coroutines, comprehensions, and generator expressions areoptimized in this fashion. Note: most interpreter optimizations areapplied to all scopes, only those relying on a known set of localand nonlocal variable names are restricted to optimized scopes.

package

A Pythonmodule which can contain submodules or recursively,subpackages. Technically, a package is a Python module with a__path__ attribute.

See alsoregular package andnamespace package.

parameter

A named entity in afunction (or method) definition thatspecifies anargument (or in some cases, arguments) that thefunction can accept. There are five kinds of parameter:

  • positional-or-keyword: specifies an argument that can be passedeitherpositionally or as akeyword argument. This is the default kind of parameter, for examplefooandbar in the following:

    deffunc(foo,bar=None):...
  • positional-only: specifies an argument that can be supplied onlyby position. Positional-only parameters can be defined by including a/ character in the parameter list of the function definition afterthem, for exampleposonly1 andposonly2 in the following:

    deffunc(posonly1,posonly2,/,positional_or_keyword):...
  • keyword-only: specifies an argument that can be supplied onlyby keyword. Keyword-only parameters can be defined by including asingle var-positional parameter or bare* in the parameter listof the function definition before them, for examplekw_only1 andkw_only2 in the following:

    deffunc(arg,*,kw_only1,kw_only2):...
  • var-positional: specifies that an arbitrary sequence ofpositional arguments can be provided (in addition to any positionalarguments already accepted by other parameters). Such a parameter canbe defined by prepending the parameter name with*, for exampleargs in the following:

    deffunc(*args,**kwargs):...
  • var-keyword: specifies that arbitrarily many keyword argumentscan be provided (in addition to any keyword arguments already acceptedby other parameters). Such a parameter can be defined by prependingthe parameter name with**, for examplekwargs in the exampleabove.

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

See also theargument glossary entry, the FAQ question onthe difference between arguments and parameters, theinspect.Parameter class, theFunction definitions section, andPEP 362.

path entry

A single location on theimport path which thepathbased finder consults to find modules for importing.

path entry finder

Afinder returned by a callable onsys.path_hooks(i.e. apath entry hook) which knows how to locate modules givenapath entry.

Seeimportlib.abc.PathEntryFinder for the methods that path entryfinders implement.

path entry hook

A callable on thesys.path_hooks list which returns apathentry finder if it knows how to find modules on a specificpathentry.

path based finder

One of the defaultmeta path finders whichsearches animport path for modules.

path-like object

An object representing a file system path. A path-like object is eitherastr orbytes object representing a path, or an objectimplementing theos.PathLike protocol. An object that supportstheos.PathLike protocol can be converted to astr orbytes file system path by calling theos.fspath() function;os.fsdecode() andos.fsencode() can be used to guarantee astr orbytes result instead, respectively. IntroducedbyPEP 519.

PEP

Python Enhancement Proposal. A PEP is a design documentproviding information to the Python community, or describing a newfeature for Python or its processes or environment. PEPs shouldprovide a concise technical specification and a rationale for proposedfeatures.

PEPs are intended to be the primary mechanisms for proposing major newfeatures, for collecting community input on an issue, and for documentingthe design decisions that have gone into Python. The PEP author isresponsible for building consensus within the community and documentingdissenting opinions.

SeePEP 1.

portion

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

positional argument

Seeargument.

provisional API

A provisional API is one which has been deliberately excluded fromthe standard library’s backwards compatibility guarantees. While majorchanges to such interfaces are not expected, as long as they are markedprovisional, backwards incompatible changes (up to and including removalof the interface) may occur if deemed necessary by core developers. Suchchanges will not be made gratuitously – they will occur only if seriousfundamental flaws are uncovered that were missed prior to the inclusionof the API.

Even for provisional APIs, backwards incompatible changes are seen asa “solution of last resort” - every attempt will still be made to finda backwards compatible resolution to any identified problems.

This process allows the standard library to continue to evolve overtime, without locking in problematic design errors for extended periodsof time. SeePEP 411 for more details.

provisional package

Seeprovisional API.

Python 3000

Nickname for the Python 3.x release line (coined long ago when therelease of version 3 was something in the distant future.) This is alsoabbreviated “Py3k”.

Pythonic

An idea or piece of code which closely follows the most common idiomsof the Python language, rather than implementing code using conceptscommon to other languages. For example, a common idiom in Python isto loop over all elements of an iterable using aforstatement. Many other languages don’t have this type of construct, sopeople unfamiliar with Python sometimes use a numerical counter instead:

foriinrange(len(food)):print(food[i])

As opposed to the cleaner, Pythonic method:

forpieceinfood:print(piece)
qualified name

A dotted name showing the “path” from a module’s global scope to aclass, function or method defined in that module, as defined inPEP 3155. For top-level functions and classes, the qualified nameis the same as the object’s name:

>>>classC:...classD:...defmeth(self):...pass...>>>C.__qualname__'C'>>>C.D.__qualname__'C.D'>>>C.D.meth.__qualname__'C.D.meth'

When used to refer to modules, thefully qualified name means theentire dotted path to the module, including any parent packages,e.g.email.mime.text:

>>>importemail.mime.text>>>email.mime.text.__name__'email.mime.text'
reference count

The number of references to an object. When the reference count of anobject drops to zero, it is deallocated. Some objects areimmortal and have reference counts that are never modified, andtherefore the objects are never deallocated. Reference counting isgenerally not visible to Python code, but it is a key element of theCPython implementation. Programmers can call thesys.getrefcount() function to return thereference count for a particular object.

regular package

A traditionalpackage, such as a directory containing an__init__.py file.

See alsonamespace package.

REPL

An acronym for the “read–eval–print loop”, another name for theinteractive interpreter shell.

__slots__

A declaration inside a class that saves memory by pre-declaring space forinstance attributes and eliminating instance dictionaries. Thoughpopular, the technique is somewhat tricky to get right and is bestreserved for rare cases where there are large numbers of instances in amemory-critical application.

sequence

Aniterable which supports efficient element access using integerindices via the__getitem__() special method and defines a__len__() method that returns the length of the sequence.Some built-in sequence types arelist,str,tuple, andbytes. Note thatdict alsosupports__getitem__() and__len__(), but is considered amapping rather than a sequence because the lookups use arbitraryhashable keys rather than integers.

Thecollections.abc.Sequence abstract base classdefines a much richer interface that goes beyond just__getitem__() and__len__(), addingcount(),index(),__contains__(), and__reversed__(). Types that implement this expandedinterface can be registered explicitly usingregister(). For more documentation on sequencemethods generally, seeCommon Sequence Operations.

set comprehension

A compact way to process all or part of the elements in an iterable andreturn a set with the results.results={cforcin'abracadabra'ifcnotin'abc'} generates the set of strings{'r','d'}. SeeDisplays for lists, sets and dictionaries.

single dispatch

A form ofgeneric function dispatch where the implementation ischosen based on the type of a single argument.

slice

An object usually containing a portion of asequence. A slice iscreated using the subscript notation,[] with colons between numberswhen several are given, such as invariable_name[1:3:5]. The bracket(subscript) notation usesslice objects internally.

soft deprecated

A soft deprecated API should not be used in new code,but it is safe for already existing code to use it.The API remains documented and tested, but will not be enhanced further.

Soft deprecation, unlike normal deprecation, does not plan on removing the APIand will not emit warnings.

SeePEP 387: Soft Deprecation.

special method

A method that is called implicitly by Python to execute a certainoperation on a type, such as addition. Such methods have names startingand ending with double underscores. Special methods are documented inSpecial method names.

statement

A statement is part of a suite (a “block” of code). A statement is eitheranexpression or one of several constructs with a keyword, suchasif,while orfor.

static type checker

An external tool that reads Python code and analyzes it, looking forissues such as incorrect types. See alsotype hintsand thetyping module.

strong reference

In Python’s C API, a strong reference is a reference to an objectwhich is owned by the code holding the reference. The strongreference is taken by callingPy_INCREF() when thereference is created and released withPy_DECREF()when the reference is deleted.

ThePy_NewRef() function can be used to create a strong referenceto an object. Usually, thePy_DECREF() function must be called onthe strong reference before exiting the scope of the strong reference, toavoid leaking one reference.

See alsoborrowed reference.

text encoding

A string in Python is a sequence of Unicode code points (in rangeU+0000U+10FFFF). To store or transfer a string, it needs to beserialized as a sequence of bytes.

Serializing a string into a sequence of bytes is known as “encoding”, andrecreating the string from the sequence of bytes is known as “decoding”.

There are a variety of different text serializationcodecs, which are collectively referred to as“text encodings”.

text file

Afile object able to read and writestr objects.Often, a text file actually accesses a byte-oriented datastreamand handles thetext encoding automatically.Examples of text files are files opened in text mode ('r' or'w'),sys.stdin,sys.stdout, and instances ofio.StringIO.

See alsobinary file for a file object able to read and writebytes-like objects.

token

A small unit of source code, generated by thelexical analyzer (also called thetokenizer).Names, numbers, strings, operators,newlines and similar are represented by tokens.

Thetokenize module exposes Python’s lexical analyzer.Thetoken module contains information on the various typesof tokens.

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 functionalitynot available with single-quoted strings, they are useful for a numberof reasons. They allow you to include unescaped single and doublequotes within a string and they can span multiple lines without theuse of the continuation character, making them especially useful whenwriting docstrings.

type

The type of a Python object determines what kind of object it is; everyobject has a type. An object’s type is accessible as its__class__ attribute or can be retrieved withtype(obj).

type alias

A synonym for a type, created by assigning the type to an identifier.

Type aliases are useful for simplifyingtype hints.For example:

defremove_gray_shades(colors:list[tuple[int,int,int]])->list[tuple[int,int,int]]:pass

could be made more readable like this:

Color=tuple[int,int,int]defremove_gray_shades(colors:list[Color])->list[Color]:pass

Seetyping andPEP 484, which describe this functionality.

type hint

Anannotation that specifies the expected type for a variable, a classattribute, or a function parameter or return value.

Type hints are optional and are not enforced by Python butthey are useful tostatic type checkers.They can also aid IDEs with code completion and refactoring.

Type hints of global variables, class attributes, and functions,but not local variables, can be accessed usingtyping.get_type_hints().

Seetyping andPEP 484, which describe this functionality.

universal newlines

A manner of interpreting text streams in which all of the following arerecognized as ending a line: the Unix end-of-line convention'\n',the Windows convention'\r\n', and the old Macintosh convention'\r'. SeePEP 278 andPEP 3116, as well asbytes.splitlines() for an additional use.

variable annotation

Anannotation of a variable or a class attribute.

When annotating a variable or a class attribute, assignment is optional:

classC:field:'annotation'

Variable annotations are usually used fortype hints: for example this variable is expected to takeint values:

count:int=0

Variable annotation syntax is explained in sectionAnnotated assignment statements.

Seefunction annotation,PEP 484andPEP 526, which describe this functionality.Also seeAnnotations Best Practicesfor best practices on working with annotations.

virtual environment

A cooperatively isolated runtime environment that allows Python usersand applications to install and upgrade Python distribution packageswithout interfering with the behaviour of other Python applicationsrunning on the same system.

See alsovenv.

virtual machine

A computer defined entirely in software. Python’s virtual machineexecutes thebytecode emitted by the bytecode compiler.

Zen of Python

Listing of Python design principles and philosophies that are helpful inunderstanding and using the language. The listing can be found by typing“importthis” at the interactive prompt.