Document the PyInstance_*() functions and data.

This commit is contained in:
Fred Drake 2001-01-28 06:39:35 +00:00
parent 0149e84af2
commit 5838d0fc84
2 changed files with 39 additions and 2 deletions

View file

@ -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