Ignore files with name that starts like an emacs lock files (#5554)

* Fix 'path' shadowing variable from outer scope

* Ignore file that starts like emacs's file lock

Closes #367

Co-authored-by: Daniël van Noord <[email protected]>

Author: Pierre-Sassoulas

ChangeLog

@@ -30,6 +30,13 @@ Release date: TBA
 
   Closes #5499
 
+* By default, pylint does no longer take files starting with ``.#`` into account. Those are
+  considered `emacs file locks`. See
+  https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Locks.html.
+  This behavior can be reverted by redefining the ``ignore-patterns`` option.
+
+  Closes #367
+
 * ``used-before-assignment`` now assumes that assignments in except blocks
   may not have occurred and warns accordingly.
 

doc/whatsnew/2.13.rst

@@ -32,6 +32,14 @@ Extensions
 Other Changes
 =============
 
+* By default, pylint does no longer take files starting with ``.#`` into account. Those are
+  considered `emacs file locks`_. This behavior can be reverted by redefining the
+  ``ignore-patterns`` option.
+
+  Closes #367
+
+.. _`emacs file locks`: https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Locks.html
+
 * Fixed extremely long processing of long lines with comma's.
 
   Closes #5483

pylint/lint/expand_modules.py

@@ -8,8 +8,8 @@
 
 
 def _modpath_from_file(filename, is_namespace, path=None):
-    def _is_package_cb(path, parts):
-        return modutils.check_modpath_has_init(path, parts) or is_namespace
+    def _is_package_cb(inner_path, parts):
+        return modutils.check_modpath_has_init(inner_path, parts) or is_namespace
 
     return modutils.modpath_from_file_with_callback(
         filename, path=path, is_package_cb=_is_package_cb

pylint/lint/pylinter.py

@@ -223,9 +223,10 @@ def make_options():
                     "type": "regexp_csv",
                     "metavar": "<pattern>[,<pattern>...]",
                     "dest": "black_list_re",
-                    "default": (),
+                    "default": (r"^\.#",),
                     "help": "Files or directories matching the regex patterns are"
-                    " skipped. The regex matches against base names, not paths.",
+                    " skipped. The regex matches against base names, not paths. The default value "
+                    "ignores emacs file locks",
                 },
             ),
             (

pylint/testutils/configuration_test.py

@@ -5,11 +5,13 @@
 import copy
 import json
 import logging
+import re
 import unittest
 from pathlib import Path
 from typing import Any, Dict, List, Tuple, Union
 from unittest.mock import Mock
 
+from pylint.constants import PY38_PLUS
 from pylint.lint import Run
 
 # We use Any in this typing because the configuration contains real objects and constants
@@ -18,6 +20,13 @@
 PylintConfiguration = Dict[str, ConfigurationValue]
 
 
+if not PY38_PLUS:
+    # We need to deepcopy a compiled regex pattern
+    # In python 3.6 and 3.7 this require a hack
+    # See https://stackoverflow.com/a/56935186
+    copy._deepcopy_dispatch[type(re.compile(""))] = lambda r, _: r  # type: ignore[attr-defined]
+
+
 def get_expected_or_default(
     tested_configuration_file: Union[str, Path],
     suffix: str,
@@ -31,7 +40,7 @@ def get_expected_or_default(
         with open(expected_result_path, encoding="utf8") as f:
             expected = f.read()
         # logging is helpful to realize your file is not taken into
-        # account after a misspell of the file name. The output of the
+        # account after a misspelling of the file name. The output of the
         # program is checked during the test so printing messes with the result.
         logging.info("%s exists.", expected_result_path)
     else:
@@ -139,7 +148,7 @@ def run_using_a_configuration_file(
     # would not be accessible outside the `with` block.
     with unittest.mock.patch("sys.exit") as mocked_exit:
         # Do not actually run checks, that could be slow. We don't mock
-        # `Pylinter.check`: it calls `Pylinter.initialize` which is
+        # `PyLinter.check`: it calls `PyLinter.initialize` which is
         # needed to properly set up messages inclusion/exclusion
         # in `_msg_states`, used by `is_message_enabled`.
         check = "pylint.lint.pylinter.check_parallel"

pylint/utils/linterstats.py

@@ -155,7 +155,7 @@ def __str__(self) -> str:
         {self.percent_duplicated_lines}"""
 
     def init_single_module(self, module_name: str) -> None:
-        """Use through Pylinter.set_current_module so Pyliner.current_name is consistent."""
+        """Use through PyLinter.set_current_module so PyLinter.current_name is consistent."""
         self.by_module[module_name] = ModuleStats(
             convention=0, error=0, fatal=0, info=0, refactor=0, statement=0, warning=0
         )

tests/functional/e/.#emacs_file_lock.py

@@ -0,0 +1,4 @@
+# The name is invalid, but we should not analyse this file
+# Because its filename reseambles an emacs file lock ignored by default
+# https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Locks.html
+# See https://github.com/PyCQA/pylint/issues/367

tests/functional/e/.#emacs_file_lock_by_conf.py

@@ -0,0 +1,3 @@
+# The name is invalid, but we should not analyse this file
+# Because it resembles an emacs file lock and is ignored by the configuration
+# See https://github.com/PyCQA/pylint/issues/367

tests/functional/e/.#emacs_file_lock_by_conf.rc

@@ -0,0 +1,2 @@
+[MASTER]
+ignore-patterns=^\.#

tests/functional/e/.#emacs_file_lock_redefined_conf.py

@@ -0,0 +1,3 @@
+# [invalid-name]
+# The name is invalid and we should analyse this file
+# as ignore-patterns is redefined in the configuration