Server : Apache
System : Linux server1.cgrithy.com 3.10.0-1160.95.1.el7.x86_64 #1 SMP Mon Jul 24 13:59:37 UTC 2023 x86_64
User : nobody ( 99)
PHP Version : 8.1.23
Disable Function : NONE
Directory : /usr/share/doc/python-docs-2.7.5/html/library/
|
Server : Apache System : Linux server1.cgrithy.com 3.10.0-1160.95.1.el7.x86_64 #1 SMP Mon Jul 24 13:59:37 UTC 2023 x86_64 User : nobody ( 99) PHP Version : 8.1.23 Disable Function : NONE Directory : /usr/share/doc/python-docs-2.7.5/html/library/ |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>13.2. ConfigParser — Configuration file parser — Python 2.7.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.7.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python 2.7.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python 2.7.5 documentation" href="../index.html" />
<link rel="up" title="13. File Formats" href="fileformats.html" />
<link rel="next" title="13.3. robotparser — Parser for robots.txt" href="robotparser.html" />
<link rel="prev" title="13.1. csv — CSV File Reading and Writing" href="csv.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
<script type="text/javascript" src="../_static/copybutton.js"></script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="robotparser.html" title="13.3. robotparser — Parser for robots.txt"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="csv.html" title="13.1. csv — CSV File Reading and Writing"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.5 documentation</a> »
</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="fileformats.html" accesskey="U">13. File Formats</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-ConfigParser">
<span id="configparser-configuration-file-parser"></span><h1>13.2. <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-mod docutils literal"><span class="pre">ConfigParser</span></tt></a> — Configuration file parser<a class="headerlink" href="#module-ConfigParser" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-mod docutils literal"><span class="pre">ConfigParser</span></tt></a> module has been renamed to <tt class="xref py py-mod docutils literal"><span class="pre">configparser</span></tt> in
Python 3. The <a class="reference internal" href="../glossary.html#term-to3"><em class="xref std std-term">2to3</em></a> tool will automatically adapt imports when
converting your sources to Python 3.</p>
</div>
<p id="index-0">This module defines the class <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a>. The <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a>
class implements a basic configuration file parser language which provides a
structure similar to what you would find on Microsoft Windows INI files. You
can use this to write Python programs which can be customized by end users
easily.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This library does <em>not</em> interpret or write the value-type prefixes used in
the Windows Registry extended version of INI syntax.</p>
</div>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Module <a class="reference internal" href="shlex.html#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a></dt>
<dd>Support for a creating Unix shell-like mini-languages which can be used
as an alternate format for application configuration files.</dd>
<dt>Module <a class="reference internal" href="json.html#module-json" title="json: Encode and decode the JSON format."><tt class="xref py py-mod docutils literal"><span class="pre">json</span></tt></a></dt>
<dd>The json module implements a subset of JavaScript syntax which can also
be used for this purpose.</dd>
</dl>
</div>
<p>The configuration file consists of sections, led by a <tt class="docutils literal"><span class="pre">[section]</span></tt> header and
followed by <tt class="docutils literal"><span class="pre">name:</span> <span class="pre">value</span></tt> entries, with continuations in the style of
<span class="target" id="index-1"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a> (see section 3.1.1, “LONG HEADER FIELDS”); <tt class="docutils literal"><span class="pre">name=value</span></tt> is also
accepted. Note that leading whitespace is removed from values. The optional
values can contain format strings which refer to other values in the same
section, or values in a special <tt class="docutils literal"><span class="pre">DEFAULT</span></tt> section. Additional defaults can be
provided on initialization and retrieval. Lines beginning with <tt class="docutils literal"><span class="pre">'#'</span></tt> or
<tt class="docutils literal"><span class="pre">';'</span></tt> are ignored and may be used to provide comments.</p>
<p>Configuration files may include comments, prefixed by specific characters (<tt class="docutils literal"><span class="pre">#</span></tt>
and <tt class="docutils literal"><span class="pre">;</span></tt>). Comments may appear on their own in an otherwise empty line, or may
be entered in lines holding values or section names. In the latter case, they
need to be preceded by a whitespace character to be recognized as a comment.
(For backwards compatibility, only <tt class="docutils literal"><span class="pre">;</span></tt> starts an inline comment, while <tt class="docutils literal"><span class="pre">#</span></tt>
does not.)</p>
<p>On top of the core functionality, <a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">SafeConfigParser</span></tt></a> supports
interpolation. This means values can contain format strings which refer to
other values in the same section, or values in a special <tt class="docutils literal"><span class="pre">DEFAULT</span></tt> section.
Additional defaults can be provided on initialization.</p>
<p>For example:</p>
<div class="highlight-python"><pre>[My Section]
foodir: %(dir)s/whatever
dir=frob
long: this value continues
in the next line</pre>
</div>
<p>would resolve the <tt class="docutils literal"><span class="pre">%(dir)s</span></tt> to the value of <tt class="docutils literal"><span class="pre">dir</span></tt> (<tt class="docutils literal"><span class="pre">frob</span></tt> in this case).
All reference expansions are done on demand.</p>
<p>Default values can be specified by passing them into the <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a>
constructor as a dictionary. Additional defaults may be passed into the
<tt class="xref py py-meth docutils literal"><span class="pre">get()</span></tt> method which will override all others.</p>
<p>Sections are normally stored in a built-in dictionary. An alternative dictionary
type can be passed to the <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> constructor. For example, if a
dictionary type is passed that sorts its keys, the sections will be sorted on
write-back, as will be the keys within each section.</p>
<dl class="class">
<dt id="ConfigParser.RawConfigParser">
<em class="property">class </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">RawConfigParser</tt><big>(</big><span class="optional">[</span><em>defaults</em><span class="optional">[</span>, <em>dict_type</em><span class="optional">[</span>, <em>allow_no_value</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser" title="Permalink to this definition">¶</a></dt>
<dd><p>The basic configuration object. When <em>defaults</em> is given, it is initialized
into the dictionary of intrinsic defaults. When <em>dict_type</em> is given, it will
be used to create the dictionary objects for the list of sections, for the
options within a section, and for the default values. When <em>allow_no_value</em>
is true (default: <tt class="docutils literal"><span class="pre">False</span></tt>), options without values are accepted; the value
presented for these is <tt class="docutils literal"><span class="pre">None</span></tt>.</p>
<p>This class does not
support the magical interpolation behavior.</p>
<p>All option names are passed through the <a class="reference internal" href="#ConfigParser.RawConfigParser.optionxform" title="ConfigParser.RawConfigParser.optionxform"><tt class="xref py py-meth docutils literal"><span class="pre">optionxform()</span></tt></a> method. Its
default implementation converts option names to lower case.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span><em>dict_type</em> was added.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>The default <em>dict_type</em> is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><tt class="xref py py-class docutils literal"><span class="pre">collections.OrderedDict</span></tt></a>.
<em>allow_no_value</em> was added.</p>
</dd></dl>
<dl class="class">
<dt id="ConfigParser.ConfigParser">
<em class="property">class </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">ConfigParser</tt><big>(</big><span class="optional">[</span><em>defaults</em><span class="optional">[</span>, <em>dict_type</em><span class="optional">[</span>, <em>allow_no_value</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.ConfigParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived class of <a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">RawConfigParser</span></tt></a> that implements the magical
interpolation feature and adds optional arguments to the <a class="reference internal" href="#ConfigParser.ConfigParser.get" title="ConfigParser.ConfigParser.get"><tt class="xref py py-meth docutils literal"><span class="pre">get()</span></tt></a> and
<a class="reference internal" href="#ConfigParser.ConfigParser.items" title="ConfigParser.ConfigParser.items"><tt class="xref py py-meth docutils literal"><span class="pre">items()</span></tt></a> methods. The values in <em>defaults</em> must be appropriate for the
<tt class="docutils literal"><span class="pre">%()s</span></tt> string interpolation. Note that <em>__name__</em> is an intrinsic default;
its value is the section name, and will override any value provided in
<em>defaults</em>.</p>
<p>All option names used in interpolation will be passed through the
<tt class="xref py py-meth docutils literal"><span class="pre">optionxform()</span></tt> method just like any other option name reference. Using
the default implementation of <tt class="xref py py-meth docutils literal"><span class="pre">optionxform()</span></tt>, the values <tt class="docutils literal"><span class="pre">foo</span> <span class="pre">%(bar)s</span></tt>
and <tt class="docutils literal"><span class="pre">foo</span> <span class="pre">%(BAR)s</span></tt> are equivalent.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span><em>dict_type</em> was added.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>The default <em>dict_type</em> is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><tt class="xref py py-class docutils literal"><span class="pre">collections.OrderedDict</span></tt></a>.
<em>allow_no_value</em> was added.</p>
</dd></dl>
<dl class="class">
<dt id="ConfigParser.SafeConfigParser">
<em class="property">class </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">SafeConfigParser</tt><big>(</big><span class="optional">[</span><em>defaults</em><span class="optional">[</span>, <em>dict_type</em><span class="optional">[</span>, <em>allow_no_value</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.SafeConfigParser" title="Permalink to this definition">¶</a></dt>
<dd><p>Derived class of <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> that implements a more-sane variant of
the magical interpolation feature. This implementation is more predictable as
well. New applications should prefer this version if they don’t need to be
compatible with older versions of Python.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span><em>dict_type</em> was added.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>The default <em>dict_type</em> is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><tt class="xref py py-class docutils literal"><span class="pre">collections.OrderedDict</span></tt></a>.
<em>allow_no_value</em> was added.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.Error">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">Error</tt><a class="headerlink" href="#ConfigParser.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for all other configparser exceptions.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.NoSectionError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">NoSectionError</tt><a class="headerlink" href="#ConfigParser.NoSectionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when a specified section is not found.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.DuplicateSectionError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">DuplicateSectionError</tt><a class="headerlink" href="#ConfigParser.DuplicateSectionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised if <tt class="xref py py-meth docutils literal"><span class="pre">add_section()</span></tt> is called with the name of a section
that is already present.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.NoOptionError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">NoOptionError</tt><a class="headerlink" href="#ConfigParser.NoOptionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when a specified option is not found in the specified section.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.InterpolationError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">InterpolationError</tt><a class="headerlink" href="#ConfigParser.InterpolationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for exceptions raised when problems occur performing string
interpolation.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.InterpolationDepthError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">InterpolationDepthError</tt><a class="headerlink" href="#ConfigParser.InterpolationDepthError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when string interpolation cannot be completed because the
number of iterations exceeds <a class="reference internal" href="#ConfigParser.MAX_INTERPOLATION_DEPTH" title="ConfigParser.MAX_INTERPOLATION_DEPTH"><tt class="xref py py-const docutils literal"><span class="pre">MAX_INTERPOLATION_DEPTH</span></tt></a>. Subclass of
<a class="reference internal" href="#ConfigParser.InterpolationError" title="ConfigParser.InterpolationError"><tt class="xref py py-exc docutils literal"><span class="pre">InterpolationError</span></tt></a>.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.InterpolationMissingOptionError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">InterpolationMissingOptionError</tt><a class="headerlink" href="#ConfigParser.InterpolationMissingOptionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when an option referenced from a value does not exist. Subclass
of <a class="reference internal" href="#ConfigParser.InterpolationError" title="ConfigParser.InterpolationError"><tt class="xref py py-exc docutils literal"><span class="pre">InterpolationError</span></tt></a>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.InterpolationSyntaxError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">InterpolationSyntaxError</tt><a class="headerlink" href="#ConfigParser.InterpolationSyntaxError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when the source text into which substitutions are made does not
conform to the required syntax. Subclass of <a class="reference internal" href="#ConfigParser.InterpolationError" title="ConfigParser.InterpolationError"><tt class="xref py py-exc docutils literal"><span class="pre">InterpolationError</span></tt></a>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.MissingSectionHeaderError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">MissingSectionHeaderError</tt><a class="headerlink" href="#ConfigParser.MissingSectionHeaderError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when attempting to parse a file which has no section headers.</p>
</dd></dl>
<dl class="exception">
<dt id="ConfigParser.ParsingError">
<em class="property">exception </em><tt class="descclassname">ConfigParser.</tt><tt class="descname">ParsingError</tt><a class="headerlink" href="#ConfigParser.ParsingError" title="Permalink to this definition">¶</a></dt>
<dd><p>Exception raised when errors occur attempting to parse a file.</p>
</dd></dl>
<dl class="data">
<dt id="ConfigParser.MAX_INTERPOLATION_DEPTH">
<tt class="descclassname">ConfigParser.</tt><tt class="descname">MAX_INTERPOLATION_DEPTH</tt><a class="headerlink" href="#ConfigParser.MAX_INTERPOLATION_DEPTH" title="Permalink to this definition">¶</a></dt>
<dd><p>The maximum depth for recursive interpolation for <tt class="xref py py-meth docutils literal"><span class="pre">get()</span></tt> when the <em>raw</em>
parameter is false. This is relevant only for the <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> class.</p>
</dd></dl>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Module <a class="reference internal" href="shlex.html#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><tt class="xref py py-mod docutils literal"><span class="pre">shlex</span></tt></a></dt>
<dd>Support for a creating Unix shell-like mini-languages which can be used as an
alternate format for application configuration files.</dd>
</dl>
</div>
<div class="section" id="rawconfigparser-objects">
<span id="id1"></span><h2>13.2.1. RawConfigParser Objects<a class="headerlink" href="#rawconfigparser-objects" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">RawConfigParser</span></tt></a> instances have the following methods:</p>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.defaults">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">defaults</tt><big>(</big><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.defaults" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dictionary containing the instance-wide defaults.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.sections">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">sections</tt><big>(</big><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.sections" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the sections available; <tt class="docutils literal"><span class="pre">DEFAULT</span></tt> is not included in the
list.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.add_section">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">add_section</tt><big>(</big><em>section</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.add_section" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a section named <em>section</em> to the instance. If a section by the given name
already exists, <a class="reference internal" href="#ConfigParser.DuplicateSectionError" title="ConfigParser.DuplicateSectionError"><tt class="xref py py-exc docutils literal"><span class="pre">DuplicateSectionError</span></tt></a> is raised. If the name
<tt class="docutils literal"><span class="pre">DEFAULT</span></tt> (or any of it’s case-insensitive variants) is passed,
<a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> is raised.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.has_section">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">has_section</tt><big>(</big><em>section</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.has_section" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates whether the named section is present in the configuration. The
<tt class="docutils literal"><span class="pre">DEFAULT</span></tt> section is not acknowledged.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.options">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">options</tt><big>(</big><em>section</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.options" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of options available in the specified <em>section</em>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.has_option">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">has_option</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.has_option" title="Permalink to this definition">¶</a></dt>
<dd><p>If the given section exists, and contains the given option, return
<a class="reference internal" href="constants.html#True" title="True"><tt class="xref py py-const docutils literal"><span class="pre">True</span></tt></a>; otherwise return <a class="reference internal" href="constants.html#False" title="False"><tt class="xref py py-const docutils literal"><span class="pre">False</span></tt></a>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.6.</span></p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.read">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">read</tt><big>(</big><em>filenames</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.read" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempt to read and parse a list of filenames, returning a list of filenames
which were successfully parsed. If <em>filenames</em> is a string or Unicode string,
it is treated as a single filename. If a file named in <em>filenames</em> cannot be
opened, that file will be ignored. This is designed so that you can specify a
list of potential configuration file locations (for example, the current
directory, the user’s home directory, and some system-wide directory), and all
existing configuration files in the list will be read. If none of the named
files exist, the <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> instance will contain an empty dataset.
An application which requires initial values to be loaded from a file should
load the required file or files using <a class="reference internal" href="#ConfigParser.RawConfigParser.readfp" title="ConfigParser.RawConfigParser.readfp"><tt class="xref py py-meth docutils literal"><span class="pre">readfp()</span></tt></a> before calling <a class="reference internal" href="#ConfigParser.RawConfigParser.read" title="ConfigParser.RawConfigParser.read"><tt class="xref py py-meth docutils literal"><span class="pre">read()</span></tt></a>
for any optional files:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ConfigParser</span><span class="o">,</span> <span class="nn">os</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">config</span><span class="o">.</span><span class="n">readfp</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="s">'defaults.cfg'</span><span class="p">))</span>
<span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">([</span><span class="s">'site.cfg'</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="s">'~/.myapp.cfg'</span><span class="p">)])</span>
</pre></div>
</div>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.4: </span>Returns list of successfully parsed filenames.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.readfp">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">readfp</tt><big>(</big><em>fp</em><span class="optional">[</span>, <em>filename</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.readfp" title="Permalink to this definition">¶</a></dt>
<dd><p>Read and parse configuration data from the file or file-like object in <em>fp</em>
(only the <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><tt class="xref py py-meth docutils literal"><span class="pre">readline()</span></tt></a> method is used). If <em>filename</em> is omitted and <em>fp</em>
has a <tt class="xref py py-attr docutils literal"><span class="pre">name</span></tt> attribute, that is used for <em>filename</em>; the default is
<tt class="docutils literal"><span class="pre"><???></span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.get">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">get</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an <em>option</em> value for the named <em>section</em>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.getint">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">getint</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.getint" title="Permalink to this definition">¶</a></dt>
<dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em> to an
integer.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.getfloat">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">getfloat</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.getfloat" title="Permalink to this definition">¶</a></dt>
<dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em> to a
floating point number.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.getboolean">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">getboolean</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.getboolean" title="Permalink to this definition">¶</a></dt>
<dd><p>A convenience method which coerces the <em>option</em> in the specified <em>section</em> to a
Boolean value. Note that the accepted values for the option are <tt class="docutils literal"><span class="pre">"1"</span></tt>,
<tt class="docutils literal"><span class="pre">"yes"</span></tt>, <tt class="docutils literal"><span class="pre">"true"</span></tt>, and <tt class="docutils literal"><span class="pre">"on"</span></tt>, which cause this method to return <tt class="docutils literal"><span class="pre">True</span></tt>,
and <tt class="docutils literal"><span class="pre">"0"</span></tt>, <tt class="docutils literal"><span class="pre">"no"</span></tt>, <tt class="docutils literal"><span class="pre">"false"</span></tt>, and <tt class="docutils literal"><span class="pre">"off"</span></tt>, which cause it to return
<tt class="docutils literal"><span class="pre">False</span></tt>. These string values are checked in a case-insensitive manner. Any
other value will cause it to raise <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.items">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">items</tt><big>(</big><em>section</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.items" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of <tt class="docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> pairs for each option in the given <em>section</em>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.set">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">set</tt><big>(</big><em>section</em>, <em>option</em>, <em>value</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.set" title="Permalink to this definition">¶</a></dt>
<dd><p>If the given section exists, set the given option to the specified value;
otherwise raise <a class="reference internal" href="#ConfigParser.NoSectionError" title="ConfigParser.NoSectionError"><tt class="xref py py-exc docutils literal"><span class="pre">NoSectionError</span></tt></a>. While it is possible to use
<a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">RawConfigParser</span></tt></a> (or <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> with <em>raw</em> parameters set to
true) for <em>internal</em> storage of non-string values, full functionality (including
interpolation and output to files) can only be achieved using string values.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.6.</span></p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.write">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">write</tt><big>(</big><em>fileobject</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a representation of the configuration to the specified file object. This
representation can be parsed by a future <a class="reference internal" href="#ConfigParser.RawConfigParser.read" title="ConfigParser.RawConfigParser.read"><tt class="xref py py-meth docutils literal"><span class="pre">read()</span></tt></a> call.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.6.</span></p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.remove_option">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">remove_option</tt><big>(</big><em>section</em>, <em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.remove_option" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the specified <em>option</em> from the specified <em>section</em>. If the section does
not exist, raise <a class="reference internal" href="#ConfigParser.NoSectionError" title="ConfigParser.NoSectionError"><tt class="xref py py-exc docutils literal"><span class="pre">NoSectionError</span></tt></a>. If the option existed to be removed,
return <a class="reference internal" href="constants.html#True" title="True"><tt class="xref py py-const docutils literal"><span class="pre">True</span></tt></a>; otherwise return <a class="reference internal" href="constants.html#False" title="False"><tt class="xref py py-const docutils literal"><span class="pre">False</span></tt></a>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.6.</span></p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.remove_section">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">remove_section</tt><big>(</big><em>section</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.remove_section" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the specified <em>section</em> from the configuration. If the section in fact
existed, return <tt class="docutils literal"><span class="pre">True</span></tt>. Otherwise return <tt class="docutils literal"><span class="pre">False</span></tt>.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.RawConfigParser.optionxform">
<tt class="descclassname">RawConfigParser.</tt><tt class="descname">optionxform</tt><big>(</big><em>option</em><big>)</big><a class="headerlink" href="#ConfigParser.RawConfigParser.optionxform" title="Permalink to this definition">¶</a></dt>
<dd><p>Transforms the option name <em>option</em> as found in an input file or as passed in
by client code to the form that should be used in the internal structures.
The default implementation returns a lower-case version of <em>option</em>;
subclasses may override this or client code can set an attribute of this name
on instances to affect this behavior.</p>
<p>You don’t necessarily need to subclass a ConfigParser to use this method, you
can also re-set it on an instance, to a function that takes a string
argument. Setting it to <tt class="docutils literal"><span class="pre">str</span></tt>, for example, would make option names case
sensitive:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">cfgparser</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="p">()</span>
<span class="o">...</span>
<span class="n">cfgparser</span><span class="o">.</span><span class="n">optionxform</span> <span class="o">=</span> <span class="nb">str</span>
</pre></div>
</div>
<p>Note that when reading configuration files, whitespace around the
option names are stripped before <a class="reference internal" href="#ConfigParser.RawConfigParser.optionxform" title="ConfigParser.RawConfigParser.optionxform"><tt class="xref py py-meth docutils literal"><span class="pre">optionxform()</span></tt></a> is called.</p>
</dd></dl>
</div>
<div class="section" id="configparser-objects">
<span id="id2"></span><h2>13.2.2. ConfigParser Objects<a class="headerlink" href="#configparser-objects" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> class extends some methods of the
<a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">RawConfigParser</span></tt></a> interface, adding some optional arguments.</p>
<dl class="method">
<dt id="ConfigParser.ConfigParser.get">
<tt class="descclassname">ConfigParser.</tt><tt class="descname">get</tt><big>(</big><em>section</em>, <em>option</em><span class="optional">[</span>, <em>raw</em><span class="optional">[</span>, <em>vars</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.ConfigParser.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an <em>option</em> value for the named <em>section</em>. If <em>vars</em> is provided, it
must be a dictionary. The <em>option</em> is looked up in <em>vars</em> (if provided),
<em>section</em>, and in <em>defaults</em> in that order.</p>
<p>All the <tt class="docutils literal"><span class="pre">'%'</span></tt> interpolations are expanded in the return values, unless the
<em>raw</em> argument is true. Values for interpolation keys are looked up in the
same manner as the option.</p>
</dd></dl>
<dl class="method">
<dt id="ConfigParser.ConfigParser.items">
<tt class="descclassname">ConfigParser.</tt><tt class="descname">items</tt><big>(</big><em>section</em><span class="optional">[</span>, <em>raw</em><span class="optional">[</span>, <em>vars</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#ConfigParser.ConfigParser.items" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of <tt class="docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> pairs for each option in the given <em>section</em>.
Optional arguments have the same meaning as for the <a class="reference internal" href="#ConfigParser.ConfigParser.get" title="ConfigParser.ConfigParser.get"><tt class="xref py py-meth docutils literal"><span class="pre">get()</span></tt></a> method.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.3.</span></p>
</dd></dl>
</div>
<div class="section" id="safeconfigparser-objects">
<span id="id3"></span><h2>13.2.3. SafeConfigParser Objects<a class="headerlink" href="#safeconfigparser-objects" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">SafeConfigParser</span></tt></a> class implements the same extended interface as
<a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a>, with the following addition:</p>
<dl class="method">
<dt id="ConfigParser.SafeConfigParser.set">
<tt class="descclassname">SafeConfigParser.</tt><tt class="descname">set</tt><big>(</big><em>section</em>, <em>option</em>, <em>value</em><big>)</big><a class="headerlink" href="#ConfigParser.SafeConfigParser.set" title="Permalink to this definition">¶</a></dt>
<dd><p>If the given section exists, set the given option to the specified value;
otherwise raise <a class="reference internal" href="#ConfigParser.NoSectionError" title="ConfigParser.NoSectionError"><tt class="xref py py-exc docutils literal"><span class="pre">NoSectionError</span></tt></a>. <em>value</em> must be a string (<a class="reference internal" href="functions.html#str" title="str"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></a>
or <a class="reference internal" href="functions.html#unicode" title="unicode"><tt class="xref py py-class docutils literal"><span class="pre">unicode</span></tt></a>); if not, <a class="reference internal" href="exceptions.html#exceptions.TypeError" title="exceptions.TypeError"><tt class="xref py py-exc docutils literal"><span class="pre">TypeError</span></tt></a> is raised.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
</dd></dl>
</div>
<div class="section" id="examples">
<h2>13.2.4. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>An example of writing to a configuration file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ConfigParser</span>
<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>
<span class="c"># When adding sections or items, add them in the reverse order of</span>
<span class="c"># how you want them to be displayed in the actual file.</span>
<span class="c"># In addition, please note that using RawConfigParser's and the raw</span>
<span class="c"># mode of ConfigParser's respective set functions, you can assign</span>
<span class="c"># non-string values to keys internally, but will receive an error</span>
<span class="c"># when attempting to write to a file or when you get it in non-raw</span>
<span class="c"># mode. SafeConfigParser does not allow such assignments to take place.</span>
<span class="n">config</span><span class="o">.</span><span class="n">add_section</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'an_int'</span><span class="p">,</span> <span class="s">'15'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'a_bool'</span><span class="p">,</span> <span class="s">'true'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'a_float'</span><span class="p">,</span> <span class="s">'3.1415'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'baz'</span><span class="p">,</span> <span class="s">'fun'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'bar'</span><span class="p">,</span> <span class="s">'Python'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">,</span> <span class="s">'</span><span class="si">%(bar)s</span><span class="s"> is </span><span class="si">%(baz)s</span><span class="s">!'</span><span class="p">)</span>
<span class="c"># Writing our configuration file to 'example.cfg'</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'example.cfg'</span><span class="p">,</span> <span class="s">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">configfile</span><span class="p">:</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>
</pre></div>
</div>
<p>An example of reading the configuration file again:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ConfigParser</span>
<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>
<span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s">'example.cfg'</span><span class="p">)</span>
<span class="c"># getfloat() raises an exception if the value is not a float</span>
<span class="c"># getint() and getboolean() also do this for their respective types</span>
<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="s">'Section1'</span><span class="p">,</span> <span class="s">'a_float'</span><span class="p">)</span>
<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="s">'Section1'</span><span class="p">,</span> <span class="s">'an_int'</span><span class="p">)</span>
<span class="k">print</span> <span class="n">a_float</span> <span class="o">+</span> <span class="n">an_int</span>
<span class="c"># Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.</span>
<span class="c"># This is because we are using a RawConfigParser().</span>
<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="s">'Section1'</span><span class="p">,</span> <span class="s">'a_bool'</span><span class="p">):</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span>
</pre></div>
</div>
<p>To get interpolation, you will need to use a <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-class docutils literal"><span class="pre">ConfigParser</span></tt></a> or
<a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><tt class="xref py py-class docutils literal"><span class="pre">SafeConfigParser</span></tt></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ConfigParser</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">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s">'example.cfg'</span><span class="p">)</span>
<span class="c"># Set the third, optional argument of get to 1 if you wish to use raw mode.</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c"># -> "Python is fun!"</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c"># -> "%(bar)s is %(baz)s!"</span>
<span class="c"># The optional fourth argument is a dict with members that will take</span>
<span class="c"># precedence in interpolation.</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="p">{</span><span class="s">'bar'</span><span class="p">:</span> <span class="s">'Documentation'</span><span class="p">,</span>
<span class="s">'baz'</span><span class="p">:</span> <span class="s">'evil'</span><span class="p">})</span>
</pre></div>
</div>
<p>Defaults are available in all three types of ConfigParsers. They are used in
interpolation if an option used is not defined elsewhere.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ConfigParser</span>
<span class="c"># New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each</span>
<span class="n">config</span> <span class="o">=</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">SafeConfigParser</span><span class="p">({</span><span class="s">'bar'</span><span class="p">:</span> <span class="s">'Life'</span><span class="p">,</span> <span class="s">'baz'</span><span class="p">:</span> <span class="s">'hard'</span><span class="p">})</span>
<span class="n">config</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s">'example.cfg'</span><span class="p">)</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span> <span class="c"># -> "Python is fun!"</span>
<span class="n">config</span><span class="o">.</span><span class="n">remove_option</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'bar'</span><span class="p">)</span>
<span class="n">config</span><span class="o">.</span><span class="n">remove_option</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'baz'</span><span class="p">)</span>
<span class="k">print</span> <span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'Section1'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span> <span class="c"># -> "Life is hard!"</span>
</pre></div>
</div>
<p>The function <tt class="docutils literal"><span class="pre">opt_move</span></tt> below can be used to move options between sections:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">opt_move</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">section1</span><span class="p">,</span> <span class="n">section2</span><span class="p">,</span> <span class="n">option</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">config</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">section2</span><span class="p">,</span> <span class="n">option</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="n">section1</span><span class="p">,</span> <span class="n">option</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
<span class="k">except</span> <span class="n">ConfigParser</span><span class="o">.</span><span class="n">NoSectionError</span><span class="p">:</span>
<span class="c"># Create non-existent section</span>
<span class="n">config</span><span class="o">.</span><span class="n">add_section</span><span class="p">(</span><span class="n">section2</span><span class="p">)</span>
<span class="n">opt_move</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">section1</span><span class="p">,</span> <span class="n">section2</span><span class="p">,</span> <span class="n">option</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">config</span><span class="o">.</span><span class="n">remove_option</span><span class="p">(</span><span class="n">section1</span><span class="p">,</span> <span class="n">option</span><span class="p">)</span>
</pre></div>
</div>
<p>Some configuration files are known to include settings without values, but which
otherwise conform to the syntax supported by <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><tt class="xref py py-mod docutils literal"><span class="pre">ConfigParser</span></tt></a>. The
<em>allow_no_value</em> parameter to the constructor can be used to indicate that such
values should be accepted:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">ConfigParser</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">io</span>
<span class="gp">>>> </span><span class="n">sample_config</span> <span class="o">=</span> <span class="s">"""</span>
<span class="gp">... </span><span class="s">[mysqld]</span>
<span class="gp">... </span><span class="s">user = mysql</span>
<span class="gp">... </span><span class="s">pid-file = /var/run/mysqld/mysqld.pid</span>
<span class="gp">... </span><span class="s">skip-external-locking</span>
<span class="gp">... </span><span class="s">old_passwords = 1</span>
<span class="gp">... </span><span class="s">skip-bdb</span>
<span class="gp">... </span><span class="s">skip-innodb</span>
<span class="gp">... </span><span class="s">"""</span>
<span class="gp">>>> </span><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><span class="n">allow_no_value</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">readfp</span><span class="p">(</span><span class="n">io</span><span class="o">.</span><span class="n">BytesIO</span><span class="p">(</span><span class="n">sample_config</span><span class="p">))</span>
<span class="gp">>>> </span><span class="c"># Settings with values are treated as before:</span>
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"mysqld"</span><span class="p">,</span> <span class="s">"user"</span><span class="p">)</span>
<span class="go">'mysql'</span>
<span class="gp">>>> </span><span class="c"># Settings without values provide None:</span>
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"mysqld"</span><span class="p">,</span> <span class="s">"skip-bdb"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="c"># Settings which aren't specified still raise an error:</span>
<span class="gp">>>> </span><span class="n">config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"mysqld"</span><span class="p">,</span> <span class="s">"does-not-exist"</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">ConfigParser.NoOptionError: No option 'does-not-exist' in section</span>: <span class="n">'mysqld'</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">13.2. <tt class="docutils literal"><span class="pre">ConfigParser</span></tt> — Configuration file parser</a><ul>
<li><a class="reference internal" href="#rawconfigparser-objects">13.2.1. RawConfigParser Objects</a></li>
<li><a class="reference internal" href="#configparser-objects">13.2.2. ConfigParser Objects</a></li>
<li><a class="reference internal" href="#safeconfigparser-objects">13.2.3. SafeConfigParser Objects</a></li>
<li><a class="reference internal" href="#examples">13.2.4. Examples</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="csv.html"
title="previous chapter">13.1. <tt class="docutils literal"><span class="pre">csv</span></tt> — CSV File Reading and Writing</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="robotparser.html"
title="next chapter">13.3. <tt class="docutils literal"><span class="pre">robotparser</span></tt> — Parser for robots.txt</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../bugs.html">Report a Bug</a></li>
<li><a href="../_sources/library/configparser.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="robotparser.html" title="13.3. robotparser — Parser for robots.txt"
>next</a> |</li>
<li class="right" >
<a href="csv.html" title="13.1. csv — CSV File Reading and Writing"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a> »</li>
<li>
<a href="../index.html">Python 2.7.5 documentation</a> »
</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="fileformats.html" >13. File Formats</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Oct 13, 2020.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>