libnew.tex 2.4 KB
Newer Older
1
\section{\module{new} ---
2
         Creation of runtime internal objects}
3 4

\declaremodule{builtin}{new}
5
\sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
6 7 8 9 10 11 12 13 14 15 16
\modulesynopsis{Interface to the creation of runtime implementation objects.}


The \module{new} module allows an interface to the interpreter object
creation functions. This is for use primarily in marshal-type functions,
when a new object needs to be created ``magically'' and not by using the
regular creation functions. This module provides a low-level interface
to the interpreter, so care must be exercised when using this module.

The \module{new} module defines the following functions:

17
\begin{funcdesc}{instance}{class\optional{, dict}}
18
This function creates an instance of \var{class} with dictionary
19 20 21 22
\var{dict} without calling the \method{__init__()} constructor.  If
\var{dict} is omitted or \code{None}, a new, empty dictionary is
created for the new instance.  Note that there are no guarantees that
the object will be in a consistent state.
23 24 25 26
\end{funcdesc}

\begin{funcdesc}{instancemethod}{function, instance, class}
This function will return a method object, bound to \var{instance}, or
27 28 29
unbound if \var{instance} is \code{None}.  \var{function} must be
callable, and \var{instance} must be an instance object or
\code{None}.
30 31
\end{funcdesc}

32
\begin{funcdesc}{function}{code, globals\optional{, name\optional{, argdefs}}}
33
Returns a (Python) function with the given code and globals. If
34 35 36
\var{name} is given, it must be a string or \code{None}.  If it is a
string, the function will have the given name, otherwise the function
name will be taken from \code{\var{code}.co_name}.  If
37
\var{argdefs} is given, it must be a tuple and will be used to
38
determine the default values of parameters.
39 40 41 42 43
\end{funcdesc}

\begin{funcdesc}{code}{argcount, nlocals, stacksize, flags, codestring,
                       constants, names, varnames, filename, name, firstlineno,
                       lnotab}
44
This function is an interface to the \cfunction{PyCode_New()} C
45
function.
46
%XXX This is still undocumented!!!!!!!!!!!
47 48 49 50
\end{funcdesc}

\begin{funcdesc}{module}{name}
This function returns a new module object with name \var{name}.
51
\var{name} must be a string.
52 53 54 55 56
\end{funcdesc}

\begin{funcdesc}{classobj}{name, baseclasses, dict}
This function returns a new class object, with name \var{name}, derived
from \var{baseclasses} (which should be a tuple of classes) and with
57
namespace \var{dict}.
58
\end{funcdesc}