PageRenderTime 1530ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/deimos2.4/deimos/python/methodobject.html

https://bitbucket.org/ariovistus/ariovistus.bitbucket.org
HTML | 452 lines | 388 code | 63 blank | 1 comment | 0 complexity | 47f1404ad6dff29d510eb8f26cd92940 MD5 | raw file
  1. <html><head>
  2. <meta http-equiv="content-type" content="text/html; charset=utf-8">
  3. <meta content="text/javascript" http-equiv="content-script-type">
  4. <title>deimos.python.methodobject</title>
  5. <link rel="stylesheet" type="text/css" href="/candydoc/style.css">
  6. <!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="/candydoc/ie56hack.css"><![endif]-->
  7. <script language="JavaScript" src="/candydoc/util.js" type="text/javascript"></script>
  8. <script language="JavaScript" src="/candydoc/tree.js" type="text/javascript"></script>
  9. <script language="JavaScript" src="/candydoc/explorer.js" type="text/javascript"></script>
  10. </head><body>
  11. <div id="tabarea"></div><div id="explorerclient"></div>
  12. <div id="content"><script>explorer.initialize("deimos.python.methodobject");</script>
  13. <table class="content">
  14. <tr><td id="docbody"><h1>deimos.python.methodobject</h1><!-- Generated by Ddoc from ../pyd//infrastructure/deimos/python/methodobject.d -->
  15. Mirror methodobject.h
  16. <br><br>
  17. Method object interface<br><br>
  18. <script>explorer.outline.incSymbolLevel();</script>
  19. <dl>
  20. <script>explorer.outline.writeEnabled = true;</script>
  21. <dt><span class="decl">PyTypeObject
  22. <span class="currsymbol">PyCFunction_Type</span>
  23. <script>explorer.outline.addDecl('PyCFunction_Type');</script>;
  24. </span></dt>
  25. <script>explorer.outline.writeEnabled = false;</script>
  26. <dd>This is about the type 'builtin_function_or_method',
  27. not Python methods in user-defined classes. See classobject.h
  28. for the latter. <br><br>
  29. </dd>
  30. <script>explorer.outline.writeEnabled = true;</script>
  31. <dt><span class="decl">int
  32. <span class="currsymbol">PyCFunction_Check</span>
  33. <script>explorer.outline.addDecl('PyCFunction_Check');</script>()(PyObject* <span class="funcparam">op</span>);
  34. </span></dt>
  35. <script>explorer.outline.writeEnabled = false;</script>
  36. <dd><br><br>
  37. </dd>
  38. <script>explorer.outline.writeEnabled = true;</script>
  39. <dt><span class="decl">alias
  40. <span class="currsymbol">PyCFunction</span>
  41. <script>explorer.outline.addDecl('PyCFunction');</script>;
  42. </span></dt>
  43. <script>explorer.outline.writeEnabled = false;</script>
  44. <dd><br><br>
  45. </dd>
  46. <script>explorer.outline.writeEnabled = true;</script>
  47. <dt><span class="decl">alias
  48. <span class="currsymbol">PyCFunctionWithKeywords</span>
  49. <script>explorer.outline.addDecl('PyCFunctionWithKeywords');</script>;
  50. </span></dt>
  51. <script>explorer.outline.writeEnabled = false;</script>
  52. <dd><br><br>
  53. </dd>
  54. <script>explorer.outline.writeEnabled = true;</script>
  55. <dt><span class="decl">alias
  56. <span class="currsymbol">PyNoArgsFunction</span>
  57. <script>explorer.outline.addDecl('PyNoArgsFunction');</script>;
  58. </span></dt>
  59. <script>explorer.outline.writeEnabled = false;</script>
  60. <dd><br><br>
  61. </dd>
  62. <script>explorer.outline.writeEnabled = true;</script>
  63. <dt><span class="decl">PyCFunction
  64. <span class="currsymbol">PyCFunction_GetFunction</span>
  65. <script>explorer.outline.addDecl('PyCFunction_GetFunction');</script>(PyObject*);
  66. </span></dt>
  67. <script>explorer.outline.writeEnabled = false;</script>
  68. <dd><br><br>
  69. </dd>
  70. <script>explorer.outline.writeEnabled = true;</script>
  71. <dt><span class="decl">PyObject*
  72. <span class="currsymbol">PyCFunction_GetSelf</span>
  73. <script>explorer.outline.addDecl('PyCFunction_GetSelf');</script>(PyObject*);
  74. </span></dt>
  75. <script>explorer.outline.writeEnabled = false;</script>
  76. <dd><br><br>
  77. </dd>
  78. <script>explorer.outline.writeEnabled = true;</script>
  79. <dt><span class="decl">int
  80. <span class="currsymbol">PyCFunction_GetFlags</span>
  81. <script>explorer.outline.addDecl('PyCFunction_GetFlags');</script>(PyObject*);
  82. </span></dt>
  83. <script>explorer.outline.writeEnabled = false;</script>
  84. <dd><br><br>
  85. </dd>
  86. <script>explorer.outline.writeEnabled = true;</script>
  87. <dt><span class="decl">auto
  88. <span class="currsymbol">PyCFunction_GET_FUNCTION</span>
  89. <script>explorer.outline.addDecl('PyCFunction_GET_FUNCTION');</script>()(PyObject* <span class="funcparam">func</span>);
  90. <br>auto
  91. <span class="currsymbol">PyCFunction_GET_SELF</span>
  92. <script>explorer.outline.addDecl('PyCFunction_GET_SELF');</script>()(PyObject* <span class="funcparam">func</span>);
  93. <br>auto
  94. <span class="currsymbol">PyCFunction_GET_FLAGS</span>
  95. <script>explorer.outline.addDecl('PyCFunction_GET_FLAGS');</script>(PyObject* <span class="funcparam">func</span>);
  96. </span></dt>
  97. <script>explorer.outline.writeEnabled = false;</script>
  98. <dd>Macros for direct access to these values. Type checks are *not*
  99. done, so use with care. <br><br>
  100. </dd>
  101. <script>explorer.outline.writeEnabled = true;</script>
  102. <dt><span class="decl">PyObject*
  103. <span class="currsymbol">PyCFunction_Call</span>
  104. <script>explorer.outline.addDecl('PyCFunction_Call');</script>(PyObject*, PyObject*, PyObject*);
  105. </span></dt>
  106. <script>explorer.outline.writeEnabled = false;</script>
  107. <dd><br><br>
  108. </dd>
  109. <script>explorer.outline.writeEnabled = true;</script>
  110. <dt><span class="decl">struct
  111. <span class="currsymbol">PyMethodDef</span>
  112. <script>explorer.outline.addDecl('PyMethodDef');</script>;
  113. </span></dt>
  114. <script>explorer.outline.writeEnabled = false;</script>
  115. <dd><br><br>
  116. <script>explorer.outline.incSymbolLevel();</script>
  117. <dl>
  118. <script>explorer.outline.writeEnabled = true;</script>
  119. <dt><span class="decl">const(char)*
  120. <span class="currsymbol">ml_name</span>
  121. <script>explorer.outline.addDecl('ml_name');</script>;
  122. </span></dt>
  123. <script>explorer.outline.writeEnabled = false;</script>
  124. <dd>The name of the built-in function/method <br><br>
  125. </dd>
  126. <script>explorer.outline.writeEnabled = true;</script>
  127. <dt><span class="decl">PyCFunction
  128. <span class="currsymbol">ml_meth</span>
  129. <script>explorer.outline.addDecl('ml_meth');</script>;
  130. </span></dt>
  131. <script>explorer.outline.writeEnabled = false;</script>
  132. <dd>The C function that implements it <br><br>
  133. </dd>
  134. <script>explorer.outline.writeEnabled = true;</script>
  135. <dt><span class="decl">int
  136. <span class="currsymbol">ml_flags</span>
  137. <script>explorer.outline.addDecl('ml_flags');</script>;
  138. </span></dt>
  139. <script>explorer.outline.writeEnabled = false;</script>
  140. <dd>Combination of METH_xxx flags, which mostly
  141. describe the args expected by the C func <br><br>
  142. </dd>
  143. <script>explorer.outline.writeEnabled = true;</script>
  144. <dt><span class="decl">const(char)*
  145. <span class="currsymbol">ml_doc</span>
  146. <script>explorer.outline.addDecl('ml_doc');</script>;
  147. </span></dt>
  148. <script>explorer.outline.writeEnabled = false;</script>
  149. <dd>The _doc__ attribute, or NULL <br><br>
  150. </dd>
  151. </dl>
  152. <script>explorer.outline.decSymbolLevel();</script>
  153. </dd>
  154. <script>explorer.outline.writeEnabled = true;</script>
  155. <dt><span class="decl">PyObject*
  156. <span class="currsymbol">Py_FindMethod</span>
  157. <script>explorer.outline.addDecl('Py_FindMethod');</script>(PyMethodDef*, PyObject*, const(char)*);
  158. </span></dt>
  159. <script>explorer.outline.writeEnabled = false;</script>
  160. <dd><b>Availability:</b><br>
  161. 2.*<br><br>
  162. </dd>
  163. <script>explorer.outline.writeEnabled = true;</script>
  164. <dt><span class="decl">PyObject*
  165. <span class="currsymbol">PyCFunction_NewEx</span>
  166. <script>explorer.outline.addDecl('PyCFunction_NewEx');</script>(PyMethodDef*, PyObject*, PyObject*);
  167. </span></dt>
  168. <script>explorer.outline.writeEnabled = false;</script>
  169. <dd><br><br>
  170. </dd>
  171. <script>explorer.outline.writeEnabled = true;</script>
  172. <dt><span class="decl">PyObject*
  173. <span class="currsymbol">PyCFunction_New</span>
  174. <script>explorer.outline.addDecl('PyCFunction_New');</script>()(PyMethodDef* <span class="funcparam">ml</span>, PyObject* <span class="funcparam">self</span>);
  175. </span></dt>
  176. <script>explorer.outline.writeEnabled = false;</script>
  177. <dd><br><br>
  178. </dd>
  179. <script>explorer.outline.writeEnabled = true;</script>
  180. <dt><span class="decl">int
  181. <span class="currsymbol">METH_OLDARGS</span>
  182. <script>explorer.outline.addDecl('METH_OLDARGS');</script>;
  183. <br>int
  184. <span class="currsymbol">METH_VARARGS</span>
  185. <script>explorer.outline.addDecl('METH_VARARGS');</script>;
  186. <br>int
  187. <span class="currsymbol">METH_KEYWORDS</span>
  188. <script>explorer.outline.addDecl('METH_KEYWORDS');</script>;
  189. </span></dt>
  190. <script>explorer.outline.writeEnabled = false;</script>
  191. <dd>Flag passed to newmethodobject <br><br>
  192. </dd>
  193. <script>explorer.outline.writeEnabled = true;</script>
  194. <dt><span class="decl">int
  195. <span class="currsymbol">METH_NOARGS</span>
  196. <script>explorer.outline.addDecl('METH_NOARGS');</script>;
  197. <br>int
  198. <span class="currsymbol">METH_O</span>
  199. <script>explorer.outline.addDecl('METH_O');</script>;
  200. </span></dt>
  201. <script>explorer.outline.writeEnabled = false;</script>
  202. <dd>
  203. <span class="currsymbol">METH_NOARGS</span>
  204. <script>explorer.outline.addDecl('METH_NOARGS');</script> and METH_O must not be combined with the flags above. <br><br>
  205. </dd>
  206. <script>explorer.outline.writeEnabled = true;</script>
  207. <dt><span class="decl">int
  208. <span class="currsymbol">METH_CLASS</span>
  209. <script>explorer.outline.addDecl('METH_CLASS');</script>;
  210. <br>int
  211. <span class="currsymbol">METH_STATIC</span>
  212. <script>explorer.outline.addDecl('METH_STATIC');</script>;
  213. </span></dt>
  214. <script>explorer.outline.writeEnabled = false;</script>
  215. <dd>
  216. <span class="currsymbol">METH_CLASS</span>
  217. <script>explorer.outline.addDecl('METH_CLASS');</script> and METH_STATIC are a little different; these control
  218. the construction of methods for a class. These cannot be used for
  219. functions in modules. <br><br>
  220. </dd>
  221. <script>explorer.outline.writeEnabled = true;</script>
  222. <dt><span class="decl">int
  223. <span class="currsymbol">METH_COEXIST</span>
  224. <script>explorer.outline.addDecl('METH_COEXIST');</script>;
  225. </span></dt>
  226. <script>explorer.outline.writeEnabled = false;</script>
  227. <dd>
  228. <span class="currsymbol">METH_COEXIST</span>
  229. <script>explorer.outline.addDecl('METH_COEXIST');</script> allows a method to be entered eventhough a slot has
  230. already filled the entry. When defined, the flag allows a separate
  231. method, "_contains__" for example, to coexist with a defined
  232. slot like sq_contains. <br><br>
  233. </dd>
  234. <script>explorer.outline.writeEnabled = true;</script>
  235. <dt><span class="decl">struct
  236. <span class="currsymbol">PyMethodChain</span>
  237. <script>explorer.outline.addDecl('PyMethodChain');</script>;
  238. </span></dt>
  239. <script>explorer.outline.writeEnabled = false;</script>
  240. <dd><b>Availability:</b><br>
  241. 2.*<br><br>
  242. <script>explorer.outline.incSymbolLevel();</script>
  243. <dl>
  244. <script>explorer.outline.writeEnabled = true;</script>
  245. <dt><span class="decl">PyMethodDef*
  246. <span class="currsymbol">methods</span>
  247. <script>explorer.outline.addDecl('methods');</script>;
  248. </span></dt>
  249. <script>explorer.outline.writeEnabled = false;</script>
  250. <dd>Methods of this type <br><br>
  251. </dd>
  252. <script>explorer.outline.writeEnabled = true;</script>
  253. <dt><span class="decl">PyMethodChain*
  254. <span class="currsymbol">link</span>
  255. <script>explorer.outline.addDecl('link');</script>;
  256. </span></dt>
  257. <script>explorer.outline.writeEnabled = false;</script>
  258. <dd>NULL or base type <br><br>
  259. </dd>
  260. </dl>
  261. <script>explorer.outline.decSymbolLevel();</script>
  262. </dd>
  263. <script>explorer.outline.writeEnabled = true;</script>
  264. <dt><span class="decl">PyObject*
  265. <span class="currsymbol">Py_FindMethodInChain</span>
  266. <script>explorer.outline.addDecl('Py_FindMethodInChain');</script>(PyMethodChain*, PyObject*, const(char)*);
  267. </span></dt>
  268. <script>explorer.outline.writeEnabled = false;</script>
  269. <dd><b>Availability:</b><br>
  270. 2.*<br><br>
  271. </dd>
  272. <script>explorer.outline.writeEnabled = true;</script>
  273. <dt><span class="decl">struct
  274. <span class="currsymbol">PyCFunctionObject</span>
  275. <script>explorer.outline.addDecl('PyCFunctionObject');</script>;
  276. </span></dt>
  277. <script>explorer.outline.writeEnabled = false;</script>
  278. <dd>subclass of PyObject<br><br>
  279. <script>explorer.outline.incSymbolLevel();</script>
  280. <dl>
  281. <script>explorer.outline.writeEnabled = true;</script>
  282. <dt><span class="decl">PyMethodDef*
  283. <span class="currsymbol">m_ml</span>
  284. <script>explorer.outline.addDecl('m_ml');</script>;
  285. </span></dt>
  286. <script>explorer.outline.writeEnabled = false;</script>
  287. <dd>Description of the C function to call <br><br>
  288. </dd>
  289. <script>explorer.outline.writeEnabled = true;</script>
  290. <dt><span class="decl">PyObject*
  291. <span class="currsymbol">m_self</span>
  292. <script>explorer.outline.addDecl('m_self');</script>;
  293. </span></dt>
  294. <script>explorer.outline.writeEnabled = false;</script>
  295. <dd>Passed as 'self' arg to the C func, can be NULL <br><br>
  296. </dd>
  297. <script>explorer.outline.writeEnabled = true;</script>
  298. <dt><span class="decl">PyObject*
  299. <span class="currsymbol">m_module</span>
  300. <script>explorer.outline.addDecl('m_module');</script>;
  301. </span></dt>
  302. <script>explorer.outline.writeEnabled = false;</script>
  303. <dd>The _module__ attribute, can be anything <br><br>
  304. </dd>
  305. </dl>
  306. <script>explorer.outline.decSymbolLevel();</script>
  307. </dd>
  308. </dl>
  309. <script>explorer.outline.decSymbolLevel();</script>
  310. </td></tr>
  311. <tr><td id="docfooter">
  312. Page was generated with
  313. <img src="/candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
  314. on Fri Sep 21 00:22:05 2012
  315. </td></tr>
  316. </table>
  317. </div>
  318. <script>
  319. explorer.packageExplorer.addModule("deimos.python.abstract_");
  320. explorer.packageExplorer.addModule("deimos.python.ast");
  321. explorer.packageExplorer.addModule("deimos.python.boolobject");
  322. explorer.packageExplorer.addModule("deimos.python.bufferobject");
  323. explorer.packageExplorer.addModule("deimos.python.bytearrayobject");
  324. explorer.packageExplorer.addModule("deimos.python.bytesobject");
  325. explorer.packageExplorer.addModule("deimos.python.cellobject");
  326. explorer.packageExplorer.addModule("deimos.python.ceval");
  327. explorer.packageExplorer.addModule("deimos.python.classobject");
  328. explorer.packageExplorer.addModule("deimos.python.cobject");
  329. explorer.packageExplorer.addModule("deimos.python.codecs");
  330. explorer.packageExplorer.addModule("deimos.python.code");
  331. explorer.packageExplorer.addModule("deimos.python.compile");
  332. explorer.packageExplorer.addModule("deimos.python.complexobject");
  333. explorer.packageExplorer.addModule("deimos.python.cStringIO");
  334. explorer.packageExplorer.addModule("deimos.python.datetime");
  335. explorer.packageExplorer.addModule("deimos.python.descrobject");
  336. explorer.packageExplorer.addModule("deimos.python.dictobject");
  337. explorer.packageExplorer.addModule("deimos.python.enumobject");
  338. explorer.packageExplorer.addModule("deimos.python.errcode");
  339. explorer.packageExplorer.addModule("deimos.python.eval");
  340. explorer.packageExplorer.addModule("deimos.python.fileobject");
  341. explorer.packageExplorer.addModule("deimos.python.floatobject");
  342. explorer.packageExplorer.addModule("deimos.python.frameobject");
  343. explorer.packageExplorer.addModule("deimos.python.funcobject");
  344. explorer.packageExplorer.addModule("deimos.python.genobject");
  345. explorer.packageExplorer.addModule("deimos.python.grammar");
  346. explorer.packageExplorer.addModule("deimos.python.import_");
  347. explorer.packageExplorer.addModule("deimos.python.intobject");
  348. explorer.packageExplorer.addModule("deimos.python.intrcheck");
  349. explorer.packageExplorer.addModule("deimos.python.iterobject");
  350. explorer.packageExplorer.addModule("deimos.python.listobject");
  351. explorer.packageExplorer.addModule("deimos.python.longintrepr");
  352. explorer.packageExplorer.addModule("deimos.python.longobject");
  353. explorer.packageExplorer.addModule("deimos.python.marshal");
  354. explorer.packageExplorer.addModule("deimos.python.memoryobject");
  355. explorer.packageExplorer.addModule("deimos.python.methodobject");
  356. explorer.packageExplorer.addModule("deimos.python.modsupport");
  357. explorer.packageExplorer.addModule("deimos.python.moduleobject");
  358. explorer.packageExplorer.addModule("deimos.python.node");
  359. explorer.packageExplorer.addModule("deimos.python.object");
  360. explorer.packageExplorer.addModule("deimos.python.objimpl");
  361. explorer.packageExplorer.addModule("deimos.python.parsetok");
  362. explorer.packageExplorer.addModule("deimos.python.pgenheaders");
  363. explorer.packageExplorer.addModule("deimos.python.pyarena");
  364. explorer.packageExplorer.addModule("deimos.python.pyatomic");
  365. explorer.packageExplorer.addModule("deimos.python.pycapsule");
  366. explorer.packageExplorer.addModule("deimos.python.pydebug");
  367. explorer.packageExplorer.addModule("deimos.python.pyerrors");
  368. explorer.packageExplorer.addModule("deimos.python.pymem");
  369. explorer.packageExplorer.addModule("deimos.python.pyport");
  370. explorer.packageExplorer.addModule("deimos.python.pystate");
  371. explorer.packageExplorer.addModule("deimos.python.pystrcmp");
  372. explorer.packageExplorer.addModule("deimos.python.pystrtod");
  373. explorer.packageExplorer.addModule("deimos.python.Python");
  374. explorer.packageExplorer.addModule("deimos.python.pythonrun");
  375. explorer.packageExplorer.addModule("deimos.python.pythread");
  376. explorer.packageExplorer.addModule("deimos.python.rangeobject");
  377. explorer.packageExplorer.addModule("deimos.python.setobject");
  378. explorer.packageExplorer.addModule("deimos.python.sliceobject");
  379. explorer.packageExplorer.addModule("deimos.python.stringobject");
  380. explorer.packageExplorer.addModule("deimos.python.structmember");
  381. explorer.packageExplorer.addModule("deimos.python.structseq");
  382. explorer.packageExplorer.addModule("deimos.python.symtable");
  383. explorer.packageExplorer.addModule("deimos.python.sysmodule");
  384. explorer.packageExplorer.addModule("deimos.python.timefuncs");
  385. explorer.packageExplorer.addModule("deimos.python.traceback");
  386. explorer.packageExplorer.addModule("deimos.python.tupleobject");
  387. explorer.packageExplorer.addModule("deimos.python.unicodeobject");
  388. explorer.packageExplorer.addModule("deimos.python.weakrefobject");</script>
  389. </body></html>