blob: 2a5c7f5144bf342efbaf72a85c6ad00b684a1405 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001
Georg Brandl1a3284e2007-12-02 09:40:06 +00002:mod:`builtins` --- Built-in objects
3====================================
Georg Brandl116aa622007-08-15 14:28:22 +00004
Georg Brandl1a3284e2007-12-02 09:40:06 +00005.. module:: builtins
Georg Brandl116aa622007-08-15 14:28:22 +00006 :synopsis: The module that provides the built-in namespace.
7
8
9This module provides direct access to all 'built-in' identifiers of Python; for
Georg Brandl1a3284e2007-12-02 09:40:06 +000010example, ``builtins.open`` is the full name for the built-in function
Georg Brandl116aa622007-08-15 14:28:22 +000011:func:`open`. See chapter :ref:`builtin`.
12
13This module is not normally accessed explicitly by most applications, but can be
14useful in modules that provide objects with the same name as a built-in value,
15but in which the built-in of that name is also needed. For example, in a module
16that wants to implement an :func:`open` function that wraps the built-in
17:func:`open`, this module can be used directly::
18
Georg Brandl1a3284e2007-12-02 09:40:06 +000019 import builtins
Georg Brandl116aa622007-08-15 14:28:22 +000020
21 def open(path):
Georg Brandl1a3284e2007-12-02 09:40:06 +000022 f = builtins.open(path, 'r')
Georg Brandl116aa622007-08-15 14:28:22 +000023 return UpperCaser(f)
24
25 class UpperCaser:
26 '''Wrapper around a file that converts output to upper-case.'''
27
28 def __init__(self, f):
29 self._f = f
30
31 def read(self, count=-1):
32 return self._f.read(count).upper()
33
34 # ...
35
36As an implementation detail, most modules have the name ``__builtins__`` (note
37the ``'s'``) made available as part of their globals. The value of
38``__builtins__`` is normally either this module or the value of this modules's
39:attr:`__dict__` attribute. Since this is an implementation detail, it may not
40be used by alternate implementations of Python.
41