Merge pull request #2 from SVilgelm/ignore-empty-files

Ignoring empty files

Author: HaaLeo

README.md

@@ -20,6 +20,8 @@ Generate a `.pylintrc` file by executing `pylint --generate-rcfile`.
 Then add `pylintfileheader` to the plugins to load and set the `file-header` option to the [regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) that the file header should match.  
 When the `file-header` setting is omitted, pylint will pass.
 
+* `file-header-ignore-empty-files` turns on the mode of ignoring the empty files, like `__init__.py`. The default value is `False`.
+
 ## Example
 
 ### Setup

pylintfileheader/file_header_checker.py

@@ -36,11 +36,28 @@ class FileHeaderChecker(BaseChecker):
                 'help': 'The file header that should be on top of a file.',
             }
         ),
+        (
+            'file-header-ignore-empty-files',
+            {
+                'default': False,
+                'type': 'yn',
+                'metavar': 'y_or_n',
+                'help': 'Ignoring the empty files.',
+            }
+        ),
     )
 
     def process_module(self, node):
         """Process the astroid node stream."""
         if self.config.file_header:
+            content = None
+            with node.stream() as stream:
+                # Explicit decoding required by python 3
+                content = stream.read().decode('utf-8')
+
+            if self.config.file_header_ignore_empty_files and not content:
+                return
+
             if sys.version_info[0] < 3:
                 pattern = re.compile(
                     r'\A' + self.config.file_header, re.LOCALE | re.MULTILINE)
@@ -49,11 +66,6 @@ def process_module(self, node):
                 pattern = re.compile(
                     r'\A' + self.config.file_header, re.MULTILINE)
 
-            content = None
-            with node.stream() as stream:
-                # Explicit decoding required by python 3
-                content = stream.read().decode('utf-8')
-
             matches = pattern.findall(content)
 
             if len(matches) != 1:

pylintfileheadertest/file_header_checker_test.py

@@ -51,3 +51,23 @@ def test_config_empty_no_message_added(self):
         node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = '# Invalid\n# Header'
         with self.assertNoMessages():
             self.checker.process_module(node_mock)
+
+    def test_ignore_empty_files(self):
+        """When the `file-header-ignore-empty-files` option is set to True."""
+
+        self.checker.config.file_header_ignore_empty_files = True
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = ''
+        with self.assertNoMessages():
+            self.checker.process_module(node_mock)
+
+    def test_do_not_ignore_empty_files(self):
+        """When the `file-header-ignore-empty-files` option is set to False (default value)."""
+
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = ''
+        with self.assertAddsMessages(pylint.testutils.Message(
+                msg_id='invalid-file-header',
+                line=1,
+                args='# Valid\n# Header')):
+            self.checker.process_module(node_mock)

requirements-dev.txt

@@ -11,3 +11,5 @@ pytest-cov
 setuptools>=38.6.0
 twine>=1.11.0
 wheel>=0.31.0
+# The last compitible version with python3.4, it is needed for twine
+readme-renderer==24.0; python_version == '3.4'