pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-12 23:54:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Catch UnicodeDecodeError while parsing config files

Browse source
This commit is contained in:
Anthony Sottile 2017-10-09 09:23:08 -07:00
parent 2e12a2024b
commit bbe8d6d6c6
2 changed files with 27 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/flake8/options/config.py
View file

@ -60,13 +60,21 @@ class ConfigFileFinder(object):
@staticmethod @staticmethod
def _read_config(files): def _read_config(files):
config = configparser.RawConfigParser() config = configparser.RawConfigParser()
try: if isinstance(files, (str, type(u''))):
found_files = config.read(files) files = [files]
except configparser.ParsingError:
LOG.exception("There was an error trying to parse a config " found_files = []
"file. The files we were attempting to parse " for filename in files:
"were: %r", files) try:
found_files = [] found_files.extend(config.read(filename))
except UnicodeDecodeError:
LOG.exception("There was an error decoding a config file."
"The file with a problem was %s.",
filename)
except configparser.ParsingError:
LOG.exception("There was an error trying to parse a config "
"file. The file with a problem was %s.",
filename)
return (config, found_files) return (config, found_files)
def cli_config(self, files): def cli_config(self, files):

13
tests/unit/test_config_file_finder.py
View file

@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
"""Tests for the ConfigFileFinder.""" """Tests for the ConfigFileFinder."""
import configparser import configparser
import os import os
@ -135,4 +136,14 @@ def test_local_configs_double_read():
]) ])
def test_read_config_catches_broken_config_files(files): def test_read_config_catches_broken_config_files(files):
"""Verify that we do not allow the exception to bubble up.""" """Verify that we do not allow the exception to bubble up."""
assert config.ConfigFileFinder._read_config(files)[1] == [] _, parsed = config.ConfigFileFinder._read_config(files)
assert BROKEN_CONFIG_PATH not in parsed
def test_read_config_catches_decoding_errors(tmpdir):
"""Verify that we do not allow the exception to bubble up."""
setup_cfg = tmpdir.join('setup.cfg')
# pick an encoding that's unlikely to be a default
setup_cfg.write_binary(u'[x]\ny = €'.encode('cp1252'))
_, parsed = config.ConfigFileFinder._read_config(setup_cfg.strpath)
assert parsed == []