klipper-dgus/scripts/check_whitespace.py

71 lines
2.2 KiB
Python
Executable File

#!/usr/bin/env python2
# Check files for whitespace problems
#
# Copyright (C) 2018 Kevin O'Connor <kevin@koconnor.net>
#
# This file may be distributed under the terms of the GNU GPLv3 license.
import sys, os.path, unicodedata
HaveError = False
def report_error(filename, lineno, msg):
global HaveError
if not HaveError:
sys.stderr.write("\n\nERROR:\nERROR: White space errors\nERROR:\n")
HaveError = True
sys.stderr.write("%s:%d: %s\n" % (filename, lineno + 1, msg))
def check_file(filename):
# Open and read file
try:
f = open(filename, 'rb')
data = f.read()
f.close()
except IOError:
return
if not data:
# Empty files are okay
return
# Do checks
is_source_code = any([filename.endswith(s) for s in ['.c', '.h', '.py']])
lineno = 0
for lineno, line in enumerate(data.split('\n')):
# Verify line is valid utf-8
try:
line = line.decode('utf-8')
except UnicodeDecodeError:
report_error(filename, lineno, "Found non utf-8 character")
continue
# Check for control characters
for c in line:
if unicodedata.category(c).startswith('C'):
char_name = repr(c)
if c == '\t':
if os.path.basename(filename).lower() == 'makefile':
continue
char_name = 'tab'
report_error(filename, lineno, "Invalid %s character" % (
char_name,))
break
# Check for trailing space
if line.endswith(' '):
report_error(filename, lineno, "Line has trailing spaces")
# Check for more than 80 characters
if is_source_code and len(line) > 80:
report_error(filename, lineno, "Line longer than 80 characters")
if not data.endswith('\n'):
report_error(filename, lineno, "No newline at end of file")
if data.endswith('\n\n'):
report_error(filename, lineno, "Extra newlines at end of file")
def main():
files = sys.argv[1:]
for filename in files:
check_file(filename)
if HaveError:
sys.stderr.write("\n\n")
sys.exit(-1)
if __name__ == '__main__':
main()