Python Built in Functions Tutorial
Python Built in Functions Tutorial
Built-in Functions
The Python interpreter has a number of functions built into it that are always a
vailable. They are listed here in alphabetical order.
Built-in Functions
abs() divmod()
input()
open() staticmethod()
all() enumerate()
int() ord() str()
any() eval() isinstance()
pow() sum()
basestring()
execfile()
issubclass()
print()
super()
bin() file() iter() property()
tuple()
bool() filter()
len() range()
type()
bytearray()
float()
list() raw_input()
unichr()
callable()
format()
locals()
reduce()
unicode()
chr() frozenset()
long() reload()
vars()
classmethod() getattr()
map() repr() xrange()
cmp() globals()
max() reversed()
zip()
compile()
hasattr()
memoryview()
round()
__import__()
complex()
hash() min() set()
delattr()
help() next() setattr()
dict() hex() object()
slice()
dir() id()
oct() sorted()
In addition, there are other four built-in functions that are no longer consider
ed essential: apply(), buffer(), coerce(), and intern(). They are documented in
the Non-essential Built-in Functions section.
abs(x)
Return the absolute value of a number. The argument may be a plain or long i
nteger or a floating point number. If the argument is a complex number, its magn
itude is returned.
all(iterable)
Return True if all elements of the iterable are true (or if the iterable is
empty). Equivalent to:
def all(iterable):
for element in iterable:
if not element:
return False
return True
New in version 2.5.
any(iterable)
Return True if any element of the iterable is true. If the iterable is empty
, return False. Equivalent to:
def any(iterable):
for element in iterable:
if element:
return True
return False
New in version 2.5.
basestring()
This abstract type is the superclass for str and unicode. It cannot be calle
d or instantiated, but it can be used to test whether an object is an instance o
f str or unicode. isinstance(obj, basestring) is equivalent to isinstance(obj, (
str, unicode)).
New in version 2.3.
bin(x)
Convert an integer number to a binary string. The result is a valid Python e
xpression. If x is not a Python int object, it has to define an __index__() meth
od that returns an integer.
New in version 2.6.
class bool([x])
Return a Boolean value, i.e. one of True or False. x is converted using the
standard truth testing procedure. If x is false or omitted, this returns False;
otherwise it returns True. bool is also a class, which is a subclass of int. Cla
ss bool cannot be subclassed further. Its only instances are False and True.
New in version 2.2.1.
Changed in version 2.3: If no argument is given, this function returns False
.
class bytearray([source[, encoding[, errors]]])
Return a new array of bytes. The bytearray class is a mutable sequence of in
tegers in the range 0 <= x < 256. It has most of the usual methods of mutable se
quences, described in Mutable Sequence Types, as well as most methods that the s
tr type has, see String Methods.
The optional source parameter can be used to initialize the array in a few d
ifferent ways:
If it is unicode, you must also give the encoding (and optionally, error
s) parameters; bytearray() then converts the unicode to bytes using unicode.enco
de().
If it is an integer, the array will have that size and will be initializ
ed with null bytes.
If it is an object conforming to the buffer interface, a read-only buffe
r of the object will be used to initialize the bytes array.
If it is an iterable, it must be an iterable of integers in the range 0
<= x < 256, which are used as the initial contents of the array.
Without an argument, an array of size 0 is created.
New in version 2.6.
callable(object)
Return True if the object argument appears callable, False if not. If this r
eturns true, it is still possible that a call fails, but if it is false, calling
object will never succeed. Note that classes are callable (calling a class retu
rns a new instance); class instances are callable if they have a __call__() meth
od.
chr(i)
Return a string of one character whose ASCII code is the integer i. For exam
ple, chr(97) returns the string 'a'. This is the inverse of ord(). The argument
must be in the range [0..255], inclusive; ValueError will be raised if i is outs
ide that range. See also unichr().
classmethod(function)
Return a class method for function.
A class method receives the class as implicit first argument, just like an i
nstance method receives the instance. To declare a class method, use this idiom:
class C(object):
@classmethod
def f(cls, arg1, arg2, ...):
...
The @classmethod form is a function decorator see the description of functio
n definitions in Function definitions for details.
It can be called either on the class (such as C.f()) or on an instance (such
as C().f()). The instance is ignored except for its class. If a class method is
called for a derived class, the derived class object is passed as the implied f
irst argument.
Class methods are different than C++ or Java static methods. If you want tho
se, see staticmethod() in this section.
For more information on class methods, consult the documentation on the stan
dard type hierarchy in The standard type hierarchy.
New in version 2.2.
Changed in version 2.4: Function decorator syntax added.
cmp(x, y)
Compare the two objects x and y and return an integer according to the outco
me. The return value is negative if x < y, zero if x == y and strictly positive
if x > y.
compile(source, filename, mode[, flags[, dont_inherit]])
Compile the source into a code or AST object. Code objects can be executed b
y an exec statement or evaluated by a call to eval(). source can either be a Uni
code string, a Latin-1 encoded string or an AST object. Refer to the ast module
documentation for information on how to work with AST objects.
The filename argument should give the file from which the code was read; pas
s some recognizable value if it wasnt read from a file ( <string> is commonly us
ed).
The mode argument specifies what kind of code must be compiled; it can be e
xec if source consists of a sequence of statements, eval if it consists of a
single expression, or single if it consists of a single interactive statement
(in the latter case, expression statements that evaluate to something other than
None will be printed).
The optional arguments flags and dont_inherit control which future statement
s (see PEP 236) affect the compilation of source. If neither is present (or both
are zero) the code is compiled with those future statements that are in effect
in the code that is calling compile(). If the flags argument is given and dont_i
nherit is not (or is zero) then the future statements specified by the flags arg
ument are used in addition to those that would be used anyway. If dont_inherit i
s a non-zero integer then the flags argument is it the future statements in effe
ct around the call to compile are ignored.
Future statements are specified by bits which can be bitwise ORed together t
o specify multiple statements. The bitfield required to specify a given feature
can be found as the compiler_flag attribute on the _Feature instance in the __fu
ture__ module.
This function raises SyntaxError if the compiled source is invalid, and Type
Error if the source contains null bytes.
If you want to parse Python code into its AST representation, see ast.parse(
).
Note
When compiling a string with multi-line code in single or eval mode, inp
ut must be terminated by at least one newline character. This is to facilitate d
etection of incomplete and complete statements in the code module.
Changed in version 2.3: The flags and dont_inherit arguments were added.
Changed in version 2.6: Support for compiling AST objects.
Changed in version 2.7: Allowed use of Windows and Mac newlines. Also input
in exec mode does not have to end in a newline anymore.
class complex([real[, imag]])
Return a complex number with the value real + imag*j or convert a string or
number to a complex number. If the first parameter is a string, it will be inter
preted as a complex number and the function must be called without a second para
meter. The second parameter can never be a string. Each argument may be any nume
ric type (including complex). If imag is omitted, it defaults to zero and the fu
nction serves as a numeric conversion function like int(), long() and float(). I
f both arguments are omitted, returns 0j.
Note
When converting from a string, the string must not contain whitespace around
the central + or - operator. For example, complex( 1+2j ) is fine, but complex(
1 + 2j ) raises ValueError.
The complex type is described in Numeric Types int, float, long, complex.
delattr(object, name)
This is a relative of setattr(). The arguments are an object and a string. T
he string must be the name of one of the objects attributes. The function deletes
the named attribute, provided the object allows it. For example, delattr(x, fo
obar ) is equivalent to del x.foobar.
class dict(**kwarg)
class dict(mapping, **kwarg)
class dict(iterable, **kwarg)
Create a new dictionary. The dict object is the dictionary class. See dict a
nd Mapping Types dict for documentation about this class.
For other containers see the built-in list, set, and tuple classes, as well
as the collections module.
dir([object])
Without arguments, return the list of names in the current local scope. With
an argument, attempt to return a list of valid attributes for that object.
If the object has a method named __dir__(), this method will be called and m
ust return the list of attributes. This allows objects that implement a custom _
_getattr__() or __getattribute__() function to customize the way dir() reports t
heir attributes.
If the object does not provide __dir__(), the function tries its best to gat
her information from the objects __dict__ attribute, if defined, and from its typ
e object. The resulting list is not necessarily complete, and may be inaccurate
when the object has a custom __getattr__().
The default dir() mechanism behaves differently with different types of obje
cts, as it attempts to produce the most relevant, rather than complete, informat
ion:
If the object is a module object, the list contains the names of the mod
ules attributes.
If the object is a type or class object, the list contains the names of
its attributes, and recursively of the attributes of its bases.
Otherwise, the list contains the objects attributes names, the names of it
s classs attributes, and recursively of the attributes of its classs base classes.
The resulting list is sorted alphabetically. For example:
>>> import struct
>>> dir() # show the names in the module namespace
[ __builtins__ , __doc__ , __name__ , struct ]
>>> dir(struct) # show the names in the struct module
[ Struct , __builtins__ , __doc__ , __file__ , __name__ ,
__package__ , _clearcache , calcsize , error , pack , pack_into ,
unpack , unpack_from ]
>>> class Shape(object):
def __dir__(self):
return [ area , perimeter , location ]
>>> s = Shape()
>>> dir(s)
[ area , perimeter , location ]
Note
Because dir() is supplied primarily as a convenience for use at an interacti
ve prompt, it tries to supply an interesting set of names more than it tries to
supply a rigorously or consistently defined set of names, and its detailed behav
ior may change across releases. For example, metaclass attributes are not in the
result list when the argument is a class.
divmod(a, b)
Take two (non complex) numbers as arguments and return a pair of numbers con
sisting of their quotient and remainder when using long division. With mixed ope
rand types, the rules for binary arithmetic operators apply. For plain and long
integers, the result is the same as (a // b, a % b). For floating point numbers
the result is (q, a % b), where q is usually math.floor(a / b) but may be 1 less
than that. In any case q * b + a % b is very close to a, if a % b is non-zero i
t has the same sign as b, and 0 <= abs(a % b) < abs(b).
Changed in version 2.3: Using divmod() with complex numbers is deprecated.
enumerate(sequence, start=0)
Return an enumerate object. sequence must be a sequence, an iterator, or som
e other object which supports iteration. The next() method of the iterator retur
ned by enumerate() returns a tuple containing a count (from start which defaults
to 0) and the values obtained from iterating over sequence:
>>> seasons = [ Spring , Summer , Fall , Winter ]
>>> list(enumerate(seasons))
[(0, Spring ), (1, Summer ), (2, Fall ), (3, Winter )]
>>> list(enumerate(seasons, start=1))
[(1, Spring ), (2, Summer ), (3, Fall ), (4, Winter )]
Equivalent to:
def enumerate(sequence, start=0):
n = start
for elem in sequence:
yield n, elem
n += 1
New in version 2.3.
Changed in version 2.6: The start parameter was added.
eval(expression[, globals[, locals]])
The arguments are a Unicode or Latin-1 encoded string and optional globals a
nd locals. If provided, globals must be a dictionary. If provided, locals can be
any mapping object.
Changed in version 2.4: formerly locals was required to be a dictionary.
The expression argument is parsed and evaluated as a Python expression (tech
nically speaking, a condition list) using the globals and locals dictionaries as
global and local namespace. If the globals dictionary is present and lacks __bui
ltins__, the current globals are copied into globals before expression is parsed.
This means that expression normally has full access to the standard __builtin__
module and restricted environments are propagated. If the locals dictionary is
omitted it defaults to the globals dictionary. If both dictionaries are omitted,
the expression is executed in the environment where eval() is called. The retur
n value is the result of the evaluated expression. Syntax errors are reported as
exceptions. Example:
>>> x = 1
>>> print eval( x+1 )
2
This function can also be used to execute arbitrary code objects (such as th
ose created by compile()). In this case pass a code object instead of a string.
If the code object has been compiled with exec as the mode argument, eval()s re
globals()
Return a dictionary representing the current global symbol table. This is al
ways the dictionary of the current module (inside a function or method, this is
the module where it is defined, not the module from which it is called).
hasattr(object, name)
The arguments are an object and a string. The result is True if the string i
s the name of one of the objects attributes, False if not. (This is implemented b
y calling getattr(object, name) and seeing whether it raises an exception or not
.)
hash(object)
Return the hash
s. They are used to
Numeric values that
different types, as
value of the object (if it has one). Hash values are integer
quickly compare dictionary keys during a dictionary lookup.
compare equal have the same hash value (even if they are of
is the case for 1 and 1.0).
help([object])
Invoke the built-in help system. (This function is intended for interactive
use.) If no argument is given, the interactive help system starts on the interpr
eter console. If the argument is a string, then the string is looked up as the n
ame of a module, function, class, method, keyword, or documentation topic, and a
help page is printed on the console. If the argument is any other kind of objec
t, a help page on the object is generated.
This function is added to the built-in namespace by the site module.
New in version 2.2.
hex(x)
Convert an integer number (of any size) to a lowercase hexadecimal string pr
efixed with 0x, for example:
>>> hex(255)
0xff
>>> hex(-42)
-0x2a
>>> hex(1L)
0x1L
If x is not a Python int or long object, it has to define an __index__() met
hod that returns an integer.
See also int() for converting a hexadecimal string to an integer using a bas
e of 16.
Note
To obtain a hexadecimal string representation for a float, use the float.hex
() method.
Changed in version 2.4: Formerly only returned an unsigned literal.
id(object)
Return the identity of an object. This is an integer (or long integer) which i
s guaranteed to be unique and constant for this object during its lifetime. Two
objects with non-overlapping lifetimes may have the same id() value.
CPython implementation detail: This is the address of the object in memory.
input([prompt])
Equivalent to eval(raw_input(prompt)).
This function does not catch user errors. If the input is not syntactically
valid, a SyntaxError will be raised. Other exceptions may be raised if there is
an error during evaluation.
If the readline module was loaded, then input() will use it to provide elabo
rate line editing and history features.
Consider using the raw_input() function for general input from users.
class int(x=0)
class int(x, base=10)
Return an integer object constructed from a number or string x, or return 0
if no arguments are given. If x is a number, it can be a plain integer, a long i
nteger, or a floating point number. If x is floating point, the conversion trunc
ates towards zero. If the argument is outside the integer range, the function re
turns a long object instead.
If x is not a number or if base is given, then x must be a string or Unicode
object representing an integer literal in radix base. Optionally, the literal c
an be preceded by + or - (with no space in between) and surrounded by whitespace
. A base-n literal consists of the digits 0 to n-1, with a to z (or A to Z) havi
ng values 10 to 35. The default base is 10. The allowed values are 0 and 2-36. B
ase-2, -8, and -16 literals can be optionally prefixed with 0b/0B, 0o/0O/0, or 0
x/0X, as with integer literals in code. Base 0 means to interpret the string exa
ctly as an integer literal, so that the actual base is 2, 8, 10, or 16.
The integer type is described in Numeric Types int, float, long, complex.
isinstance(object, classinfo)
Return true if the object argument is an instance of the classinfo argument,
or of a (direct, indirect or virtual) subclass thereof. Also return true if cla
ssinfo is a type object (new-style class) and object is an object of that type o
r of a (direct, indirect or virtual) subclass thereof. If object is not a class
instance or an object of the given type, the function always returns false. If c
lassinfo is neither a class object nor a type object, it may be a tuple of class
or type objects, or may recursively contain other such tuples (other sequence t
ypes are not accepted). If classinfo is not a class, type, or tuple of classes,
types, and such tuples, a TypeError exception is raised.
Changed in version 2.2: Support for a tuple of type information was added.
issubclass(class, classinfo)
Return true if class is a subclass (direct, indirect or virtual) of classinf
o. A class is considered a subclass of itself. classinfo may be a tuple of class
objects, in which case every entry in classinfo will be checked. In any other c
ase, a TypeError exception is raised.
Changed in version 2.3: Support for a tuple of type information was added.
iter(o[, sentinel])
Return an iterator object. The first argument is interpreted very differentl
y depending on the presence of the second argument. Without a second argument, o
must be a collection object which supports the iteration protocol (the __iter__
() method), or it must support the sequence protocol (the __getitem__() method w
ith integer arguments starting at 0). If it does not support either of those pro
tocols, TypeError is raised. If the second argument, sentinel, is given, then o
must be a callable object. The iterator created in this case will call o with no
arguments for each call to its next() method; if the value returned is equal to
sentinel, StopIteration will be raised, otherwise the value will be returned.
One useful application of the second form of iter() is to read lines of a fi
le until a certain line is reached. The following example reads a file until the
readline() method returns an empty string:
with open( mydata.txt ) as fp:
for line in iter(fp.readline,
process_line(line)
):
Retrieve the next item from the iterator by calling its next() method. If de
fault is given, it is returned if the iterator is exhausted, otherwise StopItera
tion is raised.
New in version 2.6.
class object
Return a new featureless object. object is a base for all new style classes.
It has the methods that are common to all instances of new style classes.
New in version 2.2.
Changed in version 2.3: This function does not accept any arguments. Formerl
y, it accepted arguments but ignored them.
oct(x)
Convert an integer number (of any size) to an octal string. The result is a
valid Python expression.
Changed in version 2.4: Formerly only returned an unsigned literal.
open(name[, mode[, buffering]])
Open a file, returning an object of the file type described in section File
Objects. If the file cannot be opened, IOError is raised. When opening a file, i
ts preferable to use open() instead of invoking the file constructor directly.
The first two arguments are the same as for stdios fopen(): name is the file
name to be opened, and mode is a string indicating how the file is to be opened.
The most commonly-used values of mode are r for reading, w for writing (
truncating the file if it already exists), and a for appending (which on some
Unix systems means that all writes append to the end of the file regardless of t
he current seek position). If mode is omitted, it defaults to r . The default i
s to use text mode, which may convert \n characters to a platform-specific rep
resentation on writing and back on reading. Thus, when opening a binary file, yo
u should append b to the mode value to open the file in binary mode, which wil
l improve portability. (Appending b is useful even on systems that dont treat b
inary and text files differently, where it serves as documentation.) See below f
or more possible values of mode.
The optional buffering argument specifies the files desired buffer size: 0 me
ans unbuffered, 1 means line buffered, any other positive value means use a buff
er of (approximately) that size (in bytes). A negative buffering means to use th
e system default, which is usually line buffered for tty devices and fully buffe
red for other files. If omitted, the system default is used. [2]
Modes r+
note that w+
nary mode, on
ms that dont
the same as normal text mode. Note that file objects so opened also have an att
ribute called newlines which has a value of None (if no newlines have yet been s
een), \n , \r , \r\n , or a tuple containing all the newline types seen.
Python enforces that the mode, after stripping U , begins with r , w
or
a .
Python provides many file handling modules including fileinput, os, os.path,
tempfile, and shutil.
Changed in version 2.5: Restriction on first letter of mode string introduce
d.
ord(c)
Given a string of length one, return an integer representing the Unicode cod
e point of the character when the argument is a unicode object, or the value of
the byte when the argument is an 8-bit string. For example, ord( a ) returns the
integer 97, ord(u \u2020 ) returns 8224. This is the inverse of chr() for 8-bit
strings and of unichr() for unicode objects. If a unicode argument is given and
Python was built with UCS2 Unicode, then the characters code point must be in th
e range [0..65535] inclusive; otherwise the string length is two, and a TypeErro
r will be raised.
pow(x, y[, z])
Return x to the power y; if z is present, return x to the power y, modulo z
(computed more efficiently than pow(x, y) % z). The two-argument form pow(x, y)
is equivalent to using the power operator: x**y.
The arguments must have numeric types. With mixed operand types, the coercio
n rules for binary arithmetic operators apply. For int and long int operands, th
e result has the same type as the operands (after coercion) unless the second ar
gument is negative; in that case, all arguments are converted to float and a flo
at result is delivered. For example, 10**2 returns 100, but 10**-2 returns 0.01.
(This last feature was added in Python 2.2. In Python 2.1 and before, if both a
rguments were of integer types and the second argument was negative, an exceptio
n was raised.) If the second argument is negative, the third argument must be om
itted. If z is present, x and y must be of integer types, and y must be non-nega
tive. (This restriction was added in Python 2.2. In Python 2.1 and before, float
ing 3-argument pow() returned platform-dependent results depending on floating-p
oint rounding accidents.)
print(*objects, sep=
, end= \n , file=sys.stdout)
Print objects to the stream file, separated by sep and followed by end. sep,
end and file, if present, must be given as keyword arguments.
All non-keyword arguments are converted to strings like str() does and writt
en to the stream, separated by sep and followed by end. Both sep and end must be
strings; they can also be None, which means to use the default values. If no ob
jects are given, print() will just write end.
The file argument must be an object with a write(string) method; if it is no
t present or None, sys.stdout will be used. Output buffering is determined by fi
le. Use file.flush() to ensure, for instance, immediate appearance on a screen.
Note
This function is not normally available as a built-in since the name print i
s recognized as the print statement. To disable the statement and use the print(
) function, use this future statement at the top of your module:
from __future__ import print_function
New in version 2.6.
class property([fget[, fset[, fdel[, doc]]]])
Return a property attribute for new-style classes (classes that derive from
object).
fget is a function for getting an attribute value. fset is a function for se
tting an attribute value. fdel is a function for deleting an attribute value. An
d doc creates a docstring for the attribute.
A typical use is to define a managed attribute x:
class C(object):
def __init__(self):
self._x = None
def getx(self):
return self._x
def setx(self, value):
self._x = value
def delx(self):
del self._x
x = property(getx, setx, delx, "I m the x property.")
If c is an instance of C, c.x will invoke the getter, c.x = value will invok
e the setter and del c.x the deleter.
If given, doc will be the docstring of the property attribute. Otherwise, th
e property will copy fgets docstring (if it exists). This makes it possible to cr
eate read-only properties easily using property() as a decorator:
class Parrot(object):
def __init__(self):
self._voltage = 100000
@property
def voltage(self):
"""Get the current voltage."""
return self._voltage
The @property decorator turns the voltage() method into a getter for a read-on
ly attribute with the same name, and it sets the docstring for voltage to Get the
current voltage.
A property object has getter, setter, and deleter methods usable as decorato
rs that create a copy of the property with the corresponding accessor function s
et to the decorated function. This is best explained with an example:
class C(object):
def __init__(self):
self._x = None
@property
def x(self):
"""I m the x property."""
return self._x
@x.setter
def x(self, value):
self._x = value
@x.deleter
def x(self):
del self._x
This code is exactly equivalent to the first example. Be sure to give the ad
ditional functions the same name as the original property (x in this case.)
The returned property object also has the attributes fget, fset, and fdel co
rresponding to the constructor arguments.
New in version 2.2.
Changed in version 2.5: Use fgets docstring if no doc given.
Changed in version 2.6: The getter, setter, and deleter attributes were adde
d.
range(stop)
range(start, stop[, step])
This is a versatile function to create lists containing arithmetic progressi
ons. It is most often used in for loops. The arguments must be plain integers. I
f the step argument is omitted, it defaults to 1. If the start argument is omitt
ed, it defaults to 0. The full form returns a list of plain integers [start, sta
rt + step, start + 2 * step, ...]. If step is positive, the last element is the
largest start + i * step less than stop; if step is negative, the last element i
s the smallest start + i * step greater than stop. step must not be zero (or els
e ValueError is raised). Example:
>>>
[0,
>>>
[1,
>>>
[0,
>>>
[0,
>>>
[0,
>>>
[]
>>>
[]
range(10)
1, 2, 3, 4, 5, 6, 7, 8, 9]
range(1, 11)
2, 3, 4, 5, 6, 7, 8, 9, 10]
range(0, 30, 5)
5, 10, 15, 20, 25]
range(0, 10, 3)
3, 6, 9]
range(0, -10, -1)
-1, -2, -3, -4, -5, -6, -7, -8, -9]
range(0)
range(1, 0)
raw_input([prompt])
If the prompt argument is present, it is written to standard output without
a trailing newline. The function then reads a line from input, converts it to a
string (stripping a trailing newline), and returns that. When EOF is read, EOFEr
ror is raised. Example:
Note
The behavior of round() for floats can be surprising: for example, round(2.6
75, 2) gives 2.67 instead of the expected 2.68. This is not a bug: its a result o
f the fact that most decimal fractions cant be represented exactly as a float. Se
e Floating Point Arithmetic: Issues and Limitations for more information.
class set([iterable])
Return a new set object, optionally with elements taken from iterable. set i
s a built-in class. See set and Set Types set, frozenset for documentation about
this class.
For other containers see the built-in frozenset, list, tuple, and dict class
es, as well as the collections module.
New in version 2.4.
setattr(object, name, value)
This is the counterpart of getattr(). The arguments are an object, a string
and an arbitrary value. The string may name an existing attribute or a new attri
bute. The function assigns the value to the attribute, provided the object allow
s it. For example, setattr(x, foobar , 123) is equivalent to x.foobar = 123.
class slice(stop)
class slice(start, stop[, step])
Return a slice object representing the set of indices specified by range(sta
rt, stop, step). The start and step arguments default to None. Slice objects hav
e read-only data attributes start, stop and step which merely return the argumen
t values (or their default). They have no other explicit functionality; however
they are used by Numerical Python and other third party extensions. Slice object
s are also generated when extended indexing syntax is used. For example: a[start
:stop:step] or a[start:stop, i]. See itertools.islice() for an alternate version
that returns an iterator.
sorted(iterable[, cmp[, key[, reverse]]])
Return a new sorted list from the items in iterable.
The optional arguments cmp, key, and reverse have the same meaning as those
for the list.sort() method (described in section Mutable Sequence Types).
cmp specifies a custom comparison function of two arguments (iterable elemen
ts) which should return a negative, zero or positive number depending on whether
the first argument is considered smaller than, equal to, or larger than the sec
ond argument: cmp=lambda x,y: cmp(x.lower(), y.lower()). The default value is No
ne.
key specifies a function of one argument that is used to extract a compariso
n key from each list element: key=str.lower. The default value is None (compare
the elements directly).
reverse is a boolean value. If set to True, then the list elements are sorte
d as if each comparison were reversed.
In general, the key and reverse conversion processes are much faster than sp
ecifying an equivalent cmp function. This is because cmp is called multiple time
s for each list element while key and reverse touch each element only once. Use
For some use cases, there are good alternatives to sum(). The preferred, fas
t way to concatenate a sequence of strings is by calling .join(sequence). To a
dd floating point values with extended precision, see math.fsum(). To concatenat
e a series of iterables, consider using itertools.chain().
New in version 2.3.
super(type[, object-or-type])
Return a proxy object that delegates method calls to a parent or sibling cla
ss of type. This is useful for accessing inherited methods that have been overri
dden in a class. The search order is same as that used by getattr() except that
the type itself is skipped.
The __mro__ attribute of the type lists the method resolution search order u
sed by both getattr() and super(). The attribute is dynamic and can change whene
ver the inheritance hierarchy is updated.
If the second argument is omitted, the super object returned is unbound. If
the second argument is an object, isinstance(obj, type) must be true. If the sec
ond argument is a type, issubclass(type2, type) must be true (this is useful for
classmethods).
Note
super() only works for new-style classes.
There are two typical use cases for super. In a class hierarchy with single
inheritance, super can be used to refer to parent classes without naming them ex
plicitly, thus making the code more maintainable. This use closely parallels the
use of super in other programming languages.
The second use case is to support cooperative multiple inheritance in a dyna
mic execution environment. This use case is unique to Python and is not found in
statically compiled languages or languages that only support single inheritance
. This makes it possible to implement diamond diagrams where multiple base classes
implement the same method. Good design dictates that this method have the same
calling signature in every case (because the order of calls is determined at run
time, because that order adapts to changes in the class hierarchy, and because t
hat order can include sibling classes that are unknown prior to runtime).
For both use cases, a typical superclass call looks like this:
class C(B):
def method(self, arg):
super(C, self).method(arg)
Note that super() is implemented as part of the binding process for explicit
dotted attribute lookups such as super().__getitem__(name). It does so by imple
menting its own __getattribute__() method for searching classes in a predictable
order that supports cooperative multiple inheritance. Accordingly, super() is u
ndefined for implicit lookups using statements or operators such as super()[name
].
Also note that super() is not limited to use inside methods. The two argumen
t form specifies the arguments exactly and makes the appropriate references.
For practical suggestions on how to design cooperative classes using super()
, see guide to using super().
to replace input characters which cannot be decoded. See also the codecs module.
If no optional parameters are given, unicode() will mimic the behaviour of s
tr() except that it returns Unicode strings instead of 8-bit strings. More preci
sely, if object is a Unicode string or subclass it will return that Unicode stri
ng without any additional decoding applied.
For objects which provide a __unicode__() method, it will call this method w
ithout arguments to create a Unicode string. For all other objects, the 8-bit st
ring version or representation is requested and then converted to a Unicode stri
ng using the codec for the default encoding in strict mode.
For more information on Unicode strings see Sequence Types str, unicode, lis
t, tuple, bytearray, buffer, xrange which describes sequence functionality (Unic
ode strings are sequences), and also the string-specific methods described in th
e String Methods section. To output formatted strings use template strings or th
e % operator described in the String Formatting Operations section. In addition
see the String Services section. See also str().
New in version 2.0.
Changed in version 2.2: Support for __unicode__() added.
vars([object])
Return the __dict__ attribute for a module, class, instance, or any other ob
ject with a __dict__ attribute.
Objects such as modules and instances have an updateable __dict__ attribute;
however, other objects may have write restrictions on their __dict__ attributes
(for example, new-style classes use a dictproxy to prevent direct dictionary up
dates).
Without an argument, vars() acts like locals(). Note, the locals dictionary
is only useful for reads since updates to the locals dictionary are ignored.
xrange(stop)
xrange(start, stop[, step])
This function is very similar to range(), but returns an xrange object inste
ad of a list. This is an opaque sequence type which yields the same values as th
e corresponding list, without actually storing them all simultaneously. The adva
ntage of xrange() over range() is minimal (since xrange() still has to create th
e values when asked for them) except when a very large range is used on a memory
-starved machine or when all of the ranges elements are never used (such as when
the loop is usually terminated with break). For more information on xrange objec
ts, see XRange Type and Sequence Types str, unicode, list, tuple, bytearray, buf
fer, xrange.
CPython implementation detail: xrange() is intended to be simple and fast. I
mplementations may impose restrictions to achieve this. The C implementation of
Python restricts all arguments to native C longs (short Python integers), and also
requires that the number of elements fit in a native C long. If a larger range
is needed, an alternate version can be crafted using the itertools module: islic
e(count(start, step), (stop-start+step-1+2*(step<0))//step).
zip([iterable, ...])
This function returns a list of tuples, where the i-th tuple contains the ith element from each of the argument sequences or iterables. The returned list i
s truncated in length to the length of the shortest argument sequence. When ther
e are multiple arguments which are all of the same length, zip() is similar to m
ap() with an initial argument of None. With a single sequence argument, it retur
ns a list of 1-tuples. With no arguments, it returns an empty list.
The left-to-right evaluation order of the iterables is guaranteed. This make
s possible an idiom for clustering a data series into n-length groups using zip(
*[iter(s)]*n).
zip() in conjunction with the * operator can be used to unzip a list:
>>> x = [1, 2, 3]
>>> y = [4, 5, 6]
>>> zipped = zip(x, y)
>>> zipped
[(1, 4), (2, 5), (3, 6)]
>>> x2, y2 = zip(*zipped)
>>> x == list(x2) and y == list(y2)
True
New in version 2.0.
Changed in version 2.4: Formerly, zip() required at least one argument and z
ip() raised a TypeError instead of returning an empty list.
__import__(name[, globals[, locals[, fromlist[, level]]]])
Note
This is an advanced function that is not needed in everyday Python programmi
ng, unlike importlib.import_module().
This function is invoked by the import statement. It can be replaced (by imp
orting the __builtin__ module and assigning to __builtin__.__import__) in order
to change semantics of the import statement, but nowadays it is usually simpler
to use import hooks (see PEP 302). Direct use of __import__() is rare, except in
cases where you want to import a module whose name is only known at runtime.
The function imports the module name, potentially using the given globals an
d locals to determine how to interpret the name in a package context. The fromli
st gives the names of objects or submodules that should be imported from the mod
ule given by name. The standard implementation does not use its locals argument
at all, and uses its globals only to determine the package context of the import
statement.
level specifies whether to use absolute or relative imports. The default is
-1 which indicates both absolute and relative imports will be attempted. 0 means
only perform absolute imports. Positive values for level indicate the number of
parent directories to search relative to the directory of the module calling __
import__().
When the name variable is of the form package.module, normally, the top-leve
l package (the name up till the first dot) is returned, not the module named by
name. However, when a non-empty fromlist argument is given, the module named by
name is returned.
For example, the statement import spam results in bytecode resembling the fo
llowing code:
spam = __import__( spam , globals(), locals(), [], -1)