Clean up pylint warnings in filesystem_mock.py.

third_party/WebKit/Tools/Scripts/webkitpy/common/system/filesystem_mock.py

 # Copyright (C) 2009 Google Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #    * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #    * Redistributions in binary form must reproduce the above
 # copyright notice, this list of conditions and the following disclaimer
@@ skipping 14 matching lines @@
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import StringIO
 import errno
 import hashlib
 import os
 import re
 
-from webkitpy.common.system import path
-
 
 class MockFileSystem(object):
     sep = '/'
     pardir = '..'
 
     def __init__(self, files=None, dirs=None, cwd='/'):
-        """Initializes a "mock" filesystem that can be used to completely
-        stub out a filesystem.
+        """Initializes a "mock" filesystem that can be used to replace the
+        FileSystem class in tests.
 
         Args:
-            files: a dict of filenames -> file contents. A file contents
-                value of None is used to indicate that the file should
-                not exist.
+            files: A dictionary of filenames to file contents. A file contents
+                value of None indicates that the file does not exist.
         """
         self.files = files or {}
         self.executable_files = set()
         self.written_files = {}
         self.last_tmpdir = None
         self.current_tmpno = 0
         self.cwd = cwd
         self.dirs = set(dirs or [])
         self.dirs.add(cwd)
-        for f in self.files:
-            d = self.dirname(f)
-            while not d in self.dirs:
-                self.dirs.add(d)
-                d = self.dirname(d)
+        for file_path in self.files:
+            directory = self.dirname(file_path)
+            while directory not in self.dirs:
+                self.dirs.add(directory)
+                directory = self.dirname(directory)
 
     def clear_written_files(self):
         # This function can be used to track what is written between steps in a test.
         self.written_files = {}
 
     def _raise_not_found(self, path):
         raise IOError(errno.ENOENT, path, os.strerror(errno.ENOENT))
 
     def _split(self, path):
-        # This is not quite a full implementation of os.path.split
+        # This is not quite a full implementation of os.path.split; see:
         # http://docs.python.org/library/os.path.html#os.path.split
         if self.sep in path:
             return path.rsplit(self.sep, 1)
         return ('', path)
 
     def make_executable(self, file_path):
         self.executable_files.add(file_path)
 
     def abspath(self, path):
         if os.path.isabs(path):
@@ skipping 36 matching lines @@
 
         self.files[destination] = self.files[source]
         self.written_files[destination] = self.files[source]
 
     def dirname(self, path):
         return self._split(path)[0]
 
     def exists(self, path):
         return self.isfile(path) or self.isdir(path)
 
-    def files_under(self, path, dirs_to_skip=[], file_filter=None):
-        def filter_all(fs, dirpath, basename):
+    def files_under(self, path, dirs_to_skip=None, file_filter=None):
+        dirs_to_skip = dirs_to_skip or []
+
+        def filter_all(fs, dirpath, basename):  # pylint: disable=unused-argument
             return True

[jeffcarp, 2016/11/15 19:10:01]

Would turning this into a lambda get rid of the lint error? I seem to remember
that being the case for the code we worked on last week...

 
         file_filter = file_filter or filter_all
         files = []
         if self.isfile(path):
             if file_filter(self, self.dirname(path), self.basename(path)) and self.files[path] is not None:
                 files.append(path)
             return files
 
         if self.basename(path) in dirs_to_skip:
             return []
@@ skipping 19 matching lines @@
     def getcwd(self):
         return self.cwd
 
     def glob(self, glob_string):
         # FIXME: This handles '*', but not '?', '[', or ']'.
         glob_string = re.escape(glob_string)
         glob_string = glob_string.replace('\\*', '[^\\/]*') + '$'
         glob_string = glob_string.replace('\\/', '/')
         path_filter = lambda path: re.match(glob_string, path)
 
-        # We could use fnmatch.fnmatch, but that might not do the right thing on windows.
+        # We could use fnmatch.fnmatch, but that might not do the right thing on Windows.
         existing_files = [path for path, contents in self.files.items() if contents is not None]
         return filter(path_filter, existing_files) + filter(path_filter, self.dirs)
 
     def isabs(self, path):
         return path.startswith(self.sep)
 
     def isfile(self, path):
         return path in self.files and self.files[path] is not None
 
     def isdir(self, path):
         return self.normpath(path) in self.dirs
 
     def _slow_but_correct_join(self, *comps):
         return re.sub(re.escape(os.path.sep), self.sep, os.path.join(*comps))
 
     def join(self, *comps):
         # This function is called a lot, so we optimize it; there are
-        # unittests to check that we match _slow_but_correct_join(), above.
+        # unit tests to check that we match _slow_but_correct_join(), above.
         path = ''
         sep = self.sep
         for comp in comps:
             if not comp:
                 continue
             if comp[0] == sep:
                 path = comp
                 continue
             if path:
                 path += sep
             path += comp
         if comps[-1] == '' and path:
             path += '/'
         path = path.replace(sep + sep, sep)
         return path
 
     def listdir(self, path):
-        _, dirs, files = list(self.walk(path))[0]
-        return dirs + files
+        _, directories, files = list(self.walk(path))[0]
+        return directories + files
 
     def walk(self, top):
         sep = self.sep
         if not self.isdir(top):
             raise OSError("%s is not a directory" % top)
 
         if not top.endswith(sep):
             top += sep
 
-        dirs = []
+        directories = []
         files = []
-        for f in self.files:
-            if self.exists(f) and f.startswith(top):
-                remaining = f[len(top):]
+        for file_path in self.files:
+            if self.exists(file_path) and file_path.startswith(top):
+                remaining = file_path[len(top):]
                 if sep in remaining:
-                    dir = remaining[:remaining.index(sep)]
-                    if not dir in dirs:
-                        dirs.append(dir)
+                    directory = remaining[:remaining.index(sep)]
+                    if directory not in directories:
+                        directories.append(directory)
                 else:
                     files.append(remaining)
-        file_system_tuples = [(top[:-1], dirs, files)]
-        for dir in dirs:
-            dir = top + dir
-            tuples_from_subdirs = self.walk(dir)
+        file_system_tuples = [(top[:-1], directories, files)]
+        for directory in directories:
+            directory = top + directory
+            tuples_from_subdirs = self.walk(directory)
             file_system_tuples += tuples_from_subdirs
         return file_system_tuples
 
     def mtime(self, path):
         if self.exists(path):
             return 0
         self._raise_not_found(path)
 
-    def _mktemp(self, suffix='', prefix='tmp', dir=None, **kwargs):
+    def _mktemp(self, suffix='', prefix='tmp', dir=None, **_):  # pylint: disable=redefined-builtin
         if dir is None:
             dir = self.sep + '__im_tmp'
         curno = self.current_tmpno
         self.current_tmpno += 1
         self.last_tmpdir = self.join(dir, '%s_%u_%s' % (prefix, curno, suffix))
         return self.last_tmpdir
 
     def mkdtemp(self, **kwargs):
         class TemporaryDirectory(object):
 
             def __init__(self, fs, **kwargs):
                 self._kwargs = kwargs
                 self._filesystem = fs
-                self._directory_path = fs._mktemp(**kwargs)
+                self._directory_path = fs._mktemp(**kwargs)  # pylint: disable=protected-access
                 fs.maybe_make_directory(self._directory_path)
 
             def __str__(self):
                 return self._directory_path
 
             def __enter__(self):
                 return self._directory_path
 
-            def __exit__(self, type, value, traceback):
+            def __exit__(self, exception_type, exception_value, traceback):
                 # Only self-delete if necessary.
 
                 # FIXME: Should we delete non-empty directories?
                 if self._filesystem.exists(self._directory_path):
                     self._filesystem.rmtree(self._directory_path)
 
         return TemporaryDirectory(fs=self, **kwargs)
 
     def maybe_make_directory(self, *path):
         norm_path = self.normpath(self.join(*path))
@@ skipping 107 matching lines @@
             rel_path = path[len(common_root) + 1:]
 
         return dot_dot + rel_path
 
     def remove(self, path):
         if self.files[path] is None:
             self._raise_not_found(path)
         self.files[path] = None
         self.written_files[path] = None
 
-    def rmtree(self, path):
-        path = self.normpath(path)
+    def rmtree(self, path_to_remove):
+        path_to_remove = self.normpath(path_to_remove)
 
-        for f in self.files:
-            # We need to add a trailing separator to path to avoid matching
-            # cases like path='/foo/b' and f='/foo/bar/baz'.
-            if f == path or f.startswith(path + self.sep):
-                self.files[f] = None
+        for file_path in self.files:
+            # We need to add a trailing separator to path_to_remove to avoid matching
+            # cases like path_to_remove='/foo/b' and file_path='/foo/bar/baz'.
+            if file_path == path_to_remove or file_path.startswith(path_to_remove + self.sep):
+                self.files[file_path] = None
 
-        self.dirs = set(filter(lambda d: not (d == path or d.startswith(path + self.sep)), self.dirs))
+        def should_remove(directory):
+            return directory == path_to_remove or directory.startswith(path_to_remove + self.sep)
+
+        self.dirs = {d for d in self.dirs if not should_remove(d)}
 
     def copytree(self, source, destination):
         source = self.normpath(source)
         destination = self.normpath(destination)
 
         for source_file in list(self.files):
             if source_file.startswith(source):
                 destination_path = self.join(destination, self.relpath(source_file, source))
                 self.maybe_make_directory(self.dirname(destination_path))
                 self.files[destination_path] = self.files[source_file]
@@ skipping 15 matching lines @@
 
     def __init__(self, fs, path):
         self.fs = fs
         self.path = path
         self.closed = False
         self.fs.files[path] = ""
 
     def __enter__(self):
         return self
 
-    def __exit__(self, type, value, traceback):
+    def __exit__(self, exception_type, exception_value, traceback):
         self.close()
 
     def close(self):
         self.closed = True
 
-    def write(self, str):
-        self.fs.files[self.path] += str
+    def write(self, string):
+        self.fs.files[self.path] += string
         self.fs.written_files[self.path] = self.fs.files[self.path]
 
 
 class WritableTextFileObject(WritableBinaryFileObject):
 
-    def write(self, str):
-        WritableBinaryFileObject.write(self, str.encode('utf-8'))
+    def write(self, string):
+        WritableBinaryFileObject.write(self, string.encode('utf-8'))
 
 
 class ReadableBinaryFileObject(object):
 
     def __init__(self, fs, path, data):
         self.fs = fs
         self.path = path
         self.closed = False
         self.data = data
         self.offset = 0
 
     def __enter__(self):
         return self
 
-    def __exit__(self, type, value, traceback):
+    def __exit__(self, exception_type, exception_value, traceback):
         self.close()
 
     def close(self):
         self.closed = True
 
-    def read(self, bytes=None):
-        if not bytes:
+    def read(self, num_bytes=None):
+        if not num_bytes:
             return self.data[self.offset:]
         start = self.offset
-        self.offset += bytes
+        self.offset += num_bytes
         return self.data[start:self.offset]
 
 
 class ReadableTextFileObject(ReadableBinaryFileObject):
 
     def __init__(self, fs, path, data):
         super(ReadableTextFileObject, self).__init__(fs, path, StringIO.StringIO(data.decode("utf-8")))
 
     def close(self):
         self.data.close()
         super(ReadableTextFileObject, self).close()
 
-    def read(self, bytes=-1):
-        return self.data.read(bytes)
+    def read(self, num_bytes=-1):
+        return self.data.read(num_bytes)
 
     def readline(self, length=None):
         return self.data.readline(length)
 
     def __iter__(self):
         return self.data.__iter__()
 
     def next(self):
         return self.data.next()
 
     def seek(self, offset, whence=os.SEEK_SET):
         self.data.seek(offset, whence)