Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	editdlrm
abc.rst.txt	7219	0644	editdlrm
aepack.rst.txt	4257	0644	editdlrm
aetools.rst.txt	3532	0644	editdlrm
aetypes.rst.txt	4257	0644	editdlrm
aifc.rst.txt	7086	0644	editdlrm
al.rst.txt	5309	0644	editdlrm
allos.rst.txt	695	0644	editdlrm
anydbm.rst.txt	4111	0644	editdlrm
archiving.rst.txt	424	0644	editdlrm
argparse.rst.txt	74685	0644	editdlrm
array.rst.txt	10524	0644	editdlrm
ast.rst.txt	10111	0644	editdlrm
asynchat.rst.txt	9206	0644	editdlrm
asyncore.rst.txt	12937	0644	editdlrm
atexit.rst.txt	3910	0644	editdlrm
audioop.rst.txt	10395	0644	editdlrm
autogil.rst.txt	1015	0644	editdlrm
base64.rst.txt	6252	0644	editdlrm
basehttpserver.rst.txt	10404	0644	editdlrm
bastion.rst.txt	2611	0644	editdlrm
bdb.rst.txt	12456	0644	editdlrm
binascii.rst.txt	6508	0644	editdlrm
binhex.rst.txt	1910	0644	editdlrm
bisect.rst.txt	5415	0644	editdlrm
bsddb.rst.txt	7575	0644	editdlrm
bz2.rst.txt	8064	0644	editdlrm
calendar.rst.txt	11282	0644	editdlrm
carbon.rst.txt	15956	0644	editdlrm
cd.rst.txt	11974	0644	editdlrm
cgi.rst.txt	22853	0644	editdlrm
cgihttpserver.rst.txt	2788	0644	editdlrm
cgitb.rst.txt	2874	0644	editdlrm
chunk.rst.txt	4955	0644	editdlrm
cmath.rst.txt	7647	0644	editdlrm
cmd.rst.txt	8565	0644	editdlrm
code.rst.txt	7115	0644	editdlrm
codecs.rst.txt	66966	0644	editdlrm
codeop.rst.txt	3774	0644	editdlrm
collections.rst.txt	41448	0644	editdlrm
colorpicker.rst.txt	913	0644	editdlrm
colorsys.rst.txt	1819	0644	editdlrm
commands.rst.txt	2595	0644	editdlrm
compileall.rst.txt	4678	0644	editdlrm
compiler.rst.txt	37464	0644	editdlrm
configparser.rst.txt	19607	0644	editdlrm
constants.rst.txt	2328	0644	editdlrm
contextlib.rst.txt	6012	0644	editdlrm
cookie.rst.txt	9543	0644	editdlrm
cookielib.rst.txt	27875	0644	editdlrm
copy.rst.txt	3351	0644	editdlrm
copy_reg.rst.txt	2329	0644	editdlrm
crypt.rst.txt	2292	0644	editdlrm
crypto.rst.txt	355	0644	editdlrm
csv.rst.txt	22757	0644	editdlrm
ctypes.rst.txt	90513	0644	editdlrm
curses.ascii.rst.txt	9046	0644	editdlrm
curses.panel.rst.txt	2740	0644	editdlrm
curses.rst.txt	74877	0644	editdlrm
custominterp.rst.txt	570	0644	editdlrm
datatypes.rst.txt	864	0644	editdlrm
datetime.rst.txt	74679	0644	editdlrm
dbhash.rst.txt	3865	0644	editdlrm
dbm.rst.txt	3117	0644	editdlrm
debug.rst.txt	446	0644	editdlrm
decimal.rst.txt	70926	0644	editdlrm
development.rst.txt	640	0644	editdlrm
difflib.rst.txt	30716	0644	editdlrm
dircache.rst.txt	1813	0644	editdlrm
dis.rst.txt	23248	0644	editdlrm
distribution.rst.txt	426	0644	editdlrm
distutils.rst.txt	1958	0644	editdlrm
dl.rst.txt	3392	0644	editdlrm
doctest.rst.txt	73985	0644	editdlrm
docxmlrpcserver.rst.txt	3802	0644	editdlrm
dumbdbm.rst.txt	2841	0644	editdlrm
dummy_thread.rst.txt	1058	0644	editdlrm
dummy_threading.rst.txt	799	0644	editdlrm
easydialogs.rst.txt	10346	0644	editdlrm
email-examples.rst.txt	1271	0644	editdlrm
email.charset.rst.txt	9654	0644	editdlrm
email.encoders.rst.txt	2376	0644	editdlrm
email.errors.rst.txt	4006	0644	editdlrm
email.generator.rst.txt	6132	0644	editdlrm
email.header.rst.txt	7531	0644	editdlrm
email.iterators.rst.txt	2421	0644	editdlrm
email.message.rst.txt	25217	0644	editdlrm
email.mime.rst.txt	9917	0644	editdlrm
email.parser.rst.txt	10327	0644	editdlrm
email.rst.txt	16111	0644	editdlrm
email.utils.rst.txt	6475	0644	editdlrm
ensurepip.rst.txt	5022	0644	editdlrm
errno.rst.txt	6708	0644	editdlrm
exceptions.rst.txt	18343	0644	editdlrm
fcntl.rst.txt	7361	0644	editdlrm
filecmp.rst.txt	5348	0644	editdlrm
fileformats.rst.txt	302	0644	editdlrm
fileinput.rst.txt	7417	0644	editdlrm
filesys.rst.txt	806	0644	editdlrm
fl.rst.txt	17646	0644	editdlrm
fm.rst.txt	2699	0644	editdlrm
fnmatch.rst.txt	3104	0644	editdlrm
formatter.rst.txt	13245	0644	editdlrm
fpectl.rst.txt	4171	0644	editdlrm
fpformat.rst.txt	1747	0644	editdlrm
fractions.rst.txt	5297	0644	editdlrm
framework.rst.txt	11444	0644	editdlrm
frameworks.rst.txt	378	0644	editdlrm
ftplib.rst.txt	15720	0644	editdlrm
functions.rst.txt	75554	0644	editdlrm
functools.rst.txt	7448	0644	editdlrm
future_builtins.rst.txt	2010	0644	editdlrm
gc.rst.txt	9014	0644	editdlrm
gdbm.rst.txt	4882	0644	editdlrm
gensuitemodule.rst.txt	3113	0644	editdlrm
getopt.rst.txt	6670	0644	editdlrm
getpass.rst.txt	1876	0644	editdlrm
gettext.rst.txt	29040	0644	editdlrm
gl.rst.txt	6009	0644	editdlrm
glob.rst.txt	2414	0644	editdlrm
grp.rst.txt	2256	0644	editdlrm
gzip.rst.txt	4828	0644	editdlrm
hashlib.rst.txt	7379	0644	editdlrm
heapq.rst.txt	13185	0644	editdlrm
hmac.rst.txt	3073	0644	editdlrm
hotshot.rst.txt	4289	0644	editdlrm
htmllib.rst.txt	7379	0644	editdlrm
htmlparser.rst.txt	11640	0644	editdlrm
httplib.rst.txt	37454	0644	editdlrm
i18n.rst.txt	409	0644	editdlrm
ic.rst.txt	5005	0644	editdlrm
idle.rst.txt	22182	0644	editdlrm
imageop.rst.txt	4001	0644	editdlrm
imaplib.rst.txt	17221	0644	editdlrm
imgfile.rst.txt	2765	0644	editdlrm
imghdr.rst.txt	2635	0644	editdlrm
imp.rst.txt	12593	0644	editdlrm
importlib.rst.txt	1126	0644	editdlrm
imputil.rst.txt	7023	0644	editdlrm
index.rst.txt	2287	0644	editdlrm
inspect.rst.txt	28151	0644	editdlrm
internet.rst.txt	950	0644	editdlrm
intro.rst.txt	2803	0644	editdlrm
io.rst.txt	39015	0644	editdlrm
ipc.rst.txt	630	0644	editdlrm
itertools.rst.txt	36324	0644	editdlrm
jpeg.rst.txt	3858	0644	editdlrm
json.rst.txt	25545	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	523	0644	editdlrm
linecache.rst.txt	1887	0644	editdlrm
locale.rst.txt	24975	0644	editdlrm
logging.config.rst.txt	31560	0644	editdlrm
logging.handlers.rst.txt	28153	0644	editdlrm
logging.rst.txt	46882	0644	editdlrm
mac.rst.txt	791	0644	editdlrm
macos.rst.txt	3824	0644	editdlrm
macosa.rst.txt	3964	0644	editdlrm
macostools.rst.txt	4017	0644	editdlrm
macpath.rst.txt	650	0644	editdlrm
mailbox.rst.txt	68129	0644	editdlrm
mailcap.rst.txt	3675	0644	editdlrm
markup.rst.txt	1249	0644	editdlrm
marshal.rst.txt	5689	0644	editdlrm
math.rst.txt	10920	0644	editdlrm
md5.rst.txt	2815	0644	editdlrm
mhlib.rst.txt	3966	0644	editdlrm
mimetools.rst.txt	4504	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
mimewriter.rst.txt	3360	0644	editdlrm
mimify.rst.txt	3519	0644	editdlrm
miniaeframe.rst.txt	2564	0644	editdlrm
misc.rst.txt	248	0644	editdlrm
mm.rst.txt	447	0644	editdlrm
mmap.rst.txt	10481	0644	editdlrm
modulefinder.rst.txt	3380	0644	editdlrm
modules.rst.txt	382	0644	editdlrm
msilib.rst.txt	19062	0644	editdlrm
msvcrt.rst.txt	4346	0644	editdlrm
multifile.rst.txt	6613	0644	editdlrm
multiprocessing.rst.txt	92621	0644	editdlrm
mutex.rst.txt	1939	0644	editdlrm
netdata.rst.txt	432	0644	editdlrm
netrc.rst.txt	3119	0644	editdlrm
new.rst.txt	2653	0644	editdlrm
nis.rst.txt	2108	0644	editdlrm
nntplib.rst.txt	14531	0644	editdlrm
numbers.rst.txt	8007	0644	editdlrm
numeric.rst.txt	751	0644	editdlrm
operator.rst.txt	22092	0644	editdlrm
optparse.rst.txt	77101	0644	editdlrm
os.path.rst.txt	13094	0644	editdlrm
os.rst.txt	82580	0644	editdlrm
ossaudiodev.rst.txt	17309	0644	editdlrm
othergui.rst.txt	2721	0644	editdlrm
parser.rst.txt	15385	0644	editdlrm
pdb.rst.txt	16043	0644	editdlrm
persistence.rst.txt	826	0644	editdlrm
pickle.rst.txt	37262	0644	editdlrm
pickletools.rst.txt	1997	0644	editdlrm
pipes.rst.txt	3786	0644	editdlrm
pkgutil.rst.txt	7714	0644	editdlrm
platform.rst.txt	9554	0644	editdlrm
plistlib.rst.txt	4134	0644	editdlrm
popen2.rst.txt	7022	0644	editdlrm
poplib.rst.txt	6220	0644	editdlrm
posix.rst.txt	3630	0644	editdlrm
posixfile.rst.txt	7200	0644	editdlrm
pprint.rst.txt	9071	0644	editdlrm
profile.rst.txt	28666	0644	editdlrm
pty.rst.txt	1762	0644	editdlrm
pwd.rst.txt	2725	0644	editdlrm
pyclbr.rst.txt	3296	0644	editdlrm
pydoc.rst.txt	4083	0644	editdlrm
pyexpat.rst.txt	28891	0644	editdlrm
python.rst.txt	514	0644	editdlrm
py_compile.rst.txt	2479	0644	editdlrm
queue.rst.txt	7034	0644	editdlrm
quopri.rst.txt	2670	0644	editdlrm
random.rst.txt	13319	0644	editdlrm
re.rst.txt	55102	0644	editdlrm
readline.rst.txt	10513	0644	editdlrm
repr.rst.txt	4718	0644	editdlrm
resource.rst.txt	9595	0644	editdlrm
restricted.rst.txt	3327	0644	editdlrm
rexec.rst.txt	11742	0644	editdlrm
rfc822.rst.txt	14037	0644	editdlrm
rlcompleter.rst.txt	2494	0644	editdlrm
robotparser.rst.txt	2190	0644	editdlrm
runpy.rst.txt	6938	0644	editdlrm
sched.rst.txt	4644	0644	editdlrm
scrolledtext.rst.txt	1379	0644	editdlrm
select.rst.txt	20705	0644	editdlrm
sets.rst.txt	14973	0644	editdlrm
sgi.rst.txt	322	0644	editdlrm
sgmllib.rst.txt	10664	0644	editdlrm
sha.rst.txt	2807	0644	editdlrm
shelve.rst.txt	8319	0644	editdlrm
shlex.rst.txt	11313	0644	editdlrm
shutil.rst.txt	13491	0644	editdlrm
signal.rst.txt	10719	0644	editdlrm
simplehttpserver.rst.txt	4559	0644	editdlrm
simplexmlrpcserver.rst.txt	10881	0644	editdlrm
site.rst.txt	7880	0644	editdlrm
smtpd.rst.txt	2464	0644	editdlrm
smtplib.rst.txt	14906	0644	editdlrm
sndhdr.rst.txt	1759	0644	editdlrm
socket.rst.txt	40765	0644	editdlrm
socketserver.rst.txt	22512	0644	editdlrm
someos.rst.txt	599	0644	editdlrm
spwd.rst.txt	2825	0644	editdlrm
sqlite3.rst.txt	35448	0644	editdlrm
ssl.rst.txt	76554	0644	editdlrm
stat.rst.txt	7778	0644	editdlrm
statvfs.rst.txt	1300	0644	editdlrm
stdtypes.rst.txt	122668	0644	editdlrm
string.rst.txt	44085	0644	editdlrm
stringio.rst.txt	4166	0644	editdlrm
stringprep.rst.txt	4238	0644	editdlrm
strings.rst.txt	746	0644	editdlrm
struct.rst.txt	17100	0644	editdlrm
subprocess.rst.txt	33648	0644	editdlrm
sun.rst.txt	249	0644	editdlrm
sunau.rst.txt	7124	0644	editdlrm
sunaudio.rst.txt	5849	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	5064	0644	editdlrm
sys.rst.txt	47520	0644	editdlrm
sysconfig.rst.txt	7639	0644	editdlrm
syslog.rst.txt	3931	0644	editdlrm
tabnanny.rst.txt	1999	0644	editdlrm
tarfile.rst.txt	28214	0644	editdlrm
telnetlib.rst.txt	7482	0644	editdlrm
tempfile.rst.txt	10504	0644	editdlrm
termios.rst.txt	3733	0644	editdlrm
test.rst.txt	17659	0644	editdlrm
textwrap.rst.txt	8552	0644	editdlrm
thread.rst.txt	6588	0644	editdlrm
threading.rst.txt	32468	0644	editdlrm
time.rst.txt	26020	0644	editdlrm
timeit.rst.txt	11598	0644	editdlrm
tix.rst.txt	22693	0644	editdlrm
tk.rst.txt	1612	0644	editdlrm
tkinter.rst.txt	33456	0644	editdlrm
token.rst.txt	2451	0644	editdlrm
tokenize.rst.txt	5570	0644	editdlrm
trace.rst.txt	6724	0644	editdlrm
traceback.rst.txt	10711	0644	editdlrm
ttk.rst.txt	57411	0644	editdlrm
tty.rst.txt	1011	0644	editdlrm
turtle.rst.txt	64097	0644	editdlrm
types.rst.txt	6200	0644	editdlrm
undoc.rst.txt	6550	0644	editdlrm
unicodedata.rst.txt	5736	0644	editdlrm
unittest.rst.txt	82952	0644	editdlrm
unix.rst.txt	490	0644	editdlrm
urllib.rst.txt	24960	0644	editdlrm
urllib2.rst.txt	35211	0644	editdlrm
urlparse.rst.txt	16071	0644	editdlrm
user.rst.txt	2748	0644	editdlrm
userdict.rst.txt	9290	0644	editdlrm
uu.rst.txt	2369	0644	editdlrm
uuid.rst.txt	8378	0644	editdlrm
warnings.rst.txt	19815	0644	editdlrm
wave.rst.txt	5047	0644	editdlrm
weakref.rst.txt	12926	0644	editdlrm
webbrowser.rst.txt	9863	0644	editdlrm
whichdb.rst.txt	931	0644	editdlrm
windows.rst.txt	273	0644	editdlrm
winsound.rst.txt	5066	0644	editdlrm
wsgiref.rst.txt	30567	0644	editdlrm
xdrlib.rst.txt	8077	0644	editdlrm
xml.dom.minidom.rst.txt	11208	0644	editdlrm
xml.dom.pulldom.rst.txt	1571	0644	editdlrm
xml.dom.rst.txt	40182	0644	editdlrm
xml.etree.elementtree.rst.txt	35707	0644	editdlrm
xml.rst.txt	6090	0644	editdlrm
xml.sax.handler.rst.txt	15371	0644	editdlrm
xml.sax.reader.rst.txt	12257	0644	editdlrm
xml.sax.rst.txt	6460	0644	editdlrm
xml.sax.utils.rst.txt	3560	0644	editdlrm
xmlrpclib.rst.txt	22559	0644	editdlrm
zipfile.rst.txt	18871	0644	editdlrm
zipimport.rst.txt	5957	0644	editdlrm
zlib.rst.txt	12766	0644	editdlrm
_winreg.rst.txt	23305	0644	editdlrm
__builtin__.rst.txt	1494	0644	editdlrm
__future__.rst.txt	4952	0644	editdlrm
__main__.rst.txt	535	0644	editdlrm

:mod:`ConfigParser` --- Configuration file parser ================================================= .. module:: ConfigParser :synopsis: Configuration file parser. .. moduleauthor:: Ken Manheimer .. moduleauthor:: Barry Warsaw .. moduleauthor:: Eric S. Raymond .. sectionauthor:: Christopher G. Petrilli .. note:: The :mod:`ConfigParser` module has been renamed to :mod:`configparser` in Python 3. The :term:`2to3` tool will automatically adapt imports when converting your sources to Python 3. .. index:: pair: .ini; file pair: configuration; file single: ini file single: Windows ini file This module defines the class :class:`~ConfigParser.ConfigParser`. The :class:`~ConfigParser.ConfigParser` 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. .. note:: This library does *not* interpret or write the value-type prefixes used in the Windows Registry extended version of INI syntax. .. seealso:: Module :mod:`shlex` Support for creating Unix shell-like mini-languages which can be used as an alternate format for application configuration files. Module :mod:`json` The json module implements a subset of JavaScript syntax which can also be used for this purpose. The configuration file consists of sections, led by a ``[section]`` header and followed by ``name: value`` entries, with continuations in the style of :rfc:`822` (see section 3.1.1, "LONG HEADER FIELDS"); ``name=value`` 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 ``DEFAULT`` section. Additional defaults can be provided on initialization and retrieval. Lines beginning with ``'#'`` or ``';'`` are ignored and may be used to provide comments. Configuration files may include comments, prefixed by specific characters (``#`` and ``;``). 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 ``;`` starts an inline comment, while ``#`` does not.) On top of the core functionality, :class:`SafeConfigParser` supports interpolation. This means values can contain format strings which refer to other values in the same section, or values in a special ``DEFAULT`` section. Additional defaults can be provided on initialization. For example:: [My Section] foodir: %(dir)s/whatever dir=frob long: this value continues in the next line would resolve the ``%(dir)s`` to the value of ``dir`` (``frob`` in this case). All reference expansions are done on demand. Default values can be specified by passing them into the :class:`~ConfigParser.ConfigParser` constructor as a dictionary. Additional defaults may be passed into the :meth:`get` method which will override all others. Sections are normally stored in a built-in dictionary. An alternative dictionary type can be passed to the :class:`~ConfigParser.ConfigParser` 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. .. class:: RawConfigParser([defaults[, dict_type[, allow_no_value]]]) 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: ``False``), options without values are accepted; the value presented for these is ``None``. This class does not support the magical interpolation behavior. All option names are passed through the :meth:`optionxform` method. Its default implementation converts option names to lower case. .. versionadded:: 2.3 .. versionchanged:: 2.6 *dict_type* was added. .. versionchanged:: 2.7 The default *dict_type* is :class:`collections.OrderedDict`. *allow_no_value* was added. .. class:: ConfigParser([defaults[, dict_type[, allow_no_value]]]) Derived class of :class:`RawConfigParser` that implements the magical interpolation feature and adds optional arguments to the :meth:`get` and :meth:`items` methods. The values in *defaults* must be appropriate for the ``%()s`` 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 :meth:`optionxform` method just like any other option name reference. Using the default implementation of :meth:`optionxform`, the values ``foo %(bar)s`` and ``foo %(BAR)s`` are equivalent. .. versionadded:: 2.3 .. versionchanged:: 2.6 *dict_type* was added. .. versionchanged:: 2.7 The default *dict_type* is :class:`collections.OrderedDict`. *allow_no_value* was added. .. class:: SafeConfigParser([defaults[, dict_type[, allow_no_value]]]) Derived class of :class:`~ConfigParser.ConfigParser` 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. .. XXX Need to explain what's safer/more predictable about it. .. versionadded:: 2.3 .. versionchanged:: 2.6 *dict_type* was added. .. versionchanged:: 2.7 The default *dict_type* is :class:`collections.OrderedDict`. *allow_no_value* was added. .. exception:: Error Base class for all other configparser exceptions. .. exception:: NoSectionError Exception raised when a specified section is not found. .. exception:: DuplicateSectionError Exception raised if :meth:`add_section` is called with the name of a section that is already present. .. exception:: NoOptionError Exception raised when a specified option is not found in the specified section. .. exception:: InterpolationError Base class for exceptions raised when problems occur performing string interpolation. .. exception:: InterpolationDepthError Exception raised when string interpolation cannot be completed because the number of iterations exceeds :const:`MAX_INTERPOLATION_DEPTH`. Subclass of :exc:`InterpolationError`. .. exception:: InterpolationMissingOptionError Exception raised when an option referenced from a value does not exist. Subclass of :exc:`InterpolationError`. .. versionadded:: 2.3 .. exception:: InterpolationSyntaxError Exception raised when the source text into which substitutions are made does not conform to the required syntax. Subclass of :exc:`InterpolationError`. .. versionadded:: 2.3 .. exception:: MissingSectionHeaderError Exception raised when attempting to parse a file which has no section headers. .. exception:: ParsingError Exception raised when errors occur attempting to parse a file. .. data:: MAX_INTERPOLATION_DEPTH The maximum depth for recursive interpolation for :meth:`get` when the *raw* parameter is false. This is relevant only for the :class:`~ConfigParser.ConfigParser` class. .. seealso:: Module :mod:`shlex` Support for a creating Unix shell-like mini-languages which can be used as an alternate format for application configuration files. .. _rawconfigparser-objects: RawConfigParser Objects ----------------------- :class:`RawConfigParser` instances have the following methods: .. method:: RawConfigParser.defaults() Return a dictionary containing the instance-wide defaults. .. method:: RawConfigParser.sections() Return a list of the sections available; ``DEFAULT`` is not included in the list. .. method:: RawConfigParser.add_section(section) Add a section named *section* to the instance. If a section by the given name already exists, :exc:`DuplicateSectionError` is raised. If the name ``DEFAULT`` (or any of it's case-insensitive variants) is passed, :exc:`ValueError` is raised. .. method:: RawConfigParser.has_section(section) Indicates whether the named section is present in the configuration. The ``DEFAULT`` section is not acknowledged. .. method:: RawConfigParser.options(section) Returns a list of options available in the specified *section*. .. method:: RawConfigParser.has_option(section, option) If the given section exists, and contains the given option, return :const:`True`; otherwise return :const:`False`. .. versionadded:: 1.6 .. method:: RawConfigParser.read(filenames) 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 :class:`~ConfigParser.ConfigParser` 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 :meth:`readfp` before calling :meth:`read` for any optional files:: import ConfigParser, os config = ConfigParser.ConfigParser() config.readfp(open('defaults.cfg')) config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')]) .. versionchanged:: 2.4 Returns list of successfully parsed filenames. .. method:: RawConfigParser.readfp(fp[, filename]) Read and parse configuration data from the file or file-like object in *fp* (only the :meth:`readline` method is used). If *filename* is omitted and *fp* has a :attr:`name` attribute, that is used for *filename*; the default is ````. .. method:: RawConfigParser.get(section, option) Get an *option* value for the named *section*. .. method:: RawConfigParser.getint(section, option) A convenience method which coerces the *option* in the specified *section* to an integer. .. method:: RawConfigParser.getfloat(section, option) A convenience method which coerces the *option* in the specified *section* to a floating point number. .. method:: RawConfigParser.getboolean(section, option) A convenience method which coerces the *option* in the specified *section* to a Boolean value. Note that the accepted values for the option are ``"1"``, ``"yes"``, ``"true"``, and ``"on"``, which cause this method to return ``True``, and ``"0"``, ``"no"``, ``"false"``, and ``"off"``, which cause it to return ``False``. These string values are checked in a case-insensitive manner. Any other value will cause it to raise :exc:`ValueError`. .. method:: RawConfigParser.items(section) Return a list of ``(name, value)`` pairs for each option in the given *section*. .. method:: RawConfigParser.set(section, option, value) If the given section exists, set the given option to the specified value; otherwise raise :exc:`NoSectionError`. While it is possible to use :class:`RawConfigParser` (or :class:`~ConfigParser.ConfigParser` 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. .. versionadded:: 1.6 .. method:: RawConfigParser.write(fileobject) Write a representation of the configuration to the specified file object. This representation can be parsed by a future :meth:`read` call. .. versionadded:: 1.6 .. method:: RawConfigParser.remove_option(section, option) Remove the specified *option* from the specified *section*. If the section does not exist, raise :exc:`NoSectionError`. If the option existed to be removed, return :const:`True`; otherwise return :const:`False`. .. versionadded:: 1.6 .. method:: RawConfigParser.remove_section(section) Remove the specified *section* from the configuration. If the section in fact existed, return ``True``. Otherwise return ``False``. .. method:: RawConfigParser.optionxform(option) 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 ``str``, for example, would make option names case sensitive:: cfgparser = ConfigParser() ... cfgparser.optionxform = str Note that when reading configuration files, whitespace around the option names are stripped before :meth:`optionxform` is called. .. _configparser-objects: ConfigParser Objects -------------------- The :class:`~ConfigParser.ConfigParser` class extends some methods of the :class:`RawConfigParser` interface, adding some optional arguments. .. method:: ConfigParser.get(section, option[, raw[, vars]]) 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 ``'%'`` 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. .. method:: ConfigParser.items(section[, raw[, vars]]) Return a list of ``(name, value)`` pairs for each option in the given *section*. Optional arguments have the same meaning as for the :meth:`get` method. .. versionadded:: 2.3 .. _safeconfigparser-objects: SafeConfigParser Objects ------------------------ The :class:`SafeConfigParser` class implements the same extended interface as :class:`~ConfigParser.ConfigParser`, with the following addition: .. method:: SafeConfigParser.set(section, option, value) If the given section exists, set the given option to the specified value; otherwise raise :exc:`NoSectionError`. *value* must be a string (:class:`str` or :class:`unicode`); if not, :exc:`TypeError` is raised. .. versionadded:: 2.4 Examples -------- An example of writing to a configuration file:: 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's and the raw # mode of ConfigParser'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('Section1') config.set('Section1', 'an_int', '15') config.set('Section1', 'a_bool', 'true') config.set('Section1', 'a_float', '3.1415') config.set('Section1', 'baz', 'fun') config.set('Section1', 'bar', 'Python') config.set('Section1', 'foo', '%(bar)s is %(baz)s!') # Writing our configuration file to 'example.cfg' with open('example.cfg', 'wb') as configfile: config.write(configfile) An example of reading the configuration file again:: import ConfigParser config = ConfigParser.RawConfigParser() config.read('example.cfg') # 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('Section1', 'a_float') an_int = config.getint('Section1', 'an_int') print a_float + an_int # Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'. # This is because we are using a RawConfigParser(). if config.getboolean('Section1', 'a_bool'): print config.get('Section1', 'foo') To get interpolation, you will need to use a :class:`~ConfigParser.ConfigParser` or :class:`SafeConfigParser`:: import ConfigParser config = ConfigParser.ConfigParser() config.read('example.cfg') # Set the third, optional argument of get to 1 if you wish to use raw mode. print config.get('Section1', 'foo', 0) # -> "Python is fun!" print config.get('Section1', 'foo', 1) # -> "%(bar)s is %(baz)s!" # The optional fourth argument is a dict with members that will take # precedence in interpolation. print config.get('Section1', 'foo', 0, {'bar': 'Documentation', 'baz': 'evil'}) Defaults are available in all three types of ConfigParsers. They are used in interpolation if an option used is not defined elsewhere. :: import ConfigParser # New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each config = ConfigParser.SafeConfigParser({'bar': 'Life', 'baz': 'hard'}) config.read('example.cfg') print config.get('Section1', 'foo') # -> "Python is fun!" config.remove_option('Section1', 'bar') config.remove_option('Section1', 'baz') print config.get('Section1', 'foo') # -> "Life is hard!" The function ``opt_move`` below can be used to move options between sections:: 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) Some configuration files are known to include settings without values, but which otherwise conform to the syntax supported by :mod:`ConfigParser`. The *allow_no_value* parameter to the constructor can be used to indicate that such values should be accepted: .. doctest:: >>> import ConfigParser >>> import io >>> sample_config = """ ... [mysqld] ... user = mysql ... pid-file = /var/run/mysqld/mysqld.pid ... skip-external-locking ... old_passwords = 1 ... skip-bdb ... skip-innodb ... """ >>> config = ConfigParser.RawConfigParser(allow_no_value=True) >>> config.readfp(io.BytesIO(sample_config)) >>> # Settings with values are treated as before: >>> config.get("mysqld", "user") 'mysql' >>> # Settings without values provide None: >>> config.get("mysqld", "skip-bdb") >>> # Settings which aren't specified still raise an error: >>> config.get("mysqld", "does-not-exist") Traceback (most recent call last): ... ConfigParser.NoOptionError: No option 'does-not-exist' in section: 'mysqld'