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.
ИН на ревизия: 0f75e31513
Клонове Маркери
${ item.name }
Create branch ${ searchTerm }
от '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/pprint.html

732 lines
59KB
Директен файл 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="pprint — Data pretty printer" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/pprint.py The pprint module provides a capability to “pretty-print” arbitrary Python data structures in a form which can be used as input to the interpreter. If the formatted struc..." />

  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/pprint.py The pprint module provides a capability to “pretty-print” arbitrary Python data structures in a form which can be used as input to the interpreter. If the formatted struc..." />

  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>pprint — Data pretty printer &#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="reprlib — Alternate repr() implementation" href="reprlib.html" />

  39.     <link rel="prev" title="copy — Shallow and deep copy operations" href="copy.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/pprint.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">pprint</span></code> — Data pretty printer</a><ul>

  99. <li><a class="reference internal" href="#functions">Functions</a></li>

  100. <li><a class="reference internal" href="#prettyprinter-objects">PrettyPrinter Objects</a></li>

  101. <li><a class="reference internal" href="#example">Example</a></li>

  102. </ul>

  103. </li>

  104. </ul>

  105. 

  106.   </div>

  107.   <div>

  108.     <h4>Previous topic</h4>

  109.     <p class="topless"><a href="copy.html"

  110.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">copy</span></code> — Shallow and deep copy operations</a></p>

  111.   </div>

  112.   <div>

  113.     <h4>Next topic</h4>

  114.     <p class="topless"><a href="reprlib.html"

  115.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">reprlib</span></code> — Alternate <code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code> implementation</a></p>

  116.   </div>

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

  118.     <h3>This Page</h3>

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

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

  121.       <li>

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

  123.             rel="nofollow">Show Source

  124.         </a>

  125.       </li>

  126.     </ul>

  127.   </div>

  128.         </nav>

  129.     </div>

  130. </div>

  131. 

  132.   

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

  134.       <h3>Navigation</h3>

  135.       <ul>

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

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

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

  139.         <li class="right" >

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

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

  142.         <li class="right" >

  143.           <a href="reprlib.html" title="reprlib — Alternate repr() implementation"

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

  145.         <li class="right" >

  146.           <a href="copy.html" title="copy — Shallow and deep copy operations"

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

  148. 

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

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

  151.           <li class="switchers">

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

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

  154.           </li>

  155.           <li>

  156.               

  157.           </li>

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

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

  160.     </li>

  161. 

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

  163.           <li class="nav-item nav-item-2"><a href="datatypes.html" accesskey="U">Data Types</a> &#187;</li>

  164.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pprint</span></code> — Data pretty printer</a></li>

  165.                 <li class="right">

  166.                     

  167. 

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

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

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

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

  172.         </form>

  173.     </div>

  174.                      |

  175.                 </li>

  176.             <li class="right">

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

  178.     Theme

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

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

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

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

  183.     </select>

  184. </label> |</li>

  185.             

  186.       </ul>

  187.     </div>    

  188. 

  189.     <div class="document">

  190.       <div class="documentwrapper">

  191.         <div class="bodywrapper">

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

  193.             

  194.   <section id="module-pprint">

  195. <span id="pprint-data-pretty-printer"></span><h1><a class="reference internal" href="#module-pprint" title="pprint: Data pretty printer."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pprint</span></code></a> — Data pretty printer<a class="headerlink" href="#module-pprint" title="Link to this heading">¶</a></h1>

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

  197. <hr class="docutils" />

  198. <p>The <a class="reference internal" href="#module-pprint" title="pprint: Data pretty printer."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pprint</span></code></a> module provides a capability to “pretty-print” arbitrary

  199. Python data structures in a form which can be used as input to the interpreter.

  200. If the formatted structures include objects which are not fundamental Python

  201. types, the representation may not be loadable.  This may be the case if objects

  202. such as files, sockets or classes are included, as well as many other

  203. objects which are not representable as Python literals.</p>

  204. <p>The formatted representation keeps objects on a single line if it can, and

  205. breaks them onto multiple lines if they don’t fit within the allowed width.

  206. Construct <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> objects explicitly if you need to adjust the

  207. width constraint.</p>

  208. <p>Dictionaries are sorted by key before the display is computed.</p>

  209. <div class="versionchanged">

  210. <p><span class="versionmodified changed">Changed in version 3.9: </span>Added support for pretty-printing <a class="reference internal" href="types.html#types.SimpleNamespace" title="types.SimpleNamespace"><code class="xref py py-class docutils literal notranslate"><span class="pre">types.SimpleNamespace</span></code></a>.</p>

  211. </div>

  212. <div class="versionchanged">

  213. <p><span class="versionmodified changed">Changed in version 3.10: </span>Added support for pretty-printing <a class="reference internal" href="dataclasses.html#dataclasses.dataclass" title="dataclasses.dataclass"><code class="xref py py-class docutils literal notranslate"><span class="pre">dataclasses.dataclass</span></code></a>.</p>

  214. </div>

  215. <section id="functions">

  216. <span id="pprint-functions"></span><h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2>

  217. <dl class="py function">

  218. <dt class="sig sig-object py" id="pprint.pp">

  219. <span class="sig-prename descclassname"><span class="pre">pprint.</span></span><span class="sig-name descname"><span class="pre">pp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</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="n"><span class="pre">sort_dicts</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pprint.pp" title="Link to this definition">¶</a></dt>

  220. <dd><p>Prints the formatted representation of <em>object</em> followed by a newline.

  221. If <em>sort_dicts</em> is false (the default), dictionaries will be displayed with

  222. their keys in insertion order, otherwise the dict keys will be sorted.

  223. <em>args</em> and <em>kwargs</em> will be passed to <a class="reference internal" href="#pprint.pprint" title="pprint.pprint"><code class="xref py py-func docutils literal notranslate"><span class="pre">pprint()</span></code></a> as formatting

  224. parameters.</p>

  225. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pprint</span>

  226. <span class="gp">&gt;&gt;&gt; </span><span class="n">stuff</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;spam&#39;</span><span class="p">,</span> <span class="s1">&#39;eggs&#39;</span><span class="p">,</span> <span class="s1">&#39;lumberjack&#39;</span><span class="p">,</span> <span class="s1">&#39;knights&#39;</span><span class="p">,</span> <span class="s1">&#39;ni&#39;</span><span class="p">]</span>

  227. <span class="gp">&gt;&gt;&gt; </span><span class="n">stuff</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">stuff</span><span class="p">)</span>

  228. <span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">pp</span><span class="p">(</span><span class="n">stuff</span><span class="p">)</span>

  229. <span class="go">[&lt;Recursion on list with id=...&gt;,</span>

  230. <span class="go"> &#39;spam&#39;,</span>

  231. <span class="go"> &#39;eggs&#39;,</span>

  232. <span class="go"> &#39;lumberjack&#39;,</span>

  233. <span class="go"> &#39;knights&#39;,</span>

  234. <span class="go"> &#39;ni&#39;]</span>

  235. </pre></div>

  236. </div>

  237. <div class="versionadded">

  238. <p><span class="versionmodified added">New in version 3.8.</span></p>

  239. </div>

  240. </dd></dl>

  241. 

  242. <dl class="py function">

  243. <dt class="sig sig-object py" id="pprint.pprint">

  244. <span class="sig-prename descclassname"><span class="pre">pprint.</span></span><span class="sig-name descname"><span class="pre">pprint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream</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">indent</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">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">80</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</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">sort_dicts</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">underscore_numbers</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="#pprint.pprint" title="Link to this definition">¶</a></dt>

  245. <dd><p>Prints the formatted representation of <em>object</em> on <em>stream</em>, followed by a

  246. newline.  If <em>stream</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code></a> is used. This may be used

  247. in the interactive interpreter instead of the <a class="reference internal" href="functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate"><span class="pre">print()</span></code></a> function for

  248. inspecting values (you can even reassign <code class="docutils literal notranslate"><span class="pre">print</span> <span class="pre">=</span> <span class="pre">pprint.pprint</span></code> for use

  249. within a scope).</p>

  250. <p>The configuration parameters <em>stream</em>, <em>indent</em>, <em>width</em>, <em>depth</em>,

  251. <em>compact</em>, <em>sort_dicts</em> and <em>underscore_numbers</em> are passed to the

  252. <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> constructor and their meanings are as

  253. described in its documentation below.</p>

  254. <p>Note that <em>sort_dicts</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> by default and you might want to use

  255. <a class="reference internal" href="#pprint.pp" title="pprint.pp"><code class="xref py py-func docutils literal notranslate"><span class="pre">pp()</span></code></a> instead where it is <code class="docutils literal notranslate"><span class="pre">False</span></code> by default.</p>

  256. </dd></dl>

  257. 

  258. <dl class="py function">

  259. <dt class="sig sig-object py" id="pprint.pformat">

  260. <span class="sig-prename descclassname"><span class="pre">pprint.</span></span><span class="sig-name descname"><span class="pre">pformat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</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">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">80</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</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">sort_dicts</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">underscore_numbers</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="#pprint.pformat" title="Link to this definition">¶</a></dt>

  261. <dd><p>Return the formatted representation of <em>object</em> as a string.  <em>indent</em>,

  262. <em>width</em>, <em>depth</em>, <em>compact</em>, <em>sort_dicts</em> and <em>underscore_numbers</em> are

  263. passed to the <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> constructor as formatting parameters

  264. and their meanings are as described in its documentation below.</p>

  265. </dd></dl>

  266. 

  267. <dl class="py function">

  268. <dt class="sig sig-object py" id="pprint.isreadable">

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

  270. <dd><p id="index-0">Determine if the formatted representation of <em>object</em> is “readable”, or can be

  271. used to reconstruct the value using <a class="reference internal" href="functions.html#eval" title="eval"><code class="xref py py-func docutils literal notranslate"><span class="pre">eval()</span></code></a>.  This always returns <code class="docutils literal notranslate"><span class="pre">False</span></code>

  272. for recursive objects.</p>

  273. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">isreadable</span><span class="p">(</span><span class="n">stuff</span><span class="p">)</span>

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

  275. </pre></div>

  276. </div>

  277. </dd></dl>

  278. 

  279. <dl class="py function">

  280. <dt class="sig sig-object py" id="pprint.isrecursive">

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

  282. <dd><p>Determine if <em>object</em> requires a recursive representation.  This function is

  283. subject to the same limitations as noted in <a class="reference internal" href="#pprint.saferepr" title="pprint.saferepr"><code class="xref py py-func docutils literal notranslate"><span class="pre">saferepr()</span></code></a> below and may raise an

  284. <a class="reference internal" href="exceptions.html#RecursionError" title="RecursionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">RecursionError</span></code></a> if it fails to detect a recursive object.</p>

  285. </dd></dl>

  286. 

  287. <dl class="py function">

  288. <dt class="sig sig-object py" id="pprint.saferepr">

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

  290. <dd><p>Return a string representation of <em>object</em>, protected against recursion in

  291. some common data structures, namely instances of <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>, <a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>

  292. and <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a> or subclasses whose <code class="docutils literal notranslate"><span class="pre">__repr__</span></code> has not been overridden.  If the

  293. representation of object exposes a recursive entry, the recursive reference

  294. will be represented as <code class="docutils literal notranslate"><span class="pre">&lt;Recursion</span> <span class="pre">on</span> <span class="pre">typename</span> <span class="pre">with</span> <span class="pre">id=number&gt;</span></code>.  The

  295. representation is not otherwise formatted.</p>

  296. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">saferepr</span><span class="p">(</span><span class="n">stuff</span><span class="p">)</span>

  297. <span class="go">&quot;[&lt;Recursion on list with id=...&gt;, &#39;spam&#39;, &#39;eggs&#39;, &#39;lumberjack&#39;, &#39;knights&#39;, &#39;ni&#39;]&quot;</span>

  298. </pre></div>

  299. </div>

  300. </dd></dl>

  301. 

  302. </section>

  303. <section id="prettyprinter-objects">

  304. <span id="id1"></span><h2>PrettyPrinter Objects<a class="headerlink" href="#prettyprinter-objects" title="Link to this heading">¶</a></h2>

  305. <p>This module defines one class:</p>

  306. <dl class="py class" id="index-1">

  307. <dt class="sig sig-object py" id="pprint.PrettyPrinter">

  308. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pprint.</span></span><span class="sig-name descname"><span class="pre">PrettyPrinter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indent</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">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">80</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</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">stream</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</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">sort_dicts</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">underscore_numbers</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="#pprint.PrettyPrinter" title="Link to this definition">¶</a></dt>

  309. <dd><p>Construct a <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> instance.  This constructor understands

  310. several keyword parameters.</p>

  311. <p><em>stream</em> (default <code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code>) is a <a class="reference internal" href="../glossary.html#term-file-like-object"><span class="xref std std-term">file-like object</span></a> to

  312. which the output will be written by calling its <code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code> method.

  313. If both <em>stream</em> and <code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code> are <code class="docutils literal notranslate"><span class="pre">None</span></code>, then

  314. <a class="reference internal" href="#pprint.PrettyPrinter.pprint" title="pprint.PrettyPrinter.pprint"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pprint()</span></code></a> silently returns.</p>

  315. <p>Other values configure the manner in which nesting of complex data

  316. structures is displayed.</p>

  317. <p><em>indent</em> (default 1) specifies the amount of indentation added for

  318. each nesting level.</p>

  319. <p><em>depth</em> controls the number of nesting levels which may be printed; if

  320. the data structure being printed is too deep, the next contained level

  321. is replaced by <code class="docutils literal notranslate"><span class="pre">...</span></code>.  By default, there is no constraint on the

  322. depth of the objects being formatted.</p>

  323. <p><em>width</em> (default 80) specifies the desired maximum number of characters per

  324. line in the output. If a structure cannot be formatted within the width

  325. constraint, a best effort will be made.</p>

  326. <p><em>compact</em> impacts the way that long sequences (lists, tuples, sets, etc)

  327. are formatted. If <em>compact</em> is false (the default) then each item of a

  328. sequence will be formatted on a separate line.  If <em>compact</em> is true, as

  329. many items as will fit within the <em>width</em> will be formatted on each output

  330. line.</p>

  331. <p>If <em>sort_dicts</em> is true (the default), dictionaries will be formatted with

  332. their keys sorted, otherwise they will display in insertion order.</p>

  333. <p>If <em>underscore_numbers</em> is true, integers will be formatted with the

  334. <code class="docutils literal notranslate"><span class="pre">_</span></code> character for a thousands separator, otherwise underscores are not

  335. displayed (the default).</p>

  336. <div class="versionchanged">

  337. <p><span class="versionmodified changed">Changed in version 3.4: </span>Added the <em>compact</em> parameter.</p>

  338. </div>

  339. <div class="versionchanged">

  340. <p><span class="versionmodified changed">Changed in version 3.8: </span>Added the <em>sort_dicts</em> parameter.</p>

  341. </div>

  342. <div class="versionchanged">

  343. <p><span class="versionmodified changed">Changed in version 3.10: </span>Added the <em>underscore_numbers</em> parameter.</p>

  344. </div>

  345. <div class="versionchanged">

  346. <p><span class="versionmodified changed">Changed in version 3.11: </span>No longer attempts to write to <code class="xref py py-data docutils literal notranslate"><span class="pre">sys.stdout</span></code> if it is <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  347. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pprint</span>

  348. <span class="gp">&gt;&gt;&gt; </span><span class="n">stuff</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;spam&#39;</span><span class="p">,</span> <span class="s1">&#39;eggs&#39;</span><span class="p">,</span> <span class="s1">&#39;lumberjack&#39;</span><span class="p">,</span> <span class="s1">&#39;knights&#39;</span><span class="p">,</span> <span class="s1">&#39;ni&#39;</span><span class="p">]</span>

  349. <span class="gp">&gt;&gt;&gt; </span><span class="n">stuff</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">stuff</span><span class="p">[:])</span>

  350. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span> <span class="o">=</span> <span class="n">pprint</span><span class="o">.</span><span class="n">PrettyPrinter</span><span class="p">(</span><span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>

  351. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span><span class="o">.</span><span class="n">pprint</span><span class="p">(</span><span class="n">stuff</span><span class="p">)</span>

  352. <span class="go">[   [&#39;spam&#39;, &#39;eggs&#39;, &#39;lumberjack&#39;, &#39;knights&#39;, &#39;ni&#39;],</span>

  353. <span class="go">    &#39;spam&#39;,</span>

  354. <span class="go">    &#39;eggs&#39;,</span>

  355. <span class="go">    &#39;lumberjack&#39;,</span>

  356. <span class="go">    &#39;knights&#39;,</span>

  357. <span class="go">    &#39;ni&#39;]</span>

  358. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span> <span class="o">=</span> <span class="n">pprint</span><span class="o">.</span><span class="n">PrettyPrinter</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">41</span><span class="p">,</span> <span class="n">compact</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  359. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span><span class="o">.</span><span class="n">pprint</span><span class="p">(</span><span class="n">stuff</span><span class="p">)</span>

  360. <span class="go">[[&#39;spam&#39;, &#39;eggs&#39;, &#39;lumberjack&#39;,</span>

  361. <span class="go">  &#39;knights&#39;, &#39;ni&#39;],</span>

  362. <span class="go"> &#39;spam&#39;, &#39;eggs&#39;, &#39;lumberjack&#39;, &#39;knights&#39;,</span>

  363. <span class="go"> &#39;ni&#39;]</span>

  364. <span class="gp">&gt;&gt;&gt; </span><span class="n">tup</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;spam&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;eggs&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;lumberjack&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;knights&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;ni&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;dead&#39;</span><span class="p">,</span>

  365. <span class="gp">... </span><span class="p">(</span><span class="s1">&#39;parrot&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;fresh fruit&#39;</span><span class="p">,))))))))</span>

  366. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span> <span class="o">=</span> <span class="n">pprint</span><span class="o">.</span><span class="n">PrettyPrinter</span><span class="p">(</span><span class="n">depth</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>

  367. <span class="gp">&gt;&gt;&gt; </span><span class="n">pp</span><span class="o">.</span><span class="n">pprint</span><span class="p">(</span><span class="n">tup</span><span class="p">)</span>

  368. <span class="go">(&#39;spam&#39;, (&#39;eggs&#39;, (&#39;lumberjack&#39;, (&#39;knights&#39;, (&#39;ni&#39;, (&#39;dead&#39;, (...)))))))</span>

  369. </pre></div>

  370. </div>

  371. </div>

  372. </dd></dl>

  373. 

  374. <p><a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> instances have the following methods:</p>

  375. <dl class="py method">

  376. <dt class="sig sig-object py" id="pprint.PrettyPrinter.pformat">

  377. <span class="sig-prename descclassname"><span class="pre">PrettyPrinter.</span></span><span class="sig-name descname"><span class="pre">pformat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pprint.PrettyPrinter.pformat" title="Link to this definition">¶</a></dt>

  378. <dd><p>Return the formatted representation of <em>object</em>.  This takes into account the

  379. options passed to the <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> constructor.</p>

  380. </dd></dl>

  381. 

  382. <dl class="py method">

  383. <dt class="sig sig-object py" id="pprint.PrettyPrinter.pprint">

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

  385. <dd><p>Print the formatted representation of <em>object</em> on the configured stream,

  386. followed by a newline.</p>

  387. </dd></dl>

  388. 

  389. <p>The following methods provide the implementations for the corresponding

  390. functions of the same names.  Using these methods on an instance is slightly

  391. more efficient since new <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> objects don’t need to be

  392. created.</p>

  393. <dl class="py method">

  394. <dt class="sig sig-object py" id="pprint.PrettyPrinter.isreadable">

  395. <span class="sig-prename descclassname"><span class="pre">PrettyPrinter.</span></span><span class="sig-name descname"><span class="pre">isreadable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pprint.PrettyPrinter.isreadable" title="Link to this definition">¶</a></dt>

  396. <dd><p id="index-2">Determine if the formatted representation of the object is “readable,” or can be

  397. used to reconstruct the value using <a class="reference internal" href="functions.html#eval" title="eval"><code class="xref py py-func docutils literal notranslate"><span class="pre">eval()</span></code></a>.  Note that this returns

  398. <code class="docutils literal notranslate"><span class="pre">False</span></code> for recursive objects.  If the <em>depth</em> parameter of the

  399. <a class="reference internal" href="#pprint.PrettyPrinter" title="pprint.PrettyPrinter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrettyPrinter</span></code></a> is set and the object is deeper than allowed, this

  400. returns <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

  401. </dd></dl>

  402. 

  403. <dl class="py method">

  404. <dt class="sig sig-object py" id="pprint.PrettyPrinter.isrecursive">

  405. <span class="sig-prename descclassname"><span class="pre">PrettyPrinter.</span></span><span class="sig-name descname"><span class="pre">isrecursive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pprint.PrettyPrinter.isrecursive" title="Link to this definition">¶</a></dt>

  406. <dd><p>Determine if the object requires a recursive representation.</p>

  407. </dd></dl>

  408. 

  409. <p>This method is provided as a hook to allow subclasses to modify the way objects

  410. are converted to strings.  The default implementation uses the internals of the

  411. <a class="reference internal" href="#pprint.saferepr" title="pprint.saferepr"><code class="xref py py-func docutils literal notranslate"><span class="pre">saferepr()</span></code></a> implementation.</p>

  412. <dl class="py method">

  413. <dt class="sig sig-object py" id="pprint.PrettyPrinter.format">

  414. <span class="sig-prename descclassname"><span class="pre">PrettyPrinter.</span></span><span class="sig-name descname"><span class="pre">format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxlevels</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pprint.PrettyPrinter.format" title="Link to this definition">¶</a></dt>

  415. <dd><p>Returns three values: the formatted version of <em>object</em> as a string, a flag

  416. indicating whether the result is readable, and a flag indicating whether

  417. recursion was detected.  The first argument is the object to be presented.  The

  418. second is a dictionary which contains the <a class="reference internal" href="functions.html#id" title="id"><code class="xref py py-func docutils literal notranslate"><span class="pre">id()</span></code></a> of objects that are part of

  419. the current presentation context (direct and indirect containers for <em>object</em>

  420. that are affecting the presentation) as the keys; if an object needs to be

  421. presented which is already represented in <em>context</em>, the third return value

  422. should be <code class="docutils literal notranslate"><span class="pre">True</span></code>.  Recursive calls to the <a class="reference internal" href="#pprint.PrettyPrinter.format" title="pprint.PrettyPrinter.format"><code class="xref py py-meth docutils literal notranslate"><span class="pre">format()</span></code></a> method should add

  423. additional entries for containers to this dictionary.  The third argument,

  424. <em>maxlevels</em>, gives the requested limit to recursion; this will be <code class="docutils literal notranslate"><span class="pre">0</span></code> if there

  425. is no requested limit.  This argument should be passed unmodified to recursive

  426. calls. The fourth argument, <em>level</em>, gives the current level; recursive calls

  427. should be passed a value less than that of the current call.</p>

  428. </dd></dl>

  429. 

  430. </section>

  431. <section id="example">

  432. <span id="pprint-example"></span><h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>

  433. <p>To demonstrate several uses of the <a class="reference internal" href="#pprint.pp" title="pprint.pp"><code class="xref py py-func docutils literal notranslate"><span class="pre">pp()</span></code></a> function and its parameters,

  434. let’s fetch information about a project from <a class="reference external" href="https://pypi.org">PyPI</a>:</p>

  435. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">json</span>

  436. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pprint</span>

  437. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">urllib.request</span> <span class="kn">import</span> <span class="n">urlopen</span>

  438. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="n">urlopen</span><span class="p">(</span><span class="s1">&#39;https://pypi.org/pypi/sampleproject/json&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">resp</span><span class="p">:</span>

  439. <span class="gp">... </span>    <span class="n">project_info</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">resp</span><span class="p">)[</span><span class="s1">&#39;info&#39;</span><span class="p">]</span>

  440. </pre></div>

  441. </div>

  442. <p>In its basic form, <a class="reference internal" href="#pprint.pp" title="pprint.pp"><code class="xref py py-func docutils literal notranslate"><span class="pre">pp()</span></code></a> shows the whole object:</p>

  443. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">pp</span><span class="p">(</span><span class="n">project_info</span><span class="p">)</span>

  444. <span class="go">{&#39;author&#39;: &#39;The Python Packaging Authority&#39;,</span>

  445. <span class="go"> &#39;author_email&#39;: &#39;pypa-dev@googlegroups.com&#39;,</span>

  446. <span class="go"> &#39;bugtrack_url&#39;: None,</span>

  447. <span class="go"> &#39;classifiers&#39;: [&#39;Development Status :: 3 - Alpha&#39;,</span>

  448. <span class="go">                 &#39;Intended Audience :: Developers&#39;,</span>

  449. <span class="go">                 &#39;License :: OSI Approved :: MIT License&#39;,</span>

  450. <span class="go">                 &#39;Programming Language :: Python :: 2&#39;,</span>

  451. <span class="go">                 &#39;Programming Language :: Python :: 2.6&#39;,</span>

  452. <span class="go">                 &#39;Programming Language :: Python :: 2.7&#39;,</span>

  453. <span class="go">                 &#39;Programming Language :: Python :: 3&#39;,</span>

  454. <span class="go">                 &#39;Programming Language :: Python :: 3.2&#39;,</span>

  455. <span class="go">                 &#39;Programming Language :: Python :: 3.3&#39;,</span>

  456. <span class="go">                 &#39;Programming Language :: Python :: 3.4&#39;,</span>

  457. <span class="go">                 &#39;Topic :: Software Development :: Build Tools&#39;],</span>

  458. <span class="go"> &#39;description&#39;: &#39;A sample Python project\n&#39;</span>

  459. <span class="go">                &#39;=======================\n&#39;</span>

  460. <span class="go">                &#39;\n&#39;</span>

  461. <span class="go">                &#39;This is the description file for the project.\n&#39;</span>

  462. <span class="go">                &#39;\n&#39;</span>

  463. <span class="go">                &#39;The file should use UTF-8 encoding and be written using &#39;</span>

  464. <span class="go">                &#39;ReStructured Text. It\n&#39;</span>

  465. <span class="go">                &#39;will be used to generate the project webpage on PyPI, and &#39;</span>

  466. <span class="go">                &#39;should be written for\n&#39;</span>

  467. <span class="go">                &#39;that purpose.\n&#39;</span>

  468. <span class="go">                &#39;\n&#39;</span>

  469. <span class="go">                &#39;Typical contents for this file would include an overview of &#39;</span>

  470. <span class="go">                &#39;the project, basic\n&#39;</span>

  471. <span class="go">                &#39;usage examples, etc. Generally, including the project &#39;</span>

  472. <span class="go">                &#39;changelog in here is not\n&#39;</span>

  473. <span class="go">                &#39;a good idea, although a simple &quot;What\&#39;s New&quot; section for the &#39;</span>

  474. <span class="go">                &#39;most recent version\n&#39;</span>

  475. <span class="go">                &#39;may be appropriate.&#39;,</span>

  476. <span class="go"> &#39;description_content_type&#39;: None,</span>

  477. <span class="go"> &#39;docs_url&#39;: None,</span>

  478. <span class="go"> &#39;download_url&#39;: &#39;UNKNOWN&#39;,</span>

  479. <span class="go"> &#39;downloads&#39;: {&#39;last_day&#39;: -1, &#39;last_month&#39;: -1, &#39;last_week&#39;: -1},</span>

  480. <span class="go"> &#39;home_page&#39;: &#39;https://github.com/pypa/sampleproject&#39;,</span>

  481. <span class="go"> &#39;keywords&#39;: &#39;sample setuptools development&#39;,</span>

  482. <span class="go"> &#39;license&#39;: &#39;MIT&#39;,</span>

  483. <span class="go"> &#39;maintainer&#39;: None,</span>

  484. <span class="go"> &#39;maintainer_email&#39;: None,</span>

  485. <span class="go"> &#39;name&#39;: &#39;sampleproject&#39;,</span>

  486. <span class="go"> &#39;package_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  487. <span class="go"> &#39;platform&#39;: &#39;UNKNOWN&#39;,</span>

  488. <span class="go"> &#39;project_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  489. <span class="go"> &#39;project_urls&#39;: {&#39;Download&#39;: &#39;UNKNOWN&#39;,</span>

  490. <span class="go">                  &#39;Homepage&#39;: &#39;https://github.com/pypa/sampleproject&#39;},</span>

  491. <span class="go"> &#39;release_url&#39;: &#39;https://pypi.org/project/sampleproject/1.2.0/&#39;,</span>

  492. <span class="go"> &#39;requires_dist&#39;: None,</span>

  493. <span class="go"> &#39;requires_python&#39;: None,</span>

  494. <span class="go"> &#39;summary&#39;: &#39;A sample Python project&#39;,</span>

  495. <span class="go"> &#39;version&#39;: &#39;1.2.0&#39;}</span>

  496. </pre></div>

  497. </div>

  498. <p>The result can be limited to a certain <em>depth</em> (ellipsis is used for deeper

  499. contents):</p>

  500. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">pp</span><span class="p">(</span><span class="n">project_info</span><span class="p">,</span> <span class="n">depth</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>

  501. <span class="go">{&#39;author&#39;: &#39;The Python Packaging Authority&#39;,</span>

  502. <span class="go"> &#39;author_email&#39;: &#39;pypa-dev@googlegroups.com&#39;,</span>

  503. <span class="go"> &#39;bugtrack_url&#39;: None,</span>

  504. <span class="go"> &#39;classifiers&#39;: [...],</span>

  505. <span class="go"> &#39;description&#39;: &#39;A sample Python project\n&#39;</span>

  506. <span class="go">                &#39;=======================\n&#39;</span>

  507. <span class="go">                &#39;\n&#39;</span>

  508. <span class="go">                &#39;This is the description file for the project.\n&#39;</span>

  509. <span class="go">                &#39;\n&#39;</span>

  510. <span class="go">                &#39;The file should use UTF-8 encoding and be written using &#39;</span>

  511. <span class="go">                &#39;ReStructured Text. It\n&#39;</span>

  512. <span class="go">                &#39;will be used to generate the project webpage on PyPI, and &#39;</span>

  513. <span class="go">                &#39;should be written for\n&#39;</span>

  514. <span class="go">                &#39;that purpose.\n&#39;</span>

  515. <span class="go">                &#39;\n&#39;</span>

  516. <span class="go">                &#39;Typical contents for this file would include an overview of &#39;</span>

  517. <span class="go">                &#39;the project, basic\n&#39;</span>

  518. <span class="go">                &#39;usage examples, etc. Generally, including the project &#39;</span>

  519. <span class="go">                &#39;changelog in here is not\n&#39;</span>

  520. <span class="go">                &#39;a good idea, although a simple &quot;What\&#39;s New&quot; section for the &#39;</span>

  521. <span class="go">                &#39;most recent version\n&#39;</span>

  522. <span class="go">                &#39;may be appropriate.&#39;,</span>

  523. <span class="go"> &#39;description_content_type&#39;: None,</span>

  524. <span class="go"> &#39;docs_url&#39;: None,</span>

  525. <span class="go"> &#39;download_url&#39;: &#39;UNKNOWN&#39;,</span>

  526. <span class="go"> &#39;downloads&#39;: {...},</span>

  527. <span class="go"> &#39;home_page&#39;: &#39;https://github.com/pypa/sampleproject&#39;,</span>

  528. <span class="go"> &#39;keywords&#39;: &#39;sample setuptools development&#39;,</span>

  529. <span class="go"> &#39;license&#39;: &#39;MIT&#39;,</span>

  530. <span class="go"> &#39;maintainer&#39;: None,</span>

  531. <span class="go"> &#39;maintainer_email&#39;: None,</span>

  532. <span class="go"> &#39;name&#39;: &#39;sampleproject&#39;,</span>

  533. <span class="go"> &#39;package_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  534. <span class="go"> &#39;platform&#39;: &#39;UNKNOWN&#39;,</span>

  535. <span class="go"> &#39;project_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  536. <span class="go"> &#39;project_urls&#39;: {...},</span>

  537. <span class="go"> &#39;release_url&#39;: &#39;https://pypi.org/project/sampleproject/1.2.0/&#39;,</span>

  538. <span class="go"> &#39;requires_dist&#39;: None,</span>

  539. <span class="go"> &#39;requires_python&#39;: None,</span>

  540. <span class="go"> &#39;summary&#39;: &#39;A sample Python project&#39;,</span>

  541. <span class="go"> &#39;version&#39;: &#39;1.2.0&#39;}</span>

  542. </pre></div>

  543. </div>

  544. <p>Additionally, maximum character <em>width</em> can be suggested. If a long object

  545. cannot be split, the specified width will be exceeded:</p>

  546. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="o">.</span><span class="n">pp</span><span class="p">(</span><span class="n">project_info</span><span class="p">,</span> <span class="n">depth</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>

  547. <span class="go">{&#39;author&#39;: &#39;The Python Packaging Authority&#39;,</span>

  548. <span class="go"> &#39;author_email&#39;: &#39;pypa-dev@googlegroups.com&#39;,</span>

  549. <span class="go"> &#39;bugtrack_url&#39;: None,</span>

  550. <span class="go"> &#39;classifiers&#39;: [...],</span>

  551. <span class="go"> &#39;description&#39;: &#39;A sample Python project\n&#39;</span>

  552. <span class="go">                &#39;=======================\n&#39;</span>

  553. <span class="go">                &#39;\n&#39;</span>

  554. <span class="go">                &#39;This is the description file for the &#39;</span>

  555. <span class="go">                &#39;project.\n&#39;</span>

  556. <span class="go">                &#39;\n&#39;</span>

  557. <span class="go">                &#39;The file should use UTF-8 encoding and be &#39;</span>

  558. <span class="go">                &#39;written using ReStructured Text. It\n&#39;</span>

  559. <span class="go">                &#39;will be used to generate the project &#39;</span>

  560. <span class="go">                &#39;webpage on PyPI, and should be written &#39;</span>

  561. <span class="go">                &#39;for\n&#39;</span>

  562. <span class="go">                &#39;that purpose.\n&#39;</span>

  563. <span class="go">                &#39;\n&#39;</span>

  564. <span class="go">                &#39;Typical contents for this file would &#39;</span>

  565. <span class="go">                &#39;include an overview of the project, &#39;</span>

  566. <span class="go">                &#39;basic\n&#39;</span>

  567. <span class="go">                &#39;usage examples, etc. Generally, including &#39;</span>

  568. <span class="go">                &#39;the project changelog in here is not\n&#39;</span>

  569. <span class="go">                &#39;a good idea, although a simple &quot;What\&#39;s &#39;</span>

  570. <span class="go">                &#39;New&quot; section for the most recent version\n&#39;</span>

  571. <span class="go">                &#39;may be appropriate.&#39;,</span>

  572. <span class="go"> &#39;description_content_type&#39;: None,</span>

  573. <span class="go"> &#39;docs_url&#39;: None,</span>

  574. <span class="go"> &#39;download_url&#39;: &#39;UNKNOWN&#39;,</span>

  575. <span class="go"> &#39;downloads&#39;: {...},</span>

  576. <span class="go"> &#39;home_page&#39;: &#39;https://github.com/pypa/sampleproject&#39;,</span>

  577. <span class="go"> &#39;keywords&#39;: &#39;sample setuptools development&#39;,</span>

  578. <span class="go"> &#39;license&#39;: &#39;MIT&#39;,</span>

  579. <span class="go"> &#39;maintainer&#39;: None,</span>

  580. <span class="go"> &#39;maintainer_email&#39;: None,</span>

  581. <span class="go"> &#39;name&#39;: &#39;sampleproject&#39;,</span>

  582. <span class="go"> &#39;package_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  583. <span class="go"> &#39;platform&#39;: &#39;UNKNOWN&#39;,</span>

  584. <span class="go"> &#39;project_url&#39;: &#39;https://pypi.org/project/sampleproject/&#39;,</span>

  585. <span class="go"> &#39;project_urls&#39;: {...},</span>

  586. <span class="go"> &#39;release_url&#39;: &#39;https://pypi.org/project/sampleproject/1.2.0/&#39;,</span>

  587. <span class="go"> &#39;requires_dist&#39;: None,</span>

  588. <span class="go"> &#39;requires_python&#39;: None,</span>

  589. <span class="go"> &#39;summary&#39;: &#39;A sample Python project&#39;,</span>

  590. <span class="go"> &#39;version&#39;: &#39;1.2.0&#39;}</span>

  591. </pre></div>

  592. </div>

  593. </section>

  594. </section>

  595. 

  596. 

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

  598.           </div>

  599.         </div>

  600.       </div>

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

  602.         <div class="sphinxsidebarwrapper">

  603.   <div>

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

  605.     <ul>

  606. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pprint</span></code> — Data pretty printer</a><ul>

  607. <li><a class="reference internal" href="#functions">Functions</a></li>

  608. <li><a class="reference internal" href="#prettyprinter-objects">PrettyPrinter Objects</a></li>

  609. <li><a class="reference internal" href="#example">Example</a></li>

  610. </ul>

  611. </li>

  612. </ul>

  613. 

  614.   </div>

  615.   <div>

  616.     <h4>Previous topic</h4>

  617.     <p class="topless"><a href="copy.html"

  618.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">copy</span></code> — Shallow and deep copy operations</a></p>

  619.   </div>

  620.   <div>

  621.     <h4>Next topic</h4>

  622.     <p class="topless"><a href="reprlib.html"

  623.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">reprlib</span></code> — Alternate <code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code> implementation</a></p>

  624.   </div>

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

  626.     <h3>This Page</h3>

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

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

  629.       <li>

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

  631.             rel="nofollow">Show Source

  632.         </a>

  633.       </li>

  634.     </ul>

  635.   </div>

  636.         </div>

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

  638. <span>«</span>

  639. </div>

  640. 

  641.       </div>

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

  643.     </div>  

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

  645.       <h3>Navigation</h3>

  646.       <ul>

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

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

  649.              >index</a></li>

  650.         <li class="right" >

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

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

  653.         <li class="right" >

  654.           <a href="reprlib.html" title="reprlib — Alternate repr() implementation"

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

  656.         <li class="right" >

  657.           <a href="copy.html" title="copy — Shallow and deep copy operations"

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

  659. 

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

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

  662.           <li class="switchers">

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

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

  665.           </li>

  666.           <li>

  667.               

  668.           </li>

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

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

  671.     </li>

  672. 

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

  674.           <li class="nav-item nav-item-2"><a href="datatypes.html" >Data Types</a> &#187;</li>

  675.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pprint</span></code> — Data pretty printer</a></li>

  676.                 <li class="right">

  677.                     

  678. 

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

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

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

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

  683.         </form>

  684.     </div>

  685.                      |

  686.                 </li>

  687.             <li class="right">

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

  689.     Theme

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

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

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

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

  694.     </select>

  695. </label> |</li>

  696.             

  697.       </ul>

  698.     </div>  

  699.     <div class="footer">

  700.     &copy; 

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

  702.     

  703.     Copyright

  704.     

  705.       </a>

  706.      2001-2024, Python Software Foundation.

  707.     <br />

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

  709.     <br />

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

  711.     <br />

  712.     

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

  714.     

  715.     

  716.     <br />

  717. 

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

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

  720. <br />

  721.     <br />

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

  723.     

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

  725.     

  726.     <br />

  727. 

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

  729.     </div>

  730. 

  731.   </body>

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