blob: 5edc95dae80829986ada043d5d57aab25a6906fb [file] [log] [blame]
Fred Drake64bc94e1999-06-17 15:11:35 +00001\section{\module{new} ---
Fred Drakef8ca7d82000-10-10 17:03:45 +00002 Creation of runtime internal objects}
Fred Drake64bc94e1999-06-17 15:11:35 +00003
4\declaremodule{builtin}{new}
Fred Drake57657bc2000-12-01 15:25:23 +00005\sectionauthor{Moshe Zadka}{moshez@zadka.site.co.il}
Fred Drake64bc94e1999-06-17 15:11:35 +00006\modulesynopsis{Interface to the creation of runtime implementation objects.}
7
8
9The \module{new} module allows an interface to the interpreter object
10creation functions. This is for use primarily in marshal-type functions,
11when a new object needs to be created ``magically'' and not by using the
12regular creation functions. This module provides a low-level interface
13to the interpreter, so care must be exercised when using this module.
Raymond Hettinger8de636e2004-08-17 02:31:55 +000014It is possible to supply non-sensical arguments which crash the
15interpreter when the object is used.
Fred Drake64bc94e1999-06-17 15:11:35 +000016
17The \module{new} module defines the following functions:
18
Fred Drakec37f5b32001-01-28 17:23:05 +000019\begin{funcdesc}{instance}{class\optional{, dict}}
Fred Drake26921da1999-06-17 18:58:02 +000020This function creates an instance of \var{class} with dictionary
Fred Drakec37f5b32001-01-28 17:23:05 +000021\var{dict} without calling the \method{__init__()} constructor. If
22\var{dict} is omitted or \code{None}, a new, empty dictionary is
23created for the new instance. Note that there are no guarantees that
24the object will be in a consistent state.
Fred Drake64bc94e1999-06-17 15:11:35 +000025\end{funcdesc}
26
27\begin{funcdesc}{instancemethod}{function, instance, class}
28This function will return a method object, bound to \var{instance}, or
Fred Drakee0197891999-06-17 18:15:07 +000029unbound if \var{instance} is \code{None}. \var{function} must be
Guido van Rossum4f3a62d2002-01-15 19:21:05 +000030callable.
Fred Drake64bc94e1999-06-17 15:11:35 +000031\end{funcdesc}
32
Fred Drake2c4f5542000-10-10 22:00:03 +000033\begin{funcdesc}{function}{code, globals\optional{, name\optional{, argdefs}}}
Fred Drake64bc94e1999-06-17 15:11:35 +000034Returns a (Python) function with the given code and globals. If
Fred Drakee0197891999-06-17 18:15:07 +000035\var{name} is given, it must be a string or \code{None}. If it is a
36string, the function will have the given name, otherwise the function
37name will be taken from \code{\var{code}.co_name}. If
Fred Drake2c4f5542000-10-10 22:00:03 +000038\var{argdefs} is given, it must be a tuple and will be used to
Fred Drakee0197891999-06-17 18:15:07 +000039determine the default values of parameters.
Fred Drake64bc94e1999-06-17 15:11:35 +000040\end{funcdesc}
41
42\begin{funcdesc}{code}{argcount, nlocals, stacksize, flags, codestring,
43 constants, names, varnames, filename, name, firstlineno,
44 lnotab}
Fred Drakee0197891999-06-17 18:15:07 +000045This function is an interface to the \cfunction{PyCode_New()} C
Fred Drake64bc94e1999-06-17 15:11:35 +000046function.
Fred Drake9e0b6221999-06-29 15:45:09 +000047%XXX This is still undocumented!!!!!!!!!!!
Fred Drake64bc94e1999-06-17 15:11:35 +000048\end{funcdesc}
49
Neal Norwitz116078f2005-10-11 03:23:45 +000050\begin{funcdesc}{module}{name[, doc]}
Fred Drake64bc94e1999-06-17 15:11:35 +000051This function returns a new module object with name \var{name}.
Fred Drakee0197891999-06-17 18:15:07 +000052\var{name} must be a string.
Neal Norwitz116078f2005-10-11 03:23:45 +000053The optional \var{doc} argument can have any type.
Fred Drake64bc94e1999-06-17 15:11:35 +000054\end{funcdesc}
55
56\begin{funcdesc}{classobj}{name, baseclasses, dict}
57This function returns a new class object, with name \var{name}, derived
58from \var{baseclasses} (which should be a tuple of classes) and with
Fred Drakee0197891999-06-17 18:15:07 +000059namespace \var{dict}.
Fred Drake64bc94e1999-06-17 15:11:35 +000060\end{funcdesc}