Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-103606: raise RuntimeError if config file is invalid or empty (#104701) 

(this adjusts new code) raise RuntimeError if provided config file is invalid or empty, not ValueError.
This commit is contained in:
Prince Roshan 2023-05-21 03:56:49 +05:30 committed by GitHub
parent 27a68be77f
commit 12f1581b0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/library/logging.config.rst
View File

@ -88,7 +88,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
configuration). configuration).
It will raise :exc:`FileNotFoundError` if the file It will raise :exc:`FileNotFoundError` if the file
doesn't exist and :exc:`ValueError` if the file is invalid or doesn't exist and :exc:`RuntimeError` if the file is invalid or
empty. empty.
:param fname: A filename, or a file-like object, or an instance derived :param fname: A filename, or a file-like object, or an instance derived
@ -130,7 +130,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
.. versionadded:: 3.10 .. versionadded:: 3.10
The *encoding* parameter is added. The *encoding* parameter is added.
.. versionadded:: 3.12 .. versionchanged:: 3.12
An exception will be thrown if the provided file An exception will be thrown if the provided file
doesn't exist or is invalid or empty. doesn't exist or is invalid or empty.

4
Lib/logging/config.py
View File

@ -65,7 +65,7 @@ def fileConfig(fname, defaults=None, disable_existing_loggers=True, encoding=Non
if not os.path.exists(fname): if not os.path.exists(fname):
raise FileNotFoundError(f"{fname} doesn't exist") raise FileNotFoundError(f"{fname} doesn't exist")
elif not os.path.getsize(fname): elif not os.path.getsize(fname):
raise ValueError(f'{fname} is an empty file') raise RuntimeError(f'{fname} is an empty file')
if isinstance(fname, configparser.RawConfigParser): if isinstance(fname, configparser.RawConfigParser):
cp = fname cp = fname
@ -78,7 +78,7 @@ def fileConfig(fname, defaults=None, disable_existing_loggers=True, encoding=Non
encoding = io.text_encoding(encoding) encoding = io.text_encoding(encoding)
cp.read(fname, encoding=encoding) cp.read(fname, encoding=encoding)
except configparser.ParsingError as e: except configparser.ParsingError as e:
raise ValueError(f'{fname} is invalid: {e}') raise RuntimeError(f'{fname} is invalid: {e}')
formatters = _create_formatters(cp) formatters = _create_formatters(cp)

4
Lib/test/test_logging.py
View File

@ -1781,12 +1781,12 @@ class ConfigFileTest(BaseTest):
""" """
file = io.StringIO(textwrap.dedent(test_config)) file = io.StringIO(textwrap.dedent(test_config))
self.assertRaises(ValueError, logging.config.fileConfig, file) self.assertRaises(RuntimeError, logging.config.fileConfig, file)
def test_exception_if_confg_file_is_empty(self): def test_exception_if_confg_file_is_empty(self):
fd, fn = tempfile.mkstemp(prefix='test_empty_', suffix='.ini') fd, fn = tempfile.mkstemp(prefix='test_empty_', suffix='.ini')
os.close(fd) os.close(fd)
self.assertRaises(ValueError, logging.config.fileConfig, fn) self.assertRaises(RuntimeError, logging.config.fileConfig, fn)
os.remove(fn) os.remove(fn)
def test_exception_if_config_file_does_not_exist(self): def test_exception_if_config_file_does_not_exist(self):