traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Re-format the module docstring and document the new get() argument.

This commit is contained in:
Barry Warsaw 1999-01-26 22:01:37 +00:00
parent ebe2a12de8
commit f09f6a5565
1 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
Lib/ConfigParser.py
View File

@ -24,34 +24,37 @@ ConfigParser -- responsible for for parsing a list of
methods: methods:
__init__(defaults=None) -- create the parser and specify a __init__(defaults=None)
dictionary of intrinsic defaults. The create the parser and specify a dictionary of intrinsic defaults. The
keys must be strings, the values must keys must be strings, the values must be appropriate for %()s string
be appropriate for %()s string interpolation. Note that `__name__' is always an intrinsic default;
interpolation. Note that `__name__' is it's value is the section's name.
always an intrinsic default; it's value
is the section's name.
sections() -- return all the configuration section names, sans DEFAULT sections()
return all the configuration section names, sans DEFAULT
options(section) -- return list of configuration options for the named options(section)
section return list of configuration options for the named section
read(*filenames) -- read and parse the list of named configuration files read(*filenames)
read and parse the list of named configuration files
get(section, option, raw=0) -- return a string value for the named get(section, option, raw=0, vars=None)
option. All % interpolations are return a string value for the named option. All % interpolations are
expanded in the return values, based on expanded in the return values, based on the defaults passed into the
the defaults passed into the constructor constructor and the DEFAULT section. Additional substitutions may be
and the DEFAULT section. provided using the `vars' argument, which must be a dictionary whose
contents override any pre-existing defaults.
getint(section, options) -- like get(), but convert value to an integer getint(section, options)
like get(), but convert value to an integer
getfloat(section, options) -- like get(), but convert value to a float getfloat(section, options)
like get(), but convert value to a float
getboolean(section, options) -- like get(), but convert value to getboolean(section, options)
a boolean (currently defined as 0 like get(), but convert value to a boolean (currently defined as 0 or
or 1, only) 1, only)
""" """
import sys import sys
@ -176,11 +179,11 @@ class ConfigParser:
def get(self, section, option, raw=0, vars=None): def get(self, section, option, raw=0, vars=None):
"""Get an option value for a given section. """Get an option value for a given section.
All % interpolations are expanded in the return values, based All % interpolations are expanded in the return values, based on the
on the defaults passed into the constructor, unless the optional defaults passed into the constructor, unless the optional argument
argument `raw' is true. Additional substitutions may be provided `raw' is true. Additional substitutions may be provided using the
using the vars keyword argument, which override any pre-existing `vars' argument, which must be a dictionary whose contents overrides
defaults. any pre-existing defaults.
The section DEFAULT is special. The section DEFAULT is special.
""" """