/deimos2.7/deimos/python/methodobject.html
HTML | 485 lines | 415 code | 69 blank | 1 comment | 0 complexity | a9e3dce3803309cc645526a4bc4dfe10 MD5 | raw file
-
- <html><head>
- <meta http-equiv="content-type" content="text/html; charset=utf-8">
- <meta content="text/javascript" http-equiv="content-script-type">
- <title>deimos.python.methodobject</title>
- <link rel="stylesheet" type="text/css" href="/candydoc/style.css">
- <!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="/candydoc/ie56hack.css"><![endif]-->
- <script language="JavaScript" src="/candydoc/util.js" type="text/javascript"></script>
- <script language="JavaScript" src="/candydoc/tree.js" type="text/javascript"></script>
- <script language="JavaScript" src="/candydoc/explorer.js" type="text/javascript"></script>
- </head><body>
- <div id="tabarea"></div><div id="explorerclient"></div>
- <div id="content"><script>explorer.initialize("deimos.python.methodobject");</script>
- <table class="content">
- <tr><td id="docbody"><h1>deimos.python.methodobject</h1><!-- Generated by Ddoc from ../pyd//infrastructure/deimos/python/methodobject.d -->
- Mirror methodobject.h
- <br><br>
- Method object interface<br><br>
-
-
- <script>explorer.outline.incSymbolLevel();</script>
- <dl>
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyTypeObject
- <span class="currsymbol">PyCFunction_Type</span>
- <script>explorer.outline.addDecl('PyCFunction_Type');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>This is about the type 'builtin_function_or_method',
- not Python methods in user-defined classes. See classobject.h
- for the latter. <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">PyCFunction_Check</span>
- <script>explorer.outline.addDecl('PyCFunction_Check');</script>()(PyObject* <span class="funcparam">op</span>);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">alias
- <span class="currsymbol">PyCFunction</span>
- <script>explorer.outline.addDecl('PyCFunction');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">alias
- <span class="currsymbol">PyCFunctionWithKeywords</span>
- <script>explorer.outline.addDecl('PyCFunctionWithKeywords');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">alias
- <span class="currsymbol">PyNoArgsFunction</span>
- <script>explorer.outline.addDecl('PyNoArgsFunction');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyCFunction
- <span class="currsymbol">PyCFunction_GetFunction</span>
- <script>explorer.outline.addDecl('PyCFunction_GetFunction');</script>(PyObject*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">PyCFunction_GetSelf</span>
- <script>explorer.outline.addDecl('PyCFunction_GetSelf');</script>(PyObject*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">PyCFunction_GetFlags</span>
- <script>explorer.outline.addDecl('PyCFunction_GetFlags');</script>(PyObject*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">auto
- <span class="currsymbol">PyCFunction_GET_FUNCTION</span>
- <script>explorer.outline.addDecl('PyCFunction_GET_FUNCTION');</script>()(PyObject* <span class="funcparam">func</span>);
- <br>auto
- <span class="currsymbol">PyCFunction_GET_SELF</span>
- <script>explorer.outline.addDecl('PyCFunction_GET_SELF');</script>()(PyObject* <span class="funcparam">func</span>);
- <br>auto
- <span class="currsymbol">PyCFunction_GET_FLAGS</span>
- <script>explorer.outline.addDecl('PyCFunction_GET_FLAGS');</script>(PyObject* <span class="funcparam">func</span>);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Macros for direct access to these values. Type checks are *not*
- done, so use with care. <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">PyCFunction_Call</span>
- <script>explorer.outline.addDecl('PyCFunction_Call');</script>(PyObject*, PyObject*, PyObject*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">struct
- <span class="currsymbol">PyMethodDef</span>
- <script>explorer.outline.addDecl('PyMethodDef');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
-
- <script>explorer.outline.incSymbolLevel();</script>
- <dl>
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">const(char)*
- <span class="currsymbol">ml_name</span>
- <script>explorer.outline.addDecl('ml_name');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>The name of the built-in function/method <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyCFunction
- <span class="currsymbol">ml_meth</span>
- <script>explorer.outline.addDecl('ml_meth');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>The C function that implements it <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">ml_flags</span>
- <script>explorer.outline.addDecl('ml_flags');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Combination of METH_xxx flags, which mostly
- describe the args expected by the C func <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">const(char)*
- <span class="currsymbol">ml_doc</span>
- <script>explorer.outline.addDecl('ml_doc');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>The _doc__ attribute, or NULL <br><br>
-
- </dd>
- </dl>
- <script>explorer.outline.decSymbolLevel();</script>
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">Py_FindMethod</span>
- <script>explorer.outline.addDecl('Py_FindMethod');</script>(PyMethodDef*, PyObject*, const(char)*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- 2.*<br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">PyCFunction_NewEx</span>
- <script>explorer.outline.addDecl('PyCFunction_NewEx');</script>(PyMethodDef*, PyObject*, PyObject*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">PyCFunction_New</span>
- <script>explorer.outline.addDecl('PyCFunction_New');</script>()(PyMethodDef* <span class="funcparam">ml</span>, PyObject* <span class="funcparam">self</span>);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">METH_OLDARGS</span>
- <script>explorer.outline.addDecl('METH_OLDARGS');</script>;
- <br>int
- <span class="currsymbol">METH_VARARGS</span>
- <script>explorer.outline.addDecl('METH_VARARGS');</script>;
- <br>int
- <span class="currsymbol">METH_KEYWORDS</span>
- <script>explorer.outline.addDecl('METH_KEYWORDS');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Flag passed to newmethodobject <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">METH_NOARGS</span>
- <script>explorer.outline.addDecl('METH_NOARGS');</script>;
- <br>int
- <span class="currsymbol">METH_O</span>
- <script>explorer.outline.addDecl('METH_O');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>
- <span class="currsymbol">METH_NOARGS</span>
- <script>explorer.outline.addDecl('METH_NOARGS');</script> and METH_O must not be combined with the flags above. <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">METH_CLASS</span>
- <script>explorer.outline.addDecl('METH_CLASS');</script>;
- <br>int
- <span class="currsymbol">METH_STATIC</span>
- <script>explorer.outline.addDecl('METH_STATIC');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>
- <span class="currsymbol">METH_CLASS</span>
- <script>explorer.outline.addDecl('METH_CLASS');</script> and METH_STATIC are a little different; these control
- the construction of methods for a class. These cannot be used for
- functions in modules. <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">METH_COEXIST</span>
- <script>explorer.outline.addDecl('METH_COEXIST');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>
- <span class="currsymbol">METH_COEXIST</span>
- <script>explorer.outline.addDecl('METH_COEXIST');</script> allows a method to be entered eventhough a slot has
- already filled the entry. When defined, the flag allows a separate
- method, "_contains__" for example, to coexist with a defined
- slot like sq_contains. <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">struct
- <span class="currsymbol">PyMethodChain</span>
- <script>explorer.outline.addDecl('PyMethodChain');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- 2.*<br><br>
-
-
- <script>explorer.outline.incSymbolLevel();</script>
- <dl>
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyMethodDef*
- <span class="currsymbol">methods</span>
- <script>explorer.outline.addDecl('methods');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Methods of this type <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyMethodChain*
- <span class="currsymbol">link</span>
- <script>explorer.outline.addDecl('link');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>NULL or base type <br><br>
-
- </dd>
- </dl>
- <script>explorer.outline.decSymbolLevel();</script>
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">Py_FindMethodInChain</span>
- <script>explorer.outline.addDecl('Py_FindMethodInChain');</script>(PyMethodChain*, PyObject*, const(char)*);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- 2.*<br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">struct
- <span class="currsymbol">PyCFunctionObject</span>
- <script>explorer.outline.addDecl('PyCFunctionObject');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>subclass of PyObject<br><br>
-
-
- <script>explorer.outline.incSymbolLevel();</script>
- <dl>
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyMethodDef*
- <span class="currsymbol">m_ml</span>
- <script>explorer.outline.addDecl('m_ml');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Description of the C function to call <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">m_self</span>
- <script>explorer.outline.addDecl('m_self');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>Passed as 'self' arg to the C func, can be NULL <br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">PyObject*
- <span class="currsymbol">m_module</span>
- <script>explorer.outline.addDecl('m_module');</script>;
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd>The _module__ attribute, can be anything <br><br>
-
- </dd>
- </dl>
- <script>explorer.outline.decSymbolLevel();</script>
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">int
- <span class="currsymbol">PyCFunction_ClearFreeList</span>
- <script>explorer.outline.addDecl('PyCFunction_ClearFreeList');</script>();
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- >= 2.6<br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">void
- <span class="currsymbol">_PyCFunction_DebugMallocStats</span>
- <script>explorer.outline.addDecl('_PyCFunction_DebugMallocStats');</script>(shared(_iobuf)* <span class="funcparam">out_</span>);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- >= 2.7<br><br>
-
- </dd>
-
- <script>explorer.outline.writeEnabled = true;</script>
- <dt><span class="decl">void
- <span class="currsymbol">_PyMethod_DebugMallocStats</span>
- <script>explorer.outline.addDecl('_PyMethod_DebugMallocStats');</script>(shared(_iobuf)* <span class="funcparam">out_</span>);
- </span></dt>
- <script>explorer.outline.writeEnabled = false;</script>
- <dd><b>Availability:</b><br>
- >= 2.7<br><br>
-
- </dd>
- </dl>
- <script>explorer.outline.decSymbolLevel();</script>
- </td></tr>
- <tr><td id="docfooter">
- Page was generated with
- <img src="/candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
- on Fri Sep 21 00:22:06 2012
-
- </td></tr>
- </table>
- </div>
- <script>
- explorer.packageExplorer.addModule("deimos.python.abstract_");
- explorer.packageExplorer.addModule("deimos.python.ast");
- explorer.packageExplorer.addModule("deimos.python.boolobject");
- explorer.packageExplorer.addModule("deimos.python.bufferobject");
- explorer.packageExplorer.addModule("deimos.python.bytearrayobject");
- explorer.packageExplorer.addModule("deimos.python.bytesobject");
- explorer.packageExplorer.addModule("deimos.python.cellobject");
- explorer.packageExplorer.addModule("deimos.python.ceval");
- explorer.packageExplorer.addModule("deimos.python.classobject");
- explorer.packageExplorer.addModule("deimos.python.cobject");
- explorer.packageExplorer.addModule("deimos.python.codecs");
- explorer.packageExplorer.addModule("deimos.python.code");
- explorer.packageExplorer.addModule("deimos.python.compile");
- explorer.packageExplorer.addModule("deimos.python.complexobject");
- explorer.packageExplorer.addModule("deimos.python.cStringIO");
- explorer.packageExplorer.addModule("deimos.python.datetime");
- explorer.packageExplorer.addModule("deimos.python.descrobject");
- explorer.packageExplorer.addModule("deimos.python.dictobject");
- explorer.packageExplorer.addModule("deimos.python.enumobject");
- explorer.packageExplorer.addModule("deimos.python.errcode");
- explorer.packageExplorer.addModule("deimos.python.eval");
- explorer.packageExplorer.addModule("deimos.python.fileobject");
- explorer.packageExplorer.addModule("deimos.python.floatobject");
- explorer.packageExplorer.addModule("deimos.python.frameobject");
- explorer.packageExplorer.addModule("deimos.python.funcobject");
- explorer.packageExplorer.addModule("deimos.python.genobject");
- explorer.packageExplorer.addModule("deimos.python.grammar");
- explorer.packageExplorer.addModule("deimos.python.import_");
- explorer.packageExplorer.addModule("deimos.python.intobject");
- explorer.packageExplorer.addModule("deimos.python.intrcheck");
- explorer.packageExplorer.addModule("deimos.python.iterobject");
- explorer.packageExplorer.addModule("deimos.python.listobject");
- explorer.packageExplorer.addModule("deimos.python.longintrepr");
- explorer.packageExplorer.addModule("deimos.python.longobject");
- explorer.packageExplorer.addModule("deimos.python.marshal");
- explorer.packageExplorer.addModule("deimos.python.memoryobject");
- explorer.packageExplorer.addModule("deimos.python.methodobject");
- explorer.packageExplorer.addModule("deimos.python.modsupport");
- explorer.packageExplorer.addModule("deimos.python.moduleobject");
- explorer.packageExplorer.addModule("deimos.python.node");
- explorer.packageExplorer.addModule("deimos.python.object");
- explorer.packageExplorer.addModule("deimos.python.objimpl");
- explorer.packageExplorer.addModule("deimos.python.parsetok");
- explorer.packageExplorer.addModule("deimos.python.pgenheaders");
- explorer.packageExplorer.addModule("deimos.python.pyarena");
- explorer.packageExplorer.addModule("deimos.python.pyatomic");
- explorer.packageExplorer.addModule("deimos.python.pycapsule");
- explorer.packageExplorer.addModule("deimos.python.pydebug");
- explorer.packageExplorer.addModule("deimos.python.pyerrors");
- explorer.packageExplorer.addModule("deimos.python.pymem");
- explorer.packageExplorer.addModule("deimos.python.pyport");
- explorer.packageExplorer.addModule("deimos.python.pystate");
- explorer.packageExplorer.addModule("deimos.python.pystrcmp");
- explorer.packageExplorer.addModule("deimos.python.pystrtod");
- explorer.packageExplorer.addModule("deimos.python.Python");
- explorer.packageExplorer.addModule("deimos.python.pythonrun");
- explorer.packageExplorer.addModule("deimos.python.pythread");
- explorer.packageExplorer.addModule("deimos.python.rangeobject");
- explorer.packageExplorer.addModule("deimos.python.setobject");
- explorer.packageExplorer.addModule("deimos.python.sliceobject");
- explorer.packageExplorer.addModule("deimos.python.stringobject");
- explorer.packageExplorer.addModule("deimos.python.structmember");
- explorer.packageExplorer.addModule("deimos.python.structseq");
- explorer.packageExplorer.addModule("deimos.python.symtable");
- explorer.packageExplorer.addModule("deimos.python.sysmodule");
- explorer.packageExplorer.addModule("deimos.python.timefuncs");
- explorer.packageExplorer.addModule("deimos.python.traceback");
- explorer.packageExplorer.addModule("deimos.python.tupleobject");
- explorer.packageExplorer.addModule("deimos.python.unicodeobject");
- explorer.packageExplorer.addModule("deimos.python.weakrefobject");</script>
- </body></html>