read header file as binary

Author: Piotr Kasprzyk

pylintfileheader/file_header_checker.py

@@ -2,7 +2,6 @@
 #  Copyright (c) Leo Hanisch. All rights reserved.
 #  Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 # ---------------------------------------------------------------------------------------------
-import os
 import re
 import sys
 
@@ -65,8 +64,8 @@ def __init__(self, linter=None):
     def open(self):
         self.header = self.config.file_header
         if not self.header and self.config.file_header_path:
-            with open(self.config.file_header_path, 'r', encoding='utf-8') as header_file:
-                self.header = header_file.read()
+            with open(self.config.file_header_path, 'rb') as header_file:
+                self.header = header_file.read().decode('utf-8')
 
         if self.header:
             if sys.version_info[0] < 3:
@@ -84,7 +83,7 @@ def process_module(self, node):
         content = None
         with node.stream() as stream:
             # Explicit decoding required by python 3
-            content = stream.read().decode('utf-8').replace(os.linesep, '\n')
+            content = stream.read().decode('utf-8')
 
         if self.config.file_header_ignore_empty_files and not content:
             return

pylintfileheadertest/file_header_checker_test.py

@@ -4,7 +4,6 @@
 # ---------------------------------------------------------------------------------------------
 
 # pylint: disable=invalid-name,unused-variable
-import os
 import re
 import sys
 
@@ -17,13 +16,14 @@
 
 class TestFileHeaderChecker(pylint.testutils.CheckerTestCase):
     CHECKER_CLASS = FileHeaderChecker
-    CONFIG = {'file_header': '# Valid\n# Header'}
+    EXPECTED_HEADER = '# Valid\n# Header'
+    CONFIG = {'file_header': EXPECTED_HEADER}
 
     def test_valid_header_no_message_added(self):
         """Test whether no message is added, when the file header is valid."""
 
         node_mock = MagicMock()
-        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = '# Valid\n# Header'
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = self.EXPECTED_HEADER
         with self.assertNoMessages():
             self.checker.process_module(node_mock)
 
@@ -35,7 +35,7 @@ def test_invalid_header_message_added(self):
         with self.assertAddsMessages(pylint.testutils.Message(
                 msg_id='invalid-file-header',
                 line=1,
-                args='# Valid\n# Header')):
+                args=self.EXPECTED_HEADER)):
             self.checker.process_module(node_mock)
 
     def test_valid_header_not_at_top_message_added(self):
@@ -46,7 +46,7 @@ def test_valid_header_not_at_top_message_added(self):
         with self.assertAddsMessages(pylint.testutils.Message(
                 msg_id='invalid-file-header',
                 line=1,
-                args='# Valid\n# Header')):
+                args=self.EXPECTED_HEADER)):
             self.checker.process_module(node_mock)
 
     def test_ignore_empty_files(self):
@@ -66,19 +66,7 @@ def test_do_not_ignore_empty_files(self):
         with self.assertAddsMessages(pylint.testutils.Message(
                 msg_id='invalid-file-header',
                 line=1,
-                args='# Valid\n# Header')):
-            self.checker.process_module(node_mock)
-
-    def test_valid_header_in_windows_format_file(self, monkeypatch):
-        """Test whether no message is added when the source file is in windows newline format."""
-
-        windows_linesep = '\r\n'
-        monkeypatch.setattr(os, 'linesep', windows_linesep)
-        node_mock = MagicMock()
-        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = (
-            '# Valid{newline}# Header{newline}print(42)'.format(newline=windows_linesep)
-        )
-        with self.assertNoMessages():
+                args=self.EXPECTED_HEADER)):
             self.checker.process_module(node_mock)
 
 
@@ -100,8 +88,9 @@ class TestFileHeaderCheckerPathMain(TestFileHeaderChecker):
     CONFIG = {'file_header_path': 'pylintfileheadertest/header.txt'}
 
 
-class TestFileHeaderCheckerWindowsFormat(TestFileHeaderChecker):
+class TestFileHeaderCheckerPathWindows(TestFileHeaderChecker):
     CHECKER_CLASS = FileHeaderChecker
+    EXPECTED_HEADER = '# Valid\r\n# Header'
     CONFIG = {'file_header_path': 'pylintfileheadertest/windows_header.txt'}