Merge pull request #83 from yanqd0/patch

Skip unchanged files which is checked

Author: carsongee

pylintrc

@@ -1,2 +1,3 @@
 [TYPECHECK]
-ignored-classes=pytest
+ignored-classes=pytest
+disable=bad-option-value

pytest_pylint.py

@@ -16,6 +16,8 @@
 from pylint.reporters import BaseReporter
 import pytest
 
+HISTKEY = 'pylint/mtimes'
+
 
 class PyLintException(Exception):
     """Exception to raise if a file has a specified pylint error"""
@@ -152,6 +154,40 @@ def include_file(path, ignore_list, ignore_patterns=None):
     return not set(parts) & set(ignore_list)
 
 
+def pytest_configure(config):
+    """
+    Add a plugin to cache file mtimes.
+
+    :param _pytest.config.Config config: pytest config object
+    """
+    if config.option.pylint:
+        config.pylint = PylintPlugin(config)
+        config.pluginmanager.register(config.pylint)
+    config.addinivalue_line('markers', "pylint: Tests which run pylint.")
+
+
+# There will be an old-style-class error in Python 2.7,
+# or a useless-object-inheritance warning in Python 3.
+# If disable any, pylint will have a bad-option-value error in 2.7 or 3.
+# Finally I have to disable useless-object-inheritance locally
+# and bad-option-value globally.
+# pylint: disable=too-few-public-methods, useless-object-inheritance
+class PylintPlugin(object):
+    """
+    A Plugin object for pylint, which loads and records file mtimes.
+    """
+    def __init__(self, config):
+        self.mtimes = config.cache.get(HISTKEY, {})
+
+    def pytest_sessionfinish(self, session):
+        """
+        Save file mtimes to pytest cache.
+
+        :param _pytest.main.Session session: the pytest session object
+        """
+        session.config.cache.set(HISTKEY, self.mtimes)
+
+
 def pytest_collect_file(path, parent):
     """Collect files on which pylint should run"""
     config = parent.session.config
@@ -162,17 +198,18 @@ def pytest_collect_file(path, parent):
     rel_path = get_rel_path(path.strpath, parent.session.fspath.strpath)
     session = parent.session
     if session.pylint_config is None:
-        session.pylint_files.add(rel_path)
         # No pylintrc, therefore no ignores, so return the item.
-        return PyLintItem(path, parent)
-
-    if include_file(rel_path, session.pylint_ignore,
-                    session.pylint_ignore_patterns):
-        session.pylint_files.add(rel_path)
-        return PyLintItem(
+        item = PyLintItem(path, parent)
+    elif include_file(rel_path, session.pylint_ignore,
+                      session.pylint_ignore_patterns):
+        item = PyLintItem(
             path, parent, session.pylint_msg_template, session.pylintrc_file
         )
-    return None
+    else:
+        return None
+    if not item.should_skip:
+        session.pylint_files.add(rel_path)
+    return item
 
 
 def pytest_collection_finish(session):
@@ -231,6 +268,14 @@ def __init__(self, fspath, parent, msg_format=None, pylintrc_file=None):
             self._msg_format = msg_format
 
         self.pylintrc_file = pylintrc_file
+        self.__mtime = self.fspath.mtime()
+        prev_mtime = self.config.pylint.mtimes.get(self.nodeid, 0)
+        self.should_skip = (prev_mtime == self.__mtime)
+
+    def setup(self):
+        """Mark unchanged files as SKIPPED."""
+        if self.should_skip:
+            pytest.skip("file(s) previously passed pylint checks")
 
     def runtest(self):
         """Check the pylint messages to see if any errors were reported."""
@@ -243,6 +288,9 @@ def runtest(self):
         if reported_errors:
             raise PyLintException('\n'.join(reported_errors))
 
+        # Update the cache if the item passed pylint.
+        self.config.pylint.mtimes[self.nodeid] = self.__mtime
+
     def repr_failure(self, excinfo):
         """Handle any test failures by checkint that they were ours."""
         if excinfo.errisinstance(PyLintException):

test_pytest_pylint.py

@@ -216,3 +216,25 @@ def test_pylint_ignore_patterns():
     assert include_file("part", [], ignore_patterns) is False
     assert include_file("1part2", [], ignore_patterns) is True
     assert include_file("base.py", [], ignore_patterns) is False
+
+
+def test_skip_checked_files(testdir):
+    """
+    Test a file twice which can pass pylint.
+    The 2nd time should be skipped.
+    """
+    testdir.makepyfile(
+        '#!/usr/bin/env python',
+        '"""A hello world script."""',
+        '',
+        'from __future__ import print_function',
+        '',
+        'print("Hello world!")  # pylint: disable=missing-final-newline',
+    )
+    # The 1st time should be passed
+    result = testdir.runpytest('--pylint')
+    assert '1 passed' in result.stdout.str()
+
+    # The 2nd time should be skipped
+    result = testdir.runpytest('--pylint')
+    assert '1 skipped' in result.stdout.str()