blob: eff7935dc2bfb8607adaf85f79f9f91ca3712340 [file] [log] [blame]
from __future__ import print_function
import argparse
from typing import IO
from typing import List
from typing import Optional
from typing import Sequence
PASS = 0
FAIL = 1
class Requirement(object):
def __init__(self): # type: () -> None
super(Requirement, self).__init__()
self.value = None # type: Optional[bytes]
self.comments = [] # type: List[bytes]
def name(self): # type: () -> bytes
assert self.value is not None, self.value
if self.value.startswith(b'-e '):
return self.value.lower().partition(b'=')[-1]
return self.value.lower().partition(b'==')[0]
def __lt__(self, requirement): # type: (Requirement) -> int
# \n means top of file comment, so always return True,
# otherwise just do a string comparison with value.
assert self.value is not None, self.value
if self.value == b'\n':
return True
elif requirement.value == b'\n':
return False
return <
def fix_requirements(f): # type: (IO[bytes]) -> int
requirements = [] # type: List[Requirement]
before = list(f)
after = [] # type: List[bytes]
before_string = b''.join(before)
# adds new line in case one is missing
# AND a change to the requirements file is needed regardless:
if before and not before[-1].endswith(b'\n'):
before[-1] += b'\n'
# If the file is empty (i.e. only whitespace/newlines) exit early
if before_string.strip() == b'':
return PASS
for line in before:
# If the most recent requirement object has a value, then it's
# time to start building the next requirement object.
if not len(requirements) or requirements[-1].value is not None:
requirement = requirements[-1]
# If we see a newline before any requirements, then this is a
# top of file comment.
if len(requirements) == 1 and line.strip() == b'':
if (
len(requirement.comments) and
requirement.value = b'\n'
elif line.startswith(b'#') or line.strip() == b'':
requirement.value = line
# if a file ends in a comment, preserve it at the end
if requirements[-1].value is None:
rest = requirements.pop().comments
rest = []
# find and remove pkg-resources==0.0.0
# which is automatically added by broken pip package under Debian
requirements = [
req for req in requirements
if req.value != b'pkg-resources==0.0.0\n'
for requirement in sorted(requirements):
assert requirement.value, requirement.value
after_string = b''.join(after)
if before_string == after_string:
return PASS
return FAIL
def main(argv=None): # type: (Optional[Sequence[str]]) -> int
parser = argparse.ArgumentParser()
parser.add_argument('filenames', nargs='*', help='Filenames to fix')
args = parser.parse_args(argv)
retv = PASS
for arg in args.filenames:
with open(arg, 'rb+') as file_obj:
ret_for_file = fix_requirements(file_obj)
if ret_for_file:
print('Sorting {}'.format(arg))
retv |= ret_for_file
return retv
if __name__ == '__main__':