/Doc/reference/datamodel.rst

http://unladen-swallow.googlecode.com/ · ReStructuredText · 2439 lines · 1896 code · 543 blank · 0 comment · 0 complexity · 1a4a26c427249dcc208fc5f9df27b2b2 MD5 · raw file

Large files are truncated click here to view the full file

  1. .. _datamodel:
  2. **********
  3. Data model
  4. **********
  5. .. _objects:
  6. Objects, values and types
  7. =========================
  8. .. index::
  9. single: object
  10. single: data
  11. :dfn:`Objects` are Python's abstraction for data. All data in a Python program
  12. is represented by objects or by relations between objects. (In a sense, and in
  13. conformance to Von Neumann's model of a "stored program computer," code is also
  14. represented by objects.)
  15. .. index::
  16. builtin: id
  17. builtin: type
  18. single: identity of an object
  19. single: value of an object
  20. single: type of an object
  21. single: mutable object
  22. single: immutable object
  23. Every object has an identity, a type and a value. An object's *identity* never
  24. changes once it has been created; you may think of it as the object's address in
  25. memory. The ':keyword:`is`' operator compares the identity of two objects; the
  26. :func:`id` function returns an integer representing its identity (currently
  27. implemented as its address). An object's :dfn:`type` is also unchangeable. [#]_
  28. An object's type determines the operations that the object supports (e.g., "does
  29. it have a length?") and also defines the possible values for objects of that
  30. type. The :func:`type` function returns an object's type (which is an object
  31. itself). The *value* of some objects can change. Objects whose value can
  32. change are said to be *mutable*; objects whose value is unchangeable once they
  33. are created are called *immutable*. (The value of an immutable container object
  34. that contains a reference to a mutable object can change when the latter's value
  35. is changed; however the container is still considered immutable, because the
  36. collection of objects it contains cannot be changed. So, immutability is not
  37. strictly the same as having an unchangeable value, it is more subtle.) An
  38. object's mutability is determined by its type; for instance, numbers, strings
  39. and tuples are immutable, while dictionaries and lists are mutable.
  40. .. index::
  41. single: garbage collection
  42. single: reference counting
  43. single: unreachable object
  44. Objects are never explicitly destroyed; however, when they become unreachable
  45. they may be garbage-collected. An implementation is allowed to postpone garbage
  46. collection or omit it altogether --- it is a matter of implementation quality
  47. how garbage collection is implemented, as long as no objects are collected that
  48. are still reachable. (Implementation note: CPython currently uses a
  49. reference-counting scheme with (optional) delayed detection of cyclically linked
  50. garbage, which collects most objects as soon as they become unreachable, but is
  51. not guaranteed to collect garbage containing circular references. See the
  52. documentation of the :mod:`gc` module for information on controlling the
  53. collection of cyclic garbage. Other implementations act differently and CPython
  54. may change.)
  55. Note that the use of the implementation's tracing or debugging facilities may
  56. keep objects alive that would normally be collectable. Also note that catching
  57. an exception with a ':keyword:`try`...\ :keyword:`except`' statement may keep
  58. objects alive.
  59. Some objects contain references to "external" resources such as open files or
  60. windows. It is understood that these resources are freed when the object is
  61. garbage-collected, but since garbage collection is not guaranteed to happen,
  62. such objects also provide an explicit way to release the external resource,
  63. usually a :meth:`close` method. Programs are strongly recommended to explicitly
  64. close such objects. The ':keyword:`try`...\ :keyword:`finally`' statement
  65. provides a convenient way to do this.
  66. .. index:: single: container
  67. Some objects contain references to other objects; these are called *containers*.
  68. Examples of containers are tuples, lists and dictionaries. The references are
  69. part of a container's value. In most cases, when we talk about the value of a
  70. container, we imply the values, not the identities of the contained objects;
  71. however, when we talk about the mutability of a container, only the identities
  72. of the immediately contained objects are implied. So, if an immutable container
  73. (like a tuple) contains a reference to a mutable object, its value changes if
  74. that mutable object is changed.
  75. Types affect almost all aspects of object behavior. Even the importance of
  76. object identity is affected in some sense: for immutable types, operations that
  77. compute new values may actually return a reference to any existing object with
  78. the same type and value, while for mutable objects this is not allowed. E.g.,
  79. after ``a = 1; b = 1``, ``a`` and ``b`` may or may not refer to the same object
  80. with the value one, depending on the implementation, but after ``c = []; d =
  81. []``, ``c`` and ``d`` are guaranteed to refer to two different, unique, newly
  82. created empty lists. (Note that ``c = d = []`` assigns the same object to both
  83. ``c`` and ``d``.)
  84. .. _types:
  85. The standard type hierarchy
  86. ===========================
  87. .. index::
  88. single: type
  89. pair: data; type
  90. pair: type; hierarchy
  91. pair: extension; module
  92. pair: C; language
  93. Below is a list of the types that are built into Python. Extension modules
  94. (written in C, Java, or other languages, depending on the implementation) can
  95. define additional types. Future versions of Python may add types to the type
  96. hierarchy (e.g., rational numbers, efficiently stored arrays of integers, etc.).
  97. .. index::
  98. single: attribute
  99. pair: special; attribute
  100. triple: generic; special; attribute
  101. Some of the type descriptions below contain a paragraph listing 'special
  102. attributes.' These are attributes that provide access to the implementation and
  103. are not intended for general use. Their definition may change in the future.
  104. None
  105. .. index:: object: None
  106. This type has a single value. There is a single object with this value. This
  107. object is accessed through the built-in name ``None``. It is used to signify the
  108. absence of a value in many situations, e.g., it is returned from functions that
  109. don't explicitly return anything. Its truth value is false.
  110. NotImplemented
  111. .. index:: object: NotImplemented
  112. This type has a single value. There is a single object with this value. This
  113. object is accessed through the built-in name ``NotImplemented``. Numeric methods
  114. and rich comparison methods may return this value if they do not implement the
  115. operation for the operands provided. (The interpreter will then try the
  116. reflected operation, or some other fallback, depending on the operator.) Its
  117. truth value is true.
  118. Ellipsis
  119. .. index:: object: Ellipsis
  120. This type has a single value. There is a single object with this value. This
  121. object is accessed through the built-in name ``Ellipsis``. It is used to
  122. indicate the presence of the ``...`` syntax in a slice. Its truth value is
  123. true.
  124. :class:`numbers.Number`
  125. .. index:: object: numeric
  126. These are created by numeric literals and returned as results by arithmetic
  127. operators and arithmetic built-in functions. Numeric objects are immutable;
  128. once created their value never changes. Python numbers are of course strongly
  129. related to mathematical numbers, but subject to the limitations of numerical
  130. representation in computers.
  131. Python distinguishes between integers, floating point numbers, and complex
  132. numbers:
  133. :class:`numbers.Integral`
  134. .. index:: object: integer
  135. These represent elements from the mathematical set of integers (positive and
  136. negative).
  137. There are three types of integers:
  138. Plain integers
  139. .. index::
  140. object: plain integer
  141. single: OverflowError (built-in exception)
  142. These represent numbers in the range -2147483648 through 2147483647.
  143. (The range may be larger on machines with a larger natural word size,
  144. but not smaller.) When the result of an operation would fall outside
  145. this range, the result is normally returned as a long integer (in some
  146. cases, the exception :exc:`OverflowError` is raised instead). For the
  147. purpose of shift and mask operations, integers are assumed to have a
  148. binary, 2's complement notation using 32 or more bits, and hiding no
  149. bits from the user (i.e., all 4294967296 different bit patterns
  150. correspond to different values).
  151. Long integers
  152. .. index:: object: long integer
  153. These represent numbers in an unlimited range, subject to available
  154. (virtual) memory only. For the purpose of shift and mask operations, a
  155. binary representation is assumed, and negative numbers are represented
  156. in a variant of 2's complement which gives the illusion of an infinite
  157. string of sign bits extending to the left.
  158. Booleans
  159. .. index::
  160. object: Boolean
  161. single: False
  162. single: True
  163. These represent the truth values False and True. The two objects
  164. representing the values False and True are the only Boolean objects.
  165. The Boolean type is a subtype of plain integers, and Boolean values
  166. behave like the values 0 and 1, respectively, in almost all contexts,
  167. the exception being that when converted to a string, the strings
  168. ``"False"`` or ``"True"`` are returned, respectively.
  169. .. index:: pair: integer; representation
  170. The rules for integer representation are intended to give the most
  171. meaningful interpretation of shift and mask operations involving negative
  172. integers and the least surprises when switching between the plain and long
  173. integer domains. Any operation, if it yields a result in the plain
  174. integer domain, will yield the same result in the long integer domain or
  175. when using mixed operands. The switch between domains is transparent to
  176. the programmer.
  177. :class:`numbers.Real` (:class:`float`)
  178. .. index::
  179. object: floating point
  180. pair: floating point; number
  181. pair: C; language
  182. pair: Java; language
  183. These represent machine-level double precision floating point numbers. You are
  184. at the mercy of the underlying machine architecture (and C or Java
  185. implementation) for the accepted range and handling of overflow. Python does not
  186. support single-precision floating point numbers; the savings in processor and
  187. memory usage that are usually the reason for using these is dwarfed by the
  188. overhead of using objects in Python, so there is no reason to complicate the
  189. language with two kinds of floating point numbers.
  190. :class:`numbers.Complex`
  191. .. index::
  192. object: complex
  193. pair: complex; number
  194. These represent complex numbers as a pair of machine-level double precision
  195. floating point numbers. The same caveats apply as for floating point numbers.
  196. The real and imaginary parts of a complex number ``z`` can be retrieved through
  197. the read-only attributes ``z.real`` and ``z.imag``.
  198. Sequences
  199. .. index::
  200. builtin: len
  201. object: sequence
  202. single: index operation
  203. single: item selection
  204. single: subscription
  205. These represent finite ordered sets indexed by non-negative numbers. The
  206. built-in function :func:`len` returns the number of items of a sequence. When
  207. the length of a sequence is *n*, the index set contains the numbers 0, 1,
  208. ..., *n*-1. Item *i* of sequence *a* is selected by ``a[i]``.
  209. .. index:: single: slicing
  210. Sequences also support slicing: ``a[i:j]`` selects all items with index *k* such
  211. that *i* ``<=`` *k* ``<`` *j*. When used as an expression, a slice is a
  212. sequence of the same type. This implies that the index set is renumbered so
  213. that it starts at 0.
  214. .. index:: single: extended slicing
  215. Some sequences also support "extended slicing" with a third "step" parameter:
  216. ``a[i:j:k]`` selects all items of *a* with index *x* where ``x = i + n*k``, *n*
  217. ``>=`` ``0`` and *i* ``<=`` *x* ``<`` *j*.
  218. Sequences are distinguished according to their mutability:
  219. Immutable sequences
  220. .. index::
  221. object: immutable sequence
  222. object: immutable
  223. An object of an immutable sequence type cannot change once it is created. (If
  224. the object contains references to other objects, these other objects may be
  225. mutable and may be changed; however, the collection of objects directly
  226. referenced by an immutable object cannot change.)
  227. The following types are immutable sequences:
  228. Strings
  229. .. index::
  230. builtin: chr
  231. builtin: ord
  232. object: string
  233. single: character
  234. single: byte
  235. single: ASCII@ASCII
  236. The items of a string are characters. There is no separate character type; a
  237. character is represented by a string of one item. Characters represent (at
  238. least) 8-bit bytes. The built-in functions :func:`chr` and :func:`ord` convert
  239. between characters and nonnegative integers representing the byte values. Bytes
  240. with the values 0-127 usually represent the corresponding ASCII values, but the
  241. interpretation of values is up to the program. The string data type is also
  242. used to represent arrays of bytes, e.g., to hold data read from a file.
  243. .. index::
  244. single: ASCII@ASCII
  245. single: EBCDIC
  246. single: character set
  247. pair: string; comparison
  248. builtin: chr
  249. builtin: ord
  250. (On systems whose native character set is not ASCII, strings may use EBCDIC in
  251. their internal representation, provided the functions :func:`chr` and
  252. :func:`ord` implement a mapping between ASCII and EBCDIC, and string comparison
  253. preserves the ASCII order. Or perhaps someone can propose a better rule?)
  254. Unicode
  255. .. index::
  256. builtin: unichr
  257. builtin: ord
  258. builtin: unicode
  259. object: unicode
  260. single: character
  261. single: integer
  262. single: Unicode
  263. The items of a Unicode object are Unicode code units. A Unicode code unit is
  264. represented by a Unicode object of one item and can hold either a 16-bit or
  265. 32-bit value representing a Unicode ordinal (the maximum value for the ordinal
  266. is given in ``sys.maxunicode``, and depends on how Python is configured at
  267. compile time). Surrogate pairs may be present in the Unicode object, and will
  268. be reported as two separate items. The built-in functions :func:`unichr` and
  269. :func:`ord` convert between code units and nonnegative integers representing the
  270. Unicode ordinals as defined in the Unicode Standard 3.0. Conversion from and to
  271. other encodings are possible through the Unicode method :meth:`encode` and the
  272. built-in function :func:`unicode`.
  273. Tuples
  274. .. index::
  275. object: tuple
  276. pair: singleton; tuple
  277. pair: empty; tuple
  278. The items of a tuple are arbitrary Python objects. Tuples of two or more items
  279. are formed by comma-separated lists of expressions. A tuple of one item (a
  280. 'singleton') can be formed by affixing a comma to an expression (an expression
  281. by itself does not create a tuple, since parentheses must be usable for grouping
  282. of expressions). An empty tuple can be formed by an empty pair of parentheses.
  283. Mutable sequences
  284. .. index::
  285. object: mutable sequence
  286. object: mutable
  287. pair: assignment; statement
  288. single: delete
  289. statement: del
  290. single: subscription
  291. single: slicing
  292. Mutable sequences can be changed after they are created. The subscription and
  293. slicing notations can be used as the target of assignment and :keyword:`del`
  294. (delete) statements.
  295. There is currently a single intrinsic mutable sequence type:
  296. Lists
  297. .. index:: object: list
  298. The items of a list are arbitrary Python objects. Lists are formed by placing a
  299. comma-separated list of expressions in square brackets. (Note that there are no
  300. special cases needed to form lists of length 0 or 1.)
  301. .. index:: module: array
  302. The extension module :mod:`array` provides an additional example of a mutable
  303. sequence type.
  304. Set types
  305. .. index::
  306. builtin: len
  307. object: set type
  308. These represent unordered, finite sets of unique, immutable objects. As such,
  309. they cannot be indexed by any subscript. However, they can be iterated over, and
  310. the built-in function :func:`len` returns the number of items in a set. Common
  311. uses for sets are fast membership testing, removing duplicates from a sequence,
  312. and computing mathematical operations such as intersection, union, difference,
  313. and symmetric difference.
  314. For set elements, the same immutability rules apply as for dictionary keys. Note
  315. that numeric types obey the normal rules for numeric comparison: if two numbers
  316. compare equal (e.g., ``1`` and ``1.0``), only one of them can be contained in a
  317. set.
  318. There are currently two intrinsic set types:
  319. Sets
  320. .. index:: object: set
  321. These represent a mutable set. They are created by the built-in :func:`set`
  322. constructor and can be modified afterwards by several methods, such as
  323. :meth:`add`.
  324. Frozen sets
  325. .. index:: object: frozenset
  326. These represent an immutable set. They are created by the built-in
  327. :func:`frozenset` constructor. As a frozenset is immutable and
  328. :term:`hashable`, it can be used again as an element of another set, or as
  329. a dictionary key.
  330. Mappings
  331. .. index::
  332. builtin: len
  333. single: subscription
  334. object: mapping
  335. These represent finite sets of objects indexed by arbitrary index sets. The
  336. subscript notation ``a[k]`` selects the item indexed by ``k`` from the mapping
  337. ``a``; this can be used in expressions and as the target of assignments or
  338. :keyword:`del` statements. The built-in function :func:`len` returns the number
  339. of items in a mapping.
  340. There is currently a single intrinsic mapping type:
  341. Dictionaries
  342. .. index:: object: dictionary
  343. These represent finite sets of objects indexed by nearly arbitrary values. The
  344. only types of values not acceptable as keys are values containing lists or
  345. dictionaries or other mutable types that are compared by value rather than by
  346. object identity, the reason being that the efficient implementation of
  347. dictionaries requires a key's hash value to remain constant. Numeric types used
  348. for keys obey the normal rules for numeric comparison: if two numbers compare
  349. equal (e.g., ``1`` and ``1.0``) then they can be used interchangeably to index
  350. the same dictionary entry.
  351. Dictionaries are mutable; they can be created by the ``{...}`` notation (see
  352. section :ref:`dict`).
  353. .. index::
  354. module: dbm
  355. module: gdbm
  356. module: bsddb
  357. The extension modules :mod:`dbm`, :mod:`gdbm`, and :mod:`bsddb` provide
  358. additional examples of mapping types.
  359. Callable types
  360. .. index::
  361. object: callable
  362. pair: function; call
  363. single: invocation
  364. pair: function; argument
  365. These are the types to which the function call operation (see section
  366. :ref:`calls`) can be applied:
  367. User-defined functions
  368. .. index::
  369. pair: user-defined; function
  370. object: function
  371. object: user-defined function
  372. A user-defined function object is created by a function definition (see
  373. section :ref:`function`). It should be called with an argument list
  374. containing the same number of items as the function's formal parameter
  375. list.
  376. Special attributes:
  377. +-----------------------+-------------------------------+-----------+
  378. | Attribute | Meaning | |
  379. +=======================+===============================+===========+
  380. | :attr:`func_doc` | The function's documentation | Writable |
  381. | | string, or ``None`` if | |
  382. | | unavailable | |
  383. +-----------------------+-------------------------------+-----------+
  384. | :attr:`__doc__` | Another way of spelling | Writable |
  385. | | :attr:`func_doc` | |
  386. +-----------------------+-------------------------------+-----------+
  387. | :attr:`func_name` | The function's name | Writable |
  388. +-----------------------+-------------------------------+-----------+
  389. | :attr:`__name__` | Another way of spelling | Writable |
  390. | | :attr:`func_name` | |
  391. +-----------------------+-------------------------------+-----------+
  392. | :attr:`__module__` | The name of the module the | Writable |
  393. | | function was defined in, or | |
  394. | | ``None`` if unavailable. | |
  395. +-----------------------+-------------------------------+-----------+
  396. | :attr:`func_defaults` | A tuple containing default | Writable |
  397. | | argument values for those | |
  398. | | arguments that have defaults, | |
  399. | | or ``None`` if no arguments | |
  400. | | have a default value | |
  401. +-----------------------+-------------------------------+-----------+
  402. | :attr:`func_code` | The code object representing | Writable |
  403. | | the compiled function body. | |
  404. +-----------------------+-------------------------------+-----------+
  405. | :attr:`func_globals` | A reference to the dictionary | Read-only |
  406. | | that holds the function's | |
  407. | | global variables --- the | |
  408. | | global namespace of the | |
  409. | | module in which the function | |
  410. | | was defined. | |
  411. +-----------------------+-------------------------------+-----------+
  412. | :attr:`func_dict` | The namespace supporting | Writable |
  413. | | arbitrary function | |
  414. | | attributes. | |
  415. +-----------------------+-------------------------------+-----------+
  416. | :attr:`func_closure` | ``None`` or a tuple of cells | Read-only |
  417. | | that contain bindings for the | |
  418. | | function's free variables. | |
  419. +-----------------------+-------------------------------+-----------+
  420. Most of the attributes labelled "Writable" check the type of the assigned value.
  421. .. versionchanged:: 2.4
  422. ``func_name`` is now writable.
  423. Function objects also support getting and setting arbitrary attributes, which
  424. can be used, for example, to attach metadata to functions. Regular attribute
  425. dot-notation is used to get and set such attributes. *Note that the current
  426. implementation only supports function attributes on user-defined functions.
  427. Function attributes on built-in functions may be supported in the future.*
  428. Additional information about a function's definition can be retrieved from its
  429. code object; see the description of internal types below.
  430. .. index::
  431. single: func_doc (function attribute)
  432. single: __doc__ (function attribute)
  433. single: __name__ (function attribute)
  434. single: __module__ (function attribute)
  435. single: __dict__ (function attribute)
  436. single: func_defaults (function attribute)
  437. single: func_closure (function attribute)
  438. single: func_code (function attribute)
  439. single: func_globals (function attribute)
  440. single: func_dict (function attribute)
  441. pair: global; namespace
  442. User-defined methods
  443. .. index::
  444. object: method
  445. object: user-defined method
  446. pair: user-defined; method
  447. A user-defined method object combines a class, a class instance (or ``None``)
  448. and any callable object (normally a user-defined function).
  449. Special read-only attributes: :attr:`im_self` is the class instance object,
  450. :attr:`im_func` is the function object; :attr:`im_class` is the class of
  451. :attr:`im_self` for bound methods or the class that asked for the method for
  452. unbound methods; :attr:`__doc__` is the method's documentation (same as
  453. ``im_func.__doc__``); :attr:`__name__` is the method name (same as
  454. ``im_func.__name__``); :attr:`__module__` is the name of the module the method
  455. was defined in, or ``None`` if unavailable.
  456. .. versionchanged:: 2.2
  457. :attr:`im_self` used to refer to the class that defined the method.
  458. .. versionchanged:: 2.6
  459. For 3.0 forward-compatibility, :attr:`im_func` is also available as
  460. :attr:`__func__`, and :attr:`im_self` as :attr:`__self__`.
  461. .. index::
  462. single: __doc__ (method attribute)
  463. single: __name__ (method attribute)
  464. single: __module__ (method attribute)
  465. single: im_func (method attribute)
  466. single: im_self (method attribute)
  467. Methods also support accessing (but not setting) the arbitrary function
  468. attributes on the underlying function object.
  469. User-defined method objects may be created when getting an attribute of a class
  470. (perhaps via an instance of that class), if that attribute is a user-defined
  471. function object, an unbound user-defined method object, or a class method
  472. object. When the attribute is a user-defined method object, a new method object
  473. is only created if the class from which it is being retrieved is the same as, or
  474. a derived class of, the class stored in the original method object; otherwise,
  475. the original method object is used as it is.
  476. .. index::
  477. single: im_class (method attribute)
  478. single: im_func (method attribute)
  479. single: im_self (method attribute)
  480. When a user-defined method object is created by retrieving a user-defined
  481. function object from a class, its :attr:`im_self` attribute is ``None``
  482. and the method object is said to be unbound. When one is created by
  483. retrieving a user-defined function object from a class via one of its
  484. instances, its :attr:`im_self` attribute is the instance, and the method
  485. object is said to be bound. In either case, the new method's
  486. :attr:`im_class` attribute is the class from which the retrieval takes
  487. place, and its :attr:`im_func` attribute is the original function object.
  488. .. index:: single: im_func (method attribute)
  489. When a user-defined method object is created by retrieving another method object
  490. from a class or instance, the behaviour is the same as for a function object,
  491. except that the :attr:`im_func` attribute of the new instance is not the
  492. original method object but its :attr:`im_func` attribute.
  493. .. index::
  494. single: im_class (method attribute)
  495. single: im_func (method attribute)
  496. single: im_self (method attribute)
  497. When a user-defined method object is created by retrieving a class method object
  498. from a class or instance, its :attr:`im_self` attribute is the class itself (the
  499. same as the :attr:`im_class` attribute), and its :attr:`im_func` attribute is
  500. the function object underlying the class method.
  501. When an unbound user-defined method object is called, the underlying function
  502. (:attr:`im_func`) is called, with the restriction that the first argument must
  503. be an instance of the proper class (:attr:`im_class`) or of a derived class
  504. thereof.
  505. When a bound user-defined method object is called, the underlying function
  506. (:attr:`im_func`) is called, inserting the class instance (:attr:`im_self`) in
  507. front of the argument list. For instance, when :class:`C` is a class which
  508. contains a definition for a function :meth:`f`, and ``x`` is an instance of
  509. :class:`C`, calling ``x.f(1)`` is equivalent to calling ``C.f(x, 1)``.
  510. When a user-defined method object is derived from a class method object, the
  511. "class instance" stored in :attr:`im_self` will actually be the class itself, so
  512. that calling either ``x.f(1)`` or ``C.f(1)`` is equivalent to calling ``f(C,1)``
  513. where ``f`` is the underlying function.
  514. Note that the transformation from function object to (unbound or bound) method
  515. object happens each time the attribute is retrieved from the class or instance.
  516. In some cases, a fruitful optimization is to assign the attribute to a local
  517. variable and call that local variable. Also notice that this transformation only
  518. happens for user-defined functions; other callable objects (and all non-callable
  519. objects) are retrieved without transformation. It is also important to note
  520. that user-defined functions which are attributes of a class instance are not
  521. converted to bound methods; this *only* happens when the function is an
  522. attribute of the class.
  523. Generator functions
  524. .. index::
  525. single: generator; function
  526. single: generator; iterator
  527. A function or method which uses the :keyword:`yield` statement (see section
  528. :ref:`yield`) is called a :dfn:`generator
  529. function`. Such a function, when called, always returns an iterator object
  530. which can be used to execute the body of the function: calling the iterator's
  531. :meth:`next` method will cause the function to execute until it provides a value
  532. using the :keyword:`yield` statement. When the function executes a
  533. :keyword:`return` statement or falls off the end, a :exc:`StopIteration`
  534. exception is raised and the iterator will have reached the end of the set of
  535. values to be returned.
  536. Built-in functions
  537. .. index::
  538. object: built-in function
  539. object: function
  540. pair: C; language
  541. A built-in function object is a wrapper around a C function. Examples of
  542. built-in functions are :func:`len` and :func:`math.sin` (:mod:`math` is a
  543. standard built-in module). The number and type of the arguments are
  544. determined by the C function. Special read-only attributes:
  545. :attr:`__doc__` is the function's documentation string, or ``None`` if
  546. unavailable; :attr:`__name__` is the function's name; :attr:`__self__` is
  547. set to ``None`` (but see the next item); :attr:`__module__` is the name of
  548. the module the function was defined in or ``None`` if unavailable.
  549. Built-in methods
  550. .. index::
  551. object: built-in method
  552. object: method
  553. pair: built-in; method
  554. This is really a different disguise of a built-in function, this time containing
  555. an object passed to the C function as an implicit extra argument. An example of
  556. a built-in method is ``alist.append()``, assuming *alist* is a list object. In
  557. this case, the special read-only attribute :attr:`__self__` is set to the object
  558. denoted by *list*.
  559. Class Types
  560. Class types, or "new-style classes," are callable. These objects normally act
  561. as factories for new instances of themselves, but variations are possible for
  562. class types that override :meth:`__new__`. The arguments of the call are passed
  563. to :meth:`__new__` and, in the typical case, to :meth:`__init__` to initialize
  564. the new instance.
  565. Classic Classes
  566. .. index::
  567. single: __init__() (object method)
  568. object: class
  569. object: class instance
  570. object: instance
  571. pair: class object; call
  572. Class objects are described below. When a class object is called, a new class
  573. instance (also described below) is created and returned. This implies a call to
  574. the class's :meth:`__init__` method if it has one. Any arguments are passed on
  575. to the :meth:`__init__` method. If there is no :meth:`__init__` method, the
  576. class must be called without arguments.
  577. Class instances
  578. Class instances are described below. Class instances are callable only when the
  579. class has a :meth:`__call__` method; ``x(arguments)`` is a shorthand for
  580. ``x.__call__(arguments)``.
  581. Modules
  582. .. index::
  583. statement: import
  584. object: module
  585. Modules are imported by the :keyword:`import` statement (see section
  586. :ref:`import`). A module object has a
  587. namespace implemented by a dictionary object (this is the dictionary referenced
  588. by the func_globals attribute of functions defined in the module). Attribute
  589. references are translated to lookups in this dictionary, e.g., ``m.x`` is
  590. equivalent to ``m.__dict__["x"]``. A module object does not contain the code
  591. object used to initialize the module (since it isn't needed once the
  592. initialization is done).
  593. Attribute assignment updates the module's namespace dictionary, e.g., ``m.x =
  594. 1`` is equivalent to ``m.__dict__["x"] = 1``.
  595. .. index:: single: __dict__ (module attribute)
  596. Special read-only attribute: :attr:`__dict__` is the module's namespace as a
  597. dictionary object.
  598. .. index::
  599. single: __name__ (module attribute)
  600. single: __doc__ (module attribute)
  601. single: __file__ (module attribute)
  602. pair: module; namespace
  603. Predefined (writable) attributes: :attr:`__name__` is the module's name;
  604. :attr:`__doc__` is the module's documentation string, or ``None`` if
  605. unavailable; :attr:`__file__` is the pathname of the file from which the module
  606. was loaded, if it was loaded from a file. The :attr:`__file__` attribute is not
  607. present for C modules that are statically linked into the interpreter; for
  608. extension modules loaded dynamically from a shared library, it is the pathname
  609. of the shared library file.
  610. Classes
  611. Both class types (new-style classes) and class objects (old-style/classic
  612. classes) are typically created by class definitions (see section
  613. :ref:`class`). A class has a namespace implemented by a dictionary object.
  614. Class attribute references are translated to lookups in this dictionary, e.g.,
  615. ``C.x`` is translated to ``C.__dict__["x"]`` (although for new-style classes
  616. in particular there are a number of hooks which allow for other means of
  617. locating attributes). When the attribute name is not found there, the
  618. attribute search continues in the base classes. For old-style classes, the
  619. search is depth-first, left-to-right in the order of occurrence in the base
  620. class list. New-style classes use the more complex C3 method resolution
  621. order which behaves correctly even in the presence of 'diamond'
  622. inheritance structures where there are multiple inheritance paths
  623. leading back to a common ancestor. Additional details on the C3 MRO used by
  624. new-style classes can be found in the documentation accompanying the
  625. 2.3 release at http://www.python.org/download/releases/2.3/mro/.
  626. .. XXX: Could we add that MRO doc as an appendix to the language ref?
  627. .. index::
  628. object: class
  629. object: class instance
  630. object: instance
  631. pair: class object; call
  632. single: container
  633. object: dictionary
  634. pair: class; attribute
  635. When a class attribute reference (for class :class:`C`, say) would yield a
  636. user-defined function object or an unbound user-defined method object whose
  637. associated class is either :class:`C` or one of its base classes, it is
  638. transformed into an unbound user-defined method object whose :attr:`im_class`
  639. attribute is :class:`C`. When it would yield a class method object, it is
  640. transformed into a bound user-defined method object whose :attr:`im_class`
  641. and :attr:`im_self` attributes are both :class:`C`. When it would yield a
  642. static method object, it is transformed into the object wrapped by the static
  643. method object. See section :ref:`descriptors` for another way in which
  644. attributes retrieved from a class may differ from those actually contained in
  645. its :attr:`__dict__` (note that only new-style classes support descriptors).
  646. .. index:: triple: class; attribute; assignment
  647. Class attribute assignments update the class's dictionary, never the dictionary
  648. of a base class.
  649. .. index:: pair: class object; call
  650. A class object can be called (see above) to yield a class instance (see below).
  651. .. index::
  652. single: __name__ (class attribute)
  653. single: __module__ (class attribute)
  654. single: __dict__ (class attribute)
  655. single: __bases__ (class attribute)
  656. single: __doc__ (class attribute)
  657. Special attributes: :attr:`__name__` is the class name; :attr:`__module__` is
  658. the module name in which the class was defined; :attr:`__dict__` is the
  659. dictionary containing the class's namespace; :attr:`__bases__` is a tuple
  660. (possibly empty or a singleton) containing the base classes, in the order of
  661. their occurrence in the base class list; :attr:`__doc__` is the class's
  662. documentation string, or None if undefined.
  663. Class instances
  664. .. index::
  665. object: class instance
  666. object: instance
  667. pair: class; instance
  668. pair: class instance; attribute
  669. A class instance is created by calling a class object (see above). A class
  670. instance has a namespace implemented as a dictionary which is the first place in
  671. which attribute references are searched. When an attribute is not found there,
  672. and the instance's class has an attribute by that name, the search continues
  673. with the class attributes. If a class attribute is found that is a user-defined
  674. function object or an unbound user-defined method object whose associated class
  675. is the class (call it :class:`C`) of the instance for which the attribute
  676. reference was initiated or one of its bases, it is transformed into a bound
  677. user-defined method object whose :attr:`im_class` attribute is :class:`C` and
  678. whose :attr:`im_self` attribute is the instance. Static method and class method
  679. objects are also transformed, as if they had been retrieved from class
  680. :class:`C`; see above under "Classes". See section :ref:`descriptors` for
  681. another way in which attributes of a class retrieved via its instances may
  682. differ from the objects actually stored in the class's :attr:`__dict__`. If no
  683. class attribute is found, and the object's class has a :meth:`__getattr__`
  684. method, that is called to satisfy the lookup.
  685. .. index:: triple: class instance; attribute; assignment
  686. Attribute assignments and deletions update the instance's dictionary, never a
  687. class's dictionary. If the class has a :meth:`__setattr__` or
  688. :meth:`__delattr__` method, this is called instead of updating the instance
  689. dictionary directly.
  690. .. index::
  691. object: numeric
  692. object: sequence
  693. object: mapping
  694. Class instances can pretend to be numbers, sequences, or mappings if they have
  695. methods with certain special names. See section :ref:`specialnames`.
  696. .. index::
  697. single: __dict__ (instance attribute)
  698. single: __class__ (instance attribute)
  699. Special attributes: :attr:`__dict__` is the attribute dictionary;
  700. :attr:`__class__` is the instance's class.
  701. Files
  702. .. index::
  703. object: file
  704. builtin: open
  705. single: popen() (in module os)
  706. single: makefile() (socket method)
  707. single: sys.stdin
  708. single: sys.stdout
  709. single: sys.stderr
  710. single: stdio
  711. single: stdin (in module sys)
  712. single: stdout (in module sys)
  713. single: stderr (in module sys)
  714. A file object represents an open file. File objects are created by the
  715. :func:`open` built-in function, and also by :func:`os.popen`,
  716. :func:`os.fdopen`, and the :meth:`makefile` method of socket objects (and
  717. perhaps by other functions or methods provided by extension modules). The
  718. objects ``sys.stdin``, ``sys.stdout`` and ``sys.stderr`` are initialized to
  719. file objects corresponding to the interpreter's standard input, output and
  720. error streams. See :ref:`bltin-file-objects` for complete documentation of
  721. file objects.
  722. Internal types
  723. .. index::
  724. single: internal type
  725. single: types, internal
  726. A few types used internally by the interpreter are exposed to the user. Their
  727. definitions may change with future versions of the interpreter, but they are
  728. mentioned here for completeness.
  729. Code objects
  730. .. index::
  731. single: bytecode
  732. object: code
  733. Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`.
  734. The difference between a code object and a function object is that the function
  735. object contains an explicit reference to the function's globals (the module in
  736. which it was defined), while a code object contains no context; also the default
  737. argument values are stored in the function object, not in the code object
  738. (because they represent values calculated at run-time). Unlike function
  739. objects, code objects are nearly immutable and contain no references (directly or
  740. indirectly) to mutable objects.
  741. Special read-only attributes: :attr:`co_name` gives the function name;
  742. :attr:`co_argcount` is the number of positional arguments (including arguments
  743. with default values); :attr:`co_nlocals` is the number of local variables used
  744. by the function (including arguments); :attr:`co_varnames` is a tuple containing
  745. the names of the local variables (starting with the argument names);
  746. :attr:`co_cellvars` is a tuple containing the names of local variables that are
  747. referenced by nested functions; :attr:`co_freevars` is a tuple containing the
  748. names of free variables; :attr:`co_code` is a string representing the sequence
  749. of bytecode instructions; :attr:`co_consts` is a tuple containing the literals
  750. used by the bytecode; :attr:`co_names` is a tuple containing the names used by
  751. the bytecode; :attr:`co_filename` is the filename from which the code was
  752. compiled; :attr:`co_firstlineno` is the first line number of the function;
  753. :attr:`co_lnotab` is a string encoding the mapping from bytecode offsets to line
  754. numbers (for details see the source code of the interpreter);
  755. :attr:`co_stacksize` is the required stack size (including local variables);
  756. :attr:`co_flags` is an integer encoding a number of flags for the interpreter.
  757. :attr:`co_llvm` refers to an llvm::Function wrapper that can pretty-print the
  758. LLVM assembly that implements this code object.
  759. Writable attributes: :attr:`co_use_jit` is ``True`` if LLVM will be used to
  760. run this function, or ``False`` if the normal CPython interpreter will be used.
  761. :attr:`co_optimization` is an integer from -1 to 2 recording how optimized
  762. :attr:`co_llvm` is. -1 is totally unoptimized, and 0 is the default
  763. optimization that happens before a function is JITted. You cannot lower the
  764. optimization level of an already-optimized function.
  765. .. index::
  766. single: co_argcount (code object attribute)
  767. single: co_code (code object attribute)
  768. single: co_consts (code object attribute)
  769. single: co_filename (code object attribute)
  770. single: co_firstlineno (code object attribute)
  771. single: co_flags (code object attribute)
  772. single: co_lnotab (code object attribute)
  773. single: co_name (code object attribute)
  774. single: co_names (code object attribute)
  775. single: co_nlocals (code object attribute)
  776. single: co_stacksize (code object attribute)
  777. single: co_varnames (code object attribute)
  778. single: co_cellvars (code object attribute)
  779. single: co_freevars (code object attribute)
  780. single: co_use_jit (code object attribute)
  781. single: co_optimization (code object attribute)
  782. single: co_llvm (code object attribute)
  783. .. index:: object: generator
  784. The following flag bits are defined for :attr:`co_flags`: bit ``0x04`` is set if
  785. the function uses the ``*arguments`` syntax to accept an arbitrary number of
  786. positional arguments; bit ``0x08`` is set if the function uses the
  787. ``**keywords`` syntax to accept arbitrary keyword arguments; bit ``0x20`` is set
  788. if the function is a generator.
  789. Future feature declarations (``from __future__ import division``) also use bits
  790. in :attr:`co_flags` to indicate whether a code object was compiled with a
  791. particular feature enabled: bit ``0x2000`` is set if the function was compiled
  792. with future division enabled; bits ``0x10`` and ``0x1000`` were used in earlier
  793. versions of Python.
  794. Other bits in :attr:`co_flags` are reserved for internal use.
  795. .. index:: single: documentation string
  796. If a code object represents a function, the first item in :attr:`co_consts` is
  797. the documentation string of the function, or ``None`` if undefined.
  798. Frame objects
  799. .. index:: object: frame
  800. Frame objects represent execution frames. They may occur in traceback objects
  801. (see below).
  802. .. index::
  803. single: f_back (frame attribute)
  804. single: f_code (frame attribute)
  805. single: f_globals (frame attribute)
  806. single: f_locals (frame attribute)
  807. single: f_lasti (frame attribute)
  808. single: f_builtins (frame attribute)
  809. single: f_restricted (frame attribute)
  810. Special read-only attributes: :attr:`f_back` is to the previous stack frame
  811. (towards the caller), or ``None`` if this is the bottom stack frame;
  812. :attr:`f_code` is the code object being executed in this frame; :attr:`f_locals`
  813. is the dictionary used to look up local variables; :attr:`f_globals` is used for
  814. global variables; :attr:`f_builtins` is used for built-in (intrinsic) names;
  815. :attr:`f_restricted` is a flag indicating whether the function is executing in
  816. restricted execution mode; :attr:`f_lasti` gives the precise instruction (this
  817. is an index into the bytecode string of the code object).
  818. .. index::
  819. single: f_trace (frame attribute)
  820. single: f_exc_type (frame attribute)
  821. single: f_exc_value (frame attribute)
  822. single: f_exc_traceback (frame attribute)
  823. single: f_lineno (frame attribute)
  824. Special writable attributes: :attr:`f_trace`, if not ``None``, is a function
  825. called at the start of each source code line (this is used by the debugger);
  826. :attr:`f_exc_type`, :attr:`f_exc_value`, :attr:`f_exc_traceback` represent the
  827. last exception raised in the parent frame provided another exception was ever
  828. raised in the current frame (in all other cases they are None); :attr:`f_lineno`
  829. is the current line number of the frame --- writing to this from within a trace
  830. function jumps to the given line (only for the bottom-most frame). A debugger
  831. can implement a Jump command (aka Set Next Statement) by writing to f_lineno.
  832. Traceback objects
  833. .. index::
  834. object: traceback
  835. pair: stack; trace
  836. pair: exception; handler
  837. pair: execution; stack
  838. single: exc_info (in module sys)
  839. single: exc_traceback (in module sys)
  840. single: last_traceback (in module sys)
  841. single: sys.exc_info
  842. single: sys.exc_traceback
  843. single: sys.last_traceback
  844. Traceback objects represent a stack trace of an exception. A traceback object
  845. is created when an exception occurs. When the search for an exception handler
  846. unwinds the execution stack, at each unwound level a traceback object is
  847. inserted in front of the current traceback. When an exception handler is
  848. entered, the stack trace is made available to the program. (See section
  849. :ref:`try`.) It is accessible as ``sys.exc_traceback``,
  850. and also as the third item of the tuple returned by ``sys.exc_info()``. The
  851. latter is the preferred interface, since it works correctly when the program is
  852. using multiple threads. When the program contains no suitable handler, the stack
  853. trace is written (nicely formatted) to the standard error stream; if the
  854. interpreter is interactive, it is also made available to the user as
  855. ``sys.last_traceback``.
  856. .. index::
  857. single: tb_next (traceback attribute)
  858. single: tb_frame (traceback attribute)
  859. single: tb_lineno (traceback attribute)
  860. single: tb_lasti (traceback attribute)
  861. statement: try
  862. Special read-only attributes: :attr:`tb_next` is the next level in the stack
  863. trace (towards the frame where the exception occurred), or ``None`` if there is
  864. no next level; :attr:`tb_frame` points to the execution frame of the current
  865. level; :attr:`tb_lineno` gives the line number where the exception occurred;
  866. :attr:`tb_lasti` indicates the precise instruction. The line number and last
  867. instruction in the traceback may differ from the line number of its frame object
  868. if the exception occurred in a :keyword:`try` statement with no matching except
  869. clause or with a finally clause.
  870. Slice objects
  871. .. index:: builtin: slice
  872. Slice objects are used to represent slices when *extended slice syntax* is us