blob: 670d3d7922e43abe85e94945b5d725ddcea10fcc [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001:mod:`new` --- Creation of runtime internal objects
2===================================================
3
4.. module:: new
5 :synopsis: Interface to the creation of runtime implementation objects.
Brett Cannond7265d62008-05-09 05:18:40 +00006 :deprecated:
7
Brett Cannonccdf9082008-05-10 02:25:00 +00008.. deprecated:: 2.6
Georg Brandl47fe9812009-01-01 15:46:10 +00009 The :mod:`new` module has been removed in Python 3.0. Use the :mod:`types`
10 module's classes instead.
Brett Cannond7265d62008-05-09 05:18:40 +000011
Georg Brandl8ec7f652007-08-15 14:28:01 +000012.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
13
14
15The :mod:`new` module allows an interface to the interpreter object creation
16functions. This is for use primarily in marshal-type functions, when a new
17object needs to be created "magically" and not by using the regular creation
18functions. This module provides a low-level interface to the interpreter, so
19care must be exercised when using this module. It is possible to supply
20non-sensical arguments which crash the interpreter when the object is used.
21
22The :mod:`new` module defines the following functions:
23
24
25.. function:: instance(class[, dict])
26
27 This function creates an instance of *class* with dictionary *dict* without
28 calling the :meth:`__init__` constructor. If *dict* is omitted or ``None``, a
29 new, empty dictionary is created for the new instance. Note that there are no
30 guarantees that the object will be in a consistent state.
31
32
33.. function:: instancemethod(function, instance, class)
34
35 This function will return a method object, bound to *instance*, or unbound if
36 *instance* is ``None``. *function* must be callable.
37
38
39.. function:: function(code, globals[, name[, argdefs[, closure]]])
40
41 Returns a (Python) function with the given code and globals. If *name* is given,
42 it must be a string or ``None``. If it is a string, the function will have the
43 given name, otherwise the function name will be taken from ``code.co_name``. If
44 *argdefs* is given, it must be a tuple and will be used to determine the default
45 values of parameters. If *closure* is given, it must be ``None`` or a tuple of
46 cell objects containing objects to bind to the names in ``code.co_freevars``.
47
48
49.. function:: code(argcount, nlocals, stacksize, flags, codestring, constants, names, varnames, filename, name, firstlineno, lnotab)
50
51 This function is an interface to the :cfunc:`PyCode_New` C function.
52
Georg Brandlb19be572007-12-29 10:57:00 +000053 .. XXX This is still undocumented!
Georg Brandl8ec7f652007-08-15 14:28:01 +000054
55
56.. function:: module(name[, doc])
57
58 This function returns a new module object with name *name*. *name* must be a
59 string. The optional *doc* argument can have any type.
60
61
62.. function:: classobj(name, baseclasses, dict)
63
64 This function returns a new class object, with name *name*, derived from
65 *baseclasses* (which should be a tuple of classes) and with namespace *dict*.
66