gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

356 lines
19KB

  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <meta property="og:title" content="Generator Objects" />
  7. <meta property="og:type" content="website" />
  8. <meta property="og:url" content="https://docs.python.org/3/c-api/gen.html" />
  9. <meta property="og:site_name" content="Python documentation" />
  10. <meta property="og:description" content="Generator objects are what Python uses to implement generator iterators. They are normally created by iterating over a function that yields values, rather than explicitly calling PyGen_New() or PyG..." />
  11. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />
  12. <meta property="og:image:alt" content="Python documentation" />
  13. <meta name="description" content="Generator objects are what Python uses to implement generator iterators. They are normally created by iterating over a function that yields values, rather than explicitly calling PyGen_New() or PyG..." />
  14. <meta property="og:image:width" content="200" />
  15. <meta property="og:image:height" content="200" />
  16. <meta name="theme-color" content="#3776ab" />
  17. <title>Generator Objects &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
  18. <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
  19. <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />
  20. <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />
  21. <script src="../_static/documentation_options.js?v=2c828074"></script>
  22. <script src="../_static/doctools.js?v=888ff710"></script>
  23. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  24. <script src="../_static/sidebar.js"></script>
  25. <link rel="search" type="application/opensearchdescription+xml"
  26. title="Search within Python 3.12.3 documentation"
  27. href="../_static/opensearch.xml"/>
  28. <link rel="author" title="About these documents" href="../about.html" />
  29. <link rel="index" title="Index" href="../genindex.html" />
  30. <link rel="search" title="Search" href="../search.html" />
  31. <link rel="copyright" title="Copyright" href="../copyright.html" />
  32. <link rel="next" title="Coroutine Objects" href="coro.html" />
  33. <link rel="prev" title="Frame Objects" href="frame.html" />
  34. <link rel="canonical" href="https://docs.python.org/3/c-api/gen.html" />
  35. <style>
  36. @media only screen {
  37. table.full-width-table {
  38. width: 100%;
  39. }
  40. }
  41. </style>
  42. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
  43. <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />
  44. <script type="text/javascript" src="../_static/copybutton.js"></script>
  45. <script type="text/javascript" src="../_static/menu.js"></script>
  46. <script type="text/javascript" src="../_static/search-focus.js"></script>
  47. <script type="text/javascript" src="../_static/themetoggle.js"></script>
  48. </head>
  49. <body>
  50. <div class="mobile-nav">
  51. <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
  52. aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
  53. <nav class="nav-content" role="navigation">
  54. <label for="menuToggler" class="toggler__label">
  55. <span></span>
  56. </label>
  57. <span class="nav-items-wrapper">
  58. <a href="https://www.python.org/" class="nav-logo">
  59. <img src="../_static/py.svg" alt="Python logo"/>
  60. </a>
  61. <span class="version_switcher_placeholder"></span>
  62. <form role="search" class="search" action="../search.html" method="get">
  63. <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
  64. <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
  65. </svg>
  66. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
  67. <input type="submit" value="Go"/>
  68. </form>
  69. </span>
  70. </nav>
  71. <div class="menu-wrapper">
  72. <nav class="menu" role="navigation" aria-label="main navigation">
  73. <div class="language_switcher_placeholder"></div>
  74. <label class="theme-selector-label">
  75. Theme
  76. <select class="theme-selector" oninput="activateTheme(this.value)">
  77. <option value="auto" selected>Auto</option>
  78. <option value="light">Light</option>
  79. <option value="dark">Dark</option>
  80. </select>
  81. </label>
  82. <div>
  83. <h4>Previous topic</h4>
  84. <p class="topless"><a href="frame.html"
  85. title="previous chapter">Frame Objects</a></p>
  86. </div>
  87. <div>
  88. <h4>Next topic</h4>
  89. <p class="topless"><a href="coro.html"
  90. title="next chapter">Coroutine Objects</a></p>
  91. </div>
  92. <div role="note" aria-label="source link">
  93. <h3>This Page</h3>
  94. <ul class="this-page-menu">
  95. <li><a href="../bugs.html">Report a Bug</a></li>
  96. <li>
  97. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/gen.rst"
  98. rel="nofollow">Show Source
  99. </a>
  100. </li>
  101. </ul>
  102. </div>
  103. </nav>
  104. </div>
  105. </div>
  106. <div class="related" role="navigation" aria-label="related navigation">
  107. <h3>Navigation</h3>
  108. <ul>
  109. <li class="right" style="margin-right: 10px">
  110. <a href="../genindex.html" title="General Index"
  111. accesskey="I">index</a></li>
  112. <li class="right" >
  113. <a href="../py-modindex.html" title="Python Module Index"
  114. >modules</a> |</li>
  115. <li class="right" >
  116. <a href="coro.html" title="Coroutine Objects"
  117. accesskey="N">next</a> |</li>
  118. <li class="right" >
  119. <a href="frame.html" title="Frame Objects"
  120. accesskey="P">previous</a> |</li>
  121. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  122. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  123. <li class="switchers">
  124. <div class="language_switcher_placeholder"></div>
  125. <div class="version_switcher_placeholder"></div>
  126. </li>
  127. <li>
  128. </li>
  129. <li id="cpython-language-and-version">
  130. <a href="../index.html">3.12.3 Documentation</a> &#187;
  131. </li>
  132. <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
  133. <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &#187;</li>
  134. <li class="nav-item nav-item-this"><a href="">Generator Objects</a></li>
  135. <li class="right">
  136. <div class="inline-search" role="search">
  137. <form class="inline-search" action="../search.html" method="get">
  138. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  139. <input type="submit" value="Go" />
  140. </form>
  141. </div>
  142. |
  143. </li>
  144. <li class="right">
  145. <label class="theme-selector-label">
  146. Theme
  147. <select class="theme-selector" oninput="activateTheme(this.value)">
  148. <option value="auto" selected>Auto</option>
  149. <option value="light">Light</option>
  150. <option value="dark">Dark</option>
  151. </select>
  152. </label> |</li>
  153. </ul>
  154. </div>
  155. <div class="document">
  156. <div class="documentwrapper">
  157. <div class="bodywrapper">
  158. <div class="body" role="main">
  159. <section id="generator-objects">
  160. <span id="gen-objects"></span><h1>Generator Objects<a class="headerlink" href="#generator-objects" title="Link to this heading">¶</a></h1>
  161. <p>Generator objects are what Python uses to implement generator iterators. They
  162. are normally created by iterating over a function that yields values, rather
  163. than explicitly calling <a class="reference internal" href="#c.PyGen_New" title="PyGen_New"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyGen_New()</span></code></a> or <a class="reference internal" href="#c.PyGen_NewWithQualName" title="PyGen_NewWithQualName"><code class="xref c c-func docutils literal notranslate"><span class="pre">PyGen_NewWithQualName()</span></code></a>.</p>
  164. <dl class="c type">
  165. <dt class="sig sig-object c" id="c.PyGenObject">
  166. <span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyGenObject</span></span></span><a class="headerlink" href="#c.PyGenObject" title="Link to this definition">¶</a><br /></dt>
  167. <dd><p>The C structure used for generator objects.</p>
  168. </dd></dl>
  169. <dl class="c var">
  170. <dt class="sig sig-object c" id="c.PyGen_Type">
  171. <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><span class="n"><span class="pre">PyTypeObject</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyGen_Type</span></span></span><a class="headerlink" href="#c.PyGen_Type" title="Link to this definition">¶</a><br /></dt>
  172. <dd><p>The type object corresponding to generator objects.</p>
  173. </dd></dl>
  174. <dl class="c function">
  175. <dt class="sig sig-object c" id="c.PyGen_Check">
  176. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyGen_Check</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ob</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyGen_Check" title="Link to this definition">¶</a><br /></dt>
  177. <dd><p>Return true if <em>ob</em> is a generator object; <em>ob</em> must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>. This
  178. function always succeeds.</p>
  179. </dd></dl>
  180. <dl class="c function">
  181. <dt class="sig sig-object c" id="c.PyGen_CheckExact">
  182. <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyGen_CheckExact</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ob</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyGen_CheckExact" title="Link to this definition">¶</a><br /></dt>
  183. <dd><p>Return true if <em>ob</em>’s type is <a class="reference internal" href="#c.PyGen_Type" title="PyGen_Type"><code class="xref c c-type docutils literal notranslate"><span class="pre">PyGen_Type</span></code></a>; <em>ob</em> must not be
  184. <code class="docutils literal notranslate"><span class="pre">NULL</span></code>. This function always succeeds.</p>
  185. </dd></dl>
  186. <dl class="c function">
  187. <dt class="sig sig-object c" id="c.PyGen_New">
  188. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyGen_New</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="frame.html#c.PyFrameObject" title="PyFrameObject"><span class="n"><span class="pre">PyFrameObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">frame</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyGen_New" title="Link to this definition">¶</a><br /></dt>
  189. <dd><em class="refcount">Return value: New reference.</em><p>Create and return a new generator object based on the <em>frame</em> object.
  190. A reference to <em>frame</em> is stolen by this function. The argument must not be
  191. <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>
  192. </dd></dl>
  193. <dl class="c function">
  194. <dt class="sig sig-object c" id="c.PyGen_NewWithQualName">
  195. <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">PyGen_NewWithQualName</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="frame.html#c.PyFrameObject" title="PyFrameObject"><span class="n"><span class="pre">PyFrameObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">frame</span></span>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">qualname</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.PyGen_NewWithQualName" title="Link to this definition">¶</a><br /></dt>
  196. <dd><em class="refcount">Return value: New reference.</em><p>Create and return a new generator object based on the <em>frame</em> object,
  197. with <code class="docutils literal notranslate"><span class="pre">__name__</span></code> and <code class="docutils literal notranslate"><span class="pre">__qualname__</span></code> set to <em>name</em> and <em>qualname</em>.
  198. A reference to <em>frame</em> is stolen by this function. The <em>frame</em> argument
  199. must not be <code class="docutils literal notranslate"><span class="pre">NULL</span></code>.</p>
  200. </dd></dl>
  201. </section>
  202. <div class="clearer"></div>
  203. </div>
  204. </div>
  205. </div>
  206. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  207. <div class="sphinxsidebarwrapper">
  208. <div>
  209. <h4>Previous topic</h4>
  210. <p class="topless"><a href="frame.html"
  211. title="previous chapter">Frame Objects</a></p>
  212. </div>
  213. <div>
  214. <h4>Next topic</h4>
  215. <p class="topless"><a href="coro.html"
  216. title="next chapter">Coroutine Objects</a></p>
  217. </div>
  218. <div role="note" aria-label="source link">
  219. <h3>This Page</h3>
  220. <ul class="this-page-menu">
  221. <li><a href="../bugs.html">Report a Bug</a></li>
  222. <li>
  223. <a href="https://github.com/python/cpython/blob/main/Doc/c-api/gen.rst"
  224. rel="nofollow">Show Source
  225. </a>
  226. </li>
  227. </ul>
  228. </div>
  229. </div>
  230. <div id="sidebarbutton" title="Collapse sidebar">
  231. <span>«</span>
  232. </div>
  233. </div>
  234. <div class="clearer"></div>
  235. </div>
  236. <div class="related" role="navigation" aria-label="related navigation">
  237. <h3>Navigation</h3>
  238. <ul>
  239. <li class="right" style="margin-right: 10px">
  240. <a href="../genindex.html" title="General Index"
  241. >index</a></li>
  242. <li class="right" >
  243. <a href="../py-modindex.html" title="Python Module Index"
  244. >modules</a> |</li>
  245. <li class="right" >
  246. <a href="coro.html" title="Coroutine Objects"
  247. >next</a> |</li>
  248. <li class="right" >
  249. <a href="frame.html" title="Frame Objects"
  250. >previous</a> |</li>
  251. <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>
  252. <li><a href="https://www.python.org/">Python</a> &#187;</li>
  253. <li class="switchers">
  254. <div class="language_switcher_placeholder"></div>
  255. <div class="version_switcher_placeholder"></div>
  256. </li>
  257. <li>
  258. </li>
  259. <li id="cpython-language-and-version">
  260. <a href="../index.html">3.12.3 Documentation</a> &#187;
  261. </li>
  262. <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
  263. <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &#187;</li>
  264. <li class="nav-item nav-item-this"><a href="">Generator Objects</a></li>
  265. <li class="right">
  266. <div class="inline-search" role="search">
  267. <form class="inline-search" action="../search.html" method="get">
  268. <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />
  269. <input type="submit" value="Go" />
  270. </form>
  271. </div>
  272. |
  273. </li>
  274. <li class="right">
  275. <label class="theme-selector-label">
  276. Theme
  277. <select class="theme-selector" oninput="activateTheme(this.value)">
  278. <option value="auto" selected>Auto</option>
  279. <option value="light">Light</option>
  280. <option value="dark">Dark</option>
  281. </select>
  282. </label> |</li>
  283. </ul>
  284. </div>
  285. <div class="footer">
  286. &copy;
  287. <a href="../copyright.html">
  288. Copyright
  289. </a>
  290. 2001-2024, Python Software Foundation.
  291. <br />
  292. This page is licensed under the Python Software Foundation License Version 2.
  293. <br />
  294. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
  295. <br />
  296. See <a href="/license.html">History and License</a> for more information.<br />
  297. <br />
  298. The Python Software Foundation is a non-profit corporation.
  299. <a href="https://www.python.org/psf/donations/">Please donate.</a>
  300. <br />
  301. <br />
  302. Last updated on Apr 09, 2024 (13:47 UTC).
  303. <a href="/bugs.html">Found a bug</a>?
  304. <br />
  305. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
  306. </div>
  307. </body>
  308. </html>
上海开阖软件有限公司 沪ICP备12045867号-1