[Python-checkins] bpo-43731: Add an `encoding` parameter to logging.fileConfig() (GH-25273)
methane
webhook-mailer at python.org
Tue Apr 13 05:17:33 EDT 2021
https://github.com/python/cpython/commit/c2b7a66b91cdb96fbfdb160f96797208ddc5e436
commit: c2b7a66b91cdb96fbfdb160f96797208ddc5e436
branch: master
author: Inada Naoki <songofacandy at gmail.com>
committer: methane <songofacandy at gmail.com>
date: 2021-04-13T18:17:03+09:00
summary:
bpo-43731: Add an `encoding` parameter to logging.fileConfig() (GH-25273)
files:
A Misc/NEWS.d/next/Library/2021-04-08-15-19-20.bpo-43731.nnVd3h.rst
M Doc/library/logging.config.rst
M Lib/logging/config.py
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index cab49f6072f35..f833bcdd1fcf5 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -77,7 +77,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
.. versionadded:: 3.2
-.. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True)
+.. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True, encoding=None)
Reads the logging configuration from a :mod:`configparser`\-format file. The
format of the file should be as described in
@@ -111,6 +111,8 @@ in :mod:`logging` itself) and defining handlers which are declared either in
they or their ancestors are explicitly named
in the logging configuration.
+ :param encoding: The encoding used to open file when *fname* is filename.
+
.. versionchanged:: 3.4
An instance of a subclass of :class:`~configparser.RawConfigParser` is
now accepted as a value for ``fname``. This facilitates:
@@ -121,6 +123,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in
application (e.g. based on command-line parameters or other aspects
of the runtime environment) before being passed to ``fileConfig``.
+ .. versionadded:: 3.10
+ The *encoding* parameter is added.
+
.. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)
Starts up a socket server on the specified port, and listens for new
diff --git a/Lib/logging/config.py b/Lib/logging/config.py
index fd3aded7608cb..3bc63b78621ab 100644
--- a/Lib/logging/config.py
+++ b/Lib/logging/config.py
@@ -48,7 +48,7 @@
# _listener holds the server object doing the listening
_listener = None
-def fileConfig(fname, defaults=None, disable_existing_loggers=True):
+def fileConfig(fname, defaults=None, disable_existing_loggers=True, encoding=None):
"""
Read the logging configuration from a ConfigParser-format file.
@@ -66,7 +66,8 @@ def fileConfig(fname, defaults=None, disable_existing_loggers=True):
if hasattr(fname, 'readline'):
cp.read_file(fname)
else:
- cp.read(fname)
+ encoding = io.text_encoding(encoding)
+ cp.read(fname, encoding=encoding)
formatters = _create_formatters(cp)
diff --git a/Misc/NEWS.d/next/Library/2021-04-08-15-19-20.bpo-43731.nnVd3h.rst b/Misc/NEWS.d/next/Library/2021-04-08-15-19-20.bpo-43731.nnVd3h.rst
new file mode 100644
index 0000000000000..e5309c92fddba
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2021-04-08-15-19-20.bpo-43731.nnVd3h.rst
@@ -0,0 +1 @@
+Add an ``encoding`` parameter :func:`logging.fileConfig()`.
More information about the Python-checkins
mailing list