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

bpo-33943: Add references in the docs for logging.basicConfig (GH-7858) 

Adds references to info about file modes, `time.strftime()`, string formatting
syntaxes, and logging levels.
This commit is contained in:
Andrés Delfino 2018-06-25 03:06:10 -03:00 committed by Tal Einat
parent cf67d6a934
commit a8ddf85a84
2 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/library/functions.rst
View File

@ -971,6 +971,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
========= ===============================================================

41
Doc/library/logging.rst
View File

@ -1147,41 +1147,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. |
+--------------+---------------------------------------------+
| ``force`` | If this keyword argument is specified as |
| | true, any existing handlers attached to the |