mirror of
https://github.com/python/cpython.git
synced 2025-11-03 11:23:31 +00:00
Renamed ConfigParser to configparser.
Merged revisions 63247-63248 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r63247 | georg.brandl | 2008-05-14 18:30:31 -0400 (Wed, 14 May 2008) | 2 lines Update configparser docs for lowercasing rename. ........ r63248 | alexandre.vassalotti | 2008-05-14 18:44:22 -0400 (Wed, 14 May 2008) | 8 lines Updated import statements to use the new `configparser` module name. Updated the documentation to use the new name. Revert addition of the stub entry for the old name. Georg, I am reverting your changes since this commit should propagate to py3k. ........
This commit is contained in:
parent
84726faf41
commit
1d1eaa45c9
11 changed files with 61 additions and 58 deletions
|
|
@ -1,15 +1,14 @@
|
|||
|
||||
:mod:`ConfigParser` --- Configuration file parser
|
||||
:mod:`configparser` --- Configuration file parser
|
||||
=================================================
|
||||
|
||||
.. module:: ConfigParser
|
||||
.. module:: configparser
|
||||
:synopsis: Configuration file parser.
|
||||
|
||||
.. moduleauthor:: Ken Manheimer <klm@zope.com>
|
||||
.. moduleauthor:: Barry Warsaw <bwarsaw@python.org>
|
||||
.. moduleauthor:: Eric S. Raymond <esr@thyrsus.com>
|
||||
.. sectionauthor:: Christopher G. Petrilli <petrilli@amber.org>
|
||||
|
||||
|
||||
.. index::
|
||||
pair: .ini; file
|
||||
pair: configuration; file
|
||||
|
|
@ -213,9 +212,9 @@ RawConfigParser Objects
|
|||
load the required file or files using :meth:`readfp` before calling :meth:`read`
|
||||
for any optional files::
|
||||
|
||||
import ConfigParser, os
|
||||
import configparser, os
|
||||
|
||||
config = ConfigParser.ConfigParser()
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(open('defaults.cfg'))
|
||||
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')])
|
||||
|
||||
|
|
@ -342,9 +341,9 @@ Examples
|
|||
|
||||
An example of writing to a configuration file::
|
||||
|
||||
import ConfigParser
|
||||
import configparser
|
||||
|
||||
config = ConfigParser.RawConfigParser()
|
||||
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.
|
||||
|
|
@ -367,9 +366,9 @@ An example of writing to a configuration file::
|
|||
|
||||
An example of reading the configuration file again::
|
||||
|
||||
import ConfigParser
|
||||
import configparser
|
||||
|
||||
config = ConfigParser.RawConfigParser()
|
||||
config = configparser.RawConfigParser()
|
||||
config.read('example.cfg')
|
||||
|
||||
# getfloat() raises an exception if the value is not a float
|
||||
|
|
@ -386,9 +385,9 @@ An example of reading the configuration file again::
|
|||
To get interpolation, you will need to use a :class:`ConfigParser` or
|
||||
:class:`SafeConfigParser`::
|
||||
|
||||
import ConfigParser
|
||||
import configparser
|
||||
|
||||
config = ConfigParser.ConfigParser()
|
||||
config = configparser.ConfigParser()
|
||||
config.read('example.cfg')
|
||||
|
||||
# Set the third, optional argument of get to 1 if you wish to use raw mode.
|
||||
|
|
@ -403,10 +402,10 @@ To get interpolation, you will need to use a :class:`ConfigParser` or
|
|||
Defaults are available in all three types of ConfigParsers. They are used in
|
||||
interpolation if an option used is not defined elsewhere. ::
|
||||
|
||||
import ConfigParser
|
||||
import configparser
|
||||
|
||||
# New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
|
||||
config = ConfigParser.SafeConfigParser({'bar': 'Life', 'baz': 'hard'})
|
||||
config = configparser.SafeConfigParser({'bar': 'Life', 'baz': 'hard'})
|
||||
config.read('example.cfg')
|
||||
|
||||
print(config.get('Section1', 'foo')) # -> "Python is fun!"
|
||||
|
|
@ -419,7 +418,7 @@ 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:
|
||||
except configparser.NoSectionError:
|
||||
# Create non-existent section
|
||||
config.add_section(section2)
|
||||
opt_move(config, section1, section2, option)
|
||||
|
|
|
|||
|
|
@ -2202,12 +2202,12 @@ in :mod:`logging` itself) and defining handlers which are declared either in
|
|||
|
||||
.. function:: fileConfig(fname[, defaults])
|
||||
|
||||
Reads the logging configuration from a ConfigParser-format file named *fname*.
|
||||
This function can be called several times from an application, allowing an end
|
||||
user the ability to select from various pre-canned configurations (if the
|
||||
developer provides a mechanism to present the choices and load the chosen
|
||||
configuration). Defaults to be passed to ConfigParser can be specified in the
|
||||
*defaults* argument.
|
||||
Reads the logging configuration from a :mod:`configparser`\-format file named
|
||||
*fname*. This function can be called several times from an application,
|
||||
allowing an end user the ability to select from various pre-canned
|
||||
configurations (if the developer provides a mechanism to present the choices
|
||||
and load the chosen configuration). Defaults to be passed to the ConfigParser
|
||||
can be specified in the *defaults* argument.
|
||||
|
||||
|
||||
.. function:: listen([port])
|
||||
|
|
@ -2237,18 +2237,20 @@ in :mod:`logging` itself) and defining handlers which are declared either in
|
|||
Configuration file format
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The configuration file format understood by :func:`fileConfig` is based on
|
||||
ConfigParser functionality. The file must contain sections called ``[loggers]``,
|
||||
``[handlers]`` and ``[formatters]`` which identify by name the entities of each
|
||||
type which are defined in the file. For each such entity, there is a separate
|
||||
section which identified how that entity is configured. Thus, for a logger named
|
||||
``log01`` in the ``[loggers]`` section, the relevant configuration details are
|
||||
held in a section ``[logger_log01]``. Similarly, a handler called ``hand01`` in
|
||||
the ``[handlers]`` section will have its configuration held in a section called
|
||||
``[handler_hand01]``, while a formatter called ``form01`` in the
|
||||
``[formatters]`` section will have its configuration specified in a section
|
||||
called ``[formatter_form01]``. The root logger configuration must be specified
|
||||
in a section called ``[logger_root]``.
|
||||
The configuration file format understood by :func:`fileConfig` is
|
||||
based on :mod:`configparser` functionality. The file must contain
|
||||
sections called ``[loggers]``, ``[handlers]`` and ``[formatters]``
|
||||
which identify by name the entities of each type which are defined in
|
||||
the file. For each such entity, there is a separate section which
|
||||
identified how that entity is configured. Thus, for a logger named
|
||||
``log01`` in the ``[loggers]`` section, the relevant configuration
|
||||
details are held in a section ``[logger_log01]``. Similarly, a handler
|
||||
called ``hand01`` in the ``[handlers]`` section will have its
|
||||
configuration held in a section called ``[handler_hand01]``, while a
|
||||
formatter called ``form01`` in the ``[formatters]`` section will have
|
||||
its configuration specified in a section called
|
||||
``[formatter_form01]``. The root logger configuration must be
|
||||
specified in a section called ``[logger_root]``.
|
||||
|
||||
Examples of these sections in the file are given below. ::
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ The :mod:`shlex` module defines the following class:
|
|||
|
||||
.. seealso::
|
||||
|
||||
Module :mod:`ConfigParser`
|
||||
Module :mod:`configparser`
|
||||
Parser for configuration files similar to the Windows :file:`.ini` files.
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue