diff options
author | Fred Drake <fdrake@acm.org> | 2001-01-28 06:39:35 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-01-28 06:39:35 (GMT) |
commit | 5838d0fc846e2d601967e988f14c88b25d4d17ed (patch) | |
tree | d3986f988d6395b33faad81d6109849bd8ad9e3a /Doc/api | |
parent | 0149e84af280523f74bc2bccb6505eb12cf5bf9c (diff) | |
download | cpython-5838d0fc846e2d601967e988f14c88b25d4d17ed.zip cpython-5838d0fc846e2d601967e988f14c88b25d4d17ed.tar.gz cpython-5838d0fc846e2d601967e988f14c88b25d4d17ed.tar.bz2 |
Document the PyInstance_*() functions and data.
Diffstat (limited to 'Doc/api')
-rw-r--r-- | Doc/api/api.tex | 32 | ||||
-rw-r--r-- | Doc/api/refcounts.dat | 9 |
2 files changed, 39 insertions, 2 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex index 3d89adf..03eebdf 100644 --- a/Doc/api/api.tex +++ b/Doc/api/api.tex @@ -3694,6 +3694,36 @@ set. \end{cfuncdesc} +\subsection{Instance Objects \label{instanceObjects}} + +\obindex{instance} +There are very few functions specific to instance objects. + +\begin{cvardesc}{PyTypeObject}{PyInstance_Type} + Type object for class instances. +\end{cvardesc} + +\begin{cfuncdesc}{int}{PyInstance_Check}{PyObject *obj} + Returns true if \var{obj} is an instance. +\end{cfuncdesc} + +\begin{cfuncdesc}{PyObject*}{PyInstance_New}{PyObject *class, + PyObject *arg, + PyObject *kw} + Create a new instance of a specific class. The parameters \var{arg} + and \var{kw} are used as the positional and keyword parameters to + the object's constructor. +\end{cfuncdesc} + +\begin{cfuncdesc}{PyObject*}{PyInstance_NewRaw}{PyObject *class, + PyObject *dict} + Create a new instance of a specific class without calling it's + constructor. \var{class} is the class of new object. The + \var{dict} parameter will be used as the object's \member{__dict__}; + if \NULL, a new dictionary will be created for the instance. +\end{cfuncdesc} + + \subsection{Module Objects \label{moduleObjects}} \obindex{module} @@ -4737,8 +4767,6 @@ Py_BuildValue DL_IMPORT -Py*_Check - _Py_NoneStruct diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat index 4fa5547..2a3cc00 100644 --- a/Doc/api/refcounts.dat +++ b/Doc/api/refcounts.dat @@ -332,6 +332,15 @@ PyImport_ImportModuleEx:PyObject*:fromlist:0:??? PyImport_ReloadModule:PyObject*::+1: PyImport_ReloadModule:PyObject*:m:0: +PyInstance_New:PyObject*::+1: +PyInstance_New:PyObject*:klass:+1: +PyInstance_New:PyObject*:arg:0: +PyInstance_New:PyObject*:kw:0: + +PyInstance_NewRaw:PyObject*::+1: +PyInstance_NewRaw:PyObject*:klass:+1: +PyInstance_NewRaw:PyObject*:dict:+1: + PyInt_AS_LONG:long::: PyInt_AS_LONG:PyIntObject*:io:0: |