PEP 391: Resolve uses of the default role (#3388)
This commit is contained in:
parent
bff9f540a2
commit
e9448dbb41
18
pep-0391.txt
18
pep-0391.txt
|
@ -383,7 +383,7 @@ Dictionary Schema - Detail
|
||||||
The dictionary passed to ``dictConfig()`` must contain the following
|
The dictionary passed to ``dictConfig()`` must contain the following
|
||||||
keys:
|
keys:
|
||||||
|
|
||||||
* `version` - to be set to an integer value representing the schema
|
* ``version`` - to be set to an integer value representing the schema
|
||||||
version. The only valid value at present is 1, but having this key
|
version. The only valid value at present is 1, but having this key
|
||||||
allows the schema to evolve while still preserving backwards
|
allows the schema to evolve while still preserving backwards
|
||||||
compatibility.
|
compatibility.
|
||||||
|
@ -395,7 +395,7 @@ custom instantiation is required. If so, the mechanism described
|
||||||
above is used to instantiate; otherwise, the context is used to
|
above is used to instantiate; otherwise, the context is used to
|
||||||
determine how to instantiate.
|
determine how to instantiate.
|
||||||
|
|
||||||
* `formatters` - the corresponding value will be a dict in which each
|
* ``formatters`` - the corresponding value will be a dict in which each
|
||||||
key is a formatter id and each value is a dict describing how to
|
key is a formatter id and each value is a dict describing how to
|
||||||
configure the corresponding Formatter instance.
|
configure the corresponding Formatter instance.
|
||||||
|
|
||||||
|
@ -403,7 +403,7 @@ determine how to instantiate.
|
||||||
(with defaults of ``None``) and these are used to construct a
|
(with defaults of ``None``) and these are used to construct a
|
||||||
``logging.Formatter`` instance.
|
``logging.Formatter`` instance.
|
||||||
|
|
||||||
* `filters` - the corresponding value will be a dict in which each key
|
* ``filters`` - the corresponding value will be a dict in which each key
|
||||||
is a filter id and each value is a dict describing how to configure
|
is a filter id and each value is a dict describing how to configure
|
||||||
the corresponding Filter instance.
|
the corresponding Filter instance.
|
||||||
|
|
||||||
|
@ -411,7 +411,7 @@ determine how to instantiate.
|
||||||
empty string) and this is used to construct a ``logging.Filter``
|
empty string) and this is used to construct a ``logging.Filter``
|
||||||
instance.
|
instance.
|
||||||
|
|
||||||
* `handlers` - the corresponding value will be a dict in which each
|
* ``handlers`` - the corresponding value will be a dict in which each
|
||||||
key is a handler id and each value is a dict describing how to
|
key is a handler id and each value is a dict describing how to
|
||||||
configure the corresponding Handler instance.
|
configure the corresponding Handler instance.
|
||||||
|
|
||||||
|
@ -451,7 +451,7 @@ determine how to instantiate.
|
||||||
``logging.handlers.RotatingFileHandler`` with the keyword arguments
|
``logging.handlers.RotatingFileHandler`` with the keyword arguments
|
||||||
``filename='logconfig.log', maxBytes=1024, backupCount=3``.
|
``filename='logconfig.log', maxBytes=1024, backupCount=3``.
|
||||||
|
|
||||||
* `loggers` - the corresponding value will be a dict in which each key
|
* ``loggers`` - the corresponding value will be a dict in which each key
|
||||||
is a logger name and each value is a dict describing how to
|
is a logger name and each value is a dict describing how to
|
||||||
configure the corresponding Logger instance.
|
configure the corresponding Logger instance.
|
||||||
|
|
||||||
|
@ -470,11 +470,11 @@ determine how to instantiate.
|
||||||
The specified loggers will be configured according to the level,
|
The specified loggers will be configured according to the level,
|
||||||
propagation, filters and handlers specified.
|
propagation, filters and handlers specified.
|
||||||
|
|
||||||
* `root` - this will be the configuration for the root logger.
|
* ``root`` - this will be the configuration for the root logger.
|
||||||
Processing of the configuration will be as for any logger, except
|
Processing of the configuration will be as for any logger, except
|
||||||
that the ``propagate`` setting will not be applicable.
|
that the ``propagate`` setting will not be applicable.
|
||||||
|
|
||||||
* `incremental` - whether the configuration is to be interpreted as
|
* ``incremental`` - whether the configuration is to be interpreted as
|
||||||
incremental to the existing configuration. This value defaults to
|
incremental to the existing configuration. This value defaults to
|
||||||
``False``, which means that the specified configuration replaces the
|
``False``, which means that the specified configuration replaces the
|
||||||
existing configuration with the same semantics as used by the
|
existing configuration with the same semantics as used by the
|
||||||
|
@ -483,10 +483,10 @@ determine how to instantiate.
|
||||||
If the specified value is ``True``, the configuration is processed
|
If the specified value is ``True``, the configuration is processed
|
||||||
as described in the section on `Incremental Configuration`_, below.
|
as described in the section on `Incremental Configuration`_, below.
|
||||||
|
|
||||||
* `disable_existing_loggers` - whether any existing loggers are to be
|
* ``disable_existing_loggers`` - whether any existing loggers are to be
|
||||||
disabled. This setting mirrors the parameter of the same name in
|
disabled. This setting mirrors the parameter of the same name in
|
||||||
``fileConfig()``. If absent, this parameter defaults to ``True``.
|
``fileConfig()``. If absent, this parameter defaults to ``True``.
|
||||||
This value is ignored if `incremental` is ``True``.
|
This value is ignored if ``incremental`` is ``True``.
|
||||||
|
|
||||||
A Working Example
|
A Working Example
|
||||||
-----------------
|
-----------------
|
||||||
|
|
Loading…
Reference in New Issue