0x1949 Team - FAZEMRX - MANAGER

Edit File: configparser.html

<!DOCTYPE html>

<title>13.2. ConfigParser — Configuration file parser &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.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" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/configparser.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/configparser.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="fileformats.html" accesskey="U">13. File Formats</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">13.2. <code class="xref py py-mod docutils literal notranslate">ConfigParser</code> — Configuration file parser</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-ConfigParser">
<h1>13.2. <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate">ConfigParser</code></a> — Configuration file parser<a class="headerlink" href="#module-ConfigParser" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
Note
The <a class="reference internal" href="#module-ConfigParser" title="ConfigParser: Configuration file parser."><code class="xref py py-mod docutils literal notranslate">ConfigParser</code></a> module has been renamed to <code class="xref py py-mod docutils literal notranslate">configparser</code> in
Python 3. The <a class="reference internal" href="../glossary.html#term-2to3">2to3</a> tool will automatically adapt imports when
converting your sources to Python 3.
</div>
This module defines the class <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a>. The <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></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.
<div class="admonition note">
Note
This library does not interpret or write the value-type prefixes used in
the Windows Registry extended version of INI syntax.
</div>
<div class="admonition seealso">
See also
<dl class="simple">
<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">shlex</code></a></dt><dd>Support for 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."><code class="xref py py-mod docutils literal notranslate">json</code></a></dt><dd>The json module implements a subset of JavaScript syntax which can also
be used for this purpose.
</dd>
</dl>
</div>
The configuration file consists of sections, led by a <code class="docutils literal notranslate">[section]</code> header and
followed by <code class="docutils literal notranslate">name: value</code> entries, with continuations in the style of
<a class="rfc reference external" href="https://tools.ietf.org/html/rfc822.html">RFC 822</a> (see section 3.1.1, “LONG HEADER FIELDS”); <code class="docutils literal notranslate">name=value</code> 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 <code class="docutils literal notranslate">DEFAULT</code> section. Additional defaults can be
provided on initialization and retrieval. Lines beginning with <code class="docutils literal notranslate">'#'</code> or
<code class="docutils literal notranslate">';'</code> are ignored and may be used to provide comments.
Configuration files may include comments, prefixed by specific characters (<code class="docutils literal notranslate">#</code>
and <code class="docutils literal notranslate">;</code>). 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 <code class="docutils literal notranslate">;</code> starts an inline comment, while <code class="docutils literal notranslate">#</code>
does not.)
On top of the core functionality, <a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><code class="xref py py-class docutils literal notranslate">SafeConfigParser</code></a> supports
interpolation. This means values can contain format strings which refer to
other values in the same section, or values in a special <code class="docutils literal notranslate">DEFAULT</code> section.
Additional defaults can be provided on initialization.
For example:
<div class="highlight-default notranslate"><div class="highlight"><pre>[My Section]
foodir: %(dir)s/whatever
dir=frob
long: this value continues
 in the next line
</pre></div>
</div>
would resolve the <code class="docutils literal notranslate">%(dir)s</code> to the value of <code class="docutils literal notranslate">dir</code> (<code class="docutils literal notranslate">frob</code> in this case).
All reference expansions are done on demand.
Default values can be specified by passing them into the <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a>
constructor as a dictionary. Additional defaults may be passed into the
<code class="xref py py-meth docutils literal notranslate">get()</code> method which will override all others.
Sections are normally stored in a built-in dictionary. An alternative dictionary
type can be passed to the <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></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.
<dl class="py class">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser">
class ConfigParser.RawConfigParser([defaults[, dict_type[, allow_no_value]]])<a class="headerlink" href="#ConfigParser.RawConfigParser" title="Permalink to this definition">¶</a></dt>
<dd>The basic configuration object. When defaults is given, it is initialized
into the dictionary of intrinsic defaults. When dict_type 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 allow_no_value
is true (default: <code class="docutils literal notranslate">False</code>), options without values are accepted; the value
presented for these is <code class="docutils literal notranslate">None</code>.
This class does not
support the magical interpolation behavior.
All option names are passed through the <a class="reference internal" href="#ConfigParser.RawConfigParser.optionxform" title="ConfigParser.RawConfigParser.optionxform"><code class="xref py py-meth docutils literal notranslate">optionxform()</code></a> method. Its
default implementation converts option names to lower case.
<div class="versionadded">
New in version 2.3.
</div>
<div class="versionchanged">
Changed in version 2.6: dict_type was added.
</div>
<div class="versionchanged">
Changed in version 2.7: The default dict_type is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><code class="xref py py-class docutils literal notranslate">collections.OrderedDict</code></a>.
allow_no_value was added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ConfigParser.ConfigParser">
class ConfigParser.ConfigParser([defaults[, dict_type[, allow_no_value]]])<a class="headerlink" href="#ConfigParser.ConfigParser" title="Permalink to this definition">¶</a></dt>
<dd>Derived class of <a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><code class="xref py py-class docutils literal notranslate">RawConfigParser</code></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"><code class="xref py py-meth docutils literal notranslate">get()</code></a> and
<a class="reference internal" href="#ConfigParser.ConfigParser.items" title="ConfigParser.ConfigParser.items"><code class="xref py py-meth docutils literal notranslate">items()</code></a> methods. The values in defaults must be appropriate for the
<code class="docutils literal notranslate">%()s</code> string interpolation. Note that __name__ is an intrinsic default;
its value is the section name, and will override any value provided in
defaults.
All option names used in interpolation will be passed through the
<code class="xref py py-meth docutils literal notranslate">optionxform()</code> method just like any other option name reference. Using
the default implementation of <code class="xref py py-meth docutils literal notranslate">optionxform()</code>, the values <code class="docutils literal notranslate">foo %(bar)s</code>
and <code class="docutils literal notranslate">foo %(BAR)s</code> are equivalent.
<div class="versionadded">
New in version 2.3.
</div>
<div class="versionchanged">
Changed in version 2.6: dict_type was added.
</div>
<div class="versionchanged">
Changed in version 2.7: The default dict_type is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><code class="xref py py-class docutils literal notranslate">collections.OrderedDict</code></a>.
allow_no_value was added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ConfigParser.SafeConfigParser">
class ConfigParser.SafeConfigParser([defaults[, dict_type[, allow_no_value]]])<a class="headerlink" href="#ConfigParser.SafeConfigParser" title="Permalink to this definition">¶</a></dt>
<dd>Derived class of <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></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.
<div class="versionadded">
New in version 2.3.
</div>
<div class="versionchanged">
Changed in version 2.6: dict_type was added.
</div>
<div class="versionchanged">
Changed in version 2.7: The default dict_type is <a class="reference internal" href="collections.html#collections.OrderedDict" title="collections.OrderedDict"><code class="xref py py-class docutils literal notranslate">collections.OrderedDict</code></a>.
allow_no_value was added.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.Error">
exception ConfigParser.Error<a class="headerlink" href="#ConfigParser.Error" title="Permalink to this definition">¶</a></dt>
<dd>Base class for all other configparser exceptions.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.NoSectionError">
exception ConfigParser.NoSectionError<a class="headerlink" href="#ConfigParser.NoSectionError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when a specified section is not found.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.DuplicateSectionError">
exception ConfigParser.DuplicateSectionError<a class="headerlink" href="#ConfigParser.DuplicateSectionError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised if <code class="xref py py-meth docutils literal notranslate">add_section()</code> is called with the name of a section
that is already present.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.NoOptionError">
exception ConfigParser.NoOptionError<a class="headerlink" href="#ConfigParser.NoOptionError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when a specified option is not found in the specified section.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.InterpolationError">
exception ConfigParser.InterpolationError<a class="headerlink" href="#ConfigParser.InterpolationError" title="Permalink to this definition">¶</a></dt>
<dd>Base class for exceptions raised when problems occur performing string
interpolation.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.InterpolationDepthError">
exception ConfigParser.InterpolationDepthError<a class="headerlink" href="#ConfigParser.InterpolationDepthError" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-const docutils literal notranslate">MAX_INTERPOLATION_DEPTH</code></a>. Subclass of
<a class="reference internal" href="#ConfigParser.InterpolationError" title="ConfigParser.InterpolationError"><code class="xref py py-exc docutils literal notranslate">InterpolationError</code></a>.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.InterpolationMissingOptionError">
exception ConfigParser.InterpolationMissingOptionError<a class="headerlink" href="#ConfigParser.InterpolationMissingOptionError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when an option referenced from a value does not exist. Subclass
of <a class="reference internal" href="#ConfigParser.InterpolationError" title="ConfigParser.InterpolationError"><code class="xref py py-exc docutils literal notranslate">InterpolationError</code></a>.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.InterpolationSyntaxError">
exception ConfigParser.InterpolationSyntaxError<a class="headerlink" href="#ConfigParser.InterpolationSyntaxError" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-exc docutils literal notranslate">InterpolationError</code></a>.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.MissingSectionHeaderError">
exception ConfigParser.MissingSectionHeaderError<a class="headerlink" href="#ConfigParser.MissingSectionHeaderError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when attempting to parse a file which has no section headers.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ConfigParser.ParsingError">
exception ConfigParser.ParsingError<a class="headerlink" href="#ConfigParser.ParsingError" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when errors occur attempting to parse a file.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="ConfigParser.MAX_INTERPOLATION_DEPTH">
ConfigParser.MAX_INTERPOLATION_DEPTH<a class="headerlink" href="#ConfigParser.MAX_INTERPOLATION_DEPTH" title="Permalink to this definition">¶</a></dt>
<dd>The maximum depth for recursive interpolation for <code class="xref py py-meth docutils literal notranslate">get()</code> when the raw
parameter is false. This is relevant only for the <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> class.
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<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">shlex</code></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>
<section id="rawconfigparser-objects">
<h2>13.2.1. RawConfigParser Objects<a class="headerlink" href="#rawconfigparser-objects" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><code class="xref py py-class docutils literal notranslate">RawConfigParser</code></a> instances have the following methods:
<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.defaults">
RawConfigParser.defaults()<a class="headerlink" href="#ConfigParser.RawConfigParser.defaults" title="Permalink to this definition">¶</a></dt>
<dd>Return a dictionary containing the instance-wide defaults.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.sections">
RawConfigParser.sections()<a class="headerlink" href="#ConfigParser.RawConfigParser.sections" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of the sections available; <code class="docutils literal notranslate">DEFAULT</code> is not included in the
list.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.add_section">
RawConfigParser.add_section(section)<a class="headerlink" href="#ConfigParser.RawConfigParser.add_section" title="Permalink to this definition">¶</a></dt>
<dd>Add a section named section to the instance. If a section by the given name
already exists, <a class="reference internal" href="#ConfigParser.DuplicateSectionError" title="ConfigParser.DuplicateSectionError"><code class="xref py py-exc docutils literal notranslate">DuplicateSectionError</code></a> is raised. If the name
<code class="docutils literal notranslate">DEFAULT</code> (or any of it’s case-insensitive variants) is passed,
<code class="xref py py-exc docutils literal notranslate">ValueError</code> is raised.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.has_section">
RawConfigParser.has_section(section)<a class="headerlink" href="#ConfigParser.RawConfigParser.has_section" title="Permalink to this definition">¶</a></dt>
<dd>Indicates whether the named section is present in the configuration. The
<code class="docutils literal notranslate">DEFAULT</code> section is not acknowledged.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.options">
RawConfigParser.options(section)<a class="headerlink" href="#ConfigParser.RawConfigParser.options" title="Permalink to this definition">¶</a></dt>
<dd>Returns a list of options available in the specified section.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.has_option">
RawConfigParser.has_option(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.has_option" title="Permalink to this definition">¶</a></dt>
<dd>If the given section exists, and contains the given option, return
<a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>; otherwise return <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>.
<div class="versionadded">
New in version 1.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.read">
RawConfigParser.read(filenames)<a class="headerlink" href="#ConfigParser.RawConfigParser.read" title="Permalink to this definition">¶</a></dt>
<dd>Attempt to read and parse a list of filenames, returning a list of filenames
which were successfully parsed. If filenames is a string or Unicode string,
it is treated as a single filename. If a file named in filenames 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="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></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"><code class="xref py py-meth docutils literal notranslate">readfp()</code></a> before calling <a class="reference internal" href="#ConfigParser.RawConfigParser.read" title="ConfigParser.RawConfigParser.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a>
for any optional files:
<div class="highlight-default notranslate"><div class="highlight"><pre>import ConfigParser, os

config = ConfigParser.ConfigParser()
config.readfp(open(&#39;defaults.cfg&#39;))
config.read([&#39;site.cfg&#39;, os.path.expanduser(&#39;~/.myapp.cfg&#39;)])
</pre></div>
</div>
<div class="versionchanged">
Changed in version 2.4: Returns list of successfully parsed filenames.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.readfp">
RawConfigParser.readfp(fp[, filename])<a class="headerlink" href="#ConfigParser.RawConfigParser.readfp" title="Permalink to this definition">¶</a></dt>
<dd>Read and parse configuration data from the file or file-like object in fp
(only the <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-meth docutils literal notranslate">readline()</code></a> method is used). If filename is omitted and fp
has a <code class="xref py py-attr docutils literal notranslate">name</code> attribute, that is used for filename; the default is
<code class="docutils literal notranslate">&lt;???&gt;</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.get">
RawConfigParser.get(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.get" title="Permalink to this definition">¶</a></dt>
<dd>Get an option value for the named section.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.getint">
RawConfigParser.getint(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.getint" title="Permalink to this definition">¶</a></dt>
<dd>A convenience method which coerces the option in the specified section to an
integer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.getfloat">
RawConfigParser.getfloat(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.getfloat" title="Permalink to this definition">¶</a></dt>
<dd>A convenience method which coerces the option in the specified section to a
floating point number.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.getboolean">
RawConfigParser.getboolean(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.getboolean" title="Permalink to this definition">¶</a></dt>
<dd>A convenience method which coerces the option in the specified section to a
Boolean value. Note that the accepted values for the option are <code class="docutils literal notranslate">&quot;1&quot;</code>,
<code class="docutils literal notranslate">&quot;yes&quot;</code>, <code class="docutils literal notranslate">&quot;true&quot;</code>, and <code class="docutils literal notranslate">&quot;on&quot;</code>, which cause this method to return <code class="docutils literal notranslate">True</code>,
and <code class="docutils literal notranslate">&quot;0&quot;</code>, <code class="docutils literal notranslate">&quot;no&quot;</code>, <code class="docutils literal notranslate">&quot;false&quot;</code>, and <code class="docutils literal notranslate">&quot;off&quot;</code>, which cause it to return
<code class="docutils literal notranslate">False</code>. These string values are checked in a case-insensitive manner. Any
other value will cause it to raise <code class="xref py py-exc docutils literal notranslate">ValueError</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.items">
RawConfigParser.items(section)<a class="headerlink" href="#ConfigParser.RawConfigParser.items" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of <code class="docutils literal notranslate">(name, value)</code> pairs for each option in the given section.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.set">
RawConfigParser.set(section, option, value)<a class="headerlink" href="#ConfigParser.RawConfigParser.set" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-exc docutils literal notranslate">NoSectionError</code></a>. While it is possible to use
<a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><code class="xref py py-class docutils literal notranslate">RawConfigParser</code></a> (or <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> with raw parameters set to
true) for internal storage of non-string values, full functionality (including
interpolation and output to files) can only be achieved using string values.
<div class="versionadded">
New in version 1.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.write">
RawConfigParser.write(fileobject)<a class="headerlink" href="#ConfigParser.RawConfigParser.write" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-meth docutils literal notranslate">read()</code></a> call.
<div class="versionadded">
New in version 1.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.remove_option">
RawConfigParser.remove_option(section, option)<a class="headerlink" href="#ConfigParser.RawConfigParser.remove_option" title="Permalink to this definition">¶</a></dt>
<dd>Remove the specified option from the specified section. If the section does
not exist, raise <a class="reference internal" href="#ConfigParser.NoSectionError" title="ConfigParser.NoSectionError"><code class="xref py py-exc docutils literal notranslate">NoSectionError</code></a>. If the option existed to be removed,
return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>; otherwise return <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>.
<div class="versionadded">
New in version 1.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.remove_section">
RawConfigParser.remove_section(section)<a class="headerlink" href="#ConfigParser.RawConfigParser.remove_section" title="Permalink to this definition">¶</a></dt>
<dd>Remove the specified section from the configuration. If the section in fact
existed, return <code class="docutils literal notranslate">True</code>. Otherwise return <code class="docutils literal notranslate">False</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.RawConfigParser.optionxform">
RawConfigParser.optionxform(option)<a class="headerlink" href="#ConfigParser.RawConfigParser.optionxform" title="Permalink to this definition">¶</a></dt>
<dd>Transforms the option name option 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 option;
subclasses may override this or client code can set an attribute of this name
on instances to affect this behavior.
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 <code class="docutils literal notranslate">str</code>, for example, would make option names case
sensitive:
<div class="highlight-default notranslate"><div class="highlight"><pre>cfgparser = ConfigParser()
...
cfgparser.optionxform = str
</pre></div>
</div>
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"><code class="xref py py-meth docutils literal notranslate">optionxform()</code></a> is called.
</dd></dl>

</section>
<section id="configparser-objects">
<h2>13.2.2. ConfigParser Objects<a class="headerlink" href="#configparser-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> class extends some methods of the
<a class="reference internal" href="#ConfigParser.RawConfigParser" title="ConfigParser.RawConfigParser"><code class="xref py py-class docutils literal notranslate">RawConfigParser</code></a> interface, adding some optional arguments.
<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.ConfigParser.get">
ConfigParser.get(section, option[, raw[, vars]])<a class="headerlink" href="#ConfigParser.ConfigParser.get" title="Permalink to this definition">¶</a></dt>
<dd>Get an option value for the named section. If vars is provided, it
must be a dictionary. The option is looked up in vars (if provided),
section, and in defaults in that order.
All the <code class="docutils literal notranslate">'%'</code> interpolations are expanded in the return values, unless the
raw argument is true. Values for interpolation keys are looked up in the
same manner as the option.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.ConfigParser.items">
ConfigParser.items(section[, raw[, vars]])<a class="headerlink" href="#ConfigParser.ConfigParser.items" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of <code class="docutils literal notranslate">(name, value)</code> pairs for each option in the given section.
Optional arguments have the same meaning as for the <a class="reference internal" href="#ConfigParser.ConfigParser.get" title="ConfigParser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate">get()</code></a> method.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

</section>
<section id="safeconfigparser-objects">
<h2>13.2.3. SafeConfigParser Objects<a class="headerlink" href="#safeconfigparser-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><code class="xref py py-class docutils literal notranslate">SafeConfigParser</code></a> class implements the same extended interface as
<a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a>, with the following addition:
<dl class="py method">
<dt class="sig sig-object py" id="ConfigParser.SafeConfigParser.set">
SafeConfigParser.set(section, option, value)<a class="headerlink" href="#ConfigParser.SafeConfigParser.set" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-exc docutils literal notranslate">NoSectionError</code></a>. value must be a string (<a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>
or <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate">unicode</code></a>); if not, <code class="xref py py-exc docutils literal notranslate">TypeError</code> is raised.
<div class="versionadded">
New in version 2.4.
</div>
</dd></dl>

</section>
<section id="examples">
<h2>13.2.4. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
An example of writing to a configuration file:
<div class="highlight-default notranslate"><div class="highlight"><pre>import ConfigParser

config = ConfigParser.RawConfigParser()

# When adding sections or items, add them in the reverse order of
# how you want them to be displayed in the actual file.
# In addition, please note that using RawConfigParser&#39;s and the raw
# mode of ConfigParser&#39;s respective set functions, you can assign
# non-string values to keys internally, but will receive an error
# when attempting to write to a file or when you get it in non-raw
# mode. SafeConfigParser does not allow such assignments to take place.
config.add_section(&#39;Section1&#39;)
config.set(&#39;Section1&#39;, &#39;an_int&#39;, &#39;15&#39;)
config.set(&#39;Section1&#39;, &#39;a_bool&#39;, &#39;true&#39;)
config.set(&#39;Section1&#39;, &#39;a_float&#39;, &#39;3.1415&#39;)
config.set(&#39;Section1&#39;, &#39;baz&#39;, &#39;fun&#39;)
config.set(&#39;Section1&#39;, &#39;bar&#39;, &#39;Python&#39;)
config.set(&#39;Section1&#39;, &#39;foo&#39;, &#39;%(bar)s is %(baz)s!&#39;)

# Writing our configuration file to &#39;example.cfg&#39;
with open(&#39;example.cfg&#39;, &#39;wb&#39;) as configfile:
 config.write(configfile)
</pre></div>
</div>
An example of reading the configuration file again:
<div class="highlight-default notranslate"><div class="highlight"><pre>import ConfigParser

config = ConfigParser.RawConfigParser()
config.read(&#39;example.cfg&#39;)

# getfloat() raises an exception if the value is not a float
# getint() and getboolean() also do this for their respective types
a_float = config.getfloat(&#39;Section1&#39;, &#39;a_float&#39;)
an_int = config.getint(&#39;Section1&#39;, &#39;an_int&#39;)
print a_float + an_int

# Notice that the next output does not interpolate &#39;%(bar)s&#39; or &#39;%(baz)s&#39;.
# This is because we are using a RawConfigParser().
if config.getboolean(&#39;Section1&#39;, &#39;a_bool&#39;):
 print config.get(&#39;Section1&#39;, &#39;foo&#39;)
</pre></div>
</div>
To get interpolation, you will need to use a <a class="reference internal" href="#ConfigParser.ConfigParser" title="ConfigParser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> or
<a class="reference internal" href="#ConfigParser.SafeConfigParser" title="ConfigParser.SafeConfigParser"><code class="xref py py-class docutils literal notranslate">SafeConfigParser</code></a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>import ConfigParser

# Set the third, optional argument of get to 1 if you wish to use raw mode.
print config.get(&#39;Section1&#39;, &#39;foo&#39;, 0) # -&gt; &quot;Python is fun!&quot;
print config.get(&#39;Section1&#39;, &#39;foo&#39;, 1) # -&gt; &quot;%(bar)s is %(baz)s!&quot;

# The optional fourth argument is a dict with members that will take
# precedence in interpolation.
print config.get(&#39;Section1&#39;, &#39;foo&#39;, 0, {&#39;bar&#39;: &#39;Documentation&#39;,
 &#39;baz&#39;: &#39;evil&#39;})
</pre></div>
</div>
Defaults are available in all three types of ConfigParsers. They are used in
interpolation if an option used is not defined elsewhere.
<div class="highlight-default notranslate"><div class="highlight"><pre>import ConfigParser

# New instance with &#39;bar&#39; and &#39;baz&#39; defaulting to &#39;Life&#39; and &#39;hard&#39; each
config = ConfigParser.SafeConfigParser({&#39;bar&#39;: &#39;Life&#39;, &#39;baz&#39;: &#39;hard&#39;})
config.read(&#39;example.cfg&#39;)

print config.get(&#39;Section1&#39;, &#39;foo&#39;) # -&gt; &quot;Python is fun!&quot;
config.remove_option(&#39;Section1&#39;, &#39;bar&#39;)
config.remove_option(&#39;Section1&#39;, &#39;baz&#39;)
print config.get(&#39;Section1&#39;, &#39;foo&#39;) # -&gt; &quot;Life is hard!&quot;
</pre></div>
</div>
The function <code class="docutils literal notranslate">opt_move</code> below can be used to move options between sections:
<div class="highlight-default notranslate"><div class="highlight"><pre>def opt_move(config, section1, section2, option):
 try:
 config.set(section2, option, config.get(section1, option, 1))
 except ConfigParser.NoSectionError:
 # Create non-existent section
 config.add_section(section2)
 opt_move(config, section1, section2, option)
 else:
 config.remove_option(section1, option)
</pre></div>
</div>
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."><code class="xref py py-mod docutils literal notranslate">ConfigParser</code></a>. The
allow_no_value parameter to the constructor can be used to indicate that such
values should be accepted:
<div class="highlight-pycon3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; import ConfigParser
&gt;&gt;&gt; import io

&gt;&gt;&gt; sample_config = &quot;&quot;&quot;
... [mysqld]
... user = mysql
... pid-file = /var/run/mysqld/mysqld.pid
... skip-external-locking
... old_passwords = 1
... skip-bdb
... skip-innodb
... &quot;&quot;&quot;
&gt;&gt;&gt; config = ConfigParser.RawConfigParser(allow_no_value=True)
&gt;&gt;&gt; config.readfp(io.BytesIO(sample_config))

&gt;&gt;&gt; # Settings with values are treated as before:
&gt;&gt;&gt; config.get(&quot;mysqld&quot;, &quot;user&quot;)
&#39;mysql&#39;

&gt;&gt;&gt; # Settings without values provide None:
&gt;&gt;&gt; config.get(&quot;mysqld&quot;, &quot;skip-bdb&quot;)

&gt;&gt;&gt; # Settings which aren&#39;t specified still raise an error:
&gt;&gt;&gt; config.get(&quot;mysqld&quot;, &quot;does-not-exist&quot;)
Traceback (most recent call last):
 ...
ConfigParser.NoOptionError: No option &#39;does-not-exist&#39; in section: &#39;mysqld&#39;
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">13.2. <code class="xref py py-mod docutils literal notranslate">ConfigParser</code> — 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>
 <a href="csv.html"
 title="previous chapter">13.1. <code class="xref py py-mod docutils literal notranslate">csv</code> — CSV File Reading and Writing</a>
 <h4>Next topic</h4>
 <a href="robotparser.html"
 title="next chapter">13.3. <code class="xref py py-mod docutils literal notranslate">robotparser</code> — Parser for robots.txt</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/configparser.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="fileformats.html" >13. File Formats</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">13.2. <code class="xref py py-mod docutils literal notranslate">ConfigParser</code> — Configuration file parser</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>