Don't require an encoding for check-docstring-first

This commit is contained in:
Anthony Sottile 2019-03-30 15:31:42 -07:00
parent cbc17d19d9
commit 2f6a2515ec
2 changed files with 35 additions and 18 deletions

View file

@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
from __future__ import absolute_import
from __future__ import unicode_literals
@ -10,37 +11,37 @@ from pre_commit_hooks.check_docstring_first import main
# Contents, expected, expected_output
TESTS = (
# trivial
('', 0, ''),
(b'', 0, ''),
# Acceptable
('"foo"', 0, ''),
(b'"foo"', 0, ''),
# Docstring after code
(
'from __future__ import unicode_literals\n'
'"foo"\n',
b'from __future__ import unicode_literals\n'
b'"foo"\n',
1,
'{filename}:2 Module docstring appears after code '
'(code seen on line 1).\n',
),
# Test double docstring
(
'"The real docstring"\n'
'from __future__ import absolute_import\n'
'"fake docstring"\n',
b'"The real docstring"\n'
b'from __future__ import absolute_import\n'
b'"fake docstring"\n',
1,
'{filename}:3 Multiple module docstrings '
'(first docstring on line 1).\n',
),
# Test multiple lines of code above
(
'import os\n'
'import sys\n'
'"docstring"\n',
b'import os\n'
b'import sys\n'
b'"docstring"\n',
1,
'{filename}:3 Module docstring appears after code '
'(code seen on line 1).\n',
),
# String literals in expressions are ok.
('x = "foo"\n', 0, ''),
(b'x = "foo"\n', 0, ''),
)
@ -58,6 +59,13 @@ def test_unit(capsys, contents, expected, expected_out):
@all_tests
def test_integration(tmpdir, capsys, contents, expected, expected_out):
f = tmpdir.join('test.py')
f.write(contents)
f.write_binary(contents)
assert main([f.strpath]) == expected
assert capsys.readouterr()[0] == expected_out.format(filename=f.strpath)
def test_arbitrary_encoding(tmpdir):
f = tmpdir.join('f.py')
contents = '# -*- coding: cp1252\nx = "£"'.encode('cp1252')
f.write_binary(contents)
assert main([f.strpath]) == 0