pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-04-07 20:26:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #206 from dlgallagher/requirements_txt_fixer_followup

Browse source 
Some style tweaks (requirements_txt_fixer)
This commit is contained in:
Anthony Sottile 2017-06-25 14:53:25 -04:00 • committed by GitHub
commit 50871f83cc
2 changed files with 37 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

17
pre_commit_hooks/requirements_txt_fixer.py
View file

@ -3,6 +3,10 @@ from __future__ import print_function
import argparse import argparse
PASS = 0
FAIL = 1
class Requirement(object): class Requirement(object):
def __init__(self): def __init__(self):
@ -30,14 +34,14 @@ class Requirement(object):
def fix_requirements(f): def fix_requirements(f):
requirements = [] requirements = []
before = list(f) before = tuple(f)
after = [] after = []
before_string = b''.join(before) before_string = b''.join(before)
# If the file is empty (i.e. only whitespace/newlines) exit early # If the file is empty (i.e. only whitespace/newlines) exit early
if before_string.strip() == b'': if before_string.strip() == b'':
return 0 return PASS
for line in before: for line in before:
# If the most recent requirement object has a value, then it's # If the most recent requirement object has a value, then it's
@ -60,19 +64,18 @@ def fix_requirements(f):
requirement.value = line requirement.value = line
for requirement in sorted(requirements): for requirement in sorted(requirements):
for comment in requirement.comments: after.extend(requirement.comments)
after.append(comment)
after.append(requirement.value) after.append(requirement.value)
after_string = b''.join(after) after_string = b''.join(after)
if before_string == after_string: if before_string == after_string:
return 0 return PASS
else: else:
f.seek(0) f.seek(0)
f.write(after_string) f.write(after_string)
f.truncate() f.truncate()
return 1 return FAIL
def fix_requirements_txt(argv=None): def fix_requirements_txt(argv=None):
@ -80,7 +83,7 @@ def fix_requirements_txt(argv=None):
parser.add_argument('filenames', nargs='*', help='Filenames to fix') parser.add_argument('filenames', nargs='*', help='Filenames to fix')
args = parser.parse_args(argv) args = parser.parse_args(argv)
retv = 0 retv = PASS
for arg in args.filenames: for arg in args.filenames:
with open(arg, 'rb+') as file_obj: with open(arg, 'rb+') as file_obj:

46
tests/requirements_txt_fixer_test.py
View file

@ -1,33 +1,41 @@
import pytest import pytest
from pre_commit_hooks.requirements_txt_fixer import FAIL
from pre_commit_hooks.requirements_txt_fixer import fix_requirements_txt from pre_commit_hooks.requirements_txt_fixer import fix_requirements_txt
from pre_commit_hooks.requirements_txt_fixer import PASS
from pre_commit_hooks.requirements_txt_fixer import Requirement from pre_commit_hooks.requirements_txt_fixer import Requirement
# Input, expected return value, expected output
TESTS = ( @pytest.mark.parametrize(
(b'', 0, b''), ('input_s', 'expected_retval', 'output'),
(b'\n', 0, b'\n'), (
(b'foo\nbar\n', 1, b'bar\nfoo\n'), (b'', PASS, b''),
(b'bar\nfoo\n', 0, b'bar\nfoo\n'), (b'\n', PASS, b'\n'),
(b'#comment1\nfoo\n#comment2\nbar\n', 1, b'#comment2\nbar\n#comment1\nfoo\n'), (b'foo\nbar\n', FAIL, b'bar\nfoo\n'),
(b'#comment1\nbar\n#comment2\nfoo\n', 0, b'#comment1\nbar\n#comment2\nfoo\n'), (b'bar\nfoo\n', PASS, b'bar\nfoo\n'),
(b'#comment\n\nfoo\nbar\n', 1, b'#comment\n\nbar\nfoo\n'), (b'#comment1\nfoo\n#comment2\nbar\n', FAIL, b'#comment2\nbar\n#comment1\nfoo\n'),
(b'#comment\n\nbar\nfoo\n', 0, b'#comment\n\nbar\nfoo\n'), (b'#comment1\nbar\n#comment2\nfoo\n', PASS, b'#comment1\nbar\n#comment2\nfoo\n'),
(b'\nfoo\nbar\n', 1, b'bar\n\nfoo\n'), (b'#comment\n\nfoo\nbar\n', FAIL, b'#comment\n\nbar\nfoo\n'),
(b'\nbar\nfoo\n', 0, b'\nbar\nfoo\n'), (b'#comment\n\nbar\nfoo\n', PASS, b'#comment\n\nbar\nfoo\n'),
(b'pyramid==1\npyramid-foo==2\n', 0, b'pyramid==1\npyramid-foo==2\n'), (b'\nfoo\nbar\n', FAIL, b'bar\n\nfoo\n'),
(b'ocflib\nDjango\nPyMySQL\n', 1, b'Django\nocflib\nPyMySQL\n'), (b'\nbar\nfoo\n', PASS, b'\nbar\nfoo\n'),
(b'-e git+ssh://git_url@tag#egg=ocflib\nDjango\nPyMySQL\n', 1, b'Django\n-e git+ssh://git_url@tag#egg=ocflib\nPyMySQL\n'), (b'pyramid==1\npyramid-foo==2\n', PASS, b'pyramid==1\npyramid-foo==2\n'),
(b'ocflib\nDjango\nPyMySQL\n', FAIL, b'Django\nocflib\nPyMySQL\n'),
(
b'-e git+ssh://git_url@tag#egg=ocflib\nDjango\nPyMySQL\n',
FAIL,
b'Django\n-e git+ssh://git_url@tag#egg=ocflib\nPyMySQL\n'
),
)
) )
@pytest.mark.parametrize(('input_s', 'expected_retval', 'output'), TESTS)
def test_integration(input_s, expected_retval, output, tmpdir): def test_integration(input_s, expected_retval, output, tmpdir):
path = tmpdir.join('file.txt') path = tmpdir.join('file.txt')
path.write_binary(input_s) path.write_binary(input_s)
assert fix_requirements_txt([path.strpath]) == expected_retval output_retval = fix_requirements_txt([path.strpath])
assert path.read_binary() == output assert path.read_binary() == output
assert output_retval == expected_retval
def test_requirement_object(): def test_requirement_object():