Merge pull request #36 from prusse-martin/fb-python-no-bom

Remove UTF-8 BOM from python files

Author: prusse-martin

CHANGELOG.rst

@@ -3,10 +3,12 @@ History
 =======
 
 
-Unreleased
+1.7.0
 ----------
 
 * Check if .cpp file is non-ascii, ensure it has BOM at the beginning of the file.
+* Emmit message when clang-format is not installed (or usable).
+* Ensure python files do not include BOM.
 
 1.6.0
 ------

esss_fix_format/cli.py

@@ -253,6 +253,14 @@ def _process_file(filename, check, format_code):
             error_msg = 'Error formatting code: %s' % (e,)
             click.secho(error_msg, fg='red')
             errors.append(error_msg)
+
+        if new_contents and (new_contents[0] == codecs.BOM_UTF8.decode('UTF-8')):
+            msg = ': ERROR python file should not have a BOM.'
+            error_msg = click.format_filename(filename) + msg
+            click.secho(error_msg, fg='red')
+            errors.append(error_msg)
+            new_contents = new_contents[1:]
+
     elif is_cpp(filename):
         formatter = 'legacy formatter'
 

tests/test_esss_fix_format.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+import codecs
 import io
 import os
 import subprocess
@@ -210,6 +211,25 @@ def test_empty_file(tmpdir, sort_cfg_to_tmpdir):
     run([str(filename)], expected_exit=0)
 
 
+@pytest.mark.parametrize('check', [True, False])
+def test_python_with_bom(tmpdir, sort_cfg_to_tmpdir, check):
+    filename = tmpdir.join('test.py')
+    original_contents = codecs.BOM_UTF8 + b'import io\r\n'
+    filename.write(original_contents, 'wb')
+
+    args = [str(filename)]
+    if check:
+        args = ['--check'] + args
+
+    run(args, expected_exit=1)
+
+    current_contents = filename.read('rb')
+    if check:
+        assert current_contents == original_contents
+    else:
+        assert current_contents == original_contents[len(codecs.BOM_UTF8):]
+
+
 @pytest.mark.parametrize(
     'source',
     [