Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Segui 1
Vota 0
Wiki 捐赠
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.
Albero (Tree): 0f75e31513
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/gc.html

656 lines
44KB
Originale Blame Cronologia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="gc — Garbage Collector interface" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/gc.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="This module provides an interface to the optional garbage collector. It provides the ability to disable the collector, tune the collection frequency, and set debugging options. It also provides acc..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="This module provides an interface to the optional garbage collector. It provides the ability to disable the collector, tune the collection frequency, and set debugging options. It also provides acc..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>gc — Garbage Collector interface &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="inspect — Inspect live objects" href="inspect.html" />

  39.     <link rel="prev" title="__future__ — Future statement definitions" href="__future__.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/gc.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <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>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h4>Previous topic</h4>

  97.     <p class="topless"><a href="__future__.html"

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">__future__</span></code> — Future statement definitions</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

  102.     <p class="topless"><a href="inspect.html"

  103.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">inspect</span></code> — Inspect live objects</a></p>

  104.   </div>

  105.   <div role="note" aria-label="source link">

  106.     <h3>This Page</h3>

  107.     <ul class="this-page-menu">

  108.       <li><a href="../bugs.html">Report a Bug</a></li>

  109.       <li>

  110.         <a href="https://github.com/python/cpython/blob/main/Doc/library/gc.rst"

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

  121.     <div class="related" role="navigation" aria-label="related navigation">

  122.       <h3>Navigation</h3>

  123.       <ul>

  124.         <li class="right" style="margin-right: 10px">

  125.           <a href="../genindex.html" title="General Index"

  126.              accesskey="I">index</a></li>

  127.         <li class="right" >

  128.           <a href="../py-modindex.html" title="Python Module Index"

  129.              >modules</a> |</li>

  130.         <li class="right" >

  131.           <a href="inspect.html" title="inspect — Inspect live objects"

  132.              accesskey="N">next</a> |</li>

  133.         <li class="right" >

  134.           <a href="__future__.html" title="__future__ — Future statement definitions"

  135.              accesskey="P">previous</a> |</li>

  136. 

  137.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  138.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  139.           <li class="switchers">

  140.             <div class="language_switcher_placeholder"></div>

  141.             <div class="version_switcher_placeholder"></div>

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

  146.     <li id="cpython-language-and-version">

  147.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  148.     </li>

  149. 

  150.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  151.           <li class="nav-item nav-item-2"><a href="python.html" accesskey="U">Python Runtime Services</a> &#187;</li>

  152.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">gc</span></code> — Garbage Collector interface</a></li>

  153.                 <li class="right">

  154.                     

  155. 

  156.     <div class="inline-search" role="search">

  157.         <form class="inline-search" action="../search.html" method="get">

  158.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  159.           <input type="submit" value="Go" />

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

  165. <label class="theme-selector-label">

  166.     Theme

  167.     <select class="theme-selector" oninput="activateTheme(this.value)">

  168.         <option value="auto" selected>Auto</option>

  169.         <option value="light">Light</option>

  170.         <option value="dark">Dark</option>

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

  180.           <div class="body" role="main">

  181.             

  182.   <section id="module-gc">

  183. <span id="gc-garbage-collector-interface"></span><h1><a class="reference internal" href="#module-gc" title="gc: Interface to the cycle-detecting garbage collector."><code class="xref py py-mod docutils literal notranslate"><span class="pre">gc</span></code></a> — Garbage Collector interface<a class="headerlink" href="#module-gc" title="Link to this heading">¶</a></h1>

  184. <hr class="docutils" />

  185. <p>This module provides an interface to the optional garbage collector.  It

  186. provides the ability to disable the collector, tune the collection frequency,

  187. and set debugging options.  It also provides access to unreachable objects that

  188. the collector found but cannot free.  Since the collector supplements the

  189. reference counting already used in Python, you can disable the collector if you

  190. are sure your program does not create reference cycles.  Automatic collection

  191. can be disabled by calling <code class="docutils literal notranslate"><span class="pre">gc.disable()</span></code>.  To debug a leaking program call

  192. <code class="docutils literal notranslate"><span class="pre">gc.set_debug(gc.DEBUG_LEAK)</span></code>. Notice that this includes

  193. <code class="docutils literal notranslate"><span class="pre">gc.DEBUG_SAVEALL</span></code>, causing garbage-collected objects to be saved in

  194. gc.garbage for inspection.</p>

  195. <p>The <a class="reference internal" href="#module-gc" title="gc: Interface to the cycle-detecting garbage collector."><code class="xref py py-mod docutils literal notranslate"><span class="pre">gc</span></code></a> module provides the following functions:</p>

  196. <dl class="py function">

  197. <dt class="sig sig-object py" id="gc.enable">

  198. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">enable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.enable" title="Link to this definition">¶</a></dt>

  199. <dd><p>Enable automatic garbage collection.</p>

  200. </dd></dl>

  201. 

  202. <dl class="py function">

  203. <dt class="sig sig-object py" id="gc.disable">

  204. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">disable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.disable" title="Link to this definition">¶</a></dt>

  205. <dd><p>Disable automatic garbage collection.</p>

  206. </dd></dl>

  207. 

  208. <dl class="py function">

  209. <dt class="sig sig-object py" id="gc.isenabled">

  210. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">isenabled</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.isenabled" title="Link to this definition">¶</a></dt>

  211. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if automatic collection is enabled.</p>

  212. </dd></dl>

  213. 

  214. <dl class="py function">

  215. <dt class="sig sig-object py" id="gc.collect">

  216. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">collect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">generation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.collect" title="Link to this definition">¶</a></dt>

  217. <dd><p>With no arguments, run a full collection.  The optional argument <em>generation</em>

  218. may be an integer specifying which generation to collect (from 0 to 2).  A

  219. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if the generation number  is invalid. The number of

  220. unreachable objects found is returned.</p>

  221. <p>The free lists maintained for a number of built-in types are cleared

  222. whenever a full collection or collection of the highest generation (2)

  223. is run.  Not all items in some free lists may be freed due to the

  224. particular implementation, in particular <a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>.</p>

  225. <p>The effect of calling <code class="docutils literal notranslate"><span class="pre">gc.collect()</span></code> while the interpreter is already

  226. performing a collection is undefined.</p>

  227. </dd></dl>

  228. 

  229. <dl class="py function">

  230. <dt class="sig sig-object py" id="gc.set_debug">

  231. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">set_debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.set_debug" title="Link to this definition">¶</a></dt>

  232. <dd><p>Set the garbage collection debugging flags. Debugging information will be

  233. written to <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code>.  See below for a list of debugging flags which can be

  234. combined using bit operations to control debugging.</p>

  235. </dd></dl>

  236. 

  237. <dl class="py function">

  238. <dt class="sig sig-object py" id="gc.get_debug">

  239. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_debug</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_debug" title="Link to this definition">¶</a></dt>

  240. <dd><p>Return the debugging flags currently set.</p>

  241. </dd></dl>

  242. 

  243. <dl class="py function">

  244. <dt class="sig sig-object py" id="gc.get_objects">

  245. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_objects</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">generation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_objects" title="Link to this definition">¶</a></dt>

  246. <dd><p>Returns a list of all objects tracked by the collector, excluding the list

  247. returned. If <em>generation</em> is not None, return only the objects tracked by

  248. the collector that are in that generation.</p>

  249. <div class="versionchanged">

  250. <p><span class="versionmodified changed">Changed in version 3.8: </span>New <em>generation</em> parameter.</p>

  251. </div>

  252. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">gc.get_objects</span></code> with argument <code class="docutils literal notranslate"><span class="pre">generation</span></code>.</p>

  253. </dd></dl>

  254. 

  255. <dl class="py function">

  256. <dt class="sig sig-object py" id="gc.get_stats">

  257. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_stats</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_stats" title="Link to this definition">¶</a></dt>

  258. <dd><p>Return a list of three per-generation dictionaries containing collection

  259. statistics since interpreter start.  The number of keys may change

  260. in the future, but currently each dictionary will contain the following

  261. items:</p>

  262. <ul class="simple">

  263. <li><p><code class="docutils literal notranslate"><span class="pre">collections</span></code> is the number of times this generation was collected;</p></li>

  264. <li><p><code class="docutils literal notranslate"><span class="pre">collected</span></code> is the total number of objects collected inside this

  265. generation;</p></li>

  266. <li><p><code class="docutils literal notranslate"><span class="pre">uncollectable</span></code> is the total number of objects which were found

  267. to be uncollectable (and were therefore moved to the <a class="reference internal" href="#gc.garbage" title="gc.garbage"><code class="xref py py-data docutils literal notranslate"><span class="pre">garbage</span></code></a>

  268. list) inside this generation.</p></li>

  269. </ul>

  270. <div class="versionadded">

  271. <p><span class="versionmodified added">New in version 3.4.</span></p>

  272. </div>

  273. </dd></dl>

  274. 

  275. <dl class="py function">

  276. <dt class="sig sig-object py" id="gc.set_threshold">

  277. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">set_threshold</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">threshold0</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">threshold1</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">threshold2</span></span></em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.set_threshold" title="Link to this definition">¶</a></dt>

  278. <dd><p>Set the garbage collection thresholds (the collection frequency). Setting

  279. <em>threshold0</em> to zero disables collection.</p>

  280. <p>The GC classifies objects into three generations depending on how many

  281. collection sweeps they have survived.  New objects are placed in the youngest

  282. generation (generation <code class="docutils literal notranslate"><span class="pre">0</span></code>).  If an object survives a collection it is moved

  283. into the next older generation.  Since generation <code class="docutils literal notranslate"><span class="pre">2</span></code> is the oldest

  284. generation, objects in that generation remain there after a collection.  In

  285. order to decide when to run, the collector keeps track of the number object

  286. allocations and deallocations since the last collection.  When the number of

  287. allocations minus the number of deallocations exceeds <em>threshold0</em>, collection

  288. starts.  Initially only generation <code class="docutils literal notranslate"><span class="pre">0</span></code> is examined.  If generation <code class="docutils literal notranslate"><span class="pre">0</span></code> has

  289. been examined more than <em>threshold1</em> times since generation <code class="docutils literal notranslate"><span class="pre">1</span></code> has been

  290. examined, then generation <code class="docutils literal notranslate"><span class="pre">1</span></code> is examined as well.

  291. With the third generation, things are a bit more complicated,

  292. see <a class="reference external" href="https://devguide.python.org/garbage_collector/#collecting-the-oldest-generation">Collecting the oldest generation</a> for more information.</p>

  293. </dd></dl>

  294. 

  295. <dl class="py function">

  296. <dt class="sig sig-object py" id="gc.get_count">

  297. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_count</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_count" title="Link to this definition">¶</a></dt>

  298. <dd><p>Return the current collection  counts as a tuple of <code class="docutils literal notranslate"><span class="pre">(count0,</span> <span class="pre">count1,</span>

  299. <span class="pre">count2)</span></code>.</p>

  300. </dd></dl>

  301. 

  302. <dl class="py function">

  303. <dt class="sig sig-object py" id="gc.get_threshold">

  304. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_threshold</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_threshold" title="Link to this definition">¶</a></dt>

  305. <dd><p>Return the current collection thresholds as a tuple of <code class="docutils literal notranslate"><span class="pre">(threshold0,</span>

  306. <span class="pre">threshold1,</span> <span class="pre">threshold2)</span></code>.</p>

  307. </dd></dl>

  308. 

  309. <dl class="py function">

  310. <dt class="sig sig-object py" id="gc.get_referrers">

  311. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_referrers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">objs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_referrers" title="Link to this definition">¶</a></dt>

  312. <dd><p>Return the list of objects that directly refer to any of objs. This function

  313. will only locate those containers which support garbage collection; extension

  314. types which do refer to other objects but do not support garbage collection will

  315. not be found.</p>

  316. <p>Note that objects which have already been dereferenced, but which live in cycles

  317. and have not yet been collected by the garbage collector can be listed among the

  318. resulting referrers.  To get only currently live objects, call <a class="reference internal" href="#gc.collect" title="gc.collect"><code class="xref py py-func docutils literal notranslate"><span class="pre">collect()</span></code></a>

  319. before calling <a class="reference internal" href="#gc.get_referrers" title="gc.get_referrers"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_referrers()</span></code></a>.</p>

  320. <div class="admonition warning">

  321. <p class="admonition-title">Warning</p>

  322. <p>Care must be taken when using objects returned by <a class="reference internal" href="#gc.get_referrers" title="gc.get_referrers"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_referrers()</span></code></a> because

  323. some of them could still be under construction and hence in a temporarily

  324. invalid state. Avoid using <a class="reference internal" href="#gc.get_referrers" title="gc.get_referrers"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_referrers()</span></code></a> for any purpose other than

  325. debugging.</p>

  326. </div>

  327. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">gc.get_referrers</span></code> with argument <code class="docutils literal notranslate"><span class="pre">objs</span></code>.</p>

  328. </dd></dl>

  329. 

  330. <dl class="py function">

  331. <dt class="sig sig-object py" id="gc.get_referents">

  332. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_referents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">objs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_referents" title="Link to this definition">¶</a></dt>

  333. <dd><p>Return a list of objects directly referred to by any of the arguments. The

  334. referents returned are those objects visited by the arguments’ C-level

  335. <a class="reference internal" href="../c-api/typeobj.html#c.PyTypeObject.tp_traverse" title="PyTypeObject.tp_traverse"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_traverse</span></code></a> methods (if any), and may not be all objects actually

  336. directly reachable.  <a class="reference internal" href="../c-api/typeobj.html#c.PyTypeObject.tp_traverse" title="PyTypeObject.tp_traverse"><code class="xref c c-member docutils literal notranslate"><span class="pre">tp_traverse</span></code></a> methods are supported only by objects

  337. that support garbage collection, and are only required to visit objects that may

  338. be involved in a cycle.  So, for example, if an integer is directly reachable

  339. from an argument, that integer object may or may not appear in the result list.</p>

  340. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">gc.get_referents</span></code> with argument <code class="docutils literal notranslate"><span class="pre">objs</span></code>.</p>

  341. </dd></dl>

  342. 

  343. <dl class="py function">

  344. <dt class="sig sig-object py" id="gc.is_tracked">

  345. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">is_tracked</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.is_tracked" title="Link to this definition">¶</a></dt>

  346. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the object is currently tracked by the garbage collector,

  347. <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.  As a general rule, instances of atomic types aren’t

  348. tracked and instances of non-atomic types (containers, user-defined

  349. objects…) are.  However, some type-specific optimizations can be present

  350. in order to suppress the garbage collector footprint of simple instances

  351. (e.g. dicts containing only atomic keys and values):</p>

  352. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  353. <span class="go">False</span>

  354. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span>

  355. <span class="go">False</span>

  356. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">([])</span>

  357. <span class="go">True</span>

  358. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">({})</span>

  359. <span class="go">False</span>

  360. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>

  361. <span class="go">False</span>

  362. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_tracked</span><span class="p">({</span><span class="s2">&quot;a&quot;</span><span class="p">:</span> <span class="p">[]})</span>

  363. <span class="go">True</span>

  364. </pre></div>

  365. </div>

  366. <div class="versionadded">

  367. <p><span class="versionmodified added">New in version 3.1.</span></p>

  368. </div>

  369. </dd></dl>

  370. 

  371. <dl class="py function">

  372. <dt class="sig sig-object py" id="gc.is_finalized">

  373. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">is_finalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gc.is_finalized" title="Link to this definition">¶</a></dt>

  374. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the given object has been finalized by the

  375. garbage collector, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>

  376. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">x</span> <span class="o">=</span> <span class="kc">None</span>

  377. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Lazarus</span><span class="p">:</span>

  378. <span class="gp">... </span>    <span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  379. <span class="gp">... </span>        <span class="k">global</span> <span class="n">x</span>

  380. <span class="gp">... </span>        <span class="n">x</span> <span class="o">=</span> <span class="bp">self</span>

  381. <span class="gp">...</span>

  382. <span class="gp">&gt;&gt;&gt; </span><span class="n">lazarus</span> <span class="o">=</span> <span class="n">Lazarus</span><span class="p">()</span>

  383. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_finalized</span><span class="p">(</span><span class="n">lazarus</span><span class="p">)</span>

  384. <span class="go">False</span>

  385. <span class="gp">&gt;&gt;&gt; </span><span class="k">del</span> <span class="n">lazarus</span>

  386. <span class="gp">&gt;&gt;&gt; </span><span class="n">gc</span><span class="o">.</span><span class="n">is_finalized</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>

  387. <span class="go">True</span>

  388. </pre></div>

  389. </div>

  390. <div class="versionadded">

  391. <p><span class="versionmodified added">New in version 3.9.</span></p>

  392. </div>

  393. </dd></dl>

  394. 

  395. <dl class="py function">

  396. <dt class="sig sig-object py" id="gc.freeze">

  397. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">freeze</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.freeze" title="Link to this definition">¶</a></dt>

  398. <dd><p>Freeze all the objects tracked by the garbage collector; move them to a

  399. permanent generation and ignore them in all the future collections.</p>

  400. <p>If a process will <code class="docutils literal notranslate"><span class="pre">fork()</span></code> without <code class="docutils literal notranslate"><span class="pre">exec()</span></code>, avoiding unnecessary

  401. copy-on-write in child processes will maximize memory sharing and reduce

  402. overall memory usage. This requires both avoiding creation of freed “holes”

  403. in memory pages in the parent process and ensuring that GC collections in

  404. child processes won’t touch the <code class="docutils literal notranslate"><span class="pre">gc_refs</span></code> counter of long-lived objects

  405. originating in the parent process. To accomplish both, call <code class="docutils literal notranslate"><span class="pre">gc.disable()</span></code>

  406. early in the parent process, <code class="docutils literal notranslate"><span class="pre">gc.freeze()</span></code> right before <code class="docutils literal notranslate"><span class="pre">fork()</span></code>, and

  407. <code class="docutils literal notranslate"><span class="pre">gc.enable()</span></code> early in child processes.</p>

  408. <div class="versionadded">

  409. <p><span class="versionmodified added">New in version 3.7.</span></p>

  410. </div>

  411. </dd></dl>

  412. 

  413. <dl class="py function">

  414. <dt class="sig sig-object py" id="gc.unfreeze">

  415. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">unfreeze</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.unfreeze" title="Link to this definition">¶</a></dt>

  416. <dd><p>Unfreeze the objects in the permanent generation, put them back into the

  417. oldest generation.</p>

  418. <div class="versionadded">

  419. <p><span class="versionmodified added">New in version 3.7.</span></p>

  420. </div>

  421. </dd></dl>

  422. 

  423. <dl class="py function">

  424. <dt class="sig sig-object py" id="gc.get_freeze_count">

  425. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">get_freeze_count</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gc.get_freeze_count" title="Link to this definition">¶</a></dt>

  426. <dd><p>Return the number of objects in the permanent generation.</p>

  427. <div class="versionadded">

  428. <p><span class="versionmodified added">New in version 3.7.</span></p>

  429. </div>

  430. </dd></dl>

  431. 

  432. <p>The following variables are provided for read-only access (you can mutate the

  433. values but should not rebind them):</p>

  434. <dl class="py data">

  435. <dt class="sig sig-object py" id="gc.garbage">

  436. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">garbage</span></span><a class="headerlink" href="#gc.garbage" title="Link to this definition">¶</a></dt>

  437. <dd><p>A list of objects which the collector found to be unreachable but could

  438. not be freed (uncollectable objects).  Starting with Python 3.4, this

  439. list should be empty most of the time, except when using instances of

  440. C extension types with a non-<code class="docutils literal notranslate"><span class="pre">NULL</span></code> <code class="docutils literal notranslate"><span class="pre">tp_del</span></code> slot.</p>

  441. <p>If <a class="reference internal" href="#gc.DEBUG_SAVEALL" title="gc.DEBUG_SAVEALL"><code class="xref py py-const docutils literal notranslate"><span class="pre">DEBUG_SAVEALL</span></code></a> is set, then all unreachable objects will be

  442. added to this list rather than freed.</p>

  443. <div class="versionchanged">

  444. <p><span class="versionmodified changed">Changed in version 3.2: </span>If this list is non-empty at <a class="reference internal" href="../glossary.html#term-interpreter-shutdown"><span class="xref std std-term">interpreter shutdown</span></a>, a

  445. <a class="reference internal" href="exceptions.html#ResourceWarning" title="ResourceWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResourceWarning</span></code></a> is emitted, which is silent by default.  If

  446. <a class="reference internal" href="#gc.DEBUG_UNCOLLECTABLE" title="gc.DEBUG_UNCOLLECTABLE"><code class="xref py py-const docutils literal notranslate"><span class="pre">DEBUG_UNCOLLECTABLE</span></code></a> is set, in addition all uncollectable objects

  447. are printed.</p>

  448. </div>

  449. <div class="versionchanged">

  450. <p><span class="versionmodified changed">Changed in version 3.4: </span>Following <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0442/"><strong>PEP 442</strong></a>, objects with a <a class="reference internal" href="../reference/datamodel.html#object.__del__" title="object.__del__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__del__()</span></code></a> method don’t end

  451. up in <a class="reference internal" href="#gc.garbage" title="gc.garbage"><code class="xref py py-data docutils literal notranslate"><span class="pre">gc.garbage</span></code></a> anymore.</p>

  452. </div>

  453. </dd></dl>

  454. 

  455. <dl class="py data">

  456. <dt class="sig sig-object py" id="gc.callbacks">

  457. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">callbacks</span></span><a class="headerlink" href="#gc.callbacks" title="Link to this definition">¶</a></dt>

  458. <dd><p>A list of callbacks that will be invoked by the garbage collector before and

  459. after collection.  The callbacks will be called with two arguments,

  460. <em>phase</em> and <em>info</em>.</p>

  461. <p><em>phase</em> can be one of two values:</p>

  462. <blockquote>

  463. <div><p>“start”: The garbage collection is about to start.</p>

  464. <p>“stop”: The garbage collection has finished.</p>

  465. </div></blockquote>

  466. <p><em>info</em> is a dict providing more information for the callback.  The following

  467. keys are currently defined:</p>

  468. <blockquote>

  469. <div><p>“generation”: The oldest generation being collected.</p>

  470. <p>“collected”: When <em>phase</em> is “stop”, the number of objects

  471. successfully collected.</p>

  472. <p>“uncollectable”: When <em>phase</em> is “stop”, the number of objects

  473. that could not be collected and were put in <a class="reference internal" href="#gc.garbage" title="gc.garbage"><code class="xref py py-data docutils literal notranslate"><span class="pre">garbage</span></code></a>.</p>

  474. </div></blockquote>

  475. <p>Applications can add their own callbacks to this list.  The primary

  476. use cases are:</p>

  477. <blockquote>

  478. <div><p>Gathering statistics about garbage collection, such as how often

  479. various generations are collected, and how long the collection

  480. takes.</p>

  481. <p>Allowing applications to identify and clear their own uncollectable

  482. types when they appear in <a class="reference internal" href="#gc.garbage" title="gc.garbage"><code class="xref py py-data docutils literal notranslate"><span class="pre">garbage</span></code></a>.</p>

  483. </div></blockquote>

  484. <div class="versionadded">

  485. <p><span class="versionmodified added">New in version 3.3.</span></p>

  486. </div>

  487. </dd></dl>

  488. 

  489. <p>The following constants are provided for use with <a class="reference internal" href="#gc.set_debug" title="gc.set_debug"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_debug()</span></code></a>:</p>

  490. <dl class="py data">

  491. <dt class="sig sig-object py" id="gc.DEBUG_STATS">

  492. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">DEBUG_STATS</span></span><a class="headerlink" href="#gc.DEBUG_STATS" title="Link to this definition">¶</a></dt>

  493. <dd><p>Print statistics during collection.  This information can be useful when tuning

  494. the collection frequency.</p>

  495. </dd></dl>

  496. 

  497. <dl class="py data">

  498. <dt class="sig sig-object py" id="gc.DEBUG_COLLECTABLE">

  499. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">DEBUG_COLLECTABLE</span></span><a class="headerlink" href="#gc.DEBUG_COLLECTABLE" title="Link to this definition">¶</a></dt>

  500. <dd><p>Print information on collectable objects found.</p>

  501. </dd></dl>

  502. 

  503. <dl class="py data">

  504. <dt class="sig sig-object py" id="gc.DEBUG_UNCOLLECTABLE">

  505. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">DEBUG_UNCOLLECTABLE</span></span><a class="headerlink" href="#gc.DEBUG_UNCOLLECTABLE" title="Link to this definition">¶</a></dt>

  506. <dd><p>Print information of uncollectable objects found (objects which are not

  507. reachable but cannot be freed by the collector).  These objects will be added

  508. to the <code class="docutils literal notranslate"><span class="pre">garbage</span></code> list.</p>

  509. <div class="versionchanged">

  510. <p><span class="versionmodified changed">Changed in version 3.2: </span>Also print the contents of the <a class="reference internal" href="#gc.garbage" title="gc.garbage"><code class="xref py py-data docutils literal notranslate"><span class="pre">garbage</span></code></a> list at

  511. <a class="reference internal" href="../glossary.html#term-interpreter-shutdown"><span class="xref std std-term">interpreter shutdown</span></a>, if it isn’t empty.</p>

  512. </div>

  513. </dd></dl>

  514. 

  515. <dl class="py data">

  516. <dt class="sig sig-object py" id="gc.DEBUG_SAVEALL">

  517. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">DEBUG_SAVEALL</span></span><a class="headerlink" href="#gc.DEBUG_SAVEALL" title="Link to this definition">¶</a></dt>

  518. <dd><p>When set, all unreachable objects found will be appended to <em>garbage</em> rather

  519. than being freed.  This can be useful for debugging a leaking program.</p>

  520. </dd></dl>

  521. 

  522. <dl class="py data">

  523. <dt class="sig sig-object py" id="gc.DEBUG_LEAK">

  524. <span class="sig-prename descclassname"><span class="pre">gc.</span></span><span class="sig-name descname"><span class="pre">DEBUG_LEAK</span></span><a class="headerlink" href="#gc.DEBUG_LEAK" title="Link to this definition">¶</a></dt>

  525. <dd><p>The debugging flags necessary for the collector to print information about a

  526. leaking program (equal to <code class="docutils literal notranslate"><span class="pre">DEBUG_COLLECTABLE</span> <span class="pre">|</span> <span class="pre">DEBUG_UNCOLLECTABLE</span> <span class="pre">|</span>

  527. <span class="pre">DEBUG_SAVEALL</span></code>).</p>

  528. </dd></dl>

  529. 

  530. </section>

  531. 

  532. 

  533.             <div class="clearer"></div>

  534.           </div>

  535.         </div>

  536.       </div>

  537.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  538.         <div class="sphinxsidebarwrapper">

  539.   <div>

  540.     <h4>Previous topic</h4>

  541.     <p class="topless"><a href="__future__.html"

  542.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">__future__</span></code> — Future statement definitions</a></p>

  543.   </div>

  544.   <div>

  545.     <h4>Next topic</h4>

  546.     <p class="topless"><a href="inspect.html"

  547.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">inspect</span></code> — Inspect live objects</a></p>

  548.   </div>

  549.   <div role="note" aria-label="source link">

  550.     <h3>This Page</h3>

  551.     <ul class="this-page-menu">

  552.       <li><a href="../bugs.html">Report a Bug</a></li>

  553.       <li>

  554.         <a href="https://github.com/python/cpython/blob/main/Doc/library/gc.rst"

  555.             rel="nofollow">Show Source

  556.         </a>

  557.       </li>

  558.     </ul>

  559.   </div>

  560.         </div>

  561. <div id="sidebarbutton" title="Collapse sidebar">

  562. <span>«</span>

  563. </div>

  564. 

  565.       </div>

  566.       <div class="clearer"></div>

  567.     </div>  

  568.     <div class="related" role="navigation" aria-label="related navigation">

  569.       <h3>Navigation</h3>

  570.       <ul>

  571.         <li class="right" style="margin-right: 10px">

  572.           <a href="../genindex.html" title="General Index"

  573.              >index</a></li>

  574.         <li class="right" >

  575.           <a href="../py-modindex.html" title="Python Module Index"

  576.              >modules</a> |</li>

  577.         <li class="right" >

  578.           <a href="inspect.html" title="inspect — Inspect live objects"

  579.              >next</a> |</li>

  580.         <li class="right" >

  581.           <a href="__future__.html" title="__future__ — Future statement definitions"

  582.              >previous</a> |</li>

  583. 

  584.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  585.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  586.           <li class="switchers">

  587.             <div class="language_switcher_placeholder"></div>

  588.             <div class="version_switcher_placeholder"></div>

  589.           </li>

  590.           <li>

  591.               

  592.           </li>

  593.     <li id="cpython-language-and-version">

  594.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  595.     </li>

  596. 

  597.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  598.           <li class="nav-item nav-item-2"><a href="python.html" >Python Runtime Services</a> &#187;</li>

  599.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">gc</span></code> — Garbage Collector interface</a></li>

  600.                 <li class="right">

  601.                     

  602. 

  603.     <div class="inline-search" role="search">

  604.         <form class="inline-search" action="../search.html" method="get">

  605.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  606.           <input type="submit" value="Go" />

  607.         </form>

  608.     </div>

  609.                      |

  610.                 </li>

  611.             <li class="right">

  612. <label class="theme-selector-label">

  613.     Theme

  614.     <select class="theme-selector" oninput="activateTheme(this.value)">

  615.         <option value="auto" selected>Auto</option>

  616.         <option value="light">Light</option>

  617.         <option value="dark">Dark</option>

  618.     </select>

  619. </label> |</li>

  620.             

  621.       </ul>

  622.     </div>  

  623.     <div class="footer">

  624.     &copy; 

  625.       <a href="../copyright.html">

  626.     

  627.     Copyright

  628.     

  629.       </a>

  630.      2001-2024, Python Software Foundation.

  631.     <br />

  632.     This page is licensed under the Python Software Foundation License Version 2.

  633.     <br />

  634.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  635.     <br />

  636.     

  637.       See <a href="/license.html">History and License</a> for more information.<br />

  638.     

  639.     

  640.     <br />

  641. 

  642.     The Python Software Foundation is a non-profit corporation.

  643. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  644. <br />

  645.     <br />

  646.       Last updated on Apr 09, 2024 (13:47 UTC).

  647.     

  648.       <a href="/bugs.html">Found a bug</a>?

  649.     

  650.     <br />

  651. 

  652.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  653.     </div>

  654. 

  655.   </body>

  656. </html>
上海开阖软件有限公司 沪ICP备12045867号-1