pre-commit-hooks/pre_commit_hooks/mixed_line_ending.py

import argparse
import logging
import os
import re
import sys

from enum import Enum


class LineEnding(Enum):
    CR = b'\r', '\\r', 'cr', re.compile(b'\r(?!\n)', re.DOTALL)
    CRLF = b'\r\n', '\\r\\n', 'crlf', re.compile(b'\r\n', re.DOTALL)
    LF = b'\n', '\\n', 'lf', re.compile(b'(?<!\r)\n', re.DOTALL)

    def __init__(self, string, str_print, opt_name, regex):
        self.string = string
        self.str_print = str_print
        self.opt_name = opt_name
        self.regex = regex


class MixedLineEndingOption(Enum):
    AUTO = 'auto', None
    NO = 'no', None
    CRLF = LineEnding.CRLF.opt_name, LineEnding.CRLF
    LF = LineEnding.LF.opt_name, LineEnding.LF

    def __init__(self, opt_name, line_ending_enum):
        self.opt_name = opt_name
        self.line_ending_enum = line_ending_enum


class MixedLineDetection(Enum):
    MIXED_MOSTLY_CRLF = 1, True, LineEnding.CRLF
    MIXED_MOSTLY_LF = 2, True, LineEnding.LF
    NOT_MIXED = 3, False, None
    UNKNOWN = 4, False, None

    def __init__(self, index, mle_found, line_ending_enum):
        # TODO hack to prevent enum overriding
        self.index = index
        self.mle_found = mle_found
        self.line_ending_enum = line_ending_enum


VERBOSE_OPTION_TO_LOGGING_SEVERITY = {
    0: logging.WARNING,
    1: logging.INFO,
    2: logging.DEBUG,
}


ANY_LINE_ENDING_PATTERN = re.compile(
    # match either
    b'(' +
    # \r\n
    LineEnding.CRLF.regex.pattern +
    # or \n
    b'|' + LineEnding.LF.regex.pattern +
    # or \r
    b'|' + LineEnding.CR.regex.pattern +
    b')'
)


def mixed_line_ending(argv=None):
    options = _parse_arguments(argv)

    logging.basicConfig(format='%(levelname)s: %(message)s',
                        level=options['logging_severity'])
    logging.debug('mixed_line_ending: options = %s', options)

    filenames = options['filenames']
    fix_option = options['fix']

    _check_filenames(filenames)

    if fix_option == MixedLineEndingOption.NO:
        return _process_no_fix(filenames)
    elif fix_option == MixedLineEndingOption.AUTO:
        return _process_fix_auto(filenames)
    # when a line ending character is forced with --fix option
    else:
        return _process_fix_force(filenames, fix_option.line_ending_enum)


def _parse_arguments(argv=None):
    parser = argparse.ArgumentParser()
    parser.add_argument(
        '-f',
        '--fix',
        choices=[m.opt_name for m in MixedLineEndingOption],
        default=MixedLineEndingOption.AUTO.opt_name,
        help='Replace line ending with the specified. Default is "auto"')
    parser.add_argument('filenames', nargs='*', help='Filenames to fix')
    parser.add_argument(
        '-v',
        '--verbose',
        action="count",
        default=0,
        help='Increase output verbosity')
    args = parser.parse_args(argv)

    fix = None
    if args.fix == MixedLineEndingOption.NO.opt_name:
        fix = MixedLineEndingOption.NO
    elif args.fix == MixedLineEndingOption.CRLF.opt_name:
        fix = MixedLineEndingOption.CRLF
    elif args.fix == MixedLineEndingOption.LF.opt_name:
        fix = MixedLineEndingOption.LF
    else:
        fix = MixedLineEndingOption.AUTO

    args.verbose = min(args.verbose, 2)
    severity = VERBOSE_OPTION_TO_LOGGING_SEVERITY.get(args.verbose)

    options = {'fix': fix, 'filenames': args.filenames,
               'logging_severity': severity}

    return options


def _check_filenames(filenames):
    logging.debug('_check_filenames: filenames = %s', filenames)

    for filename in filenames:
        if not os.path.isfile(filename):
            raise IOError('The file "{}" does not exist'.format(filename))


def _detect_line_ending(filename):
    with open(filename, 'rb') as f:
        buf = f.read()

        le_counts = {}
        for le_enum in LineEnding:
            le_counts[le_enum] = len(le_enum.regex.findall(buf))

        logging.debug('_detect_line_ending: le_counts = ' + str(le_counts))

        mixed = False
        le_found_previously = False
        most_le = None
        max_le_count = 0

        for le, le_count in le_counts.items():
            le_found_cur = le_count > 0

            mixed |= le_found_previously and le_found_cur
            le_found_previously |= le_found_cur

            if le_count == max_le_count:
                most_le = None
            elif le_count > max_le_count:
                max_le_count = le_count
                most_le = le

        if not mixed:
            return MixedLineDetection.NOT_MIXED

        for mld in MixedLineDetection:
            if mld.line_ending_enum is not None \
               and mld.line_ending_enum == most_le:
                return mld

        return MixedLineDetection.UNKNOWN


def _process_no_fix(filenames):
    logging.info('Checking if the files have mixed line ending.')

    mle_filenames = []
    for filename in filenames:
        detect_result = _detect_line_ending(filename)
        logging.debug('mixed_line_ending: detect_result = %s',
                      detect_result)

        if detect_result.mle_found:
            mle_filenames.append(filename)

    mle_found = len(mle_filenames) > 0

    if mle_found:
        logging.info('The following files have mixed line endings:\n\t%s',
                     '\n\t'.join(mle_filenames))

    return 1 if mle_found else 0


def _process_fix_auto(filenames):
    mle_found = False

    for filename in filenames:
        detect_result = _detect_line_ending(filename)

        logging.debug('mixed_line_ending: detect_result = %s',
                      detect_result)

        if detect_result == MixedLineDetection.NOT_MIXED:
            logging.info('The file %s has no mixed line ending', filename)

            mle_found |= False
        elif detect_result == MixedLineDetection.UNKNOWN:
            logging.info('Could not define most frequent line ending in '
                         'file %s. File skiped.', filename)

            mle_found = True
        else:
            le_enum = detect_result.line_ending_enum

            logging.info('The file %s has mixed line ending with a '
                         'majority of "%s". Converting...', filename,
                         le_enum.str_print)

            _convert_line_ending(filename, le_enum.string)
            mle_found = True

            logging.info('The file %s has been converted to "%s" line '
                         'ending.', filename, le_enum.str_print)

    return 1 if mle_found else 0


def _process_fix_force(filenames, line_ending_enum):
    for filename in filenames:
        _convert_line_ending(filename, line_ending_enum.string)

        logging.info('The file %s has been forced to "%s" line ending.',
                     filename, line_ending_enum.str_print)

    return 1


def _convert_line_ending(filename, line_ending):
    # read the file
    with open(filename, 'rb+') as f:
        bufin = f.read()

        # convert line ending
        bufout = ANY_LINE_ENDING_PATTERN.sub(line_ending, bufin)

        # write the result in the file
        f.seek(0)
        f.write(bufout)
        f.truncate()


if __name__ == '__main__':
    sys.exit(mixed_line_ending())