~dkuhlman/python-training-materials/Materials

« back to all changes in this revision

Viewing changes to python-3.5.2-docs-html/library/tracemalloc.html

  • Committer: Dave Kuhlman
  • Date: 2017-04-15 16:24:56 UTC
  • Revision ID: dkuhlman@davekuhlman.org-20170415162456-iav9vozzg4iwqwv3
Updated docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
2
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
 
 
4
 
 
5
<html xmlns="http://www.w3.org/1999/xhtml">
 
6
  <head>
 
7
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
8
    
 
9
    <title>27.7. tracemalloc — Trace memory allocations &mdash; Python 3.5.2 documentation</title>
 
10
    
 
11
    <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
 
12
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
13
    
 
14
    <script type="text/javascript">
 
15
      var DOCUMENTATION_OPTIONS = {
 
16
        URL_ROOT:    '../',
 
17
        VERSION:     '3.5.2',
 
18
        COLLAPSE_INDEX: false,
 
19
        FILE_SUFFIX: '.html',
 
20
        HAS_SOURCE:  true
 
21
      };
 
22
    </script>
 
23
    <script type="text/javascript" src="../_static/jquery.js"></script>
 
24
    <script type="text/javascript" src="../_static/underscore.js"></script>
 
25
    <script type="text/javascript" src="../_static/doctools.js"></script>
 
26
    <script type="text/javascript" src="../_static/sidebar.js"></script>
 
27
    <link rel="search" type="application/opensearchdescription+xml"
 
28
          title="Search within Python 3.5.2 documentation"
 
29
          href="../_static/opensearch.xml"/>
 
30
    <link rel="author" title="About these documents" href="../about.html" />
 
31
    <link rel="copyright" title="Copyright" href="../copyright.html" />
 
32
    <link rel="top" title="Python 3.5.2 documentation" href="../contents.html" />
 
33
    <link rel="up" title="27. Debugging and Profiling" href="debug.html" />
 
34
    <link rel="next" title="28. Software Packaging and Distribution" href="distribution.html" />
 
35
    <link rel="prev" title="27.6. trace — Trace or track Python statement execution" href="trace.html" />
 
36
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 
37
    
 
38
    <script type="text/javascript" src="../_static/copybutton.js"></script>
 
39
    <script type="text/javascript" src="../_static/version_switch.js"></script>
 
40
    
 
41
    
 
42
 
 
43
 
 
44
  </head>
 
45
  <body role="document">  
 
46
    <div class="related" role="navigation" aria-label="related navigation">
 
47
      <h3>Navigation</h3>
 
48
      <ul>
 
49
        <li class="right" style="margin-right: 10px">
 
50
          <a href="../genindex.html" title="General Index"
 
51
             accesskey="I">index</a></li>
 
52
        <li class="right" >
 
53
          <a href="../py-modindex.html" title="Python Module Index"
 
54
             >modules</a> |</li>
 
55
        <li class="right" >
 
56
          <a href="distribution.html" title="28. Software Packaging and Distribution"
 
57
             accesskey="N">next</a> |</li>
 
58
        <li class="right" >
 
59
          <a href="trace.html" title="27.6. trace — Trace or track Python statement execution"
 
60
             accesskey="P">previous</a> |</li>
 
61
        <li><img src="../_static/py.png" alt=""
 
62
                 style="vertical-align: middle; margin-top: -1px"/></li>
 
63
        <li><a href="https://www.python.org/">Python</a> &raquo;</li>
 
64
        <li>
 
65
          <span class="version_switcher_placeholder">3.5.2</span>
 
66
          <a href="../index.html">Documentation </a> &raquo;
 
67
        </li>
 
68
 
 
69
          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &raquo;</li>
 
70
          <li class="nav-item nav-item-2"><a href="debug.html" accesskey="U">27. Debugging and Profiling</a> &raquo;</li>
 
71
    <li class="right">
 
72
        
 
73
 
 
74
    <div class="inline-search" style="display: none" role="search">
 
75
        <form class="inline-search" action="../search.html" method="get">
 
76
          <input placeholder="Quick search" type="text" name="q" />
 
77
          <input type="submit" value="Go" />
 
78
          <input type="hidden" name="check_keywords" value="yes" />
 
79
          <input type="hidden" name="area" value="default" />
 
80
        </form>
 
81
    </div>
 
82
    <script type="text/javascript">$('.inline-search').show(0);</script>
 
83
         |
 
84
    </li>
 
85
 
 
86
      </ul>
 
87
    </div>    
 
88
 
 
89
    <div class="document">
 
90
      <div class="documentwrapper">
 
91
        <div class="bodywrapper">
 
92
          <div class="body" role="main">
 
93
            
 
94
  <div class="section" id="module-tracemalloc">
 
95
<span id="tracemalloc-trace-memory-allocations"></span><h1>27.7. <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> &#8212; Trace memory allocations<a class="headerlink" href="#module-tracemalloc" title="Permalink to this headline">¶</a></h1>
 
96
<div class="versionadded">
 
97
<p><span class="versionmodified">New in version 3.4.</span></p>
 
98
</div>
 
99
<p><strong>Source code:</strong> <a class="reference external" href="https://hg.python.org/cpython/file/3.5/Lib/tracemalloc.py">Lib/tracemalloc.py</a></p>
 
100
<hr class="docutils" />
 
101
<p>The tracemalloc module is a debug tool to trace memory blocks allocated by
 
102
Python. It provides the following information:</p>
 
103
<ul class="simple">
 
104
<li>Traceback where an object was allocated</li>
 
105
<li>Statistics on allocated memory blocks per filename and per line number:
 
106
total size, number and average size of allocated memory blocks</li>
 
107
<li>Compute the differences between two snapshots to detect memory leaks</li>
 
108
</ul>
 
109
<p>To trace most memory blocks allocated by Python, the module should be started
 
110
as early as possible by setting the <span class="target" id="index-0"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONTRACEMALLOC"><code class="xref std std-envvar docutils literal"><span class="pre">PYTHONTRACEMALLOC</span></code></a> environment
 
111
variable to <code class="docutils literal"><span class="pre">1</span></code>, or by using <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal"><span class="pre">-X</span></code></a> <code class="docutils literal"><span class="pre">tracemalloc</span></code> command line
 
112
option. The <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">tracemalloc.start()</span></code></a> function can be called at runtime to
 
113
start tracing Python memory allocations.</p>
 
114
<p>By default, a trace of an allocated memory block only stores the most recent
 
115
frame (1 frame). To store 25 frames at startup: set the
 
116
<span class="target" id="index-1"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONTRACEMALLOC"><code class="xref std std-envvar docutils literal"><span class="pre">PYTHONTRACEMALLOC</span></code></a> environment variable to <code class="docutils literal"><span class="pre">25</span></code>, or use the
 
117
<a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal"><span class="pre">-X</span></code></a> <code class="docutils literal"><span class="pre">tracemalloc=25</span></code> command line option.</p>
 
118
<div class="section" id="examples">
 
119
<h2>27.7.1. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
 
120
<div class="section" id="display-the-top-10">
 
121
<h3>27.7.1.1. Display the top 10<a class="headerlink" href="#display-the-top-10" title="Permalink to this headline">¶</a></h3>
 
122
<p>Display the 10 files allocating the most memory:</p>
 
123
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tracemalloc</span>
 
124
 
 
125
<span class="n">tracemalloc</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
126
 
 
127
<span class="c1"># ... run your application ...</span>
 
128
 
 
129
<span class="n">snapshot</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">take_snapshot</span><span class="p">()</span>
 
130
<span class="n">top_stats</span> <span class="o">=</span> <span class="n">snapshot</span><span class="o">.</span><span class="n">statistics</span><span class="p">(</span><span class="s1">&#39;lineno&#39;</span><span class="p">)</span>
 
131
 
 
132
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;[ Top 10 ]&quot;</span><span class="p">)</span>
 
133
<span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="n">top_stats</span><span class="p">[:</span><span class="mi">10</span><span class="p">]:</span>
 
134
    <span class="nb">print</span><span class="p">(</span><span class="n">stat</span><span class="p">)</span>
 
135
</pre></div>
 
136
</div>
 
137
<p>Example of output of the Python test suite:</p>
 
138
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="p">[</span> <span class="n">Top</span> <span class="mi">10</span> <span class="p">]</span>
 
139
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">716</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">4855</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">39328</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">126</span> <span class="n">B</span>
 
140
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">284</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">521</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">3199</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">167</span> <span class="n">B</span>
 
141
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">collections</span><span class="o">/</span><span class="n">__init__</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">368</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">244</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">2315</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">108</span> <span class="n">B</span>
 
142
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">unittest</span><span class="o">/</span><span class="n">case</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">381</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">185</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">779</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">243</span> <span class="n">B</span>
 
143
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">unittest</span><span class="o">/</span><span class="n">case</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">402</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">154</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">378</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">416</span> <span class="n">B</span>
 
144
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">abc</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">133</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">88.7</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">347</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">262</span> <span class="n">B</span>
 
145
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">1446</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">70.4</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">911</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">79</span> <span class="n">B</span>
 
146
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">1454</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">52.0</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">25</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">2131</span> <span class="n">B</span>
 
147
<span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">5</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">49.7</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">148</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mi">344</span> <span class="n">B</span>
 
148
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">sysconfig</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">411</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">48.0</span> <span class="n">KiB</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">average</span><span class="o">=</span><span class="mf">48.0</span> <span class="n">KiB</span>
 
149
</pre></div>
 
150
</div>
 
151
<p>We can see that Python loaded <code class="docutils literal"><span class="pre">4.8</span> <span class="pre">MiB</span></code> data (bytecode and constants) from
 
152
modules and that the <a class="reference internal" href="collections.html#module-collections" title="collections: Container datatypes"><code class="xref py py-mod docutils literal"><span class="pre">collections</span></code></a> module allocated <code class="docutils literal"><span class="pre">244</span> <span class="pre">KiB</span></code> to build
 
153
<a class="reference internal" href="collections.html#collections.namedtuple" title="collections.namedtuple"><code class="xref py py-class docutils literal"><span class="pre">namedtuple</span></code></a> types.</p>
 
154
<p>See <a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.statistics()</span></code></a> for more options.</p>
 
155
</div>
 
156
<div class="section" id="compute-differences">
 
157
<h3>27.7.1.2. Compute differences<a class="headerlink" href="#compute-differences" title="Permalink to this headline">¶</a></h3>
 
158
<p>Take two snapshots and display the differences:</p>
 
159
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tracemalloc</span>
 
160
<span class="n">tracemalloc</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
161
<span class="c1"># ... start your application ...</span>
 
162
 
 
163
<span class="n">snapshot1</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">take_snapshot</span><span class="p">()</span>
 
164
<span class="c1"># ... call the function leaking memory ...</span>
 
165
<span class="n">snapshot2</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">take_snapshot</span><span class="p">()</span>
 
166
 
 
167
<span class="n">top_stats</span> <span class="o">=</span> <span class="n">snapshot2</span><span class="o">.</span><span class="n">compare_to</span><span class="p">(</span><span class="n">snapshot1</span><span class="p">,</span> <span class="s1">&#39;lineno&#39;</span><span class="p">)</span>
 
168
 
 
169
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;[ Top 10 differences ]&quot;</span><span class="p">)</span>
 
170
<span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="n">top_stats</span><span class="p">[:</span><span class="mi">10</span><span class="p">]:</span>
 
171
    <span class="nb">print</span><span class="p">(</span><span class="n">stat</span><span class="p">)</span>
 
172
</pre></div>
 
173
</div>
 
174
<p>Example of output before/after running some tests of the Python test suite:</p>
 
175
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="p">[</span> <span class="n">Top</span> <span class="mi">10</span> <span class="n">differences</span> <span class="p">]</span>
 
176
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">716</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">8173</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mi">4428</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">71332</span> <span class="p">(</span><span class="o">+</span><span class="mi">39369</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">117</span> <span class="n">B</span>
 
177
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">linecache</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">127</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">940</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mi">940</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">8106</span> <span class="p">(</span><span class="o">+</span><span class="mi">8106</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">119</span> <span class="n">B</span>
 
178
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">unittest</span><span class="o">/</span><span class="n">case</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">571</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">298</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mi">298</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">589</span> <span class="p">(</span><span class="o">+</span><span class="mi">589</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">519</span> <span class="n">B</span>
 
179
<span class="o">&lt;</span><span class="n">frozen</span> <span class="n">importlib</span><span class="o">.</span><span class="n">_bootstrap</span><span class="o">&gt;</span><span class="p">:</span><span class="mi">284</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">1005</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mi">166</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">7423</span> <span class="p">(</span><span class="o">+</span><span class="mi">1526</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">139</span> <span class="n">B</span>
 
180
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">mimetypes</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">217</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mi">112</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mi">112</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">1334</span> <span class="p">(</span><span class="o">+</span><span class="mi">1334</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">86</span> <span class="n">B</span>
 
181
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">http</span><span class="o">/</span><span class="n">server</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">848</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">96.0</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mf">96.0</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">1</span> <span class="p">(</span><span class="o">+</span><span class="mi">1</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mf">96.0</span> <span class="n">KiB</span>
 
182
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">inspect</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">1465</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">83.5</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mf">83.5</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">109</span> <span class="p">(</span><span class="o">+</span><span class="mi">109</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">784</span> <span class="n">B</span>
 
183
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">unittest</span><span class="o">/</span><span class="n">mock</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">491</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">77.7</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mf">77.7</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">143</span> <span class="p">(</span><span class="o">+</span><span class="mi">143</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">557</span> <span class="n">B</span>
 
184
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">urllib</span><span class="o">/</span><span class="n">parse</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">476</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">71.8</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mf">71.8</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">969</span> <span class="p">(</span><span class="o">+</span><span class="mi">969</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">76</span> <span class="n">B</span>
 
185
<span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">4</span><span class="o">/</span><span class="n">contextlib</span><span class="o">.</span><span class="n">py</span><span class="p">:</span><span class="mi">38</span><span class="p">:</span> <span class="n">size</span><span class="o">=</span><span class="mf">67.2</span> <span class="n">KiB</span> <span class="p">(</span><span class="o">+</span><span class="mf">67.2</span> <span class="n">KiB</span><span class="p">),</span> <span class="n">count</span><span class="o">=</span><span class="mi">126</span> <span class="p">(</span><span class="o">+</span><span class="mi">126</span><span class="p">),</span> <span class="n">average</span><span class="o">=</span><span class="mi">546</span> <span class="n">B</span>
 
186
</pre></div>
 
187
</div>
 
188
<p>We can see that Python has loaded <code class="docutils literal"><span class="pre">8.2</span> <span class="pre">MiB</span></code> of module data (bytecode and
 
189
constants), and that this is <code class="docutils literal"><span class="pre">4.4</span> <span class="pre">MiB</span></code> more than had been loaded before the
 
190
tests, when the previous snapshot was taken. Similarly, the <a class="reference internal" href="linecache.html#module-linecache" title="linecache: This module provides random access to individual lines from text files."><code class="xref py py-mod docutils literal"><span class="pre">linecache</span></code></a>
 
191
module has cached <code class="docutils literal"><span class="pre">940</span> <span class="pre">KiB</span></code> of Python source code to format tracebacks, all
 
192
of it since the previous snapshot.</p>
 
193
<p>If the system has little free memory, snapshots can be written on disk using
 
194
the <a class="reference internal" href="#tracemalloc.Snapshot.dump" title="tracemalloc.Snapshot.dump"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.dump()</span></code></a> method to analyze the snapshot offline. Then use the
 
195
<a class="reference internal" href="#tracemalloc.Snapshot.load" title="tracemalloc.Snapshot.load"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.load()</span></code></a> method reload the snapshot.</p>
 
196
</div>
 
197
<div class="section" id="get-the-traceback-of-a-memory-block">
 
198
<h3>27.7.1.3. Get the traceback of a memory block<a class="headerlink" href="#get-the-traceback-of-a-memory-block" title="Permalink to this headline">¶</a></h3>
 
199
<p>Code to display the traceback of the biggest memory block:</p>
 
200
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tracemalloc</span>
 
201
 
 
202
<span class="c1"># Store 25 frames</span>
 
203
<span class="n">tracemalloc</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="mi">25</span><span class="p">)</span>
 
204
 
 
205
<span class="c1"># ... run your application ...</span>
 
206
 
 
207
<span class="n">snapshot</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">take_snapshot</span><span class="p">()</span>
 
208
<span class="n">top_stats</span> <span class="o">=</span> <span class="n">snapshot</span><span class="o">.</span><span class="n">statistics</span><span class="p">(</span><span class="s1">&#39;traceback&#39;</span><span class="p">)</span>
 
209
 
 
210
<span class="c1"># pick the biggest memory block</span>
 
211
<span class="n">stat</span> <span class="o">=</span> <span class="n">top_stats</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
212
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> memory blocks: </span><span class="si">%.1f</span><span class="s2"> KiB&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">stat</span><span class="o">.</span><span class="n">count</span><span class="p">,</span> <span class="n">stat</span><span class="o">.</span><span class="n">size</span> <span class="o">/</span> <span class="mi">1024</span><span class="p">))</span>
 
213
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">stat</span><span class="o">.</span><span class="n">traceback</span><span class="o">.</span><span class="n">format</span><span class="p">():</span>
 
214
    <span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
 
215
</pre></div>
 
216
</div>
 
217
<p>Example of output of the Python test suite (traceback limited to 25 frames):</p>
 
218
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="mi">903</span> <span class="n">memory</span> <span class="n">blocks</span><span class="p">:</span> <span class="mf">870.1</span> <span class="n">KiB</span>
 
219
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">716</span>
 
220
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1036</span>
 
221
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">934</span>
 
222
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1068</span>
 
223
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">619</span>
 
224
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1581</span>
 
225
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1614</span>
 
226
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/doctest.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">101</span>
 
227
    <span class="kn">import</span> <span class="nn">pdb</span>
 
228
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">284</span>
 
229
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">938</span>
 
230
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1068</span>
 
231
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">619</span>
 
232
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1581</span>
 
233
  <span class="n">File</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1614</span>
 
234
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/support/__init__.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1728</span>
 
235
    <span class="kn">import</span> <span class="nn">doctest</span>
 
236
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/test_pickletools.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">21</span>
 
237
    <span class="n">support</span><span class="o">.</span><span class="n">run_doctest</span><span class="p">(</span><span class="n">pickletools</span><span class="p">)</span>
 
238
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/regrtest.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1276</span>
 
239
    <span class="n">test_runner</span><span class="p">()</span>
 
240
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/regrtest.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">976</span>
 
241
    <span class="n">display_failure</span><span class="o">=</span><span class="ow">not</span> <span class="n">verbose</span><span class="p">)</span>
 
242
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/regrtest.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">761</span>
 
243
    <span class="n">match_tests</span><span class="o">=</span><span class="n">ns</span><span class="o">.</span><span class="n">match_tests</span><span class="p">)</span>
 
244
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/regrtest.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">1563</span>
 
245
    <span class="n">main</span><span class="p">()</span>
 
246
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/test/__main__.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">3</span>
 
247
    <span class="n">regrtest</span><span class="o">.</span><span class="n">main_in_temp_cwd</span><span class="p">()</span>
 
248
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/runpy.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">73</span>
 
249
    <span class="n">exec</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">run_globals</span><span class="p">)</span>
 
250
  <span class="n">File</span> <span class="s2">&quot;/usr/lib/python3.4/runpy.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">160</span>
 
251
    <span class="s2">&quot;__main__&quot;</span><span class="p">,</span> <span class="n">fname</span><span class="p">,</span> <span class="n">loader</span><span class="p">,</span> <span class="n">pkg_name</span><span class="p">)</span>
 
252
</pre></div>
 
253
</div>
 
254
<p>We can see that the most memory was allocated in the <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal"><span class="pre">importlib</span></code></a> module to
 
255
load data (bytecode and constants) from modules: <code class="docutils literal"><span class="pre">870</span> <span class="pre">KiB</span></code>. The traceback is
 
256
where the <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal"><span class="pre">importlib</span></code></a> loaded data most recently: on the <code class="docutils literal"><span class="pre">import</span> <span class="pre">pdb</span></code>
 
257
line of the <a class="reference internal" href="doctest.html#module-doctest" title="doctest: Test pieces of code within docstrings."><code class="xref py py-mod docutils literal"><span class="pre">doctest</span></code></a> module. The traceback may change if a new module is
 
258
loaded.</p>
 
259
</div>
 
260
<div class="section" id="pretty-top">
 
261
<h3>27.7.1.4. Pretty top<a class="headerlink" href="#pretty-top" title="Permalink to this headline">¶</a></h3>
 
262
<p>Code to display the 10 lines allocating the most memory with a pretty output,
 
263
ignoring <code class="docutils literal"><span class="pre">&lt;frozen</span> <span class="pre">importlib._bootstrap&gt;</span></code> and <code class="docutils literal"><span class="pre">&lt;unknown&gt;</span></code> files:</p>
 
264
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">linecache</span>
 
265
<span class="kn">import</span> <span class="nn">os</span>
 
266
<span class="kn">import</span> <span class="nn">tracemalloc</span>
 
267
 
 
268
<span class="k">def</span> <span class="nf">display_top</span><span class="p">(</span><span class="n">snapshot</span><span class="p">,</span> <span class="n">group_by</span><span class="o">=</span><span class="s1">&#39;lineno&#39;</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="mi">10</span><span class="p">):</span>
 
269
    <span class="n">snapshot</span> <span class="o">=</span> <span class="n">snapshot</span><span class="o">.</span><span class="n">filter_traces</span><span class="p">((</span>
 
270
        <span class="n">tracemalloc</span><span class="o">.</span><span class="n">Filter</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="s2">&quot;&lt;frozen importlib._bootstrap&gt;&quot;</span><span class="p">),</span>
 
271
        <span class="n">tracemalloc</span><span class="o">.</span><span class="n">Filter</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="s2">&quot;&lt;unknown&gt;&quot;</span><span class="p">),</span>
 
272
    <span class="p">))</span>
 
273
    <span class="n">top_stats</span> <span class="o">=</span> <span class="n">snapshot</span><span class="o">.</span><span class="n">statistics</span><span class="p">(</span><span class="n">group_by</span><span class="p">)</span>
 
274
 
 
275
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Top </span><span class="si">%s</span><span class="s2"> lines&quot;</span> <span class="o">%</span> <span class="n">limit</span><span class="p">)</span>
 
276
    <span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">stat</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">top_stats</span><span class="p">[:</span><span class="n">limit</span><span class="p">],</span> <span class="mi">1</span><span class="p">):</span>
 
277
        <span class="n">frame</span> <span class="o">=</span> <span class="n">stat</span><span class="o">.</span><span class="n">traceback</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 
278
        <span class="c1"># replace &quot;/path/to/module/file.py&quot; with &quot;module/file.py&quot;</span>
 
279
        <span class="n">filename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">frame</span><span class="o">.</span><span class="n">filename</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">sep</span><span class="p">)[</span><span class="o">-</span><span class="mi">2</span><span class="p">:])</span>
 
280
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;#</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">: </span><span class="si">%.1f</span><span class="s2"> KiB&quot;</span>
 
281
              <span class="o">%</span> <span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">frame</span><span class="o">.</span><span class="n">lineno</span><span class="p">,</span> <span class="n">stat</span><span class="o">.</span><span class="n">size</span> <span class="o">/</span> <span class="mi">1024</span><span class="p">))</span>
 
282
        <span class="n">line</span> <span class="o">=</span> <span class="n">linecache</span><span class="o">.</span><span class="n">getline</span><span class="p">(</span><span class="n">frame</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="n">frame</span><span class="o">.</span><span class="n">lineno</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 
283
        <span class="k">if</span> <span class="n">line</span><span class="p">:</span>
 
284
            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
 
285
 
 
286
    <span class="n">other</span> <span class="o">=</span> <span class="n">top_stats</span><span class="p">[</span><span class="n">limit</span><span class="p">:]</span>
 
287
    <span class="k">if</span> <span class="n">other</span><span class="p">:</span>
 
288
        <span class="n">size</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">stat</span><span class="o">.</span><span class="n">size</span> <span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="n">other</span><span class="p">)</span>
 
289
        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> other: </span><span class="si">%.1f</span><span class="s2"> KiB&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">other</span><span class="p">),</span> <span class="n">size</span> <span class="o">/</span> <span class="mi">1024</span><span class="p">))</span>
 
290
    <span class="n">total</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">(</span><span class="n">stat</span><span class="o">.</span><span class="n">size</span> <span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="n">top_stats</span><span class="p">)</span>
 
291
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Total allocated size: </span><span class="si">%.1f</span><span class="s2"> KiB&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">total</span> <span class="o">/</span> <span class="mi">1024</span><span class="p">))</span>
 
292
 
 
293
<span class="n">tracemalloc</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 
294
 
 
295
<span class="c1"># ... run your application ...</span>
 
296
 
 
297
<span class="n">snapshot</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">take_snapshot</span><span class="p">()</span>
 
298
<span class="n">display_top</span><span class="p">(</span><span class="n">snapshot</span><span class="p">)</span>
 
299
</pre></div>
 
300
</div>
 
301
<p>Example of output of the Python test suite:</p>
 
302
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="n">Top</span> <span class="mi">10</span> <span class="n">lines</span>
 
303
<span class="c1">#1: Lib/base64.py:414: 419.8 KiB</span>
 
304
    <span class="n">_b85chars2</span> <span class="o">=</span> <span class="p">[(</span><span class="n">a</span> <span class="o">+</span> <span class="n">b</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">_b85chars</span> <span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">_b85chars</span><span class="p">]</span>
 
305
<span class="c1">#2: Lib/base64.py:306: 419.8 KiB</span>
 
306
    <span class="n">_a85chars2</span> <span class="o">=</span> <span class="p">[(</span><span class="n">a</span> <span class="o">+</span> <span class="n">b</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">_a85chars</span> <span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">_a85chars</span><span class="p">]</span>
 
307
<span class="c1">#3: collections/__init__.py:368: 293.6 KiB</span>
 
308
    <span class="n">exec</span><span class="p">(</span><span class="n">class_definition</span><span class="p">,</span> <span class="n">namespace</span><span class="p">)</span>
 
309
<span class="c1">#4: Lib/abc.py:133: 115.2 KiB</span>
 
310
    <span class="n">cls</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">__new__</span><span class="p">(</span><span class="n">mcls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">namespace</span><span class="p">)</span>
 
311
<span class="c1">#5: unittest/case.py:574: 103.1 KiB</span>
 
312
    <span class="n">testMethod</span><span class="p">()</span>
 
313
<span class="c1">#6: Lib/linecache.py:127: 95.4 KiB</span>
 
314
    <span class="n">lines</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">readlines</span><span class="p">()</span>
 
315
<span class="c1">#7: urllib/parse.py:476: 71.8 KiB</span>
 
316
    <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">_hexdig</span> <span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">_hexdig</span><span class="p">}</span>
 
317
<span class="c1">#8: &lt;string&gt;:5: 62.0 KiB</span>
 
318
<span class="c1">#9: Lib/_weakrefset.py:37: 60.0 KiB</span>
 
319
    <span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 
320
<span class="c1">#10: Lib/base64.py:142: 59.8 KiB</span>
 
321
    <span class="n">_b32tab2</span> <span class="o">=</span> <span class="p">[</span><span class="n">a</span> <span class="o">+</span> <span class="n">b</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">_b32tab</span> <span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">_b32tab</span><span class="p">]</span>
 
322
<span class="mi">6220</span> <span class="n">other</span><span class="p">:</span> <span class="mf">3602.8</span> <span class="n">KiB</span>
 
323
<span class="n">Total</span> <span class="n">allocated</span> <span class="n">size</span><span class="p">:</span> <span class="mf">5303.1</span> <span class="n">KiB</span>
 
324
</pre></div>
 
325
</div>
 
326
<p>See <a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.statistics()</span></code></a> for more options.</p>
 
327
</div>
 
328
</div>
 
329
<div class="section" id="api">
 
330
<h2>27.7.2. API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
 
331
<div class="section" id="functions">
 
332
<h3>27.7.2.1. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
 
333
<dl class="function">
 
334
<dt id="tracemalloc.clear_traces">
 
335
<code class="descclassname">tracemalloc.</code><code class="descname">clear_traces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.clear_traces" title="Permalink to this definition">¶</a></dt>
 
336
<dd><p>Clear traces of memory blocks allocated by Python.</p>
 
337
<p>See also <a class="reference internal" href="#tracemalloc.stop" title="tracemalloc.stop"><code class="xref py py-func docutils literal"><span class="pre">stop()</span></code></a>.</p>
 
338
</dd></dl>
 
339
 
 
340
<dl class="function">
 
341
<dt id="tracemalloc.get_object_traceback">
 
342
<code class="descclassname">tracemalloc.</code><code class="descname">get_object_traceback</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.get_object_traceback" title="Permalink to this definition">¶</a></dt>
 
343
<dd><p>Get the traceback where the Python object <em>obj</em> was allocated.
 
344
Return a <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a> instance, or <code class="docutils literal"><span class="pre">None</span></code> if the <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a>
 
345
module is not tracing memory allocations or did not trace the allocation of
 
346
the object.</p>
 
347
<p>See also <a class="reference internal" href="gc.html#gc.get_referrers" title="gc.get_referrers"><code class="xref py py-func docutils literal"><span class="pre">gc.get_referrers()</span></code></a> and <a class="reference internal" href="sys.html#sys.getsizeof" title="sys.getsizeof"><code class="xref py py-func docutils literal"><span class="pre">sys.getsizeof()</span></code></a> functions.</p>
 
348
</dd></dl>
 
349
 
 
350
<dl class="function">
 
351
<dt id="tracemalloc.get_traceback_limit">
 
352
<code class="descclassname">tracemalloc.</code><code class="descname">get_traceback_limit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.get_traceback_limit" title="Permalink to this definition">¶</a></dt>
 
353
<dd><p>Get the maximum number of frames stored in the traceback of a trace.</p>
 
354
<p>The <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module must be tracing memory allocations to
 
355
get the limit, otherwise an exception is raised.</p>
 
356
<p>The limit is set by the <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">start()</span></code></a> function.</p>
 
357
</dd></dl>
 
358
 
 
359
<dl class="function">
 
360
<dt id="tracemalloc.get_traced_memory">
 
361
<code class="descclassname">tracemalloc.</code><code class="descname">get_traced_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.get_traced_memory" title="Permalink to this definition">¶</a></dt>
 
362
<dd><p>Get the current size and peak size of memory blocks traced by the
 
363
<a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module as a tuple: <code class="docutils literal"><span class="pre">(current:</span> <span class="pre">int,</span> <span class="pre">peak:</span> <span class="pre">int)</span></code>.</p>
 
364
</dd></dl>
 
365
 
 
366
<dl class="function">
 
367
<dt id="tracemalloc.get_tracemalloc_memory">
 
368
<code class="descclassname">tracemalloc.</code><code class="descname">get_tracemalloc_memory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.get_tracemalloc_memory" title="Permalink to this definition">¶</a></dt>
 
369
<dd><p>Get the memory usage in bytes of the <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module used to store
 
370
traces of memory blocks.
 
371
Return an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal"><span class="pre">int</span></code></a>.</p>
 
372
</dd></dl>
 
373
 
 
374
<dl class="function">
 
375
<dt id="tracemalloc.is_tracing">
 
376
<code class="descclassname">tracemalloc.</code><code class="descname">is_tracing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.is_tracing" title="Permalink to this definition">¶</a></dt>
 
377
<dd><p><code class="docutils literal"><span class="pre">True</span></code> if the <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module is tracing Python memory
 
378
allocations, <code class="docutils literal"><span class="pre">False</span></code> otherwise.</p>
 
379
<p>See also <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">start()</span></code></a> and <a class="reference internal" href="#tracemalloc.stop" title="tracemalloc.stop"><code class="xref py py-func docutils literal"><span class="pre">stop()</span></code></a> functions.</p>
 
380
</dd></dl>
 
381
 
 
382
<dl class="function">
 
383
<dt id="tracemalloc.start">
 
384
<code class="descclassname">tracemalloc.</code><code class="descname">start</code><span class="sig-paren">(</span><em>nframe: int=1</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.start" title="Permalink to this definition">¶</a></dt>
 
385
<dd><p>Start tracing Python memory allocations: install hooks on Python memory
 
386
allocators. Collected tracebacks of traces will be limited to <em>nframe</em>
 
387
frames. By default, a trace of a memory block only stores the most recent
 
388
frame: the limit is <code class="docutils literal"><span class="pre">1</span></code>. <em>nframe</em> must be greater or equal to <code class="docutils literal"><span class="pre">1</span></code>.</p>
 
389
<p>Storing more than <code class="docutils literal"><span class="pre">1</span></code> frame is only useful to compute statistics grouped
 
390
by <code class="docutils literal"><span class="pre">'traceback'</span></code> or to compute cumulative statistics: see the
 
391
<a class="reference internal" href="#tracemalloc.Snapshot.compare_to" title="tracemalloc.Snapshot.compare_to"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.compare_to()</span></code></a> and <a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.statistics()</span></code></a> methods.</p>
 
392
<p>Storing more frames increases the memory and CPU overhead of the
 
393
<a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module. Use the <a class="reference internal" href="#tracemalloc.get_tracemalloc_memory" title="tracemalloc.get_tracemalloc_memory"><code class="xref py py-func docutils literal"><span class="pre">get_tracemalloc_memory()</span></code></a> function
 
394
to measure how much memory is used by the <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module.</p>
 
395
<p>The <span class="target" id="index-2"></span><a class="reference internal" href="../using/cmdline.html#envvar-PYTHONTRACEMALLOC"><code class="xref std std-envvar docutils literal"><span class="pre">PYTHONTRACEMALLOC</span></code></a> environment variable
 
396
(<code class="docutils literal"><span class="pre">PYTHONTRACEMALLOC=NFRAME</span></code>) and the <a class="reference internal" href="../using/cmdline.html#cmdoption-X"><code class="xref std std-option docutils literal"><span class="pre">-X</span></code></a> <code class="docutils literal"><span class="pre">tracemalloc=NFRAME</span></code>
 
397
command line option can be used to start tracing at startup.</p>
 
398
<p>See also <a class="reference internal" href="#tracemalloc.stop" title="tracemalloc.stop"><code class="xref py py-func docutils literal"><span class="pre">stop()</span></code></a>, <a class="reference internal" href="#tracemalloc.is_tracing" title="tracemalloc.is_tracing"><code class="xref py py-func docutils literal"><span class="pre">is_tracing()</span></code></a> and <a class="reference internal" href="#tracemalloc.get_traceback_limit" title="tracemalloc.get_traceback_limit"><code class="xref py py-func docutils literal"><span class="pre">get_traceback_limit()</span></code></a>
 
399
functions.</p>
 
400
</dd></dl>
 
401
 
 
402
<dl class="function">
 
403
<dt id="tracemalloc.stop">
 
404
<code class="descclassname">tracemalloc.</code><code class="descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.stop" title="Permalink to this definition">¶</a></dt>
 
405
<dd><p>Stop tracing Python memory allocations: uninstall hooks on Python memory
 
406
allocators. Also clears all previously collected traces of memory blocks
 
407
allocated by Python.</p>
 
408
<p>Call <a class="reference internal" href="#tracemalloc.take_snapshot" title="tracemalloc.take_snapshot"><code class="xref py py-func docutils literal"><span class="pre">take_snapshot()</span></code></a> function to take a snapshot of traces before
 
409
clearing them.</p>
 
410
<p>See also <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">start()</span></code></a>, <a class="reference internal" href="#tracemalloc.is_tracing" title="tracemalloc.is_tracing"><code class="xref py py-func docutils literal"><span class="pre">is_tracing()</span></code></a> and <a class="reference internal" href="#tracemalloc.clear_traces" title="tracemalloc.clear_traces"><code class="xref py py-func docutils literal"><span class="pre">clear_traces()</span></code></a>
 
411
functions.</p>
 
412
</dd></dl>
 
413
 
 
414
<dl class="function">
 
415
<dt id="tracemalloc.take_snapshot">
 
416
<code class="descclassname">tracemalloc.</code><code class="descname">take_snapshot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.take_snapshot" title="Permalink to this definition">¶</a></dt>
 
417
<dd><p>Take a snapshot of traces of memory blocks allocated by Python. Return a new
 
418
<a class="reference internal" href="#tracemalloc.Snapshot" title="tracemalloc.Snapshot"><code class="xref py py-class docutils literal"><span class="pre">Snapshot</span></code></a> instance.</p>
 
419
<p>The snapshot does not include memory blocks allocated before the
 
420
<a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module started to trace memory allocations.</p>
 
421
<p>Tracebacks of traces are limited to <a class="reference internal" href="#tracemalloc.get_traceback_limit" title="tracemalloc.get_traceback_limit"><code class="xref py py-func docutils literal"><span class="pre">get_traceback_limit()</span></code></a> frames. Use
 
422
the <em>nframe</em> parameter of the <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">start()</span></code></a> function to store more frames.</p>
 
423
<p>The <a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module must be tracing memory allocations to take a
 
424
snapshot, see the <a class="reference internal" href="#tracemalloc.start" title="tracemalloc.start"><code class="xref py py-func docutils literal"><span class="pre">start()</span></code></a> function.</p>
 
425
<p>See also the <a class="reference internal" href="#tracemalloc.get_object_traceback" title="tracemalloc.get_object_traceback"><code class="xref py py-func docutils literal"><span class="pre">get_object_traceback()</span></code></a> function.</p>
 
426
</dd></dl>
 
427
 
 
428
</div>
 
429
<div class="section" id="filter">
 
430
<h3>27.7.2.2. Filter<a class="headerlink" href="#filter" title="Permalink to this headline">¶</a></h3>
 
431
<dl class="class">
 
432
<dt id="tracemalloc.Filter">
 
433
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Filter</code><span class="sig-paren">(</span><em>inclusive: bool</em>, <em>filename_pattern: str</em>, <em>lineno: int=None</em>, <em>all_frames: bool=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Filter" title="Permalink to this definition">¶</a></dt>
 
434
<dd><p>Filter on traces of memory blocks.</p>
 
435
<p>See the <a class="reference internal" href="fnmatch.html#fnmatch.fnmatch" title="fnmatch.fnmatch"><code class="xref py py-func docutils literal"><span class="pre">fnmatch.fnmatch()</span></code></a> function for the syntax of
 
436
<em>filename_pattern</em>. The <code class="docutils literal"><span class="pre">'.pyc'</span></code> file extension is
 
437
replaced with <code class="docutils literal"><span class="pre">'.py'</span></code>.</p>
 
438
<p>Examples:</p>
 
439
<ul class="simple">
 
440
<li><code class="docutils literal"><span class="pre">Filter(True,</span> <span class="pre">subprocess.__file__)</span></code> only includes traces of the
 
441
<a class="reference internal" href="subprocess.html#module-subprocess" title="subprocess: Subprocess management."><code class="xref py py-mod docutils literal"><span class="pre">subprocess</span></code></a> module</li>
 
442
<li><code class="docutils literal"><span class="pre">Filter(False,</span> <span class="pre">tracemalloc.__file__)</span></code> excludes traces of the
 
443
<a class="reference internal" href="#module-tracemalloc" title="tracemalloc: Trace memory allocations."><code class="xref py py-mod docutils literal"><span class="pre">tracemalloc</span></code></a> module</li>
 
444
<li><code class="docutils literal"><span class="pre">Filter(False,</span> <span class="pre">&quot;&lt;unknown&gt;&quot;)</span></code> excludes empty tracebacks</li>
 
445
</ul>
 
446
<div class="versionchanged">
 
447
<p><span class="versionmodified">Changed in version 3.5: </span>The <code class="docutils literal"><span class="pre">'.pyo'</span></code> file extension is no longer replaced with <code class="docutils literal"><span class="pre">'.py'</span></code>.</p>
 
448
</div>
 
449
<dl class="attribute">
 
450
<dt id="tracemalloc.Filter.inclusive">
 
451
<code class="descname">inclusive</code><a class="headerlink" href="#tracemalloc.Filter.inclusive" title="Permalink to this definition">¶</a></dt>
 
452
<dd><p>If <em>inclusive</em> is <code class="docutils literal"><span class="pre">True</span></code> (include), only trace memory blocks allocated
 
453
in a file with a name matching <a class="reference internal" href="#tracemalloc.Filter.filename_pattern" title="tracemalloc.Filter.filename_pattern"><code class="xref py py-attr docutils literal"><span class="pre">filename_pattern</span></code></a> at line number
 
454
<a class="reference internal" href="#tracemalloc.Filter.lineno" title="tracemalloc.Filter.lineno"><code class="xref py py-attr docutils literal"><span class="pre">lineno</span></code></a>.</p>
 
455
<p>If <em>inclusive</em> is <code class="docutils literal"><span class="pre">False</span></code> (exclude), ignore memory blocks allocated in
 
456
a file with a name matching <a class="reference internal" href="#tracemalloc.Filter.filename_pattern" title="tracemalloc.Filter.filename_pattern"><code class="xref py py-attr docutils literal"><span class="pre">filename_pattern</span></code></a> at line number
 
457
<a class="reference internal" href="#tracemalloc.Filter.lineno" title="tracemalloc.Filter.lineno"><code class="xref py py-attr docutils literal"><span class="pre">lineno</span></code></a>.</p>
 
458
</dd></dl>
 
459
 
 
460
<dl class="attribute">
 
461
<dt id="tracemalloc.Filter.lineno">
 
462
<code class="descname">lineno</code><a class="headerlink" href="#tracemalloc.Filter.lineno" title="Permalink to this definition">¶</a></dt>
 
463
<dd><p>Line number (<code class="docutils literal"><span class="pre">int</span></code>) of the filter. If <em>lineno</em> is <code class="docutils literal"><span class="pre">None</span></code>, the filter
 
464
matches any line number.</p>
 
465
</dd></dl>
 
466
 
 
467
<dl class="attribute">
 
468
<dt id="tracemalloc.Filter.filename_pattern">
 
469
<code class="descname">filename_pattern</code><a class="headerlink" href="#tracemalloc.Filter.filename_pattern" title="Permalink to this definition">¶</a></dt>
 
470
<dd><p>Filename pattern of the filter (<code class="docutils literal"><span class="pre">str</span></code>).</p>
 
471
</dd></dl>
 
472
 
 
473
<dl class="attribute">
 
474
<dt id="tracemalloc.Filter.all_frames">
 
475
<code class="descname">all_frames</code><a class="headerlink" href="#tracemalloc.Filter.all_frames" title="Permalink to this definition">¶</a></dt>
 
476
<dd><p>If <em>all_frames</em> is <code class="docutils literal"><span class="pre">True</span></code>, all frames of the traceback are checked. If
 
477
<em>all_frames</em> is <code class="docutils literal"><span class="pre">False</span></code>, only the most recent frame is checked.</p>
 
478
<p>This attribute has no effect if the traceback limit is <code class="docutils literal"><span class="pre">1</span></code>.  See the
 
479
<a class="reference internal" href="#tracemalloc.get_traceback_limit" title="tracemalloc.get_traceback_limit"><code class="xref py py-func docutils literal"><span class="pre">get_traceback_limit()</span></code></a> function and <a class="reference internal" href="#tracemalloc.Snapshot.traceback_limit" title="tracemalloc.Snapshot.traceback_limit"><code class="xref py py-attr docutils literal"><span class="pre">Snapshot.traceback_limit</span></code></a>
 
480
attribute.</p>
 
481
</dd></dl>
 
482
 
 
483
</dd></dl>
 
484
 
 
485
</div>
 
486
<div class="section" id="frame">
 
487
<h3>27.7.2.3. Frame<a class="headerlink" href="#frame" title="Permalink to this headline">¶</a></h3>
 
488
<dl class="class">
 
489
<dt id="tracemalloc.Frame">
 
490
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Frame</code><a class="headerlink" href="#tracemalloc.Frame" title="Permalink to this definition">¶</a></dt>
 
491
<dd><p>Frame of a traceback.</p>
 
492
<p>The <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a> class is a sequence of <a class="reference internal" href="#tracemalloc.Frame" title="tracemalloc.Frame"><code class="xref py py-class docutils literal"><span class="pre">Frame</span></code></a> instances.</p>
 
493
<dl class="attribute">
 
494
<dt id="tracemalloc.Frame.filename">
 
495
<code class="descname">filename</code><a class="headerlink" href="#tracemalloc.Frame.filename" title="Permalink to this definition">¶</a></dt>
 
496
<dd><p>Filename (<code class="docutils literal"><span class="pre">str</span></code>).</p>
 
497
</dd></dl>
 
498
 
 
499
<dl class="attribute">
 
500
<dt id="tracemalloc.Frame.lineno">
 
501
<code class="descname">lineno</code><a class="headerlink" href="#tracemalloc.Frame.lineno" title="Permalink to this definition">¶</a></dt>
 
502
<dd><p>Line number (<code class="docutils literal"><span class="pre">int</span></code>).</p>
 
503
</dd></dl>
 
504
 
 
505
</dd></dl>
 
506
 
 
507
</div>
 
508
<div class="section" id="snapshot">
 
509
<h3>27.7.2.4. Snapshot<a class="headerlink" href="#snapshot" title="Permalink to this headline">¶</a></h3>
 
510
<dl class="class">
 
511
<dt id="tracemalloc.Snapshot">
 
512
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Snapshot</code><a class="headerlink" href="#tracemalloc.Snapshot" title="Permalink to this definition">¶</a></dt>
 
513
<dd><p>Snapshot of traces of memory blocks allocated by Python.</p>
 
514
<p>The <a class="reference internal" href="#tracemalloc.take_snapshot" title="tracemalloc.take_snapshot"><code class="xref py py-func docutils literal"><span class="pre">take_snapshot()</span></code></a> function creates a snapshot instance.</p>
 
515
<dl class="method">
 
516
<dt id="tracemalloc.Snapshot.compare_to">
 
517
<code class="descname">compare_to</code><span class="sig-paren">(</span><em>old_snapshot: Snapshot</em>, <em>group_by: str</em>, <em>cumulative: bool=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Snapshot.compare_to" title="Permalink to this definition">¶</a></dt>
 
518
<dd><p>Compute the differences with an old snapshot. Get statistics as a sorted
 
519
list of <a class="reference internal" href="#tracemalloc.StatisticDiff" title="tracemalloc.StatisticDiff"><code class="xref py py-class docutils literal"><span class="pre">StatisticDiff</span></code></a> instances grouped by <em>group_by</em>.</p>
 
520
<p>See the <a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.statistics()</span></code></a> method for <em>group_by</em> and <em>cumulative</em>
 
521
parameters.</p>
 
522
<p>The result is sorted from the biggest to the smallest by: absolute value
 
523
of <a class="reference internal" href="#tracemalloc.StatisticDiff.size_diff" title="tracemalloc.StatisticDiff.size_diff"><code class="xref py py-attr docutils literal"><span class="pre">StatisticDiff.size_diff</span></code></a>, <a class="reference internal" href="#tracemalloc.StatisticDiff.size" title="tracemalloc.StatisticDiff.size"><code class="xref py py-attr docutils literal"><span class="pre">StatisticDiff.size</span></code></a>, absolute
 
524
value of <a class="reference internal" href="#tracemalloc.StatisticDiff.count_diff" title="tracemalloc.StatisticDiff.count_diff"><code class="xref py py-attr docutils literal"><span class="pre">StatisticDiff.count_diff</span></code></a>, <a class="reference internal" href="#tracemalloc.Statistic.count" title="tracemalloc.Statistic.count"><code class="xref py py-attr docutils literal"><span class="pre">Statistic.count</span></code></a> and
 
525
then by <a class="reference internal" href="#tracemalloc.StatisticDiff.traceback" title="tracemalloc.StatisticDiff.traceback"><code class="xref py py-attr docutils literal"><span class="pre">StatisticDiff.traceback</span></code></a>.</p>
 
526
</dd></dl>
 
527
 
 
528
<dl class="method">
 
529
<dt id="tracemalloc.Snapshot.dump">
 
530
<code class="descname">dump</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Snapshot.dump" title="Permalink to this definition">¶</a></dt>
 
531
<dd><p>Write the snapshot into a file.</p>
 
532
<p>Use <a class="reference internal" href="#tracemalloc.Snapshot.load" title="tracemalloc.Snapshot.load"><code class="xref py py-meth docutils literal"><span class="pre">load()</span></code></a> to reload the snapshot.</p>
 
533
</dd></dl>
 
534
 
 
535
<dl class="method">
 
536
<dt id="tracemalloc.Snapshot.filter_traces">
 
537
<code class="descname">filter_traces</code><span class="sig-paren">(</span><em>filters</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Snapshot.filter_traces" title="Permalink to this definition">¶</a></dt>
 
538
<dd><p>Create a new <a class="reference internal" href="#tracemalloc.Snapshot" title="tracemalloc.Snapshot"><code class="xref py py-class docutils literal"><span class="pre">Snapshot</span></code></a> instance with a filtered <a class="reference internal" href="#tracemalloc.Snapshot.traces" title="tracemalloc.Snapshot.traces"><code class="xref py py-attr docutils literal"><span class="pre">traces</span></code></a>
 
539
sequence, <em>filters</em> is a list of <a class="reference internal" href="#tracemalloc.Filter" title="tracemalloc.Filter"><code class="xref py py-class docutils literal"><span class="pre">Filter</span></code></a> instances.  If <em>filters</em>
 
540
is an empty list, return a new <a class="reference internal" href="#tracemalloc.Snapshot" title="tracemalloc.Snapshot"><code class="xref py py-class docutils literal"><span class="pre">Snapshot</span></code></a> instance with a copy of
 
541
the traces.</p>
 
542
<p>All inclusive filters are applied at once, a trace is ignored if no
 
543
inclusive filters match it. A trace is ignored if at least one exclusive
 
544
filter matches it.</p>
 
545
</dd></dl>
 
546
 
 
547
<dl class="classmethod">
 
548
<dt id="tracemalloc.Snapshot.load">
 
549
<em class="property">classmethod </em><code class="descname">load</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Snapshot.load" title="Permalink to this definition">¶</a></dt>
 
550
<dd><p>Load a snapshot from a file.</p>
 
551
<p>See also <a class="reference internal" href="#tracemalloc.Snapshot.dump" title="tracemalloc.Snapshot.dump"><code class="xref py py-meth docutils literal"><span class="pre">dump()</span></code></a>.</p>
 
552
</dd></dl>
 
553
 
 
554
<dl class="method">
 
555
<dt id="tracemalloc.Snapshot.statistics">
 
556
<code class="descname">statistics</code><span class="sig-paren">(</span><em>group_by: str</em>, <em>cumulative: bool=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Snapshot.statistics" title="Permalink to this definition">¶</a></dt>
 
557
<dd><p>Get statistics as a sorted list of <a class="reference internal" href="#tracemalloc.Statistic" title="tracemalloc.Statistic"><code class="xref py py-class docutils literal"><span class="pre">Statistic</span></code></a> instances grouped
 
558
by <em>group_by</em>:</p>
 
559
<table border="1" class="docutils">
 
560
<colgroup>
 
561
<col width="47%" />
 
562
<col width="53%" />
 
563
</colgroup>
 
564
<thead valign="bottom">
 
565
<tr class="row-odd"><th class="head">group_by</th>
 
566
<th class="head">description</th>
 
567
</tr>
 
568
</thead>
 
569
<tbody valign="top">
 
570
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'filename'</span></code></td>
 
571
<td>filename</td>
 
572
</tr>
 
573
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'lineno'</span></code></td>
 
574
<td>filename and line number</td>
 
575
</tr>
 
576
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'traceback'</span></code></td>
 
577
<td>traceback</td>
 
578
</tr>
 
579
</tbody>
 
580
</table>
 
581
<p>If <em>cumulative</em> is <code class="docutils literal"><span class="pre">True</span></code>, cumulate size and count of memory blocks of
 
582
all frames of the traceback of a trace, not only the most recent frame.
 
583
The cumulative mode can only be used with <em>group_by</em> equals to
 
584
<code class="docutils literal"><span class="pre">'filename'</span></code> and <code class="docutils literal"><span class="pre">'lineno'</span></code>.</p>
 
585
<p>The result is sorted from the biggest to the smallest by:
 
586
<a class="reference internal" href="#tracemalloc.Statistic.size" title="tracemalloc.Statistic.size"><code class="xref py py-attr docutils literal"><span class="pre">Statistic.size</span></code></a>, <a class="reference internal" href="#tracemalloc.Statistic.count" title="tracemalloc.Statistic.count"><code class="xref py py-attr docutils literal"><span class="pre">Statistic.count</span></code></a> and then by
 
587
<a class="reference internal" href="#tracemalloc.Statistic.traceback" title="tracemalloc.Statistic.traceback"><code class="xref py py-attr docutils literal"><span class="pre">Statistic.traceback</span></code></a>.</p>
 
588
</dd></dl>
 
589
 
 
590
<dl class="attribute">
 
591
<dt id="tracemalloc.Snapshot.traceback_limit">
 
592
<code class="descname">traceback_limit</code><a class="headerlink" href="#tracemalloc.Snapshot.traceback_limit" title="Permalink to this definition">¶</a></dt>
 
593
<dd><p>Maximum number of frames stored in the traceback of <a class="reference internal" href="#tracemalloc.Snapshot.traces" title="tracemalloc.Snapshot.traces"><code class="xref py py-attr docutils literal"><span class="pre">traces</span></code></a>:
 
594
result of the <a class="reference internal" href="#tracemalloc.get_traceback_limit" title="tracemalloc.get_traceback_limit"><code class="xref py py-func docutils literal"><span class="pre">get_traceback_limit()</span></code></a> when the snapshot was taken.</p>
 
595
</dd></dl>
 
596
 
 
597
<dl class="attribute">
 
598
<dt id="tracemalloc.Snapshot.traces">
 
599
<code class="descname">traces</code><a class="headerlink" href="#tracemalloc.Snapshot.traces" title="Permalink to this definition">¶</a></dt>
 
600
<dd><p>Traces of all memory blocks allocated by Python: sequence of
 
601
<a class="reference internal" href="#tracemalloc.Trace" title="tracemalloc.Trace"><code class="xref py py-class docutils literal"><span class="pre">Trace</span></code></a> instances.</p>
 
602
<p>The sequence has an undefined order. Use the <a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-meth docutils literal"><span class="pre">Snapshot.statistics()</span></code></a>
 
603
method to get a sorted list of statistics.</p>
 
604
</dd></dl>
 
605
 
 
606
</dd></dl>
 
607
 
 
608
</div>
 
609
<div class="section" id="statistic">
 
610
<h3>27.7.2.5. Statistic<a class="headerlink" href="#statistic" title="Permalink to this headline">¶</a></h3>
 
611
<dl class="class">
 
612
<dt id="tracemalloc.Statistic">
 
613
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Statistic</code><a class="headerlink" href="#tracemalloc.Statistic" title="Permalink to this definition">¶</a></dt>
 
614
<dd><p>Statistic on memory allocations.</p>
 
615
<p><a class="reference internal" href="#tracemalloc.Snapshot.statistics" title="tracemalloc.Snapshot.statistics"><code class="xref py py-func docutils literal"><span class="pre">Snapshot.statistics()</span></code></a> returns a list of <a class="reference internal" href="#tracemalloc.Statistic" title="tracemalloc.Statistic"><code class="xref py py-class docutils literal"><span class="pre">Statistic</span></code></a> instances.</p>
 
616
<p>See also the <a class="reference internal" href="#tracemalloc.StatisticDiff" title="tracemalloc.StatisticDiff"><code class="xref py py-class docutils literal"><span class="pre">StatisticDiff</span></code></a> class.</p>
 
617
<dl class="attribute">
 
618
<dt id="tracemalloc.Statistic.count">
 
619
<code class="descname">count</code><a class="headerlink" href="#tracemalloc.Statistic.count" title="Permalink to this definition">¶</a></dt>
 
620
<dd><p>Number of memory blocks (<code class="docutils literal"><span class="pre">int</span></code>).</p>
 
621
</dd></dl>
 
622
 
 
623
<dl class="attribute">
 
624
<dt id="tracemalloc.Statistic.size">
 
625
<code class="descname">size</code><a class="headerlink" href="#tracemalloc.Statistic.size" title="Permalink to this definition">¶</a></dt>
 
626
<dd><p>Total size of memory blocks in bytes (<code class="docutils literal"><span class="pre">int</span></code>).</p>
 
627
</dd></dl>
 
628
 
 
629
<dl class="attribute">
 
630
<dt id="tracemalloc.Statistic.traceback">
 
631
<code class="descname">traceback</code><a class="headerlink" href="#tracemalloc.Statistic.traceback" title="Permalink to this definition">¶</a></dt>
 
632
<dd><p>Traceback where the memory block was allocated, <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a>
 
633
instance.</p>
 
634
</dd></dl>
 
635
 
 
636
</dd></dl>
 
637
 
 
638
</div>
 
639
<div class="section" id="statisticdiff">
 
640
<h3>27.7.2.6. StatisticDiff<a class="headerlink" href="#statisticdiff" title="Permalink to this headline">¶</a></h3>
 
641
<dl class="class">
 
642
<dt id="tracemalloc.StatisticDiff">
 
643
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">StatisticDiff</code><a class="headerlink" href="#tracemalloc.StatisticDiff" title="Permalink to this definition">¶</a></dt>
 
644
<dd><p>Statistic difference on memory allocations between an old and a new
 
645
<a class="reference internal" href="#tracemalloc.Snapshot" title="tracemalloc.Snapshot"><code class="xref py py-class docutils literal"><span class="pre">Snapshot</span></code></a> instance.</p>
 
646
<p><a class="reference internal" href="#tracemalloc.Snapshot.compare_to" title="tracemalloc.Snapshot.compare_to"><code class="xref py py-func docutils literal"><span class="pre">Snapshot.compare_to()</span></code></a> returns a list of <a class="reference internal" href="#tracemalloc.StatisticDiff" title="tracemalloc.StatisticDiff"><code class="xref py py-class docutils literal"><span class="pre">StatisticDiff</span></code></a>
 
647
instances. See also the <a class="reference internal" href="#tracemalloc.Statistic" title="tracemalloc.Statistic"><code class="xref py py-class docutils literal"><span class="pre">Statistic</span></code></a> class.</p>
 
648
<dl class="attribute">
 
649
<dt id="tracemalloc.StatisticDiff.count">
 
650
<code class="descname">count</code><a class="headerlink" href="#tracemalloc.StatisticDiff.count" title="Permalink to this definition">¶</a></dt>
 
651
<dd><p>Number of memory blocks in the new snapshot (<code class="docutils literal"><span class="pre">int</span></code>): <code class="docutils literal"><span class="pre">0</span></code> if
 
652
the memory blocks have been released in the new snapshot.</p>
 
653
</dd></dl>
 
654
 
 
655
<dl class="attribute">
 
656
<dt id="tracemalloc.StatisticDiff.count_diff">
 
657
<code class="descname">count_diff</code><a class="headerlink" href="#tracemalloc.StatisticDiff.count_diff" title="Permalink to this definition">¶</a></dt>
 
658
<dd><p>Difference of number of memory blocks between the old and the new
 
659
snapshots (<code class="docutils literal"><span class="pre">int</span></code>): <code class="docutils literal"><span class="pre">0</span></code> if the memory blocks have been allocated in
 
660
the new snapshot.</p>
 
661
</dd></dl>
 
662
 
 
663
<dl class="attribute">
 
664
<dt id="tracemalloc.StatisticDiff.size">
 
665
<code class="descname">size</code><a class="headerlink" href="#tracemalloc.StatisticDiff.size" title="Permalink to this definition">¶</a></dt>
 
666
<dd><p>Total size of memory blocks in bytes in the new snapshot (<code class="docutils literal"><span class="pre">int</span></code>):
 
667
<code class="docutils literal"><span class="pre">0</span></code> if the memory blocks have been released in the new snapshot.</p>
 
668
</dd></dl>
 
669
 
 
670
<dl class="attribute">
 
671
<dt id="tracemalloc.StatisticDiff.size_diff">
 
672
<code class="descname">size_diff</code><a class="headerlink" href="#tracemalloc.StatisticDiff.size_diff" title="Permalink to this definition">¶</a></dt>
 
673
<dd><p>Difference of total size of memory blocks in bytes between the old and
 
674
the new snapshots (<code class="docutils literal"><span class="pre">int</span></code>): <code class="docutils literal"><span class="pre">0</span></code> if the memory blocks have been
 
675
allocated in the new snapshot.</p>
 
676
</dd></dl>
 
677
 
 
678
<dl class="attribute">
 
679
<dt id="tracemalloc.StatisticDiff.traceback">
 
680
<code class="descname">traceback</code><a class="headerlink" href="#tracemalloc.StatisticDiff.traceback" title="Permalink to this definition">¶</a></dt>
 
681
<dd><p>Traceback where the memory blocks were allocated, <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a>
 
682
instance.</p>
 
683
</dd></dl>
 
684
 
 
685
</dd></dl>
 
686
 
 
687
</div>
 
688
<div class="section" id="trace">
 
689
<h3>27.7.2.7. Trace<a class="headerlink" href="#trace" title="Permalink to this headline">¶</a></h3>
 
690
<dl class="class">
 
691
<dt id="tracemalloc.Trace">
 
692
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Trace</code><a class="headerlink" href="#tracemalloc.Trace" title="Permalink to this definition">¶</a></dt>
 
693
<dd><p>Trace of a memory block.</p>
 
694
<p>The <a class="reference internal" href="#tracemalloc.Snapshot.traces" title="tracemalloc.Snapshot.traces"><code class="xref py py-attr docutils literal"><span class="pre">Snapshot.traces</span></code></a> attribute is a sequence of <a class="reference internal" href="#tracemalloc.Trace" title="tracemalloc.Trace"><code class="xref py py-class docutils literal"><span class="pre">Trace</span></code></a>
 
695
instances.</p>
 
696
<dl class="attribute">
 
697
<dt id="tracemalloc.Trace.size">
 
698
<code class="descname">size</code><a class="headerlink" href="#tracemalloc.Trace.size" title="Permalink to this definition">¶</a></dt>
 
699
<dd><p>Size of the memory block in bytes (<code class="docutils literal"><span class="pre">int</span></code>).</p>
 
700
</dd></dl>
 
701
 
 
702
<dl class="attribute">
 
703
<dt id="tracemalloc.Trace.traceback">
 
704
<code class="descname">traceback</code><a class="headerlink" href="#tracemalloc.Trace.traceback" title="Permalink to this definition">¶</a></dt>
 
705
<dd><p>Traceback where the memory block was allocated, <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a>
 
706
instance.</p>
 
707
</dd></dl>
 
708
 
 
709
</dd></dl>
 
710
 
 
711
</div>
 
712
<div class="section" id="traceback">
 
713
<h3>27.7.2.8. Traceback<a class="headerlink" href="#traceback" title="Permalink to this headline">¶</a></h3>
 
714
<dl class="class">
 
715
<dt id="tracemalloc.Traceback">
 
716
<em class="property">class </em><code class="descclassname">tracemalloc.</code><code class="descname">Traceback</code><a class="headerlink" href="#tracemalloc.Traceback" title="Permalink to this definition">¶</a></dt>
 
717
<dd><p>Sequence of <a class="reference internal" href="#tracemalloc.Frame" title="tracemalloc.Frame"><code class="xref py py-class docutils literal"><span class="pre">Frame</span></code></a> instances sorted from the most recent frame to
 
718
the oldest frame.</p>
 
719
<p>A traceback contains at least <code class="docutils literal"><span class="pre">1</span></code> frame. If the <code class="docutils literal"><span class="pre">tracemalloc</span></code> module
 
720
failed to get a frame, the filename <code class="docutils literal"><span class="pre">&quot;&lt;unknown&gt;&quot;</span></code> at line number <code class="docutils literal"><span class="pre">0</span></code> is
 
721
used.</p>
 
722
<p>When a snapshot is taken, tracebacks of traces are limited to
 
723
<a class="reference internal" href="#tracemalloc.get_traceback_limit" title="tracemalloc.get_traceback_limit"><code class="xref py py-func docutils literal"><span class="pre">get_traceback_limit()</span></code></a> frames. See the <a class="reference internal" href="#tracemalloc.take_snapshot" title="tracemalloc.take_snapshot"><code class="xref py py-func docutils literal"><span class="pre">take_snapshot()</span></code></a> function.</p>
 
724
<p>The <a class="reference internal" href="#tracemalloc.Trace.traceback" title="tracemalloc.Trace.traceback"><code class="xref py py-attr docutils literal"><span class="pre">Trace.traceback</span></code></a> attribute is an instance of <a class="reference internal" href="#tracemalloc.Traceback" title="tracemalloc.Traceback"><code class="xref py py-class docutils literal"><span class="pre">Traceback</span></code></a>
 
725
instance.</p>
 
726
<dl class="method">
 
727
<dt id="tracemalloc.Traceback.format">
 
728
<code class="descname">format</code><span class="sig-paren">(</span><em>limit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tracemalloc.Traceback.format" title="Permalink to this definition">¶</a></dt>
 
729
<dd><p>Format the traceback as a list of lines with newlines.  Use the
 
730
<a class="reference internal" href="linecache.html#module-linecache" title="linecache: This module provides random access to individual lines from text files."><code class="xref py py-mod docutils literal"><span class="pre">linecache</span></code></a> module to retrieve lines from the source code.  If
 
731
<em>limit</em> is set, only format the <em>limit</em> most recent frames.</p>
 
732
<p>Similar to the <a class="reference internal" href="traceback.html#traceback.format_tb" title="traceback.format_tb"><code class="xref py py-func docutils literal"><span class="pre">traceback.format_tb()</span></code></a> function, except that
 
733
<a class="reference internal" href="#tracemalloc.Traceback.format" title="tracemalloc.Traceback.format"><code class="xref py py-meth docutils literal"><span class="pre">format()</span></code></a> does not include newlines.</p>
 
734
<p>Example:</p>
 
735
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Traceback (most recent call first):&quot;</span><span class="p">)</span>
 
736
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">traceback</span><span class="p">:</span>
 
737
    <span class="nb">print</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
 
738
</pre></div>
 
739
</div>
 
740
<p>Output:</p>
 
741
<div class="highlight-python3"><div class="highlight"><pre><span></span><span class="n">Traceback</span> <span class="p">(</span><span class="n">most</span> <span class="n">recent</span> <span class="n">call</span> <span class="n">first</span><span class="p">):</span>
 
742
  <span class="n">File</span> <span class="s2">&quot;test.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">9</span>
 
743
    <span class="n">obj</span> <span class="o">=</span> <span class="n">Object</span><span class="p">()</span>
 
744
  <span class="n">File</span> <span class="s2">&quot;test.py&quot;</span><span class="p">,</span> <span class="n">line</span> <span class="mi">12</span>
 
745
    <span class="n">tb</span> <span class="o">=</span> <span class="n">tracemalloc</span><span class="o">.</span><span class="n">get_object_traceback</span><span class="p">(</span><span class="n">f</span><span class="p">())</span>
 
746
</pre></div>
 
747
</div>
 
748
</dd></dl>
 
749
 
 
750
</dd></dl>
 
751
 
 
752
</div>
 
753
</div>
 
754
</div>
 
755
 
 
756
 
 
757
          </div>
 
758
        </div>
 
759
      </div>
 
760
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 
761
        <div class="sphinxsidebarwrapper">
 
762
  <h3><a href="../contents.html">Table Of Contents</a></h3>
 
763
  <ul>
 
764
<li><a class="reference internal" href="#">27.7. <code class="docutils literal"><span class="pre">tracemalloc</span></code> &#8212; Trace memory allocations</a><ul>
 
765
<li><a class="reference internal" href="#examples">27.7.1. Examples</a><ul>
 
766
<li><a class="reference internal" href="#display-the-top-10">27.7.1.1. Display the top 10</a></li>
 
767
<li><a class="reference internal" href="#compute-differences">27.7.1.2. Compute differences</a></li>
 
768
<li><a class="reference internal" href="#get-the-traceback-of-a-memory-block">27.7.1.3. Get the traceback of a memory block</a></li>
 
769
<li><a class="reference internal" href="#pretty-top">27.7.1.4. Pretty top</a></li>
 
770
</ul>
 
771
</li>
 
772
<li><a class="reference internal" href="#api">27.7.2. API</a><ul>
 
773
<li><a class="reference internal" href="#functions">27.7.2.1. Functions</a></li>
 
774
<li><a class="reference internal" href="#filter">27.7.2.2. Filter</a></li>
 
775
<li><a class="reference internal" href="#frame">27.7.2.3. Frame</a></li>
 
776
<li><a class="reference internal" href="#snapshot">27.7.2.4. Snapshot</a></li>
 
777
<li><a class="reference internal" href="#statistic">27.7.2.5. Statistic</a></li>
 
778
<li><a class="reference internal" href="#statisticdiff">27.7.2.6. StatisticDiff</a></li>
 
779
<li><a class="reference internal" href="#trace">27.7.2.7. Trace</a></li>
 
780
<li><a class="reference internal" href="#traceback">27.7.2.8. Traceback</a></li>
 
781
</ul>
 
782
</li>
 
783
</ul>
 
784
</li>
 
785
</ul>
 
786
 
 
787
  <h4>Previous topic</h4>
 
788
  <p class="topless"><a href="trace.html"
 
789
                        title="previous chapter">27.6. <code class="docutils literal"><span class="pre">trace</span></code> &#8212; Trace or track Python statement execution</a></p>
 
790
  <h4>Next topic</h4>
 
791
  <p class="topless"><a href="distribution.html"
 
792
                        title="next chapter">28. Software Packaging and Distribution</a></p>
 
793
  <div role="note" aria-label="source link">
 
794
    <h3>This Page</h3>
 
795
    <ul class="this-page-menu">
 
796
      <li><a href="../bugs.html">Report a Bug</a></li>
 
797
      <li><a href="../_sources/library/tracemalloc.txt"
 
798
            rel="nofollow">Show Source</a></li>
 
799
    </ul>
 
800
  </div>
 
801
        </div>
 
802
      </div>
 
803
      <div class="clearer"></div>
 
804
    </div>  
 
805
    <div class="related" role="navigation" aria-label="related navigation">
 
806
      <h3>Navigation</h3>
 
807
      <ul>
 
808
        <li class="right" style="margin-right: 10px">
 
809
          <a href="../genindex.html" title="General Index"
 
810
             >index</a></li>
 
811
        <li class="right" >
 
812
          <a href="../py-modindex.html" title="Python Module Index"
 
813
             >modules</a> |</li>
 
814
        <li class="right" >
 
815
          <a href="distribution.html" title="28. Software Packaging and Distribution"
 
816
             >next</a> |</li>
 
817
        <li class="right" >
 
818
          <a href="trace.html" title="27.6. trace — Trace or track Python statement execution"
 
819
             >previous</a> |</li>
 
820
        <li><img src="../_static/py.png" alt=""
 
821
                 style="vertical-align: middle; margin-top: -1px"/></li>
 
822
        <li><a href="https://www.python.org/">Python</a> &raquo;</li>
 
823
        <li>
 
824
          <span class="version_switcher_placeholder">3.5.2</span>
 
825
          <a href="../index.html">Documentation </a> &raquo;
 
826
        </li>
 
827
 
 
828
          <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &raquo;</li>
 
829
          <li class="nav-item nav-item-2"><a href="debug.html" >27. Debugging and Profiling</a> &raquo;</li>
 
830
    <li class="right">
 
831
        
 
832
 
 
833
    <div class="inline-search" style="display: none" role="search">
 
834
        <form class="inline-search" action="../search.html" method="get">
 
835
          <input placeholder="Quick search" type="text" name="q" />
 
836
          <input type="submit" value="Go" />
 
837
          <input type="hidden" name="check_keywords" value="yes" />
 
838
          <input type="hidden" name="area" value="default" />
 
839
        </form>
 
840
    </div>
 
841
    <script type="text/javascript">$('.inline-search').show(0);</script>
 
842
         |
 
843
    </li>
 
844
 
 
845
      </ul>
 
846
    </div>  
 
847
    <div class="footer">
 
848
    &copy; <a href="../copyright.html">Copyright</a> 2001-2016, Python Software Foundation.
 
849
    <br />
 
850
    The Python Software Foundation is a non-profit corporation.
 
851
    <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
852
    <br />
 
853
    Last updated on Sep 23, 2016.
 
854
    <a href="../bugs.html">Found a bug</a>?
 
855
    <br />
 
856
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.
 
857
    </div>
 
858
 
 
859
  </body>
 
860
</html>
 
 
b'\\ No newline at end of file'