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