diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-06-25 06:31:24 (GMT) |
|---|---|---|
| committer | Tal Einat <taleinat+github@gmail.com> | 2018-06-25 06:31:24 (GMT) |
| commit | 73848e028de58e7fb2b38bddb1638ca2323561a9 (patch) | |
| tree | a9a5033b4de0d32edae89440ad09a7a1e492709e | |
| parent | cef5da5441776090026c735ca1c9fa277f8b9931 (diff) | |
| download | cpython-73848e028de58e7fb2b38bddb1638ca2323561a9.zip cpython-73848e028de58e7fb2b38bddb1638ca2323561a9.tar.gz cpython-73848e028de58e7fb2b38bddb1638ca2323561a9.tar.bz2 | |
bpo-33943: Add references in the docs for logging.basicConfig (GH-7858) (GH-7899)
Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
(cherry picked from commit a8ddf85a84364d2c660e6670a7e06621993d1fdc)
Co-authored-by: Andrés Delfino <adelfino@gmail.com>
| -rw-r--r-- | Doc/library/functions.rst | 5 | ||||
| -rw-r--r-- | Doc/library/logging.rst | 41 |
2 files changed, 27 insertions, 19 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 501a3c9..f2f49ea 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -957,6 +957,11 @@ are always available. They are listed here in alphabetical order. encoding. (For reading and writing raw bytes use binary mode and leave *encoding* unspecified.) The available modes are: + .. _filemodes: + + .. index:: + pair: file; modes + ========= =============================================================== Character Meaning ========= =============================================================== diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 9ef174e..21b9c7d 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -1129,41 +1129,44 @@ functions. +--------------+---------------------------------------------+ | Format | Description | +==============+=============================================+ - | ``filename`` | Specifies that a FileHandler be created, | + | *filename* | Specifies that a FileHandler be created, | | | using the specified filename, rather than a | | | StreamHandler. | +--------------+---------------------------------------------+ - | ``filemode`` | Specifies the mode to open the file, if | - | | filename is specified (if filemode is | - | | unspecified, it defaults to 'a'). | + | *filemode* | If *filename* is specified, open the file | + | | in this :ref:`mode <filemodes>`. Defaults | + | | to ``'a'``. | +--------------+---------------------------------------------+ - | ``format`` | Use the specified format string for the | + | *format* | Use the specified format string for the | | | handler. | +--------------+---------------------------------------------+ - | ``datefmt`` | Use the specified date/time format. | + | *datefmt* | Use the specified date/time format, as | + | | accepted by :func:`time.strftime`. | +--------------+---------------------------------------------+ - | ``style`` | If ``format`` is specified, use this style | - | | for the format string. One of '%', '{' or | - | | '$' for %-formatting, :meth:`str.format` or | - | | :class:`string.Template` respectively, and | - | | defaulting to '%' if not specified. | + | *style* | If *format* is specified, use this style | + | | for the format string. One of ``'%'``, | + | | ``'{'`` or ``'$'`` for :ref:`printf-style | + | | <old-string-formatting>`, | + | | :meth:`str.format` or | + | | :class:`string.Template` respectively. | + | | Defaults to ``'%'``. | +--------------+---------------------------------------------+ - | ``level`` | Set the root logger level to the specified | - | | level. | + | *level* | Set the root logger level to the specified | + | | :ref:`level <levels>`. | +--------------+---------------------------------------------+ - | ``stream`` | Use the specified stream to initialize the | + | *stream* | Use the specified stream to initialize the | | | StreamHandler. Note that this argument is | - | | incompatible with 'filename' - if both are | - | | present, a ``ValueError`` is raised. | + | | incompatible with *filename* - if both | + | | are present, a ``ValueError`` is raised. | +--------------+---------------------------------------------+ - | ``handlers`` | If specified, this should be an iterable of | + | *handlers* | If specified, this should be an iterable of | | | already created handlers to add to the root | | | logger. Any handlers which don't already | | | have a formatter set will be assigned the | | | default formatter created in this function. | | | Note that this argument is incompatible | - | | with 'filename' or 'stream' - if both are | - | | present, a ``ValueError`` is raised. | + | | with *filename* or *stream* - if both | + | | are present, a ``ValueError`` is raised. | +--------------+---------------------------------------------+ .. versionchanged:: 3.2 |