Commit dbdbaaad authored by Fred Drake's avatar Fred Drake

Several new index entries to make find this easier.

Noted that name=value is allowed in addition to name: value.
parent 9fec7fee
...@@ -5,20 +5,22 @@ ...@@ -5,20 +5,22 @@
\modulesynopsis{Configuration file parser.} \modulesynopsis{Configuration file parser.}
\sectionauthor{Christopher G. Petrilli}{petrilli@amber.org} \sectionauthor{Christopher G. Petrilli}{petrilli@amber.org}
This module defines the class \class{ConfigParser}. The This module defines the class \class{ConfigParser}.
\class{ConfigParser} class implements a basic configuration file \indexii{.ini}{file}\indexii{configuration}{file}\index{ini file}
\index{Windows ini file}
The \class{ConfigParser} class implements a basic configuration file
parser language which provides a structure similar to what you would parser language which provides a structure similar to what you would
find on Microsoft Windows INI files. You can use this to write Python find on Microsoft Windows INI files. You can use this to write Python
programs which can be customized by end users easily. programs which can be customized by end users easily.
The configuration file consists of sections, lead by a The configuration file consists of sections, lead by a
\samp{[section]} header and followed by \samp{name: value} entries, \samp{[section]} header and followed by \samp{name: value} entries,
with continuations in the style of \rfc{822}. The optional values with continuations in the style of \rfc{822}; \samp{name=value} is
can contain format strings which refer to other values in the same also accepted. The optional values can contain format strings which
section, or values in a special \code{DEFAULT} section. Additional refer to other values in the same section, or values in a special
defaults can be provided upon initialization and retrieval. Lines \code{DEFAULT} section. Additional defaults can be provided upon
beginning with \character{\#} are ignored and may be used to provide initialization and retrieval. Lines beginning with \character{\#} are
comments. ignored and may be used to provide comments.
For example: For example:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment