Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
보기 1
좋아요 0
위키 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
브렌치: master
브랜치 태그
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/trace.html

581 lines
41KB
Raw 고유링크 Blame 히스토리 

  1. <!DOCTYPE html>

  2. 

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

  4.   <head>

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

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

  7. <meta property="og:title" content="trace — Trace or track Python statement execution" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/trace.py The trace module allows you to trace program execution, generate annotated statement coverage listings, print caller/callee relationships and list functions executed durin..." />

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

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

  14. <meta name="description" content="Source code: Lib/trace.py The trace module allows you to trace program execution, generate annotated statement coverage listings, print caller/callee relationships and list functions executed durin..." />

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

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

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

  18. 

  19.     <title>trace — Trace or track Python statement execution &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

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

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

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

  24.     

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

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

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

  28.     

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

  30.     

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

  32.           title="Search within Python 3.12.3 documentation"

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

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

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

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

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

  38.     <link rel="next" title="tracemalloc — Trace memory allocations" href="tracemalloc.html" />

  39.     <link rel="prev" title="timeit — Measure execution time of small code snippets" href="timeit.html" />

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

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

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

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

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

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

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

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

  59. 

  60.   </head>

  61. <body>

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

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

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

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

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

  67.             <span></span>

  68.         </label>

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

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

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

  72.             </a>

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

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

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

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

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

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

  80.             </form>

  81.         </span>

  82.     </nav>

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

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

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

  86.             

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

  88.     Theme

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

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

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

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

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code> — Trace or track Python statement execution</a><ul>

  99. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a><ul>

  100. <li><a class="reference internal" href="#main-options">Main options</a></li>

  101. <li><a class="reference internal" href="#modifiers">Modifiers</a></li>

  102. <li><a class="reference internal" href="#filters">Filters</a></li>

  103. </ul>

  104. </li>

  105. <li><a class="reference internal" href="#programmatic-interface">Programmatic Interface</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. 

  110.   </div>

  111.   <div>

  112.     <h4>Previous topic</h4>

  113.     <p class="topless"><a href="timeit.html"

  114.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">timeit</span></code> — Measure execution time of small code snippets</a></p>

  115.   </div>

  116.   <div>

  117.     <h4>Next topic</h4>

  118.     <p class="topless"><a href="tracemalloc.html"

  119.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tracemalloc</span></code> — Trace memory allocations</a></p>

  120.   </div>

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

  122.     <h3>This Page</h3>

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

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

  125.       <li>

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

  127.             rel="nofollow">Show Source

  128.         </a>

  129.       </li>

  130.     </ul>

  131.   </div>

  132.         </nav>

  133.     </div>

  134. </div>

  135. 

  136.   

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

  138.       <h3>Navigation</h3>

  139.       <ul>

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

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

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

  143.         <li class="right" >

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

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

  146.         <li class="right" >

  147.           <a href="tracemalloc.html" title="tracemalloc — Trace memory allocations"

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

  149.         <li class="right" >

  150.           <a href="timeit.html" title="timeit — Measure execution time of small code snippets"

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

  152. 

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

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

  155.           <li class="switchers">

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

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

  158.           </li>

  159.           <li>

  160.               

  161.           </li>

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

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

  164.     </li>

  165. 

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

  167.           <li class="nav-item nav-item-2"><a href="debug.html" accesskey="U">Debugging and Profiling</a> &#187;</li>

  168.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code> — Trace or track Python statement execution</a></li>

  169.                 <li class="right">

  170.                     

  171. 

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

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

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

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

  176.         </form>

  177.     </div>

  178.                      |

  179.                 </li>

  180.             <li class="right">

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

  182.     Theme

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

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

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

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

  187.     </select>

  188. </label> |</li>

  189.             

  190.       </ul>

  191.     </div>    

  192. 

  193.     <div class="document">

  194.       <div class="documentwrapper">

  195.         <div class="bodywrapper">

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

  197.             

  198.   <section id="module-trace">

  199. <span id="trace-trace-or-track-python-statement-execution"></span><h1><a class="reference internal" href="#module-trace" title="trace: Trace or track Python statement execution."><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code></a> — Trace or track Python statement execution<a class="headerlink" href="#module-trace" title="Link to this heading">¶</a></h1>

  200. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/trace.py">Lib/trace.py</a></p>

  201. <hr class="docutils" />

  202. <p>The <a class="reference internal" href="#module-trace" title="trace: Trace or track Python statement execution."><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code></a> module allows you to trace program execution, generate

  203. annotated statement coverage listings, print caller/callee relationships and

  204. list functions executed during a program run.  It can be used in another program

  205. or from the command line.</p>

  206. <div class="admonition seealso">

  207. <p class="admonition-title">See also</p>

  208. <dl class="simple">

  209. <dt><a class="reference external" href="https://coverage.readthedocs.io/">Coverage.py</a></dt><dd><p>A popular third-party coverage tool that provides HTML

  210. output along with advanced features such as branch coverage.</p>

  211. </dd>

  212. </dl>

  213. </div>

  214. <section id="command-line-usage">

  215. <span id="trace-cli"></span><h2>Command-Line Usage<a class="headerlink" href="#command-line-usage" title="Link to this heading">¶</a></h2>

  216. <p>The <a class="reference internal" href="#module-trace" title="trace: Trace or track Python statement execution."><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code></a> module can be invoked from the command line.  It can be as

  217. simple as</p>

  218. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">trace</span> <span class="o">--</span><span class="n">count</span> <span class="o">-</span><span class="n">C</span> <span class="o">.</span> <span class="n">somefile</span><span class="o">.</span><span class="n">py</span> <span class="o">...</span>

  219. </pre></div>

  220. </div>

  221. <p>The above will execute <code class="file docutils literal notranslate"><span class="pre">somefile.py</span></code> and generate annotated listings of

  222. all Python modules imported during the execution into the current directory.</p>

  223. <dl class="std option">

  224. <dt class="sig sig-object std" id="cmdoption-trace-help">

  225. <span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-help" title="Link to this definition">¶</a></dt>

  226. <dd><p>Display usage and exit.</p>

  227. </dd></dl>

  228. 

  229. <dl class="std option">

  230. <dt class="sig sig-object std" id="cmdoption-trace-version">

  231. <span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-version" title="Link to this definition">¶</a></dt>

  232. <dd><p>Display the version of the module and exit.</p>

  233. </dd></dl>

  234. 

  235. <div class="versionadded">

  236. <p><span class="versionmodified added">New in version 3.8: </span>Added <code class="docutils literal notranslate"><span class="pre">--module</span></code> option that allows to run an executable module.</p>

  237. </div>

  238. <section id="main-options">

  239. <h3>Main options<a class="headerlink" href="#main-options" title="Link to this heading">¶</a></h3>

  240. <p>At least one of the following options must be specified when invoking

  241. <a class="reference internal" href="#module-trace" title="trace: Trace or track Python statement execution."><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code></a>.  The <a class="reference internal" href="#cmdoption-trace-l"><code class="xref std std-option docutils literal notranslate"><span class="pre">--listfuncs</span></code></a> option is mutually exclusive with

  242. the <a class="reference internal" href="#cmdoption-trace-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--trace</span></code></a> and <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a> options. When

  243. <a class="reference internal" href="#cmdoption-trace-l"><code class="xref std std-option docutils literal notranslate"><span class="pre">--listfuncs</span></code></a> is provided, neither <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a> nor

  244. <a class="reference internal" href="#cmdoption-trace-t"><code class="xref std std-option docutils literal notranslate"><span class="pre">--trace</span></code></a> are accepted, and vice versa.</p>

  245. <dl class="std option">

  246. <dt class="sig sig-object std" id="cmdoption-trace-c">

  247. <span id="cmdoption-trace-count"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--count</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-c" title="Link to this definition">¶</a></dt>

  248. <dd><p>Produce a set of annotated listing files upon program completion that shows

  249. how many times each statement was executed.  See also

  250. <a class="reference internal" href="#cmdoption-trace-C"><code class="xref std std-option docutils literal notranslate"><span class="pre">--coverdir</span></code></a>, <a class="reference internal" href="#cmdoption-trace-f"><code class="xref std std-option docutils literal notranslate"><span class="pre">--file</span></code></a> and

  251. <a class="reference internal" href="#cmdoption-trace-R"><code class="xref std std-option docutils literal notranslate"><span class="pre">--no-report</span></code></a> below.</p>

  252. </dd></dl>

  253. 

  254. <dl class="std option">

  255. <dt class="sig sig-object std" id="cmdoption-trace-t">

  256. <span id="cmdoption-trace-trace"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--trace</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-t" title="Link to this definition">¶</a></dt>

  257. <dd><p>Display lines as they are executed.</p>

  258. </dd></dl>

  259. 

  260. <dl class="std option">

  261. <dt class="sig sig-object std" id="cmdoption-trace-l">

  262. <span id="cmdoption-trace-listfuncs"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--listfuncs</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-l" title="Link to this definition">¶</a></dt>

  263. <dd><p>Display the functions executed by running the program.</p>

  264. </dd></dl>

  265. 

  266. <dl class="std option">

  267. <dt class="sig sig-object std" id="cmdoption-trace-r">

  268. <span id="cmdoption-trace-report"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-r" title="Link to this definition">¶</a></dt>

  269. <dd><p>Produce an annotated list from an earlier program run that used the

  270. <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a> and <a class="reference internal" href="#cmdoption-trace-f"><code class="xref std std-option docutils literal notranslate"><span class="pre">--file</span></code></a> option.  This does not

  271. execute any code.</p>

  272. </dd></dl>

  273. 

  274. <dl class="std option">

  275. <dt class="sig sig-object std" id="cmdoption-trace-T">

  276. <span id="cmdoption-trace-trackcalls"></span><span class="sig-name descname"><span class="pre">-T</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--trackcalls</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-T" title="Link to this definition">¶</a></dt>

  277. <dd><p>Display the calling relationships exposed by running the program.</p>

  278. </dd></dl>

  279. 

  280. </section>

  281. <section id="modifiers">

  282. <h3>Modifiers<a class="headerlink" href="#modifiers" title="Link to this heading">¶</a></h3>

  283. <dl class="std option">

  284. <dt class="sig sig-object std" id="cmdoption-trace-f">

  285. <span id="cmdoption-trace-file"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--file</span></span><span class="sig-prename descclassname"><span class="pre">=&lt;file&gt;</span></span><a class="headerlink" href="#cmdoption-trace-f" title="Link to this definition">¶</a></dt>

  286. <dd><p>Name of a file to accumulate counts over several tracing runs.  Should be

  287. used with the <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a> option.</p>

  288. </dd></dl>

  289. 

  290. <dl class="std option">

  291. <dt class="sig sig-object std" id="cmdoption-trace-C">

  292. <span id="cmdoption-trace-coverdir"></span><span class="sig-name descname"><span class="pre">-C</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--coverdir</span></span><span class="sig-prename descclassname"><span class="pre">=&lt;dir&gt;</span></span><a class="headerlink" href="#cmdoption-trace-C" title="Link to this definition">¶</a></dt>

  293. <dd><p>Directory where the report files go.  The coverage report for

  294. <code class="docutils literal notranslate"><span class="pre">package.module</span></code> is written to file <code class="file docutils literal notranslate"><em><span class="pre">dir</span></em><span class="pre">/</span><em><span class="pre">package</span></em><span class="pre">/</span><em><span class="pre">module</span></em><span class="pre">.cover</span></code>.</p>

  295. </dd></dl>

  296. 

  297. <dl class="std option">

  298. <dt class="sig sig-object std" id="cmdoption-trace-m">

  299. <span id="cmdoption-trace-missing"></span><span class="sig-name descname"><span class="pre">-m</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--missing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-m" title="Link to this definition">¶</a></dt>

  300. <dd><p>When generating annotated listings, mark lines which were not executed with

  301. <code class="docutils literal notranslate"><span class="pre">&gt;&gt;&gt;&gt;&gt;&gt;</span></code>.</p>

  302. </dd></dl>

  303. 

  304. <dl class="std option">

  305. <dt class="sig sig-object std" id="cmdoption-trace-s">

  306. <span id="cmdoption-trace-summary"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--summary</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-s" title="Link to this definition">¶</a></dt>

  307. <dd><p>When using <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a> or <a class="reference internal" href="#cmdoption-trace-r"><code class="xref std std-option docutils literal notranslate"><span class="pre">--report</span></code></a>, write a brief

  308. summary to stdout for each file processed.</p>

  309. </dd></dl>

  310. 

  311. <dl class="std option">

  312. <dt class="sig sig-object std" id="cmdoption-trace-R">

  313. <span id="cmdoption-trace-no-report"></span><span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-report</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-R" title="Link to this definition">¶</a></dt>

  314. <dd><p>Do not generate annotated listings.  This is useful if you intend to make

  315. several runs with <a class="reference internal" href="#cmdoption-trace-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">--count</span></code></a>, and then produce a single set of

  316. annotated listings at the end.</p>

  317. </dd></dl>

  318. 

  319. <dl class="std option">

  320. <dt class="sig sig-object std" id="cmdoption-trace-g">

  321. <span id="cmdoption-trace-timing"></span><span class="sig-name descname"><span class="pre">-g</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--timing</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-trace-g" title="Link to this definition">¶</a></dt>

  322. <dd><p>Prefix each line with the time since the program started.  Only used while

  323. tracing.</p>

  324. </dd></dl>

  325. 

  326. </section>

  327. <section id="filters">

  328. <h3>Filters<a class="headerlink" href="#filters" title="Link to this heading">¶</a></h3>

  329. <p>These options may be repeated multiple times.</p>

  330. <dl class="std option">

  331. <dt class="sig sig-object std" id="cmdoption-trace-ignore-module">

  332. <span class="sig-name descname"><span class="pre">--ignore-module</span></span><span class="sig-prename descclassname"><span class="pre">=&lt;mod&gt;</span></span><a class="headerlink" href="#cmdoption-trace-ignore-module" title="Link to this definition">¶</a></dt>

  333. <dd><p>Ignore each of the given module names and its submodules (if it is a

  334. package).  The argument can be a list of names separated by a comma.</p>

  335. </dd></dl>

  336. 

  337. <dl class="std option">

  338. <dt class="sig sig-object std" id="cmdoption-trace-ignore-dir">

  339. <span class="sig-name descname"><span class="pre">--ignore-dir</span></span><span class="sig-prename descclassname"><span class="pre">=&lt;dir&gt;</span></span><a class="headerlink" href="#cmdoption-trace-ignore-dir" title="Link to this definition">¶</a></dt>

  340. <dd><p>Ignore all modules and packages in the named directory and subdirectories.

  341. The argument can be a list of directories separated by <a class="reference internal" href="os.html#os.pathsep" title="os.pathsep"><code class="xref py py-data docutils literal notranslate"><span class="pre">os.pathsep</span></code></a>.</p>

  342. </dd></dl>

  343. 

  344. </section>

  345. </section>

  346. <section id="programmatic-interface">

  347. <span id="trace-api"></span><h2>Programmatic Interface<a class="headerlink" href="#programmatic-interface" title="Link to this heading">¶</a></h2>

  348. <dl class="py class">

  349. <dt class="sig sig-object py" id="trace.Trace">

  350. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">trace.</span></span><span class="sig-name descname"><span class="pre">Trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">countfuncs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">countcallers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignoremods</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignoredirs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">infile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outfile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.Trace" title="Link to this definition">¶</a></dt>

  351. <dd><p>Create an object to trace execution of a single statement or expression.  All

  352. parameters are optional.  <em>count</em> enables counting of line numbers.  <em>trace</em>

  353. enables line execution tracing.  <em>countfuncs</em> enables listing of the

  354. functions called during the run.  <em>countcallers</em> enables call relationship

  355. tracking.  <em>ignoremods</em> is a list of modules or packages to ignore.

  356. <em>ignoredirs</em> is a list of directories whose modules or packages should be

  357. ignored.  <em>infile</em> is the name of the file from which to read stored count

  358. information.  <em>outfile</em> is the name of the file in which to write updated

  359. count information.  <em>timing</em> enables a timestamp relative to when tracing was

  360. started to be displayed.</p>

  361. <dl class="py method">

  362. <dt class="sig sig-object py" id="trace.Trace.run">

  363. <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.Trace.run" title="Link to this definition">¶</a></dt>

  364. <dd><p>Execute the command and gather statistics from the execution with

  365. the current tracing parameters.  <em>cmd</em> must be a string or code object,

  366. suitable for passing into <a class="reference internal" href="functions.html#exec" title="exec"><code class="xref py py-func docutils literal notranslate"><span class="pre">exec()</span></code></a>.</p>

  367. </dd></dl>

  368. 

  369. <dl class="py method">

  370. <dt class="sig sig-object py" id="trace.Trace.runctx">

  371. <span class="sig-name descname"><span class="pre">runctx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">globals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.Trace.runctx" title="Link to this definition">¶</a></dt>

  372. <dd><p>Execute the command and gather statistics from the execution with the

  373. current tracing parameters, in the defined global and local

  374. environments.  If not defined, <em>globals</em> and <em>locals</em> default to empty

  375. dictionaries.</p>

  376. </dd></dl>

  377. 

  378. <dl class="py method">

  379. <dt class="sig sig-object py" id="trace.Trace.runfunc">

  380. <span class="sig-name descname"><span class="pre">runfunc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.Trace.runfunc" title="Link to this definition">¶</a></dt>

  381. <dd><p>Call <em>func</em> with the given arguments under control of the <a class="reference internal" href="#trace.Trace" title="trace.Trace"><code class="xref py py-class docutils literal notranslate"><span class="pre">Trace</span></code></a>

  382. object with the current tracing parameters.</p>

  383. </dd></dl>

  384. 

  385. <dl class="py method">

  386. <dt class="sig sig-object py" id="trace.Trace.results">

  387. <span class="sig-name descname"><span class="pre">results</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#trace.Trace.results" title="Link to this definition">¶</a></dt>

  388. <dd><p>Return a <a class="reference internal" href="#trace.CoverageResults" title="trace.CoverageResults"><code class="xref py py-class docutils literal notranslate"><span class="pre">CoverageResults</span></code></a> object that contains the cumulative

  389. results of all previous calls to <code class="docutils literal notranslate"><span class="pre">run</span></code>, <code class="docutils literal notranslate"><span class="pre">runctx</span></code> and <code class="docutils literal notranslate"><span class="pre">runfunc</span></code>

  390. for the given <a class="reference internal" href="#trace.Trace" title="trace.Trace"><code class="xref py py-class docutils literal notranslate"><span class="pre">Trace</span></code></a> instance.  Does not reset the accumulated

  391. trace results.</p>

  392. </dd></dl>

  393. 

  394. </dd></dl>

  395. 

  396. <dl class="py class">

  397. <dt class="sig sig-object py" id="trace.CoverageResults">

  398. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">trace.</span></span><span class="sig-name descname"><span class="pre">CoverageResults</span></span><a class="headerlink" href="#trace.CoverageResults" title="Link to this definition">¶</a></dt>

  399. <dd><p>A container for coverage results, created by <a class="reference internal" href="#trace.Trace.results" title="trace.Trace.results"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Trace.results()</span></code></a>.  Should

  400. not be created directly by the user.</p>

  401. <dl class="py method">

  402. <dt class="sig sig-object py" id="trace.CoverageResults.update">

  403. <span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.CoverageResults.update" title="Link to this definition">¶</a></dt>

  404. <dd><p>Merge in data from another <a class="reference internal" href="#trace.CoverageResults" title="trace.CoverageResults"><code class="xref py py-class docutils literal notranslate"><span class="pre">CoverageResults</span></code></a> object.</p>

  405. </dd></dl>

  406. 

  407. <dl class="py method">

  408. <dt class="sig sig-object py" id="trace.CoverageResults.write_results">

  409. <span class="sig-name descname"><span class="pre">write_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_missing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coverdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trace.CoverageResults.write_results" title="Link to this definition">¶</a></dt>

  410. <dd><p>Write coverage results.  Set <em>show_missing</em> to show lines that had no

  411. hits.  Set <em>summary</em> to include in the output the coverage summary per

  412. module.  <em>coverdir</em> specifies the directory into which the coverage

  413. result files will be output.  If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the results for each source

  414. file are placed in its directory.</p>

  415. </dd></dl>

  416. 

  417. </dd></dl>

  418. 

  419. <p>A simple example demonstrating the use of the programmatic interface:</p>

  420. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>

  421. <span class="kn">import</span> <span class="nn">trace</span>

  422. 

  423. <span class="c1"># create a Trace object, telling it what to ignore, and whether to</span>

  424. <span class="c1"># do tracing or line-counting or both.</span>

  425. <span class="n">tracer</span> <span class="o">=</span> <span class="n">trace</span><span class="o">.</span><span class="n">Trace</span><span class="p">(</span>

  426.     <span class="n">ignoredirs</span><span class="o">=</span><span class="p">[</span><span class="n">sys</span><span class="o">.</span><span class="n">prefix</span><span class="p">,</span> <span class="n">sys</span><span class="o">.</span><span class="n">exec_prefix</span><span class="p">],</span>

  427.     <span class="n">trace</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>

  428.     <span class="n">count</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>

  429. 

  430. <span class="c1"># run the new command using the given tracer</span>

  431. <span class="n">tracer</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s1">&#39;main()&#39;</span><span class="p">)</span>

  432. 

  433. <span class="c1"># make a report, placing output in the current directory</span>

  434. <span class="n">r</span> <span class="o">=</span> <span class="n">tracer</span><span class="o">.</span><span class="n">results</span><span class="p">()</span>

  435. <span class="n">r</span><span class="o">.</span><span class="n">write_results</span><span class="p">(</span><span class="n">show_missing</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">coverdir</span><span class="o">=</span><span class="s2">&quot;.&quot;</span><span class="p">)</span>

  436. </pre></div>

  437. </div>

  438. </section>

  439. </section>

  440. 

  441. 

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

  443.           </div>

  444.         </div>

  445.       </div>

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

  447.         <div class="sphinxsidebarwrapper">

  448.   <div>

  449.     <h3><a href="../contents.html">Table of Contents</a></h3>

  450.     <ul>

  451. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code> — Trace or track Python statement execution</a><ul>

  452. <li><a class="reference internal" href="#command-line-usage">Command-Line Usage</a><ul>

  453. <li><a class="reference internal" href="#main-options">Main options</a></li>

  454. <li><a class="reference internal" href="#modifiers">Modifiers</a></li>

  455. <li><a class="reference internal" href="#filters">Filters</a></li>

  456. </ul>

  457. </li>

  458. <li><a class="reference internal" href="#programmatic-interface">Programmatic Interface</a></li>

  459. </ul>

  460. </li>

  461. </ul>

  462. 

  463.   </div>

  464.   <div>

  465.     <h4>Previous topic</h4>

  466.     <p class="topless"><a href="timeit.html"

  467.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">timeit</span></code> — Measure execution time of small code snippets</a></p>

  468.   </div>

  469.   <div>

  470.     <h4>Next topic</h4>

  471.     <p class="topless"><a href="tracemalloc.html"

  472.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tracemalloc</span></code> — Trace memory allocations</a></p>

  473.   </div>

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

  475.     <h3>This Page</h3>

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

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

  478.       <li>

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

  480.             rel="nofollow">Show Source

  481.         </a>

  482.       </li>

  483.     </ul>

  484.   </div>

  485.         </div>

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

  487. <span>«</span>

  488. </div>

  489. 

  490.       </div>

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

  492.     </div>  

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

  494.       <h3>Navigation</h3>

  495.       <ul>

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

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

  498.              >index</a></li>

  499.         <li class="right" >

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

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

  502.         <li class="right" >

  503.           <a href="tracemalloc.html" title="tracemalloc — Trace memory allocations"

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

  505.         <li class="right" >

  506.           <a href="timeit.html" title="timeit — Measure execution time of small code snippets"

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

  508. 

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

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

  511.           <li class="switchers">

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

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

  514.           </li>

  515.           <li>

  516.               

  517.           </li>

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

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

  520.     </li>

  521. 

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

  523.           <li class="nav-item nav-item-2"><a href="debug.html" >Debugging and Profiling</a> &#187;</li>

  524.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">trace</span></code> — Trace or track Python statement execution</a></li>

  525.                 <li class="right">

  526.                     

  527. 

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

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

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

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

  532.         </form>

  533.     </div>

  534.                      |

  535.                 </li>

  536.             <li class="right">

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

  538.     Theme

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

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

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

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

  543.     </select>

  544. </label> |</li>

  545.             

  546.       </ul>

  547.     </div>  

  548.     <div class="footer">

  549.     &copy; 

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

  551.     

  552.     Copyright

  553.     

  554.       </a>

  555.      2001-2024, Python Software Foundation.

  556.     <br />

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

  558.     <br />

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

  560.     <br />

  561.     

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

  563.     

  564.     

  565.     <br />

  566. 

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

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

  569. <br />

  570.     <br />

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

  572.     

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

  574.     

  575.     <br />

  576. 

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

  578.     </div>

  579. 

  580.   </body>

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