Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/configparser.html

1625 lines
161KB
Raw Blame History 

  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="configparser — Configuration file parser" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/configparser.py This module provides the ConfigParser class which implements a basic configuration language which provides a structure similar to what’s found in Microsoft Windows ..." />

  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/configparser.py This module provides the ConfigParser class which implements a basic configuration language which provides a structure similar to what’s found in Microsoft Windows ..." />

  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>configparser — Configuration file parser &#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="tomllib — Parse TOML files" href="tomllib.html" />

  39.     <link rel="prev" title="csv — CSV File Reading and Writing" href="csv.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/configparser.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">configparser</span></code> — Configuration file parser</a><ul>

  99. <li><a class="reference internal" href="#quick-start">Quick Start</a></li>

  100. <li><a class="reference internal" href="#supported-datatypes">Supported Datatypes</a></li>

  101. <li><a class="reference internal" href="#fallback-values">Fallback Values</a></li>

  102. <li><a class="reference internal" href="#supported-ini-file-structure">Supported INI File Structure</a></li>

  103. <li><a class="reference internal" href="#interpolation-of-values">Interpolation of values</a></li>

  104. <li><a class="reference internal" href="#mapping-protocol-access">Mapping Protocol Access</a></li>

  105. <li><a class="reference internal" href="#customizing-parser-behaviour">Customizing Parser Behaviour</a></li>

  106. <li><a class="reference internal" href="#legacy-api-examples">Legacy API Examples</a></li>

  107. <li><a class="reference internal" href="#configparser-objects">ConfigParser Objects</a></li>

  108. <li><a class="reference internal" href="#rawconfigparser-objects">RawConfigParser Objects</a></li>

  109. <li><a class="reference internal" href="#exceptions">Exceptions</a></li>

  110. </ul>

  111. </li>

  112. </ul>

  113. 

  114.   </div>

  115.   <div>

  116.     <h4>Previous topic</h4>

  117.     <p class="topless"><a href="csv.html"

  118.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">csv</span></code> — CSV File Reading and Writing</a></p>

  119.   </div>

  120.   <div>

  121.     <h4>Next topic</h4>

  122.     <p class="topless"><a href="tomllib.html"

  123.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomllib</span></code> — Parse TOML files</a></p>

  124.   </div>

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

  126.     <h3>This Page</h3>

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

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

  129.       <li>

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

  131.             rel="nofollow">Show Source

  132.         </a>

  133.       </li>

  134.     </ul>

  135.   </div>

  136.         </nav>

  137.     </div>

  138. </div>

  139. 

  140.   

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

  142.       <h3>Navigation</h3>

  143.       <ul>

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

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

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

  147.         <li class="right" >

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

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

  150.         <li class="right" >

  151.           <a href="tomllib.html" title="tomllib — Parse TOML files"

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

  153.         <li class="right" >

  154.           <a href="csv.html" title="csv — CSV File Reading and Writing"

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

  156. 

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

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

  159.           <li class="switchers">

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

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

  162.           </li>

  163.           <li>

  164.               

  165.           </li>

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

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

  168.     </li>

  169. 

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

  171.           <li class="nav-item nav-item-2"><a href="fileformats.html" accesskey="U">File Formats</a> &#187;</li>

  172.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code> — Configuration file parser</a></li>

  173.                 <li class="right">

  174.                     

  175. 

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

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

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

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

  180.         </form>

  181.     </div>

  182.                      |

  183.                 </li>

  184.             <li class="right">

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

  186.     Theme

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

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

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

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

  191.     </select>

  192. </label> |</li>

  193.             

  194.       </ul>

  195.     </div>    

  196. 

  197.     <div class="document">

  198.       <div class="documentwrapper">

  199.         <div class="bodywrapper">

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

  201.             

  202.   <section id="module-configparser">

  203. <span id="configparser-configuration-file-parser"></span><h1><a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> — Configuration file parser<a class="headerlink" href="#module-configparser" title="Link to this heading">¶</a></h1>

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

  205. <hr class="docutils" id="index-0" />

  206. <p>This module provides the <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a> class which implements a basic

  207. configuration language which provides a structure similar to what’s found in

  208. Microsoft Windows INI files.  You can use this to write Python programs which

  209. can be customized by end users easily.</p>

  210. <div class="admonition note">

  211. <p class="admonition-title">Note</p>

  212. <p>This library does <em>not</em> interpret or write the value-type prefixes used in

  213. the Windows Registry extended version of INI syntax.</p>

  214. </div>

  215. <div class="admonition seealso">

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

  217. <dl class="simple">

  218. <dt>Module <a class="reference internal" href="tomllib.html#module-tomllib" title="tomllib: Parse TOML files."><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomllib</span></code></a></dt><dd><p>TOML is a well-specified format for application configuration files.

  219. It is specifically designed to be an improved version of INI.</p>

  220. </dd>

  221. <dt>Module <a class="reference internal" href="shlex.html#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-mod docutils literal notranslate"><span class="pre">shlex</span></code></a></dt><dd><p>Support for creating Unix shell-like mini-languages which can also

  222. be used for application configuration files.</p>

  223. </dd>

  224. <dt>Module <a class="reference internal" href="json.html#module-json" title="json: Encode and decode the JSON format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code></a></dt><dd><p>The <code class="docutils literal notranslate"><span class="pre">json</span></code> module implements a subset of JavaScript syntax which is

  225. sometimes used for configuration, but does not support comments.</p>

  226. </dd>

  227. </dl>

  228. </div>

  229. <section id="quick-start">

  230. <h2>Quick Start<a class="headerlink" href="#quick-start" title="Link to this heading">¶</a></h2>

  231. <p>Let’s take a very basic configuration file that looks like this:</p>

  232. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[DEFAULT]</span>

  233. <span class="na">ServerAliveInterval</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">45</span>

  234. <span class="na">Compression</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">yes</span>

  235. <span class="na">CompressionLevel</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">9</span>

  236. <span class="na">ForwardX11</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">yes</span>

  237. 

  238. <span class="k">[forge.example]</span>

  239. <span class="na">User</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">hg</span>

  240. 

  241. <span class="k">[topsecret.server.example]</span>

  242. <span class="na">Port</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">50022</span>

  243. <span class="na">ForwardX11</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">no</span>

  244. </pre></div>

  245. </div>

  246. <p>The structure of INI files is described <a class="reference external" href="#supported-ini-file-structure">in the following section</a>.  Essentially, the file

  247. consists of sections, each of which contains keys with values.

  248. <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> classes can read and write such files.  Let’s start by

  249. creating the above configuration file programmatically.</p>

  250. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">configparser</span>

  251. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  252. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;DEFAULT&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;ServerAliveInterval&#39;</span><span class="p">:</span> <span class="s1">&#39;45&#39;</span><span class="p">,</span>

  253. <span class="gp">... </span>                     <span class="s1">&#39;Compression&#39;</span><span class="p">:</span> <span class="s1">&#39;yes&#39;</span><span class="p">,</span>

  254. <span class="gp">... </span>                     <span class="s1">&#39;CompressionLevel&#39;</span><span class="p">:</span> <span class="s1">&#39;9&#39;</span><span class="p">}</span>

  255. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>

  256. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">][</span><span class="s1">&#39;User&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;hg&#39;</span>

  257. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>

  258. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">]</span>

  259. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;Port&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;50022&#39;</span>     <span class="c1"># mutates the parser</span>

  260. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;no&#39;</span>  <span class="c1"># same here</span>

  261. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;DEFAULT&#39;</span><span class="p">][</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;yes&#39;</span>

  262. <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;example.ini&#39;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">configfile</span><span class="p">:</span>

  263. <span class="gp">... </span>  <span class="n">config</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">configfile</span><span class="p">)</span>

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

  265. </pre></div>

  266. </div>

  267. <p>As you can see, we can treat a config parser much like a dictionary.

  268. There are differences, <a class="reference external" href="#mapping-protocol-access">outlined later</a>, but

  269. the behavior is very close to what you would expect from a dictionary.</p>

  270. <p>Now that we have created and saved a configuration file, let’s read it

  271. back and explore the data it holds.</p>

  272. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  273. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">sections</span><span class="p">()</span>

  274. <span class="go">[]</span>

  275. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;example.ini&#39;</span><span class="p">)</span>

  276. <span class="go">[&#39;example.ini&#39;]</span>

  277. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">sections</span><span class="p">()</span>

  278. <span class="go">[&#39;forge.example&#39;, &#39;topsecret.server.example&#39;]</span>

  279. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;forge.example&#39;</span> <span class="ow">in</span> <span class="n">config</span>

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

  281. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;python.org&#39;</span> <span class="ow">in</span> <span class="n">config</span>

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

  283. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">][</span><span class="s1">&#39;User&#39;</span><span class="p">]</span>

  284. <span class="go">&#39;hg&#39;</span>

  285. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;DEFAULT&#39;</span><span class="p">][</span><span class="s1">&#39;Compression&#39;</span><span class="p">]</span>

  286. <span class="go">&#39;yes&#39;</span>

  287. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span> <span class="o">=</span> <span class="n">config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">]</span>

  288. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">]</span>

  289. <span class="go">&#39;no&#39;</span>

  290. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;Port&#39;</span><span class="p">]</span>

  291. <span class="go">&#39;50022&#39;</span>

  292. <span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">]:</span>  

  293. <span class="gp">... </span>    <span class="nb">print</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>

  294. <span class="go">user</span>

  295. <span class="go">compressionlevel</span>

  296. <span class="go">serveraliveinterval</span>

  297. <span class="go">compression</span>

  298. <span class="go">forwardx11</span>

  299. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">][</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">]</span>

  300. <span class="go">&#39;yes&#39;</span>

  301. </pre></div>

  302. </div>

  303. <p>As we can see above, the API is pretty straightforward.  The only bit of magic

  304. involves the <code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code> section which provides default values for all other

  305. sections <a class="footnote-reference brackets" href="#id15" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.  Note also that keys in sections are

  306. case-insensitive and stored in lowercase <a class="footnote-reference brackets" href="#id15" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.</p>

  307. <p>It is possible to read several configurations into a single

  308. <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a>, where the most recently added configuration has the

  309. highest priority. Any conflicting keys are taken from the more recent

  310. configuration while the previously existing keys are retained.</p>

  311. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  312. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;example.ini&#39;</span><span class="p">)</span>

  313. <span class="go">[&#39;example.ini&#39;]</span>

  314. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">][</span><span class="s1">&#39;Port&#39;</span><span class="p">]</span>

  315. <span class="go">&#39;50022&#39;</span>

  316. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="s2">&quot;[topsecret.server.example]</span><span class="se">\n</span><span class="s2">Port=48484&quot;</span><span class="p">)</span>

  317. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">][</span><span class="s1">&#39;Port&#39;</span><span class="p">]</span>

  318. <span class="go">&#39;48484&#39;</span>

  319. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="o">.</span><span class="n">read_dict</span><span class="p">({</span><span class="s2">&quot;topsecret.server.example&quot;</span><span class="p">:</span> <span class="p">{</span><span class="s2">&quot;Port&quot;</span><span class="p">:</span> <span class="mi">21212</span><span class="p">}})</span>

  320. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">][</span><span class="s1">&#39;Port&#39;</span><span class="p">]</span>

  321. <span class="go">&#39;21212&#39;</span>

  322. <span class="gp">&gt;&gt;&gt; </span><span class="n">another_config</span><span class="p">[</span><span class="s1">&#39;topsecret.server.example&#39;</span><span class="p">][</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">]</span>

  323. <span class="go">&#39;no&#39;</span>

  324. </pre></div>

  325. </div>

  326. <p>This behaviour is equivalent to a <a class="reference internal" href="#configparser.ConfigParser.read" title="configparser.ConfigParser.read"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ConfigParser.read()</span></code></a> call with several

  327. files passed to the <em>filenames</em> parameter.</p>

  328. </section>

  329. <section id="supported-datatypes">

  330. <h2>Supported Datatypes<a class="headerlink" href="#supported-datatypes" title="Link to this heading">¶</a></h2>

  331. <p>Config parsers do not guess datatypes of values in configuration files, always

  332. storing them internally as strings.  This means that if you need other

  333. datatypes, you should convert on your own:</p>

  334. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">int</span><span class="p">(</span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;Port&#39;</span><span class="p">])</span>

  335. <span class="go">50022</span>

  336. <span class="gp">&gt;&gt;&gt; </span><span class="nb">float</span><span class="p">(</span><span class="n">topsecret</span><span class="p">[</span><span class="s1">&#39;CompressionLevel&#39;</span><span class="p">])</span>

  337. <span class="go">9.0</span>

  338. </pre></div>

  339. </div>

  340. <p>Since this task is so common, config parsers provide a range of handy getter

  341. methods to handle integers, floats and booleans.  The last one is the most

  342. interesting because simply passing the value to <code class="docutils literal notranslate"><span class="pre">bool()</span></code> would do no good

  343. since <code class="docutils literal notranslate"><span class="pre">bool('False')</span></code> is still <code class="docutils literal notranslate"><span class="pre">True</span></code>.  This is why config parsers also

  344. provide <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getboolean()</span></code></a>.  This method is case-insensitive and

  345. recognizes Boolean values from <code class="docutils literal notranslate"><span class="pre">'yes'</span></code>/<code class="docutils literal notranslate"><span class="pre">'no'</span></code>, <code class="docutils literal notranslate"><span class="pre">'on'</span></code>/<code class="docutils literal notranslate"><span class="pre">'off'</span></code>,

  346. <code class="docutils literal notranslate"><span class="pre">'true'</span></code>/<code class="docutils literal notranslate"><span class="pre">'false'</span></code> and <code class="docutils literal notranslate"><span class="pre">'1'</span></code>/<code class="docutils literal notranslate"><span class="pre">'0'</span></code> <a class="footnote-reference brackets" href="#id15" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.  For example:</p>

  347. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">)</span>

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

  349. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;forge.example&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;ForwardX11&#39;</span><span class="p">)</span>

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

  351. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;forge.example&#39;</span><span class="p">,</span> <span class="s1">&#39;Compression&#39;</span><span class="p">)</span>

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

  353. </pre></div>

  354. </div>

  355. <p>Apart from <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getboolean()</span></code></a>, config parsers also

  356. provide equivalent <a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getint()</span></code></a> and

  357. <a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getfloat()</span></code></a> methods.  You can register your own

  358. converters and customize the provided ones. <a class="footnote-reference brackets" href="#id15" id="id4" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p>

  359. </section>

  360. <section id="fallback-values">

  361. <h2>Fallback Values<a class="headerlink" href="#fallback-values" title="Link to this heading">¶</a></h2>

  362. <p>As with a dictionary, you can use a section’s <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> method to

  363. provide fallback values:</p>

  364. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Port&#39;</span><span class="p">)</span>

  365. <span class="go">&#39;50022&#39;</span>

  366. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;CompressionLevel&#39;</span><span class="p">)</span>

  367. <span class="go">&#39;9&#39;</span>

  368. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Cipher&#39;</span><span class="p">)</span>

  369. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Cipher&#39;</span><span class="p">,</span> <span class="s1">&#39;3des-cbc&#39;</span><span class="p">)</span>

  370. <span class="go">&#39;3des-cbc&#39;</span>

  371. </pre></div>

  372. </div>

  373. <p>Please note that default values have precedence over fallback values.

  374. For instance, in our example the <code class="docutils literal notranslate"><span class="pre">'CompressionLevel'</span></code> key was

  375. specified only in the <code class="docutils literal notranslate"><span class="pre">'DEFAULT'</span></code> section.  If we try to get it from

  376. the section <code class="docutils literal notranslate"><span class="pre">'topsecret.server.example'</span></code>, we will always get the default,

  377. even if we specify a fallback:</p>

  378. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;CompressionLevel&#39;</span><span class="p">,</span> <span class="s1">&#39;3&#39;</span><span class="p">)</span>

  379. <span class="go">&#39;9&#39;</span>

  380. </pre></div>

  381. </div>

  382. <p>One more thing to be aware of is that the parser-level <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> method

  383. provides a custom, more complex interface, maintained for backwards

  384. compatibility.  When using this method, a fallback value can be provided via

  385. the <code class="docutils literal notranslate"><span class="pre">fallback</span></code> keyword-only argument:</p>

  386. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;forge.example&#39;</span><span class="p">,</span> <span class="s1">&#39;monster&#39;</span><span class="p">,</span>

  387. <span class="gp">... </span>           <span class="n">fallback</span><span class="o">=</span><span class="s1">&#39;No such things as monsters&#39;</span><span class="p">)</span>

  388. <span class="go">&#39;No such things as monsters&#39;</span>

  389. </pre></div>

  390. </div>

  391. <p>The same <code class="docutils literal notranslate"><span class="pre">fallback</span></code> argument can be used with the

  392. <a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getint()</span></code></a>, <a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getfloat()</span></code></a> and

  393. <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getboolean()</span></code></a> methods, for example:</p>

  394. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;BatchMode&#39;</span> <span class="ow">in</span> <span class="n">topsecret</span>

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

  396. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;BatchMode&#39;</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

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

  398. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;DEFAULT&#39;</span><span class="p">][</span><span class="s1">&#39;BatchMode&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;no&#39;</span>

  399. <span class="gp">&gt;&gt;&gt; </span><span class="n">topsecret</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;BatchMode&#39;</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

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

  401. </pre></div>

  402. </div>

  403. </section>

  404. <section id="supported-ini-file-structure">

  405. <h2>Supported INI File Structure<a class="headerlink" href="#supported-ini-file-structure" title="Link to this heading">¶</a></h2>

  406. <p>A configuration file consists of sections, each led by a <code class="docutils literal notranslate"><span class="pre">[section]</span></code> header,

  407. followed by key/value entries separated by a specific string (<code class="docutils literal notranslate"><span class="pre">=</span></code> or <code class="docutils literal notranslate"><span class="pre">:</span></code> by

  408. default <a class="footnote-reference brackets" href="#id15" id="id5" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>).  By default, section names are case sensitive but keys are not

  409. <a class="footnote-reference brackets" href="#id15" id="id6" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.  Leading and trailing whitespace is removed from keys and values.

  410. Values can be omitted if the parser is configured to allow it <a class="footnote-reference brackets" href="#id15" id="id7" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>,

  411. in which case the key/value delimiter may also be left

  412. out.  Values can also span multiple lines, as long as they are indented deeper

  413. than the first line of the value.  Depending on the parser’s mode, blank lines

  414. may be treated as parts of multiline values or ignored.</p>

  415. <p>By default, a valid section name can be any string that does not contain ‘\n’.

  416. To change this, see <a class="reference internal" href="#configparser.ConfigParser.SECTCRE" title="configparser.ConfigParser.SECTCRE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConfigParser.SECTCRE</span></code></a>.</p>

  417. <p>Configuration files may include comments, prefixed by specific

  418. characters (<code class="docutils literal notranslate"><span class="pre">#</span></code> and <code class="docutils literal notranslate"><span class="pre">;</span></code> by default <a class="footnote-reference brackets" href="#id15" id="id8" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>).  Comments may appear on

  419. their own on an otherwise empty line, possibly indented. <a class="footnote-reference brackets" href="#id15" id="id9" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p>

  420. <p>For example:</p>

  421. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Simple Values]</span>

  422. <span class="na">key</span><span class="o">=</span><span class="s">value</span>

  423. <span class="na">spaces in keys</span><span class="o">=</span><span class="s">allowed</span>

  424. <span class="na">spaces in values</span><span class="o">=</span><span class="s">allowed as well</span>

  425. <span class="na">spaces around the delimiter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">obviously</span>

  426. <span class="na">you can also use</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s">to delimit keys from values</span>

  427. 

  428. <span class="k">[All Values Are Strings]</span>

  429. <span class="na">values like this</span><span class="o">:</span><span class="w"> </span><span class="s">1000000</span>

  430. <span class="na">or this</span><span class="o">:</span><span class="w"> </span><span class="s">3.14159265359</span>

  431. <span class="na">are they treated as numbers?</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="s">no</span>

  432. <span class="na">integers, floats and booleans are held as</span><span class="o">:</span><span class="w"> </span><span class="s">strings</span>

  433. <span class="na">can use the API to get converted values directly</span><span class="o">:</span><span class="w"> </span><span class="s">true</span>

  434. 

  435. <span class="k">[Multiline Values]</span>

  436. <span class="na">chorus</span><span class="o">:</span><span class="w"> </span><span class="s">I&#39;m a lumberjack, and I&#39;m okay</span>

  437. <span class="w">    </span><span class="na">I sleep all night and I work all day</span>

  438. 

  439. <span class="k">[No Values]</span>

  440. <span class="na">key_without_value</span>

  441. <span class="na">empty string value here</span><span class="w"> </span><span class="o">=</span>

  442. 

  443. <span class="k">[You can use comments]</span>

  444. <span class="c1"># like this</span>

  445. <span class="c1">; or this</span>

  446. 

  447. <span class="c1"># By default only in an empty line.</span>

  448. <span class="c1"># Inline comments can be harmful because they prevent users</span>

  449. <span class="c1"># from using the delimiting characters as parts of values.</span>

  450. <span class="c1"># That being said, this can be customized.</span>

  451. 

  452. <span class="w">    </span><span class="k">[Sections Can Be Indented]</span>

  453. <span class="w">        </span><span class="na">can_values_be_as_well</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span>

  454. <span class="w">        </span><span class="na">does_that_mean_anything_special</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">False</span>

  455. <span class="w">        </span><span class="na">purpose</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">formatting for readability</span>

  456. <span class="w">        </span><span class="na">multiline_values</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">are</span>

  457. <span class="w">            </span><span class="na">handled just fine as</span>

  458. <span class="w">            </span><span class="na">long as they are indented</span>

  459. <span class="w">            </span><span class="na">deeper than the first line</span>

  460. <span class="w">            </span><span class="na">of a value</span>

  461. <span class="w">        </span><span class="c1"># Did I mention we can indent comments, too?</span>

  462. </pre></div>

  463. </div>

  464. </section>

  465. <section id="interpolation-of-values">

  466. <h2>Interpolation of values<a class="headerlink" href="#interpolation-of-values" title="Link to this heading">¶</a></h2>

  467. <p>On top of the core functionality, <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a> supports

  468. interpolation.  This means values can be preprocessed before returning them

  469. from <code class="docutils literal notranslate"><span class="pre">get()</span></code> calls.</p>

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

  471. <dt class="sig sig-object py" id="configparser.BasicInterpolation">

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

  473. <dd><p>The default implementation used by <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a>.  It enables

  474. values to contain format strings which refer to other values in the same

  475. section, or values in the special default section <a class="footnote-reference brackets" href="#id15" id="id10" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.  Additional default

  476. values can be provided on initialization.</p>

  477. <p>For example:</p>

  478. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Paths]</span>

  479. <span class="na">home_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/Users</span>

  480. <span class="na">my_dir</span><span class="o">:</span><span class="w"> </span><span class="s">%(home_dir)s/lumberjack</span>

  481. <span class="na">my_pictures</span><span class="o">:</span><span class="w"> </span><span class="s">%(my_dir)s/Pictures</span>

  482. 

  483. <span class="k">[Escape]</span>

  484. <span class="c1"># use a %% to escape the % sign (% is the only character that needs to be escaped):</span>

  485. <span class="na">gain</span><span class="o">:</span><span class="w"> </span><span class="s">80%%</span>

  486. </pre></div>

  487. </div>

  488. <p>In the example above, <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a> with <em>interpolation</em> set to

  489. <code class="docutils literal notranslate"><span class="pre">BasicInterpolation()</span></code> would resolve <code class="docutils literal notranslate"><span class="pre">%(home_dir)s</span></code> to the value of

  490. <code class="docutils literal notranslate"><span class="pre">home_dir</span></code> (<code class="docutils literal notranslate"><span class="pre">/Users</span></code> in this case).  <code class="docutils literal notranslate"><span class="pre">%(my_dir)s</span></code> in effect would

  491. resolve to <code class="docutils literal notranslate"><span class="pre">/Users/lumberjack</span></code>.  All interpolations are done on demand so

  492. keys used in the chain of references do not have to be specified in any

  493. specific order in the configuration file.</p>

  494. <p>With <code class="docutils literal notranslate"><span class="pre">interpolation</span></code> set to <code class="docutils literal notranslate"><span class="pre">None</span></code>, the parser would simply return

  495. <code class="docutils literal notranslate"><span class="pre">%(my_dir)s/Pictures</span></code> as the value of <code class="docutils literal notranslate"><span class="pre">my_pictures</span></code> and

  496. <code class="docutils literal notranslate"><span class="pre">%(home_dir)s/lumberjack</span></code> as the value of <code class="docutils literal notranslate"><span class="pre">my_dir</span></code>.</p>

  497. </dd></dl>

  498. 

  499. <dl class="py class" id="index-2">

  500. <dt class="sig sig-object py" id="configparser.ExtendedInterpolation">

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

  502. <dd><p>An alternative handler for interpolation which implements a more advanced

  503. syntax, used for instance in <code class="docutils literal notranslate"><span class="pre">zc.buildout</span></code>.  Extended interpolation is

  504. using <code class="docutils literal notranslate"><span class="pre">${section:option}</span></code> to denote a value from a foreign section.

  505. Interpolation can span multiple levels.  For convenience, if the

  506. <code class="docutils literal notranslate"><span class="pre">section:</span></code> part is omitted, interpolation defaults to the current section

  507. (and possibly the default values from the special section).</p>

  508. <p>For example, the configuration specified above with basic interpolation,

  509. would look like this with extended interpolation:</p>

  510. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Paths]</span>

  511. <span class="na">home_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/Users</span>

  512. <span class="na">my_dir</span><span class="o">:</span><span class="w"> </span><span class="s">${home_dir}/lumberjack</span>

  513. <span class="na">my_pictures</span><span class="o">:</span><span class="w"> </span><span class="s">${my_dir}/Pictures</span>

  514. 

  515. <span class="k">[Escape]</span>

  516. <span class="c1"># use a $$ to escape the $ sign ($ is the only character that needs to be escaped):</span>

  517. <span class="na">cost</span><span class="o">:</span><span class="w"> </span><span class="s">$$80</span>

  518. </pre></div>

  519. </div>

  520. <p>Values from other sections can be fetched as well:</p>

  521. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Common]</span>

  522. <span class="na">home_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/Users</span>

  523. <span class="na">library_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/Library</span>

  524. <span class="na">system_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/System</span>

  525. <span class="na">macports_dir</span><span class="o">:</span><span class="w"> </span><span class="s">/opt/local</span>

  526. 

  527. <span class="k">[Frameworks]</span>

  528. <span class="na">Python</span><span class="o">:</span><span class="w"> </span><span class="s">3.2</span>

  529. <span class="na">path</span><span class="o">:</span><span class="w"> </span><span class="s">${Common:system_dir}/Library/Frameworks/</span>

  530. 

  531. <span class="k">[Arthur]</span>

  532. <span class="na">nickname</span><span class="o">:</span><span class="w"> </span><span class="s">Two Sheds</span>

  533. <span class="na">last_name</span><span class="o">:</span><span class="w"> </span><span class="s">Jackson</span>

  534. <span class="na">my_dir</span><span class="o">:</span><span class="w"> </span><span class="s">${Common:home_dir}/twosheds</span>

  535. <span class="na">my_pictures</span><span class="o">:</span><span class="w"> </span><span class="s">${my_dir}/Pictures</span>

  536. <span class="na">python_dir</span><span class="o">:</span><span class="w"> </span><span class="s">${Frameworks:path}/Python/Versions/${Frameworks:Python}</span>

  537. </pre></div>

  538. </div>

  539. </dd></dl>

  540. 

  541. </section>

  542. <section id="mapping-protocol-access">

  543. <h2>Mapping Protocol Access<a class="headerlink" href="#mapping-protocol-access" title="Link to this heading">¶</a></h2>

  544. <div class="versionadded">

  545. <p><span class="versionmodified added">New in version 3.2.</span></p>

  546. </div>

  547. <p>Mapping protocol access is a generic name for functionality that enables using

  548. custom objects as if they were dictionaries.  In case of <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a>,

  549. the mapping interface implementation is using the

  550. <code class="docutils literal notranslate"><span class="pre">parser['section']['option']</span></code> notation.</p>

  551. <p><code class="docutils literal notranslate"><span class="pre">parser['section']</span></code> in particular returns a proxy for the section’s data in

  552. the parser.  This means that the values are not copied but they are taken from

  553. the original parser on demand.  What’s even more important is that when values

  554. are changed on a section proxy, they are actually mutated in the original

  555. parser.</p>

  556. <p><a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> objects behave as close to actual dictionaries as possible.

  557. The mapping interface is complete and adheres to the

  558. <a class="reference internal" href="collections.abc.html#collections.abc.MutableMapping" title="collections.abc.MutableMapping"><code class="xref py py-class docutils literal notranslate"><span class="pre">MutableMapping</span></code></a> ABC.

  559. However, there are a few differences that should be taken into account:</p>

  560. <ul>

  561. <li><p>By default, all keys in sections are accessible in a case-insensitive manner

  562. <a class="footnote-reference brackets" href="#id15" id="id11" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.  E.g. <code class="docutils literal notranslate"><span class="pre">for</span> <span class="pre">option</span> <span class="pre">in</span> <span class="pre">parser[&quot;section&quot;]</span></code> yields only <code class="docutils literal notranslate"><span class="pre">optionxform</span></code>’ed

  563. option key names.  This means lowercased keys by default.  At the same time,

  564. for a section that holds the key <code class="docutils literal notranslate"><span class="pre">'a'</span></code>, both expressions return <code class="docutils literal notranslate"><span class="pre">True</span></code>:</p>

  565. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="s2">&quot;a&quot;</span> <span class="ow">in</span> <span class="n">parser</span><span class="p">[</span><span class="s2">&quot;section&quot;</span><span class="p">]</span>

  566. <span class="s2">&quot;A&quot;</span> <span class="ow">in</span> <span class="n">parser</span><span class="p">[</span><span class="s2">&quot;section&quot;</span><span class="p">]</span>

  567. </pre></div>

  568. </div>

  569. </li>

  570. <li><p>All sections include <code class="docutils literal notranslate"><span class="pre">DEFAULTSECT</span></code> values as well which means that

  571. <code class="docutils literal notranslate"><span class="pre">.clear()</span></code> on a section may not leave the section visibly empty.  This is

  572. because default values cannot be deleted from the section (because technically

  573. they are not there).  If they are overridden in the section, deleting causes

  574. the default value to be visible again.  Trying to delete a default value

  575. causes a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</p></li>

  576. <li><p><code class="docutils literal notranslate"><span class="pre">DEFAULTSECT</span></code> cannot be removed from the parser:</p>

  577. <ul class="simple">

  578. <li><p>trying to delete it raises <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>,</p></li>

  579. <li><p><code class="docutils literal notranslate"><span class="pre">parser.clear()</span></code> leaves it intact,</p></li>

  580. <li><p><code class="docutils literal notranslate"><span class="pre">parser.popitem()</span></code> never returns it.</p></li>

  581. </ul>

  582. </li>

  583. <li><p><code class="docutils literal notranslate"><span class="pre">parser.get(section,</span> <span class="pre">option,</span> <span class="pre">**kwargs)</span></code> - the second argument is <strong>not</strong>

  584. a fallback value.  Note however that the section-level <code class="docutils literal notranslate"><span class="pre">get()</span></code> methods are

  585. compatible both with the mapping protocol and the classic configparser API.</p></li>

  586. <li><p><code class="docutils literal notranslate"><span class="pre">parser.items()</span></code> is compatible with the mapping protocol (returns a list of

  587. <em>section_name</em>, <em>section_proxy</em> pairs including the DEFAULTSECT).  However,

  588. this method can also be invoked with arguments: <code class="docutils literal notranslate"><span class="pre">parser.items(section,</span> <span class="pre">raw,</span>

  589. <span class="pre">vars)</span></code>.  The latter call returns a list of <em>option</em>, <em>value</em> pairs for

  590. a specified <code class="docutils literal notranslate"><span class="pre">section</span></code>, with all interpolations expanded (unless

  591. <code class="docutils literal notranslate"><span class="pre">raw=True</span></code> is provided).</p></li>

  592. </ul>

  593. <p>The mapping protocol is implemented on top of the existing legacy API so that

  594. subclasses overriding the original interface still should have mappings working

  595. as expected.</p>

  596. </section>

  597. <section id="customizing-parser-behaviour">

  598. <h2>Customizing Parser Behaviour<a class="headerlink" href="#customizing-parser-behaviour" title="Link to this heading">¶</a></h2>

  599. <p>There are nearly as many INI format variants as there are applications using it.

  600. <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> goes a long way to provide support for the largest sensible

  601. set of INI styles available.  The default functionality is mainly dictated by

  602. historical background and it’s very likely that you will want to customize some

  603. of the features.</p>

  604. <p>The most common way to change the way a specific config parser works is to use

  605. the <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code> options:</p>

  606. <ul>

  607. <li><p><em>defaults</em>, default value: <code class="docutils literal notranslate"><span class="pre">None</span></code></p>

  608. <p>This option accepts a dictionary of key-value pairs which will be initially

  609. put in the <code class="docutils literal notranslate"><span class="pre">DEFAULT</span></code> section.  This makes for an elegant way to support

  610. concise configuration files that don’t specify values which are the same as

  611. the documented default.</p>

  612. <p>Hint: if you want to specify default values for a specific section, use

  613. <a class="reference internal" href="#configparser.ConfigParser.read_dict" title="configparser.ConfigParser.read_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_dict()</span></code></a> before you read the actual file.</p>

  614. </li>

  615. <li><p><em>dict_type</em>, default value: <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></p>

  616. <p>This option has a major impact on how the mapping protocol will behave and how

  617. the written configuration files look.  With the standard dictionary, every

  618. section is stored in the order they were added to the parser.  Same goes for

  619. options within sections.</p>

  620. <p>An alternative dictionary type can be used for example to sort sections and

  621. options on write-back.</p>

  622. <p>Please note: there are ways to add a set of key-value pairs in a single

  623. operation.  When you use a regular dictionary in those operations, the order

  624. of the keys will be ordered.  For example:</p>

  625. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">parser</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  626. <span class="gp">&gt;&gt;&gt; </span><span class="n">parser</span><span class="o">.</span><span class="n">read_dict</span><span class="p">({</span><span class="s1">&#39;section1&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;key1&#39;</span><span class="p">:</span> <span class="s1">&#39;value1&#39;</span><span class="p">,</span>

  627. <span class="gp">... </span>                               <span class="s1">&#39;key2&#39;</span><span class="p">:</span> <span class="s1">&#39;value2&#39;</span><span class="p">,</span>

  628. <span class="gp">... </span>                               <span class="s1">&#39;key3&#39;</span><span class="p">:</span> <span class="s1">&#39;value3&#39;</span><span class="p">},</span>

  629. <span class="gp">... </span>                  <span class="s1">&#39;section2&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;keyA&#39;</span><span class="p">:</span> <span class="s1">&#39;valueA&#39;</span><span class="p">,</span>

  630. <span class="gp">... </span>                               <span class="s1">&#39;keyB&#39;</span><span class="p">:</span> <span class="s1">&#39;valueB&#39;</span><span class="p">,</span>

  631. <span class="gp">... </span>                               <span class="s1">&#39;keyC&#39;</span><span class="p">:</span> <span class="s1">&#39;valueC&#39;</span><span class="p">},</span>

  632. <span class="gp">... </span>                  <span class="s1">&#39;section3&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;foo&#39;</span><span class="p">:</span> <span class="s1">&#39;x&#39;</span><span class="p">,</span>

  633. <span class="gp">... </span>                               <span class="s1">&#39;bar&#39;</span><span class="p">:</span> <span class="s1">&#39;y&#39;</span><span class="p">,</span>

  634. <span class="gp">... </span>                               <span class="s1">&#39;baz&#39;</span><span class="p">:</span> <span class="s1">&#39;z&#39;</span><span class="p">}</span>

  635. <span class="gp">... </span><span class="p">})</span>

  636. <span class="gp">&gt;&gt;&gt; </span><span class="n">parser</span><span class="o">.</span><span class="n">sections</span><span class="p">()</span>

  637. <span class="go">[&#39;section1&#39;, &#39;section2&#39;, &#39;section3&#39;]</span>

  638. <span class="gp">&gt;&gt;&gt; </span><span class="p">[</span><span class="n">option</span> <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">parser</span><span class="p">[</span><span class="s1">&#39;section3&#39;</span><span class="p">]]</span>

  639. <span class="go">[&#39;foo&#39;, &#39;bar&#39;, &#39;baz&#39;]</span>

  640. </pre></div>

  641. </div>

  642. </li>

  643. <li><p><em>allow_no_value</em>, default value: <code class="docutils literal notranslate"><span class="pre">False</span></code></p>

  644. <p>Some configuration files are known to include settings without values, but

  645. which otherwise conform to the syntax supported by <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a>.  The

  646. <em>allow_no_value</em> parameter to the constructor can be used to

  647. indicate that such values should be accepted:</p>

  648. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">configparser</span>

  649. 

  650. <span class="gp">&gt;&gt;&gt; </span><span class="n">sample_config</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>

  651. <span class="gp">... </span><span class="s2">[mysqld]</span>

  652. <span class="gp">... </span><span class="s2">  user = mysql</span>

  653. <span class="gp">... </span><span class="s2">  pid-file = /var/run/mysqld/mysqld.pid</span>

  654. <span class="gp">... </span><span class="s2">  skip-external-locking</span>

  655. <span class="gp">... </span><span class="s2">  old_passwords = 1</span>

  656. <span class="gp">... </span><span class="s2">  skip-bdb</span>

  657. <span class="gp">... </span><span class="s2">  # we don&#39;t need ACID today</span>

  658. <span class="gp">... </span><span class="s2">  skip-innodb</span>

  659. <span class="gp">... </span><span class="s2">&quot;&quot;&quot;</span>

  660. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">(</span><span class="n">allow_no_value</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  661. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="n">sample_config</span><span class="p">)</span>

  662. 

  663. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Settings with values are treated as before:</span>

  664. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;mysqld&quot;</span><span class="p">][</span><span class="s2">&quot;user&quot;</span><span class="p">]</span>

  665. <span class="go">&#39;mysql&#39;</span>

  666. 

  667. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Settings without values provide None:</span>

  668. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;mysqld&quot;</span><span class="p">][</span><span class="s2">&quot;skip-bdb&quot;</span><span class="p">]</span>

  669. 

  670. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Settings which aren&#39;t specified still raise an error:</span>

  671. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;mysqld&quot;</span><span class="p">][</span><span class="s2">&quot;does-not-exist&quot;</span><span class="p">]</span>

  672. <span class="gt">Traceback (most recent call last):</span>

  673. <span class="w">  </span><span class="c">...</span>

  674. <span class="gr">KeyError</span>: <span class="n">&#39;does-not-exist&#39;</span>

  675. </pre></div>

  676. </div>

  677. </li>

  678. <li><p><em>delimiters</em>, default value: <code class="docutils literal notranslate"><span class="pre">('=',</span> <span class="pre">':')</span></code></p>

  679. <p>Delimiters are substrings that delimit keys from values within a section.

  680. The first occurrence of a delimiting substring on a line is considered

  681. a delimiter.  This means values (but not keys) can contain the delimiters.</p>

  682. <p>See also the <em>space_around_delimiters</em> argument to

  683. <a class="reference internal" href="#configparser.ConfigParser.write" title="configparser.ConfigParser.write"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ConfigParser.write()</span></code></a>.</p>

  684. </li>

  685. <li><p><em>comment_prefixes</em>, default value: <code class="docutils literal notranslate"><span class="pre">('#',</span> <span class="pre">';')</span></code></p></li>

  686. <li><p><em>inline_comment_prefixes</em>, default value: <code class="docutils literal notranslate"><span class="pre">None</span></code></p>

  687. <p>Comment prefixes are strings that indicate the start of a valid comment within

  688. a config file. <em>comment_prefixes</em> are used only on otherwise empty lines

  689. (optionally indented) whereas <em>inline_comment_prefixes</em> can be used after

  690. every valid value (e.g. section names, options and empty lines as well).  By

  691. default inline comments are disabled and <code class="docutils literal notranslate"><span class="pre">'#'</span></code> and <code class="docutils literal notranslate"><span class="pre">';'</span></code> are used as

  692. prefixes for whole line comments.</p>

  693. <div class="versionchanged">

  694. <p><span class="versionmodified changed">Changed in version 3.2: </span>In previous versions of <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> behaviour matched

  695. <code class="docutils literal notranslate"><span class="pre">comment_prefixes=('#',';')</span></code> and <code class="docutils literal notranslate"><span class="pre">inline_comment_prefixes=(';',)</span></code>.</p>

  696. </div>

  697. <p>Please note that config parsers don’t support escaping of comment prefixes so

  698. using <em>inline_comment_prefixes</em> may prevent users from specifying option

  699. values with characters used as comment prefixes.  When in doubt, avoid

  700. setting <em>inline_comment_prefixes</em>.  In any circumstances, the only way of

  701. storing comment prefix characters at the beginning of a line in multiline

  702. values is to interpolate the prefix, for example:</p>

  703. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">configparser</span> <span class="kn">import</span> <span class="n">ConfigParser</span><span class="p">,</span> <span class="n">ExtendedInterpolation</span>

  704. <span class="gp">&gt;&gt;&gt; </span><span class="n">parser</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="p">(</span><span class="n">interpolation</span><span class="o">=</span><span class="n">ExtendedInterpolation</span><span class="p">())</span>

  705. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># the default BasicInterpolation could be used as well</span>

  706. <span class="gp">&gt;&gt;&gt; </span><span class="n">parser</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span>

  707. <span class="gp">... </span><span class="s2">[DEFAULT]</span>

  708. <span class="gp">... </span><span class="s2">hash = #</span>

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

  710. <span class="gp">... </span><span class="s2">[hashes]</span>

  711. <span class="gp">... </span><span class="s2">shebang =</span>

  712. <span class="gp">... </span><span class="s2">  $</span><span class="si">{hash}</span><span class="s2">!/usr/bin/env python</span>

  713. <span class="gp">... </span><span class="s2">  $</span><span class="si">{hash}</span><span class="s2"> -*- coding: utf-8 -*-</span>

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

  715. <span class="gp">... </span><span class="s2">extensions =</span>

  716. <span class="gp">... </span><span class="s2">  enabled_extension</span>

  717. <span class="gp">... </span><span class="s2">  another_extension</span>

  718. <span class="gp">... </span><span class="s2">  #disabled_by_comment</span>

  719. <span class="gp">... </span><span class="s2">  yet_another_extension</span>

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

  721. <span class="gp">... </span><span class="s2">interpolation not necessary = if # is not at line start</span>

  722. <span class="gp">... </span><span class="s2">even in multiline values = line #1</span>

  723. <span class="gp">... </span><span class="s2">  line #2</span>

  724. <span class="gp">... </span><span class="s2">  line #3</span>

  725. <span class="gp">... </span><span class="s2">&quot;&quot;&quot;</span><span class="p">)</span>

  726. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">parser</span><span class="p">[</span><span class="s1">&#39;hashes&#39;</span><span class="p">][</span><span class="s1">&#39;shebang&#39;</span><span class="p">])</span>

  727. 

  728. <span class="go">#!/usr/bin/env python</span>

  729. <span class="go"># -*- coding: utf-8 -*-</span>

  730. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">parser</span><span class="p">[</span><span class="s1">&#39;hashes&#39;</span><span class="p">][</span><span class="s1">&#39;extensions&#39;</span><span class="p">])</span>

  731. 

  732. <span class="go">enabled_extension</span>

  733. <span class="go">another_extension</span>

  734. <span class="go">yet_another_extension</span>

  735. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">parser</span><span class="p">[</span><span class="s1">&#39;hashes&#39;</span><span class="p">][</span><span class="s1">&#39;interpolation not necessary&#39;</span><span class="p">])</span>

  736. <span class="go">if # is not at line start</span>

  737. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">parser</span><span class="p">[</span><span class="s1">&#39;hashes&#39;</span><span class="p">][</span><span class="s1">&#39;even in multiline values&#39;</span><span class="p">])</span>

  738. <span class="go">line #1</span>

  739. <span class="go">line #2</span>

  740. <span class="go">line #3</span>

  741. </pre></div>

  742. </div>

  743. </li>

  744. <li><p><em>strict</em>, default value: <code class="docutils literal notranslate"><span class="pre">True</span></code></p>

  745. <p>When set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the parser will not allow for any section or option

  746. duplicates while reading from a single source (using <a class="reference internal" href="#configparser.ConfigParser.read_file" title="configparser.ConfigParser.read_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_file()</span></code></a>,

  747. <a class="reference internal" href="#configparser.ConfigParser.read_string" title="configparser.ConfigParser.read_string"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_string()</span></code></a> or <a class="reference internal" href="#configparser.ConfigParser.read_dict" title="configparser.ConfigParser.read_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_dict()</span></code></a>).  It is recommended to use strict

  748. parsers in new applications.</p>

  749. <div class="versionchanged">

  750. <p><span class="versionmodified changed">Changed in version 3.2: </span>In previous versions of <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> behaviour matched

  751. <code class="docutils literal notranslate"><span class="pre">strict=False</span></code>.</p>

  752. </div>

  753. </li>

  754. <li><p><em>empty_lines_in_values</em>, default value: <code class="docutils literal notranslate"><span class="pre">True</span></code></p>

  755. <p>In config parsers, values can span multiple lines as long as they are

  756. indented more than the key that holds them.  By default parsers also let

  757. empty lines to be parts of values.  At the same time, keys can be arbitrarily

  758. indented themselves to improve readability.  In consequence, when

  759. configuration files get big and complex, it is easy for the user to lose

  760. track of the file structure.  Take for instance:</p>

  761. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[Section]</span>

  762. <span class="na">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">multiline</span>

  763. <span class="w">  </span><span class="na">value with a gotcha</span>

  764. 

  765. <span class="w"> </span><span class="na">this</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">is still a part of the multiline value of &#39;key&#39;</span>

  766. </pre></div>

  767. </div>

  768. <p>This can be especially problematic for the user to see if she’s using a

  769. proportional font to edit the file.  That is why when your application does

  770. not need values with empty lines, you should consider disallowing them.  This

  771. will make empty lines split keys every time.  In the example above, it would

  772. produce two keys, <code class="docutils literal notranslate"><span class="pre">key</span></code> and <code class="docutils literal notranslate"><span class="pre">this</span></code>.</p>

  773. </li>

  774. <li><p><em>default_section</em>, default value: <code class="docutils literal notranslate"><span class="pre">configparser.DEFAULTSECT</span></code> (that is:

  775. <code class="docutils literal notranslate"><span class="pre">&quot;DEFAULT&quot;</span></code>)</p>

  776. <p>The convention of allowing a special section of default values for other

  777. sections or interpolation purposes is a powerful concept of this library,

  778. letting users create complex declarative configurations.  This section is

  779. normally called <code class="docutils literal notranslate"><span class="pre">&quot;DEFAULT&quot;</span></code> but this can be customized to point to any

  780. other valid section name.  Some typical values include: <code class="docutils literal notranslate"><span class="pre">&quot;general&quot;</span></code> or

  781. <code class="docutils literal notranslate"><span class="pre">&quot;common&quot;</span></code>.  The name provided is used for recognizing default sections

  782. when reading from any source and is used when writing configuration back to

  783. a file.  Its current value can be retrieved using the

  784. <code class="docutils literal notranslate"><span class="pre">parser_instance.default_section</span></code> attribute and may be modified at runtime

  785. (i.e. to convert files from one format to another).</p>

  786. </li>

  787. <li><p><em>interpolation</em>, default value: <code class="docutils literal notranslate"><span class="pre">configparser.BasicInterpolation</span></code></p>

  788. <p>Interpolation behaviour may be customized by providing a custom handler

  789. through the <em>interpolation</em> argument. <code class="docutils literal notranslate"><span class="pre">None</span></code> can be used to turn off

  790. interpolation completely, <code class="docutils literal notranslate"><span class="pre">ExtendedInterpolation()</span></code> provides a more

  791. advanced variant inspired by <code class="docutils literal notranslate"><span class="pre">zc.buildout</span></code>.  More on the subject in the

  792. <a class="reference external" href="#interpolation-of-values">dedicated documentation section</a>.

  793. <a class="reference internal" href="#configparser.RawConfigParser" title="configparser.RawConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">RawConfigParser</span></code></a> has a default value of <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  794. </li>

  795. <li><p><em>converters</em>, default value: not set</p>

  796. <p>Config parsers provide option value getters that perform type conversion.  By

  797. default <a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getint()</span></code></a>, <a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getfloat()</span></code></a>, and

  798. <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getboolean()</span></code></a> are implemented.  Should other getters be

  799. desirable, users may define them in a subclass or pass a dictionary where each

  800. key is a name of the converter and each value is a callable implementing said

  801. conversion.  For instance, passing <code class="docutils literal notranslate"><span class="pre">{'decimal':</span> <span class="pre">decimal.Decimal}</span></code> would add

  802. <code class="xref py py-meth docutils literal notranslate"><span class="pre">getdecimal()</span></code> on both the parser object and all section proxies.  In

  803. other words, it will be possible to write both

  804. <code class="docutils literal notranslate"><span class="pre">parser_instance.getdecimal('section',</span> <span class="pre">'key',</span> <span class="pre">fallback=0)</span></code> and

  805. <code class="docutils literal notranslate"><span class="pre">parser_instance['section'].getdecimal('key',</span> <span class="pre">0)</span></code>.</p>

  806. <p>If the converter needs to access the state of the parser, it can be

  807. implemented as a method on a config parser subclass.  If the name of this

  808. method starts with <code class="docutils literal notranslate"><span class="pre">get</span></code>, it will be available on all section proxies, in

  809. the dict-compatible form (see the <code class="docutils literal notranslate"><span class="pre">getdecimal()</span></code> example above).</p>

  810. </li>

  811. </ul>

  812. <p>More advanced customization may be achieved by overriding default values of

  813. these parser attributes.  The defaults are defined on the classes, so they may

  814. be overridden by subclasses or by attribute assignment.</p>

  815. <dl class="py attribute">

  816. <dt class="sig sig-object py" id="configparser.ConfigParser.BOOLEAN_STATES">

  817. <span class="sig-prename descclassname"><span class="pre">ConfigParser.</span></span><span class="sig-name descname"><span class="pre">BOOLEAN_STATES</span></span><a class="headerlink" href="#configparser.ConfigParser.BOOLEAN_STATES" title="Link to this definition">¶</a></dt>

  818. <dd><p>By default when using <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getboolean()</span></code></a>, config parsers

  819. consider the following values <code class="docutils literal notranslate"><span class="pre">True</span></code>: <code class="docutils literal notranslate"><span class="pre">'1'</span></code>, <code class="docutils literal notranslate"><span class="pre">'yes'</span></code>, <code class="docutils literal notranslate"><span class="pre">'true'</span></code>,

  820. <code class="docutils literal notranslate"><span class="pre">'on'</span></code> and the following values <code class="docutils literal notranslate"><span class="pre">False</span></code>: <code class="docutils literal notranslate"><span class="pre">'0'</span></code>, <code class="docutils literal notranslate"><span class="pre">'no'</span></code>, <code class="docutils literal notranslate"><span class="pre">'false'</span></code>,

  821. <code class="docutils literal notranslate"><span class="pre">'off'</span></code>.  You can override this by specifying a custom dictionary of strings

  822. and their Boolean outcomes. For example:</p>

  823. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  824. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;section1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;funky&#39;</span><span class="p">:</span> <span class="s1">&#39;nope&#39;</span><span class="p">}</span>

  825. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;section1&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;funky&#39;</span><span class="p">)</span>

  826. <span class="gt">Traceback (most recent call last):</span>

  827. <span class="c">...</span>

  828. <span class="gr">ValueError</span>: <span class="n">Not a boolean: nope</span>

  829. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">BOOLEAN_STATES</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;sure&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;nope&#39;</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>

  830. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;section1&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;funky&#39;</span><span class="p">)</span>

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

  832. </pre></div>

  833. </div>

  834. <p>Other typical Boolean pairs include <code class="docutils literal notranslate"><span class="pre">accept</span></code>/<code class="docutils literal notranslate"><span class="pre">reject</span></code> or

  835. <code class="docutils literal notranslate"><span class="pre">enabled</span></code>/<code class="docutils literal notranslate"><span class="pre">disabled</span></code>.</p>

  836. </dd></dl>

  837. 

  838. <dl class="py method">

  839. <dt class="sig sig-object py">

  840. <span class="sig-prename descclassname"><span class="pre">ConfigParser.</span></span><span class="sig-name descname"><span class="pre">optionxform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span></dt>

  841. <dd><p>This method transforms option names on every read, get, or set

  842. operation.  The default converts the name to lowercase.  This also

  843. means that when a configuration file gets written, all keys will be

  844. lowercase.  Override this method if that’s unsuitable.

  845. For example:</p>

  846. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>

  847. <span class="gp">... </span><span class="s2">[Section1]</span>

  848. <span class="gp">... </span><span class="s2">Key = Value</span>

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

  850. <span class="gp">... </span><span class="s2">[Section2]</span>

  851. <span class="gp">... </span><span class="s2">AnotherKey = Value</span>

  852. <span class="gp">... </span><span class="s2">&quot;&quot;&quot;</span>

  853. <span class="gp">&gt;&gt;&gt; </span><span class="n">typical</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  854. <span class="gp">&gt;&gt;&gt; </span><span class="n">typical</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>

  855. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">typical</span><span class="p">[</span><span class="s1">&#39;Section1&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

  856. <span class="go">[&#39;key&#39;]</span>

  857. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">typical</span><span class="p">[</span><span class="s1">&#39;Section2&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

  858. <span class="go">[&#39;anotherkey&#39;]</span>

  859. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">RawConfigParser</span><span class="p">()</span>

  860. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">optionxform</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">option</span><span class="p">:</span> <span class="n">option</span>

  861. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>

  862. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;Section1&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

  863. <span class="go">[&#39;Key&#39;]</span>

  864. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">custom</span><span class="p">[</span><span class="s1">&#39;Section2&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>

  865. <span class="go">[&#39;AnotherKey&#39;]</span>

  866. </pre></div>

  867. </div>

  868. <div class="admonition note">

  869. <p class="admonition-title">Note</p>

  870. <p>The optionxform function transforms option names to a canonical form.

  871. This should be an idempotent function: if the name is already in

  872. canonical form, it should be returned unchanged.</p>

  873. </div>

  874. </dd></dl>

  875. 

  876. <dl class="py attribute">

  877. <dt class="sig sig-object py" id="configparser.ConfigParser.SECTCRE">

  878. <span class="sig-prename descclassname"><span class="pre">ConfigParser.</span></span><span class="sig-name descname"><span class="pre">SECTCRE</span></span><a class="headerlink" href="#configparser.ConfigParser.SECTCRE" title="Link to this definition">¶</a></dt>

  879. <dd><p>A compiled regular expression used to parse section headers.  The default

  880. matches <code class="docutils literal notranslate"><span class="pre">[section]</span></code> to the name <code class="docutils literal notranslate"><span class="pre">&quot;section&quot;</span></code>.  Whitespace is considered

  881. part of the section name, thus <code class="docutils literal notranslate"><span class="pre">[</span>&#160; <span class="pre">larch</span>&#160; <span class="pre">]</span></code> will be read as a section of

  882. name <code class="docutils literal notranslate"><span class="pre">&quot;</span>&#160; <span class="pre">larch</span>&#160; <span class="pre">&quot;</span></code>.  Override this attribute if that’s unsuitable.  For

  883. example:</p>

  884. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">re</span>

  885. <span class="gp">&gt;&gt;&gt; </span><span class="n">config</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>

  886. <span class="gp">... </span><span class="s2">[Section 1]</span>

  887. <span class="gp">... </span><span class="s2">option = value</span>

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

  889. <span class="gp">... </span><span class="s2">[  Section 2  ]</span>

  890. <span class="gp">... </span><span class="s2">another = val</span>

  891. <span class="gp">... </span><span class="s2">&quot;&quot;&quot;</span>

  892. <span class="gp">&gt;&gt;&gt; </span><span class="n">typical</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  893. <span class="gp">&gt;&gt;&gt; </span><span class="n">typical</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>

  894. <span class="gp">&gt;&gt;&gt; </span><span class="n">typical</span><span class="o">.</span><span class="n">sections</span><span class="p">()</span>

  895. <span class="go">[&#39;Section 1&#39;, &#39;  Section 2  &#39;]</span>

  896. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  897. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">SECTCRE</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\[ *(?P&lt;header&gt;[^]]+?) *\]&quot;</span><span class="p">)</span>

  898. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">read_string</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>

  899. <span class="gp">&gt;&gt;&gt; </span><span class="n">custom</span><span class="o">.</span><span class="n">sections</span><span class="p">()</span>

  900. <span class="go">[&#39;Section 1&#39;, &#39;Section 2&#39;]</span>

  901. </pre></div>

  902. </div>

  903. <div class="admonition note">

  904. <p class="admonition-title">Note</p>

  905. <p>While ConfigParser objects also use an <code class="docutils literal notranslate"><span class="pre">OPTCRE</span></code> attribute for recognizing

  906. option lines, it’s not recommended to override it because that would

  907. interfere with constructor options <em>allow_no_value</em> and <em>delimiters</em>.</p>

  908. </div>

  909. </dd></dl>

  910. 

  911. </section>

  912. <section id="legacy-api-examples">

  913. <h2>Legacy API Examples<a class="headerlink" href="#legacy-api-examples" title="Link to this heading">¶</a></h2>

  914. <p>Mainly because of backwards compatibility concerns, <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a>

  915. provides also a legacy API with explicit <code class="docutils literal notranslate"><span class="pre">get</span></code>/<code class="docutils literal notranslate"><span class="pre">set</span></code> methods.  While there

  916. are valid use cases for the methods outlined below, mapping protocol access is

  917. preferred for new projects.  The legacy API is at times more advanced,

  918. low-level and downright counterintuitive.</p>

  919. <p>An example of writing to a configuration file:</p>

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

  921. 

  922. <span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">RawConfigParser</span><span class="p">()</span>

  923. 

  924. <span class="c1"># Please note that using RawConfigParser&#39;s set functions, you can assign</span>

  925. <span class="c1"># non-string values to keys internally, but will receive an error when</span>

  926. <span class="c1"># attempting to write to a file or when you get it in non-raw mode. Setting</span>

  927. <span class="c1"># values using the mapping protocol or ConfigParser&#39;s set() does not allow</span>

  928. <span class="c1"># such assignments to take place.</span>

  929. <span class="n">config</span><span class="o">.</span><span class="n">add_section</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">)</span>

  930. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;an_int&#39;</span><span class="p">,</span> <span class="s1">&#39;15&#39;</span><span class="p">)</span>

  931. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;a_bool&#39;</span><span class="p">,</span> <span class="s1">&#39;true&#39;</span><span class="p">)</span>

  932. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;a_float&#39;</span><span class="p">,</span> <span class="s1">&#39;3.1415&#39;</span><span class="p">)</span>

  933. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;baz&#39;</span><span class="p">,</span> <span class="s1">&#39;fun&#39;</span><span class="p">)</span>

  934. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="s1">&#39;Python&#39;</span><span class="p">)</span>

  935. <span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">%(bar)s</span><span class="s1"> is </span><span class="si">%(baz)s</span><span class="s1">!&#39;</span><span class="p">)</span>

  936. 

  937. <span class="c1"># Writing our configuration file to &#39;example.cfg&#39;</span>

  938. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;example.cfg&#39;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">configfile</span><span class="p">:</span>

  939.     <span class="n">config</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">configfile</span><span class="p">)</span>

  940. </pre></div>

  941. </div>

  942. <p>An example of reading the configuration file again:</p>

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

  944. 

  945. <span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">RawConfigParser</span><span class="p">()</span>

  946. <span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;example.cfg&#39;</span><span class="p">)</span>

  947. 

  948. <span class="c1"># getfloat() raises an exception if the value is not a float</span>

  949. <span class="c1"># getint() and getboolean() also do this for their respective types</span>

  950. <span class="n">a_float</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getfloat</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;a_float&#39;</span><span class="p">)</span>

  951. <span class="n">an_int</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">getint</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;an_int&#39;</span><span class="p">)</span>

  952. <span class="nb">print</span><span class="p">(</span><span class="n">a_float</span> <span class="o">+</span> <span class="n">an_int</span><span class="p">)</span>

  953. 

  954. <span class="c1"># Notice that the next output does not interpolate &#39;%(bar)s&#39; or &#39;%(baz)s&#39;.</span>

  955. <span class="c1"># This is because we are using a RawConfigParser().</span>

  956. <span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">getboolean</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;a_bool&#39;</span><span class="p">):</span>

  957.     <span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">))</span>

  958. </pre></div>

  959. </div>

  960. <p>To get interpolation, use <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a>:</p>

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

  962. 

  963. <span class="n">cfg</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  964. <span class="n">cfg</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;example.cfg&#39;</span><span class="p">)</span>

  965. 

  966. <span class="c1"># Set the optional *raw* argument of get() to True if you wish to disable</span>

  967. <span class="c1"># interpolation in a single get operation.</span>

  968. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">raw</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>  <span class="c1"># -&gt; &quot;Python is fun!&quot;</span>

  969. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">raw</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>   <span class="c1"># -&gt; &quot;%(bar)s is %(baz)s!&quot;</span>

  970. 

  971. <span class="c1"># The optional *vars* argument is a dict with members that will take</span>

  972. <span class="c1"># precedence in interpolation.</span>

  973. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="nb">vars</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;bar&#39;</span><span class="p">:</span> <span class="s1">&#39;Documentation&#39;</span><span class="p">,</span>

  974.                                        <span class="s1">&#39;baz&#39;</span><span class="p">:</span> <span class="s1">&#39;evil&#39;</span><span class="p">}))</span>

  975. 

  976. <span class="c1"># The optional *fallback* argument can be used to provide a fallback value</span>

  977. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">))</span>

  978.       <span class="c1"># -&gt; &quot;Python is fun!&quot;</span>

  979. 

  980. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="s1">&#39;Monty is not.&#39;</span><span class="p">))</span>

  981.       <span class="c1"># -&gt; &quot;Python is fun!&quot;</span>

  982. 

  983. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;monster&#39;</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="s1">&#39;No such things as monsters.&#39;</span><span class="p">))</span>

  984.       <span class="c1"># -&gt; &quot;No such things as monsters.&quot;</span>

  985. 

  986. <span class="c1"># A bare print(cfg.get(&#39;Section1&#39;, &#39;monster&#39;)) would raise NoOptionError</span>

  987. <span class="c1"># but we can also use:</span>

  988. 

  989. <span class="nb">print</span><span class="p">(</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;monster&#39;</span><span class="p">,</span> <span class="n">fallback</span><span class="o">=</span><span class="kc">None</span><span class="p">))</span>

  990.       <span class="c1"># -&gt; None</span>

  991. </pre></div>

  992. </div>

  993. <p>Default values are available in both types of ConfigParsers.  They are used in

  994. interpolation if an option used is not defined elsewhere.</p>

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

  996. 

  997. <span class="c1"># New instance with &#39;bar&#39; and &#39;baz&#39; defaulting to &#39;Life&#39; and &#39;hard&#39; each</span>

  998. <span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">({</span><span class="s1">&#39;bar&#39;</span><span class="p">:</span> <span class="s1">&#39;Life&#39;</span><span class="p">,</span> <span class="s1">&#39;baz&#39;</span><span class="p">:</span> <span class="s1">&#39;hard&#39;</span><span class="p">})</span>

  999. <span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;example.cfg&#39;</span><span class="p">)</span>

  1000. 

  1001. <span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">))</span>     <span class="c1"># -&gt; &quot;Python is fun!&quot;</span>

  1002. <span class="n">config</span><span class="o">.</span><span class="n">remove_option</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;bar&#39;</span><span class="p">)</span>

  1003. <span class="n">config</span><span class="o">.</span><span class="n">remove_option</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;baz&#39;</span><span class="p">)</span>

  1004. <span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;Section1&#39;</span><span class="p">,</span> <span class="s1">&#39;foo&#39;</span><span class="p">))</span>     <span class="c1"># -&gt; &quot;Life is hard!&quot;</span>

  1005. </pre></div>

  1006. </div>

  1007. </section>

  1008. <section id="configparser-objects">

  1009. <span id="id12"></span><h2>ConfigParser Objects<a class="headerlink" href="#configparser-objects" title="Link to this heading">¶</a></h2>

  1010. <dl class="py class">

  1011. <dt class="sig sig-object py" id="configparser.ConfigParser">

  1012. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">configparser.</span></span><span class="sig-name descname"><span class="pre">ConfigParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">defaults</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">dict_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_no_value</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">delimiters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('=',</span> <span class="pre">':')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment_prefixes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('#',</span> <span class="pre">';')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inline_comment_prefixes</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">strict</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">empty_lines_in_values</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">default_section</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">configparser.DEFAULTSECT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">BasicInterpolation()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">converters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser" title="Link to this definition">¶</a></dt>

  1013. <dd><p>The main configuration parser.  When <em>defaults</em> is given, it is initialized

  1014. into the dictionary of intrinsic defaults.  When <em>dict_type</em> is given, it

  1015. will be used to create the dictionary objects for the list of sections, for

  1016. the options within a section, and for the default values.</p>

  1017. <p>When <em>delimiters</em> is given, it is used as the set of substrings that

  1018. divide keys from values.  When <em>comment_prefixes</em> is given, it will be used

  1019. as the set of substrings that prefix comments in otherwise empty lines.

  1020. Comments can be indented.  When <em>inline_comment_prefixes</em> is given, it will

  1021. be used as the set of substrings that prefix comments in non-empty lines.</p>

  1022. <p>When <em>strict</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> (the default), the parser won’t allow for

  1023. any section or option duplicates while reading from a single source (file,

  1024. string or dictionary), raising <a class="reference internal" href="#configparser.DuplicateSectionError" title="configparser.DuplicateSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">DuplicateSectionError</span></code></a> or

  1025. <a class="reference internal" href="#configparser.DuplicateOptionError" title="configparser.DuplicateOptionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">DuplicateOptionError</span></code></a>.  When <em>empty_lines_in_values</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>

  1026. (default: <code class="docutils literal notranslate"><span class="pre">True</span></code>), each empty line marks the end of an option.  Otherwise,

  1027. internal empty lines of a multiline option are kept as part of the value.

  1028. When <em>allow_no_value</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>), options without

  1029. values are accepted; the value held for these is <code class="docutils literal notranslate"><span class="pre">None</span></code> and they are

  1030. serialized without the trailing delimiter.</p>

  1031. <p>When <em>default_section</em> is given, it specifies the name for the special

  1032. section holding default values for other sections and interpolation purposes

  1033. (normally named <code class="docutils literal notranslate"><span class="pre">&quot;DEFAULT&quot;</span></code>).  This value can be retrieved and changed at

  1034. runtime using the <code class="docutils literal notranslate"><span class="pre">default_section</span></code> instance attribute. This won’t

  1035. re-evaluate an already parsed config file, but will be used when writing

  1036. parsed settings to a new config file.</p>

  1037. <p>Interpolation behaviour may be customized by providing a custom handler

  1038. through the <em>interpolation</em> argument. <code class="docutils literal notranslate"><span class="pre">None</span></code> can be used to turn off

  1039. interpolation completely, <code class="docutils literal notranslate"><span class="pre">ExtendedInterpolation()</span></code> provides a more

  1040. advanced variant inspired by <code class="docutils literal notranslate"><span class="pre">zc.buildout</span></code>.  More on the subject in the

  1041. <a class="reference external" href="#interpolation-of-values">dedicated documentation section</a>.</p>

  1042. <p>All option names used in interpolation will be passed through the

  1043. <a class="reference internal" href="#configparser.ConfigParser.optionxform" title="configparser.ConfigParser.optionxform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">optionxform()</span></code></a> method just like any other option name reference.  For

  1044. example, using the default implementation of <a class="reference internal" href="#configparser.ConfigParser.optionxform" title="configparser.ConfigParser.optionxform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">optionxform()</span></code></a> (which

  1045. converts option names to lower case), the values <code class="docutils literal notranslate"><span class="pre">foo</span> <span class="pre">%(bar)s</span></code> and <code class="docutils literal notranslate"><span class="pre">foo</span>

  1046. <span class="pre">%(BAR)s</span></code> are equivalent.</p>

  1047. <p>When <em>converters</em> is given, it should be a dictionary where each key

  1048. represents the name of a type converter and each value is a callable

  1049. implementing the conversion from string to the desired datatype.  Every

  1050. converter gets its own corresponding <code class="xref py py-meth docutils literal notranslate"><span class="pre">get*()</span></code> method on the parser

  1051. object and section proxies.</p>

  1052. <div class="versionchanged">

  1053. <p><span class="versionmodified changed">Changed in version 3.1: </span>The default <em>dict_type</em> is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.OrderedDict</span></code></a>.</p>

  1054. </div>

  1055. <div class="versionchanged">

  1056. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>allow_no_value</em>, <em>delimiters</em>, <em>comment_prefixes</em>, <em>strict</em>,

  1057. <em>empty_lines_in_values</em>, <em>default_section</em> and <em>interpolation</em> were

  1058. added.</p>

  1059. </div>

  1060. <div class="versionchanged">

  1061. <p><span class="versionmodified changed">Changed in version 3.5: </span>The <em>converters</em> argument was added.</p>

  1062. </div>

  1063. <div class="versionchanged">

  1064. <p><span class="versionmodified changed">Changed in version 3.7: </span>The <em>defaults</em> argument is read with <a class="reference internal" href="#configparser.ConfigParser.read_dict" title="configparser.ConfigParser.read_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_dict()</span></code></a>,

  1065. providing consistent behavior across the parser: non-string

  1066. keys and values are implicitly converted to strings.</p>

  1067. </div>

  1068. <div class="versionchanged">

  1069. <p><span class="versionmodified changed">Changed in version 3.8: </span>The default <em>dict_type</em> is <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>, since it now preserves

  1070. insertion order.</p>

  1071. </div>

  1072. <dl class="py method">

  1073. <dt class="sig sig-object py" id="configparser.ConfigParser.defaults">

  1074. <span class="sig-name descname"><span class="pre">defaults</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.defaults" title="Link to this definition">¶</a></dt>

  1075. <dd><p>Return a dictionary containing the instance-wide defaults.</p>

  1076. </dd></dl>

  1077. 

  1078. <dl class="py method">

  1079. <dt class="sig sig-object py" id="configparser.ConfigParser.sections">

  1080. <span class="sig-name descname"><span class="pre">sections</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.sections" title="Link to this definition">¶</a></dt>

  1081. <dd><p>Return a list of the sections available; the <em>default section</em> is not

  1082. included in the list.</p>

  1083. </dd></dl>

  1084. 

  1085. <dl class="py method">

  1086. <dt class="sig sig-object py" id="configparser.ConfigParser.add_section">

  1087. <span class="sig-name descname"><span class="pre">add_section</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.add_section" title="Link to this definition">¶</a></dt>

  1088. <dd><p>Add a section named <em>section</em> to the instance.  If a section by the given

  1089. name already exists, <a class="reference internal" href="#configparser.DuplicateSectionError" title="configparser.DuplicateSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">DuplicateSectionError</span></code></a> is raised.  If the

  1090. <em>default section</em> name is passed, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised.  The name

  1091. of the section must be a string; if not, <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised.</p>

  1092. <div class="versionchanged">

  1093. <p><span class="versionmodified changed">Changed in version 3.2: </span>Non-string section names raise <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a>.</p>

  1094. </div>

  1095. </dd></dl>

  1096. 

  1097. <dl class="py method">

  1098. <dt class="sig sig-object py" id="configparser.ConfigParser.has_section">

  1099. <span class="sig-name descname"><span class="pre">has_section</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.has_section" title="Link to this definition">¶</a></dt>

  1100. <dd><p>Indicates whether the named <em>section</em> is present in the configuration.

  1101. The <em>default section</em> is not acknowledged.</p>

  1102. </dd></dl>

  1103. 

  1104. <dl class="py method">

  1105. <dt class="sig sig-object py" id="configparser.ConfigParser.options">

  1106. <span class="sig-name descname"><span class="pre">options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.options" title="Link to this definition">¶</a></dt>

  1107. <dd><p>Return a list of options available in the specified <em>section</em>.</p>

  1108. </dd></dl>

  1109. 

  1110. <dl class="py method">

  1111. <dt class="sig sig-object py" id="configparser.ConfigParser.has_option">

  1112. <span class="sig-name descname"><span class="pre">has_option</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.has_option" title="Link to this definition">¶</a></dt>

  1113. <dd><p>If the given <em>section</em> exists, and contains the given <em>option</em>, return

  1114. <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate"><span class="pre">True</span></code></a>; otherwise return <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate"><span class="pre">False</span></code></a>.  If the specified

  1115. <em>section</em> is <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a> or an empty string, DEFAULT is assumed.</p>

  1116. </dd></dl>

  1117. 

  1118. <dl class="py method">

  1119. <dt class="sig sig-object py" id="configparser.ConfigParser.read">

  1120. <span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filenames</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</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="#configparser.ConfigParser.read" title="Link to this definition">¶</a></dt>

  1121. <dd><p>Attempt to read and parse an iterable of filenames, returning a list of

  1122. filenames which were successfully parsed.</p>

  1123. <p>If <em>filenames</em> is a string, a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object or a

  1124. <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>, it is treated as

  1125. a single filename.  If a file named in <em>filenames</em> cannot be opened, that

  1126. file will be ignored.  This is designed so that you can specify an

  1127. iterable of potential configuration file locations (for example, the

  1128. current directory, the user’s home directory, and some system-wide

  1129. directory), and all existing configuration files in the iterable will be

  1130. read.</p>

  1131. <p>If none of the named files exist, the <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a>

  1132. instance will contain an empty dataset.  An application which requires

  1133. initial values to be loaded from a file should load the required file or

  1134. files using <a class="reference internal" href="#configparser.ConfigParser.read_file" title="configparser.ConfigParser.read_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read_file()</span></code></a> before calling <a class="reference internal" href="#configparser.ConfigParser.read" title="configparser.ConfigParser.read"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read()</span></code></a> for any

  1135. optional files:</p>

  1136. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">configparser</span><span class="o">,</span> <span class="nn">os</span>

  1137. 

  1138. <span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">()</span>

  1139. <span class="n">config</span><span class="o">.</span><span class="n">read_file</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="s1">&#39;defaults.cfg&#39;</span><span class="p">))</span>

  1140. <span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">([</span><span class="s1">&#39;site.cfg&#39;</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">&#39;~/.myapp.cfg&#39;</span><span class="p">)],</span>

  1141.             <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;cp1250&#39;</span><span class="p">)</span>

  1142. </pre></div>

  1143. </div>

  1144. <div class="versionchanged">

  1145. <p><span class="versionmodified changed">Changed in version 3.2: </span>Added the <em>encoding</em> parameter.

  1146. Previously, all files were read using the default encoding for <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  1147. </div>

  1148. <div class="versionchanged">

  1149. <p><span class="versionmodified changed">Changed in version 3.6.1: </span>The <em>filenames</em> parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  1150. </div>

  1151. <div class="versionchanged">

  1152. <p><span class="versionmodified changed">Changed in version 3.7: </span>The <em>filenames</em> parameter accepts a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  1153. </div>

  1154. </dd></dl>

  1155. 

  1156. <dl class="py method">

  1157. <dt class="sig sig-object py" id="configparser.ConfigParser.read_file">

  1158. <span class="sig-name descname"><span class="pre">read_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</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="#configparser.ConfigParser.read_file" title="Link to this definition">¶</a></dt>

  1159. <dd><p>Read and parse configuration data from <em>f</em> which must be an iterable

  1160. yielding Unicode strings (for example files opened in text mode).</p>

  1161. <p>Optional argument <em>source</em> specifies the name of the file being read.  If

  1162. not given and <em>f</em> has a <code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code> attribute, that is used for

  1163. <em>source</em>; the default is <code class="docutils literal notranslate"><span class="pre">'&lt;???&gt;'</span></code>.</p>

  1164. <div class="versionadded">

  1165. <p><span class="versionmodified added">New in version 3.2: </span>Replaces <code class="xref py py-meth docutils literal notranslate"><span class="pre">readfp()</span></code>.</p>

  1166. </div>

  1167. </dd></dl>

  1168. 

  1169. <dl class="py method">

  1170. <dt class="sig sig-object py" id="configparser.ConfigParser.read_string">

  1171. <span class="sig-name descname"><span class="pre">read_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&lt;string&gt;'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.read_string" title="Link to this definition">¶</a></dt>

  1172. <dd><p>Parse configuration data from a string.</p>

  1173. <p>Optional argument <em>source</em> specifies a context-specific name of the

  1174. string passed.  If not given, <code class="docutils literal notranslate"><span class="pre">'&lt;string&gt;'</span></code> is used.  This should

  1175. commonly be a filesystem path or a URL.</p>

  1176. <div class="versionadded">

  1177. <p><span class="versionmodified added">New in version 3.2.</span></p>

  1178. </div>

  1179. </dd></dl>

  1180. 

  1181. <dl class="py method">

  1182. <dt class="sig sig-object py" id="configparser.ConfigParser.read_dict">

  1183. <span class="sig-name descname"><span class="pre">read_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dictionary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'&lt;dict&gt;'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.read_dict" title="Link to this definition">¶</a></dt>

  1184. <dd><p>Load configuration from any object that provides a dict-like <code class="docutils literal notranslate"><span class="pre">items()</span></code>

  1185. method.  Keys are section names, values are dictionaries with keys and

  1186. values that should be present in the section.  If the used dictionary

  1187. type preserves order, sections and their keys will be added in order.

  1188. Values are automatically converted to strings.</p>

  1189. <p>Optional argument <em>source</em> specifies a context-specific name of the

  1190. dictionary passed.  If not given, <code class="docutils literal notranslate"><span class="pre">&lt;dict&gt;</span></code> is used.</p>

  1191. <p>This method can be used to copy state between parsers.</p>

  1192. <div class="versionadded">

  1193. <p><span class="versionmodified added">New in version 3.2.</span></p>

  1194. </div>

  1195. </dd></dl>

  1196. 

  1197. <dl class="py method">

  1198. <dt class="sig sig-object py" id="configparser.ConfigParser.get">

  1199. <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vars=None</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">fallback</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.get" title="Link to this definition">¶</a></dt>

  1200. <dd><p>Get an <em>option</em> value for the named <em>section</em>.  If <em>vars</em> is provided, it

  1201. must be a dictionary.  The <em>option</em> is looked up in <em>vars</em> (if provided),

  1202. <em>section</em>, and in <em>DEFAULTSECT</em> in that order.  If the key is not found

  1203. and <em>fallback</em> is provided, it is used as a fallback value.  <code class="docutils literal notranslate"><span class="pre">None</span></code> can

  1204. be provided as a <em>fallback</em> value.</p>

  1205. <p>All the <code class="docutils literal notranslate"><span class="pre">'%'</span></code> interpolations are expanded in the return values, unless

  1206. the <em>raw</em> argument is true.  Values for interpolation keys are looked up

  1207. in the same manner as the option.</p>

  1208. <div class="versionchanged">

  1209. <p><span class="versionmodified changed">Changed in version 3.2: </span>Arguments <em>raw</em>, <em>vars</em> and <em>fallback</em> are keyword only to protect

  1210. users from trying to use the third argument as the <em>fallback</em> fallback

  1211. (especially when using the mapping protocol).</p>

  1212. </div>

  1213. </dd></dl>

  1214. 

  1215. <dl class="py method">

  1216. <dt class="sig sig-object py" id="configparser.ConfigParser.getint">

  1217. <span class="sig-name descname"><span class="pre">getint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vars=None</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">fallback</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.getint" title="Link to this definition">¶</a></dt>

  1218. <dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em>

  1219. to an integer.  See <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> for explanation of <em>raw</em>, <em>vars</em> and

  1220. <em>fallback</em>.</p>

  1221. </dd></dl>

  1222. 

  1223. <dl class="py method">

  1224. <dt class="sig sig-object py" id="configparser.ConfigParser.getfloat">

  1225. <span class="sig-name descname"><span class="pre">getfloat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vars=None</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">fallback</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.getfloat" title="Link to this definition">¶</a></dt>

  1226. <dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em>

  1227. to a floating point number.  See <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> for explanation of <em>raw</em>,

  1228. <em>vars</em> and <em>fallback</em>.</p>

  1229. </dd></dl>

  1230. 

  1231. <dl class="py method">

  1232. <dt class="sig sig-object py" id="configparser.ConfigParser.getboolean">

  1233. <span class="sig-name descname"><span class="pre">getboolean</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vars=None</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">fallback</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.getboolean" title="Link to this definition">¶</a></dt>

  1234. <dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em>

  1235. to a Boolean value.  Note that the accepted values for the option are

  1236. <code class="docutils literal notranslate"><span class="pre">'1'</span></code>, <code class="docutils literal notranslate"><span class="pre">'yes'</span></code>, <code class="docutils literal notranslate"><span class="pre">'true'</span></code>, and <code class="docutils literal notranslate"><span class="pre">'on'</span></code>, which cause this method to

  1237. return <code class="docutils literal notranslate"><span class="pre">True</span></code>, and <code class="docutils literal notranslate"><span class="pre">'0'</span></code>, <code class="docutils literal notranslate"><span class="pre">'no'</span></code>, <code class="docutils literal notranslate"><span class="pre">'false'</span></code>, and <code class="docutils literal notranslate"><span class="pre">'off'</span></code>, which

  1238. cause it to return <code class="docutils literal notranslate"><span class="pre">False</span></code>.  These string values are checked in a

  1239. case-insensitive manner.  Any other value will cause it to raise

  1240. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.  See <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> for explanation of <em>raw</em>, <em>vars</em> and

  1241. <em>fallback</em>.</p>

  1242. </dd></dl>

  1243. 

  1244. <dl class="py method">

  1245. <dt class="sig sig-object py" id="configparser.ConfigParser.items">

  1246. <span class="sig-name descname"><span class="pre">items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw</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">vars</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="#configparser.ConfigParser.items" title="Link to this definition">¶</a></dt>

  1247. <dt class="sig sig-object py">

  1248. <span class="sig-name descname"><span class="pre">items</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</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">vars</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></dt>

  1249. <dd><p>When <em>section</em> is not given, return a list of <em>section_name</em>,

  1250. <em>section_proxy</em> pairs, including DEFAULTSECT.</p>

  1251. <p>Otherwise, return a list of <em>name</em>, <em>value</em> pairs for the options in the

  1252. given <em>section</em>.  Optional arguments have the same meaning as for the

  1253. <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> method.</p>

  1254. <div class="versionchanged">

  1255. <p><span class="versionmodified changed">Changed in version 3.8: </span>Items present in <em>vars</em> no longer appear in the result.  The previous

  1256. behaviour mixed actual parser options with variables provided for

  1257. interpolation.</p>

  1258. </div>

  1259. </dd></dl>

  1260. 

  1261. <dl class="py method">

  1262. <dt class="sig sig-object py" id="configparser.ConfigParser.set">

  1263. <span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.set" title="Link to this definition">¶</a></dt>

  1264. <dd><p>If the given section exists, set the given option to the specified value;

  1265. otherwise raise <a class="reference internal" href="#configparser.NoSectionError" title="configparser.NoSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NoSectionError</span></code></a>.  <em>option</em> and <em>value</em> must be

  1266. strings; if not, <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised.</p>

  1267. </dd></dl>

  1268. 

  1269. <dl class="py method">

  1270. <dt class="sig sig-object py" id="configparser.ConfigParser.write">

  1271. <span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fileobject</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">space_around_delimiters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.write" title="Link to this definition">¶</a></dt>

  1272. <dd><p>Write a representation of the configuration to the specified <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file

  1273. object</span></a>, which must be opened in text mode (accepting strings).  This

  1274. representation can be parsed by a future <a class="reference internal" href="#configparser.ConfigParser.read" title="configparser.ConfigParser.read"><code class="xref py py-meth docutils literal notranslate"><span class="pre">read()</span></code></a> call.  If

  1275. <em>space_around_delimiters</em> is true, delimiters between

  1276. keys and values are surrounded by spaces.</p>

  1277. </dd></dl>

  1278. 

  1279. <div class="admonition note">

  1280. <p class="admonition-title">Note</p>

  1281. <p>Comments in the original configuration file are not preserved when

  1282. writing the configuration back.

  1283. What is considered a comment, depends on the given values for

  1284. <em>comment_prefix</em> and <em>inline_comment_prefix</em>.</p>

  1285. </div>

  1286. <dl class="py method">

  1287. <dt class="sig sig-object py" id="configparser.ConfigParser.remove_option">

  1288. <span class="sig-name descname"><span class="pre">remove_option</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.remove_option" title="Link to this definition">¶</a></dt>

  1289. <dd><p>Remove the specified <em>option</em> from the specified <em>section</em>.  If the

  1290. section does not exist, raise <a class="reference internal" href="#configparser.NoSectionError" title="configparser.NoSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NoSectionError</span></code></a>.  If the option

  1291. existed to be removed, return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate"><span class="pre">True</span></code></a>; otherwise return

  1292. <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate"><span class="pre">False</span></code></a>.</p>

  1293. </dd></dl>

  1294. 

  1295. <dl class="py method">

  1296. <dt class="sig sig-object py" id="configparser.ConfigParser.remove_section">

  1297. <span class="sig-name descname"><span class="pre">remove_section</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.remove_section" title="Link to this definition">¶</a></dt>

  1298. <dd><p>Remove the specified <em>section</em> from the configuration.  If the section in

  1299. fact existed, return <code class="docutils literal notranslate"><span class="pre">True</span></code>.  Otherwise return <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

  1300. </dd></dl>

  1301. 

  1302. <dl class="py method">

  1303. <dt class="sig sig-object py" id="configparser.ConfigParser.optionxform">

  1304. <span class="sig-name descname"><span class="pre">optionxform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.ConfigParser.optionxform" title="Link to this definition">¶</a></dt>

  1305. <dd><p>Transforms the option name <em>option</em> as found in an input file or as passed

  1306. in by client code to the form that should be used in the internal

  1307. structures.  The default implementation returns a lower-case version of

  1308. <em>option</em>; subclasses may override this or client code can set an attribute

  1309. of this name on instances to affect this behavior.</p>

  1310. <p>You don’t need to subclass the parser to use this method, you can also

  1311. set it on an instance, to a function that takes a string argument and

  1312. returns a string.  Setting it to <code class="docutils literal notranslate"><span class="pre">str</span></code>, for example, would make option

  1313. names case sensitive:</p>

  1314. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">cfgparser</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="p">()</span>

  1315. <span class="n">cfgparser</span><span class="o">.</span><span class="n">optionxform</span> <span class="o">=</span> <span class="nb">str</span>

  1316. </pre></div>

  1317. </div>

  1318. <p>Note that when reading configuration files, whitespace around the option

  1319. names is stripped before <a class="reference internal" href="#configparser.ConfigParser.optionxform" title="configparser.ConfigParser.optionxform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">optionxform()</span></code></a> is called.</p>

  1320. </dd></dl>

  1321. 

  1322. </dd></dl>

  1323. 

  1324. <dl class="py data">

  1325. <dt class="sig sig-object py" id="configparser.MAX_INTERPOLATION_DEPTH">

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

  1327. <dd><p>The maximum depth for recursive interpolation for <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> when the <em>raw</em>

  1328. parameter is false.  This is relevant only when the default <em>interpolation</em>

  1329. is used.</p>

  1330. </dd></dl>

  1331. 

  1332. </section>

  1333. <section id="rawconfigparser-objects">

  1334. <span id="id14"></span><h2>RawConfigParser Objects<a class="headerlink" href="#rawconfigparser-objects" title="Link to this heading">¶</a></h2>

  1335. <dl class="py class">

  1336. <dt class="sig sig-object py" id="configparser.RawConfigParser">

  1337. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">configparser.</span></span><span class="sig-name descname"><span class="pre">RawConfigParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">defaults=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dict_type=dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_no_value=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delimiters=('='</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">':')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment_prefixes=('#'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">';')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inline_comment_prefixes=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_lines_in_values=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_section=configparser.DEFAULTSECT</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">interpolation</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#configparser.RawConfigParser" title="Link to this definition">¶</a></dt>

  1338. <dd><p>Legacy variant of the <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a>.  It has interpolation

  1339. disabled by default and allows for non-string section names, option

  1340. names, and values via its unsafe <code class="docutils literal notranslate"><span class="pre">add_section</span></code> and <code class="docutils literal notranslate"><span class="pre">set</span></code> methods,

  1341. as well as the legacy <code class="docutils literal notranslate"><span class="pre">defaults=</span></code> keyword argument handling.</p>

  1342. <div class="versionchanged">

  1343. <p><span class="versionmodified changed">Changed in version 3.8: </span>The default <em>dict_type</em> is <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>, since it now preserves

  1344. insertion order.</p>

  1345. </div>

  1346. <div class="admonition note">

  1347. <p class="admonition-title">Note</p>

  1348. <p>Consider using <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a> instead which checks types of

  1349. the values to be stored internally.  If you don’t want interpolation, you

  1350. can use <code class="docutils literal notranslate"><span class="pre">ConfigParser(interpolation=None)</span></code>.</p>

  1351. </div>

  1352. <dl class="py method">

  1353. <dt class="sig sig-object py" id="configparser.RawConfigParser.add_section">

  1354. <span class="sig-name descname"><span class="pre">add_section</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.RawConfigParser.add_section" title="Link to this definition">¶</a></dt>

  1355. <dd><p>Add a section named <em>section</em> to the instance.  If a section by the given

  1356. name already exists, <a class="reference internal" href="#configparser.DuplicateSectionError" title="configparser.DuplicateSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">DuplicateSectionError</span></code></a> is raised.  If the

  1357. <em>default section</em> name is passed, <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised.</p>

  1358. <p>Type of <em>section</em> is not checked which lets users create non-string named

  1359. sections.  This behaviour is unsupported and may cause internal errors.</p>

  1360. </dd></dl>

  1361. 

  1362. <dl class="py method">

  1363. <dt class="sig sig-object py" id="configparser.RawConfigParser.set">

  1364. <span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">option</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#configparser.RawConfigParser.set" title="Link to this definition">¶</a></dt>

  1365. <dd><p>If the given section exists, set the given option to the specified value;

  1366. otherwise raise <a class="reference internal" href="#configparser.NoSectionError" title="configparser.NoSectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NoSectionError</span></code></a>.  While it is possible to use

  1367. <a class="reference internal" href="#configparser.RawConfigParser" title="configparser.RawConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">RawConfigParser</span></code></a> (or <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigParser</span></code></a> with <em>raw</em> parameters

  1368. set to true) for <em>internal</em> storage of non-string values, full

  1369. functionality (including interpolation and output to files) can only be

  1370. achieved using string values.</p>

  1371. <p>This method lets users assign non-string values to keys internally.  This

  1372. behaviour is unsupported and will cause errors when attempting to write

  1373. to a file or get it in non-raw mode.  <strong>Use the mapping protocol API</strong>

  1374. which does not allow such assignments to take place.</p>

  1375. </dd></dl>

  1376. 

  1377. </dd></dl>

  1378. 

  1379. </section>

  1380. <section id="exceptions">

  1381. <h2>Exceptions<a class="headerlink" href="#exceptions" title="Link to this heading">¶</a></h2>

  1382. <dl class="py exception">

  1383. <dt class="sig sig-object py" id="configparser.Error">

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

  1385. <dd><p>Base class for all other <a class="reference internal" href="#module-configparser" title="configparser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code></a> exceptions.</p>

  1386. </dd></dl>

  1387. 

  1388. <dl class="py exception">

  1389. <dt class="sig sig-object py" id="configparser.NoSectionError">

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

  1391. <dd><p>Exception raised when a specified section is not found.</p>

  1392. </dd></dl>

  1393. 

  1394. <dl class="py exception">

  1395. <dt class="sig sig-object py" id="configparser.DuplicateSectionError">

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

  1397. <dd><p>Exception raised if <a class="reference internal" href="#configparser.ConfigParser.add_section" title="configparser.ConfigParser.add_section"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_section()</span></code></a> is called with the name of a section

  1398. that is already present or in strict parsers when a section if found more

  1399. than once in a single input file, string or dictionary.</p>

  1400. <div class="versionchanged">

  1401. <p><span class="versionmodified changed">Changed in version 3.2: </span>Added the optional <em>source</em> and <em>lineno</em> attributes and parameters to

  1402. <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code>.</p>

  1403. </div>

  1404. </dd></dl>

  1405. 

  1406. <dl class="py exception">

  1407. <dt class="sig sig-object py" id="configparser.DuplicateOptionError">

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

  1409. <dd><p>Exception raised by strict parsers if a single option appears twice during

  1410. reading from a single file, string or dictionary. This catches misspellings

  1411. and case sensitivity-related errors, e.g. a dictionary may have two keys

  1412. representing the same case-insensitive configuration key.</p>

  1413. </dd></dl>

  1414. 

  1415. <dl class="py exception">

  1416. <dt class="sig sig-object py" id="configparser.NoOptionError">

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

  1418. <dd><p>Exception raised when a specified option is not found in the specified

  1419. section.</p>

  1420. </dd></dl>

  1421. 

  1422. <dl class="py exception">

  1423. <dt class="sig sig-object py" id="configparser.InterpolationError">

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

  1425. <dd><p>Base class for exceptions raised when problems occur performing string

  1426. interpolation.</p>

  1427. </dd></dl>

  1428. 

  1429. <dl class="py exception">

  1430. <dt class="sig sig-object py" id="configparser.InterpolationDepthError">

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

  1432. <dd><p>Exception raised when string interpolation cannot be completed because the

  1433. number of iterations exceeds <a class="reference internal" href="#configparser.MAX_INTERPOLATION_DEPTH" title="configparser.MAX_INTERPOLATION_DEPTH"><code class="xref py py-const docutils literal notranslate"><span class="pre">MAX_INTERPOLATION_DEPTH</span></code></a>.  Subclass of

  1434. <a class="reference internal" href="#configparser.InterpolationError" title="configparser.InterpolationError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">InterpolationError</span></code></a>.</p>

  1435. </dd></dl>

  1436. 

  1437. <dl class="py exception">

  1438. <dt class="sig sig-object py" id="configparser.InterpolationMissingOptionError">

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

  1440. <dd><p>Exception raised when an option referenced from a value does not exist.

  1441. Subclass of <a class="reference internal" href="#configparser.InterpolationError" title="configparser.InterpolationError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">InterpolationError</span></code></a>.</p>

  1442. </dd></dl>

  1443. 

  1444. <dl class="py exception">

  1445. <dt class="sig sig-object py" id="configparser.InterpolationSyntaxError">

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

  1447. <dd><p>Exception raised when the source text into which substitutions are made does

  1448. not conform to the required syntax.  Subclass of <a class="reference internal" href="#configparser.InterpolationError" title="configparser.InterpolationError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">InterpolationError</span></code></a>.</p>

  1449. </dd></dl>

  1450. 

  1451. <dl class="py exception">

  1452. <dt class="sig sig-object py" id="configparser.MissingSectionHeaderError">

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

  1454. <dd><p>Exception raised when attempting to parse a file which has no section

  1455. headers.</p>

  1456. </dd></dl>

  1457. 

  1458. <dl class="py exception">

  1459. <dt class="sig sig-object py" id="configparser.ParsingError">

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

  1461. <dd><p>Exception raised when errors occur attempting to parse a file.</p>

  1462. <div class="versionchanged">

  1463. <p><span class="versionmodified changed">Changed in version 3.12: </span>The <code class="docutils literal notranslate"><span class="pre">filename</span></code> attribute and <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code> constructor argument were

  1464. removed.  They have been available using the name <code class="docutils literal notranslate"><span class="pre">source</span></code> since 3.2.</p>

  1465. </div>

  1466. </dd></dl>

  1467. 

  1468. <p class="rubric">Footnotes</p>

  1469. <aside class="footnote-list brackets">

  1470. <aside class="footnote brackets" id="id15" role="doc-footnote">

  1471. <span class="label"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></span>

  1472. <span class="backrefs">(<a role="doc-backlink" href="#id1">1</a>,<a role="doc-backlink" href="#id2">2</a>,<a role="doc-backlink" href="#id3">3</a>,<a role="doc-backlink" href="#id4">4</a>,<a role="doc-backlink" href="#id5">5</a>,<a role="doc-backlink" href="#id6">6</a>,<a role="doc-backlink" href="#id7">7</a>,<a role="doc-backlink" href="#id8">8</a>,<a role="doc-backlink" href="#id9">9</a>,<a role="doc-backlink" href="#id10">10</a>,<a role="doc-backlink" href="#id11">11</a>)</span>

  1473. <p>Config parsers allow for heavy customization.  If you are interested in

  1474. changing the behaviour outlined by the footnote reference, consult the

  1475. <a class="reference internal" href="#customizing-parser-behaviour">Customizing Parser Behaviour</a> section.</p>

  1476. </aside>

  1477. </aside>

  1478. </section>

  1479. </section>

  1480. 

  1481. 

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

  1483.           </div>

  1484.         </div>

  1485.       </div>

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

  1487.         <div class="sphinxsidebarwrapper">

  1488.   <div>

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

  1490.     <ul>

  1491. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code> — Configuration file parser</a><ul>

  1492. <li><a class="reference internal" href="#quick-start">Quick Start</a></li>

  1493. <li><a class="reference internal" href="#supported-datatypes">Supported Datatypes</a></li>

  1494. <li><a class="reference internal" href="#fallback-values">Fallback Values</a></li>

  1495. <li><a class="reference internal" href="#supported-ini-file-structure">Supported INI File Structure</a></li>

  1496. <li><a class="reference internal" href="#interpolation-of-values">Interpolation of values</a></li>

  1497. <li><a class="reference internal" href="#mapping-protocol-access">Mapping Protocol Access</a></li>

  1498. <li><a class="reference internal" href="#customizing-parser-behaviour">Customizing Parser Behaviour</a></li>

  1499. <li><a class="reference internal" href="#legacy-api-examples">Legacy API Examples</a></li>

  1500. <li><a class="reference internal" href="#configparser-objects">ConfigParser Objects</a></li>

  1501. <li><a class="reference internal" href="#rawconfigparser-objects">RawConfigParser Objects</a></li>

  1502. <li><a class="reference internal" href="#exceptions">Exceptions</a></li>

  1503. </ul>

  1504. </li>

  1505. </ul>

  1506. 

  1507.   </div>

  1508.   <div>

  1509.     <h4>Previous topic</h4>

  1510.     <p class="topless"><a href="csv.html"

  1511.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">csv</span></code> — CSV File Reading and Writing</a></p>

  1512.   </div>

  1513.   <div>

  1514.     <h4>Next topic</h4>

  1515.     <p class="topless"><a href="tomllib.html"

  1516.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomllib</span></code> — Parse TOML files</a></p>

  1517.   </div>

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

  1519.     <h3>This Page</h3>

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

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

  1522.       <li>

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

  1524.             rel="nofollow">Show Source

  1525.         </a>

  1526.       </li>

  1527.     </ul>

  1528.   </div>

  1529.         </div>

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

  1531. <span>«</span>

  1532. </div>

  1533. 

  1534.       </div>

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

  1536.     </div>  

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

  1538.       <h3>Navigation</h3>

  1539.       <ul>

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

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

  1542.              >index</a></li>

  1543.         <li class="right" >

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

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

  1546.         <li class="right" >

  1547.           <a href="tomllib.html" title="tomllib — Parse TOML files"

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

  1549.         <li class="right" >

  1550.           <a href="csv.html" title="csv — CSV File Reading and Writing"

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

  1552. 

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

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

  1555.           <li class="switchers">

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

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

  1558.           </li>

  1559.           <li>

  1560.               

  1561.           </li>

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

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

  1564.     </li>

  1565. 

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

  1567.           <li class="nav-item nav-item-2"><a href="fileformats.html" >File Formats</a> &#187;</li>

  1568.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">configparser</span></code> — Configuration file parser</a></li>

  1569.                 <li class="right">

  1570.                     

  1571. 

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

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

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

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

  1576.         </form>

  1577.     </div>

  1578.                      |

  1579.                 </li>

  1580.             <li class="right">

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

  1582.     Theme

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

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

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

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

  1587.     </select>

  1588. </label> |</li>

  1589.             

  1590.       </ul>

  1591.     </div>  

  1592.     <div class="footer">

  1593.     &copy; 

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

  1595.     

  1596.     Copyright

  1597.     

  1598.       </a>

  1599.      2001-2024, Python Software Foundation.

  1600.     <br />

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

  1602.     <br />

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

  1604.     <br />

  1605.     

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

  1607.     

  1608.     

  1609.     <br />

  1610. 

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

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

  1613. <br />

  1614.     <br />

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

  1616.     

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

  1618.     

  1619.     <br />

  1620. 

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

  1622.     </div>

  1623. 

  1624.   </body>

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