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

Add typings to ConfigFileFinder constructor

Browse source 
`OptionManager.parse_known_args()` is guaranteed to return a list of
remaining argument strings.
This commit is contained in:
Eric N. Vander Weele 2019-08-29 16:34:30 -04:00
parent 45ad2faf8f
commit c2216c0ddf
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -17,6 +17,7 @@ class ConfigFileFinder(object):
"""Encapsulate the logic for finding and reading config files.""" """Encapsulate the logic for finding and reading config files."""
def __init__(self, program_name, args, extra_config_files): def __init__(self, program_name, args, extra_config_files):
# type: (str, List[str], List[str]) -> None
"""Initialize object to find config files. """Initialize object to find config files.
:param str program_name: :param str program_name:

12
tests/unit/test_config_file_finder.py
View file

@ -15,7 +15,7 @@ BROKEN_CONFIG_PATH = 'tests/fixtures/config_files/broken.ini'
def test_uses_default_args(): def test_uses_default_args():
"""Show that we default the args value.""" """Show that we default the args value."""
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
assert finder.parent == os.path.abspath('.') assert finder.parent == os.path.abspath('.')
@ -27,14 +27,14 @@ def test_uses_default_args():
def test_windows_detection(platform, is_windows): def test_windows_detection(platform, is_windows):
"""Verify we detect Windows to the best of our knowledge.""" """Verify we detect Windows to the best of our knowledge."""
with mock.patch.object(sys, 'platform', platform): with mock.patch.object(sys, 'platform', platform):
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
assert finder.is_windows is is_windows assert finder.is_windows is is_windows
def test_cli_config(): def test_cli_config():
"""Verify opening and reading the file specified via the cli.""" """Verify opening and reading the file specified via the cli."""
cli_filepath = CLI_SPECIFIED_FILEPATH cli_filepath = CLI_SPECIFIED_FILEPATH
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
parsed_config = finder.cli_config(cli_filepath) parsed_config = finder.cli_config(cli_filepath)
assert parsed_config.has_section('flake8') assert parsed_config.has_section('flake8')
@ -42,7 +42,7 @@ def test_cli_config():
def test_cli_config_double_read(): def test_cli_config_double_read():
"""Second request for CLI config is cached.""" """Second request for CLI config is cached."""
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
parsed_config = finder.cli_config(CLI_SPECIFIED_FILEPATH) parsed_config = finder.cli_config(CLI_SPECIFIED_FILEPATH)
boom = Exception("second request for CLI config not cached") boom = Exception("second request for CLI config not cached")
@ -113,14 +113,14 @@ def test_local_config_files(args, extra_config_files, expected):
def test_local_configs(): def test_local_configs():
"""Verify we return a ConfigParser.""" """Verify we return a ConfigParser."""
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
assert isinstance(finder.local_configs(), configparser.RawConfigParser) assert isinstance(finder.local_configs(), configparser.RawConfigParser)
def test_local_configs_double_read(): def test_local_configs_double_read():
"""Second request for local configs is cached.""" """Second request for local configs is cached."""
finder = config.ConfigFileFinder('flake8', None, []) finder = config.ConfigFileFinder('flake8', [], [])
first_read = finder.local_configs() first_read = finder.local_configs()
boom = Exception("second request for local configs not cached") boom = Exception("second request for local configs not cached")