mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-04 20:26:53 +00:00
Add example configuration sections to the docs
Add tests to verify our examples do not regress
This commit is contained in:
parent
91e07ebcff
commit
466ef2e596
4 changed files with 189 additions and 1 deletions
16
tests/fixtures/config_files/cli-specified-with-inline-comments.ini
vendored
Normal file
16
tests/fixtures/config_files/cli-specified-with-inline-comments.ini
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
[flake8]
|
||||
# This is a flake8 config, there are many like it, but this is mine
|
||||
ignore =
|
||||
# Disable E123
|
||||
E123,
|
||||
# Disable W234
|
||||
W234,
|
||||
# Also disable E111
|
||||
E111
|
||||
exclude =
|
||||
# Exclude foo/
|
||||
foo/,
|
||||
# Exclude bar/ while we're at it
|
||||
bar/,
|
||||
# Exclude bogus/
|
||||
bogus/
|
||||
16
tests/fixtures/config_files/cli-specified-without-inline-comments.ini
vendored
Normal file
16
tests/fixtures/config_files/cli-specified-without-inline-comments.ini
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
[flake8]
|
||||
# This is a flake8 config, there are many like it, but this is mine
|
||||
# Disable E123
|
||||
# Disable W234
|
||||
# Also disable E111
|
||||
ignore =
|
||||
E123,
|
||||
W234,
|
||||
E111
|
||||
# Exclude foo/
|
||||
# Exclude bar/ while we're at it
|
||||
# Exclude bogus/
|
||||
exclude =
|
||||
foo/,
|
||||
bar/,
|
||||
bogus/
|
||||
|
|
@ -172,3 +172,36 @@ def test_parse_uses_cli_config(ConfigFileManager, optmanager):
|
|||
|
||||
parser.parse(cli_config='foo.ini')
|
||||
parser.config_finder.cli_config.assert_called_once_with('foo.ini')
|
||||
|
||||
|
||||
@pytest.mark.parametrize('config_fixture_path', [
|
||||
'tests/fixtures/config_files/cli-specified.ini',
|
||||
'tests/fixtures/config_files/cli-specified-with-inline-comments.ini',
|
||||
'tests/fixtures/config_files/cli-specified-without-inline-comments.ini',
|
||||
])
|
||||
def test_parsed_configs_are_equivalent(optmanager, config_fixture_path):
|
||||
"""Verify the each file matches the expected parsed output.
|
||||
|
||||
This is used to ensure our documented behaviour does not regress.
|
||||
"""
|
||||
optmanager.add_option('--exclude', parse_from_config=True,
|
||||
comma_separated_list=True,
|
||||
normalize_paths=True)
|
||||
optmanager.add_option('--ignore', parse_from_config=True,
|
||||
comma_separated_list=True)
|
||||
parser = config.MergedConfigParser(optmanager)
|
||||
config_finder = parser.config_finder
|
||||
|
||||
with mock.patch.object(config_finder, 'local_config_files') as localcfs:
|
||||
localcfs.return_value = [config_fixture_path]
|
||||
with mock.patch.object(config_finder,
|
||||
'user_config_file') as usercf:
|
||||
usercf.return_value = []
|
||||
parsed_config = parser.merge_user_and_local_config()
|
||||
|
||||
assert parsed_config['ignore'] == ['E123', 'W234', 'E111']
|
||||
assert parsed_config['exclude'] == [
|
||||
os.path.abspath('foo/'),
|
||||
os.path.abspath('bar/'),
|
||||
os.path.abspath('bogus/'),
|
||||
]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue