Make changes on normalization of path and some cleanups

Author: kianasun

src/pip/_internal/__init__.py

@@ -116,7 +116,8 @@ def autocomplete():
         options = [(k, v) for k, v in options if k.startswith(current)]
         # get completion type given cwords and available subcommand options
         completion_type = get_path_completion_type(
-            cwords, cword, subcommand.parser.option_list_all)
+            cwords, cword, subcommand.parser.option_list_all,
+        )
         # get completion files and directories if ``completion_type`` is
         # ``<file>``, ``<dir>`` or ``<path>``
         if completion_type:
@@ -147,22 +148,23 @@ def autocomplete():
 
 
 def get_path_completion_type(cwords, cword, opts):
-    """Get the type of path completion(``file``, ``dir``, ``path`` or None)
+    """Get the type of path completion (``file``, ``dir``, ``path`` or None)
 
     :param cwords: same as the environmental variable ``COMP_WORDS``
     :param cword: same as the environmental variable ``COMP_CWORD``
     :param opts: The available options to check
-    :return: path completion type(``file``, ``dir``, ``path`` or None)
+    :return: path completion type (``file``, ``dir``, ``path`` or None)
     """
-    if cword >= 2 and cwords[cword - 2].startswith('-'):
-        for opt in opts:
-            if opt.help == optparse.SUPPRESS_HELP:
-                continue
-            for o in str(opt).split('/'):
-                if cwords[cword - 2].split('=')[0] == o:
-                    if any(x in ('path', 'file', 'dir')
-                            for x in opt.metavar.split('/')):
-                        return opt.metavar
+    if cword < 2 or not cwords[cword - 2].startswith('-'):
+        return
+    for opt in opts:
+        if opt.help == optparse.SUPPRESS_HELP:
+            continue
+        for o in str(opt).split('/'):
+            if cwords[cword - 2].split('=')[0] == o:
+                if any(x in ('path', 'file', 'dir')
+                        for x in opt.metavar.split('/')):
+                    return opt.metavar
 
 
 def auto_complete_paths(current, completion_type):
@@ -174,25 +176,25 @@ def auto_complete_paths(current, completion_type):
     :param completion_type: path completion type(`file`, `path` or `dir`)i
     :return: A generator of regular files and/or directories
     """
-    # split ``current`` into two parts(directory and name)
     directory, filename = os.path.split(current)
-    # change directory to ``directory``
     current_path = os.path.abspath(directory)
-    # check whether ``current_path`` is accessible
-    if os.access(current_path, os.R_OK):
-        # list all files that start with ``filename``
-        file_list = (x for x in os.listdir(current_path)
-                     if x.startswith(filename))
-        for f in file_list:
-            opt = os.path.join(current_path, f)
-            comp_file = os.path.join(directory, f)
-            # complete regular files when there is not ``<dir>`` after option
-            # complete directories when there is ``<file>``, ``<path>`` or
-            # ``<dir>``after option
-            if completion_type != 'dir' and os.path.isfile(opt):
-                yield comp_file
-            elif os.path.isdir(opt):
-                yield os.path.join(comp_file, '')
+    # Don't complete paths if they can't be accessed
+    if not os.access(current_path, os.R_OK):
+        return
+    filename = os.path.normcase(filename)
+    # list all files that start with ``filename``
+    file_list = (x for x in os.listdir(current_path)
+                 if os.path.normcase(x).startswith(filename))
+    for f in file_list:
+        opt = os.path.join(current_path, f)
+        comp_file = os.path.normcase(os.path.join(directory, f))
+        # complete regular files when there is not ``<dir>`` after option
+        # complete directories when there is ``<file>``, ``<path>`` or
+        # ``<dir>``after option
+        if completion_type != 'dir' and os.path.isfile(opt):
+            yield comp_file
+        elif os.path.isdir(opt):
+            yield os.path.join(comp_file, '')
 
 
 def create_main_parser():

tests/data/completion_paths/README.txt

@@ -128,19 +128,34 @@ def test_completion_files_after_option(script, data):
     (e.g. ``pip install -r``)
     """
     res, env = setup_completion(
-        script, ('pip install -r r'),
-        '3',
-        data.complete_paths
+        script=script,
+        words=('pip install -r r'),
+        cword='3',
+        cwd=data.completion_paths,
     )
-    assert 'requirements.txt' in res.stdout,\
-        "autocomplete function could not complete <file>"\
+    assert 'requirements.txt' in res.stdout, (
+        "autocomplete function could not complete <file> "
         "after options in command"
-    assert 'README.txt' not in res.stdout,\
-        "autocomplete function completed <file> that"\
+    )
+    assert os.path.join('resources', '') in res.stdout, (
+        "autocomplete function could not complete <dir> "
+        "after options in command"
+    )
+    assert not any(out in res.stdout for out in
+                   (os.path.join('REPLAY', ''), 'README.txt')), (
+        "autocomplete function completed <file> or <dir> that "
         "should not be completed"
-    assert 'resources' in res.stdout,\
-        "autocomplete function could not complete <dir>"\
+    )
+    if sys.platform != 'win32':
+        return
+    assert 'readme.txt' in res.stdout, (
+        "autocomplete function could not complete <file> "
         "after options in command"
+    )
+    assert os.path.join('replay', '') in res.stdout, (
+        "autocomplete function could not complete <dir> "
+        "after options in command"
+    )
 
 
 def test_completion_not_files_after_option(script, data):
@@ -149,13 +164,21 @@ def test_completion_not_files_after_option(script, data):
     (e.g. ``pip install``)
     """
     res, env = setup_completion(
-        script, ('pip install r'),
-        '2',
-        data.complete_paths
+        script=script,
+        words=('pip install r'),
+        cword='2',
+        cwd=data.completion_paths,
     )
-    assert 'requirements.txt' not in res.stdout,\
-        "autocomplete function completed <file> when"\
+    assert not any(out in res.stdout for out in
+                   ('requirements.txt', 'readme.txt',)), (
+        "autocomplete function completed <file> when "
         "it should not complete"
+    )
+    assert not any(os.path.join(out, '') in res.stdout
+                   for out in ('replay', 'resources')), (
+        "autocomplete function completed <dir> when "
+        "it should not complete"
+    )
 
 
 def test_completion_directories_after_option(script, data):
@@ -164,13 +187,23 @@ def test_completion_directories_after_option(script, data):
     (e.g. ``pip --cache-dir``)
     """
     res, env = setup_completion(
-        script,
-        ('pip --cache-dir resources'),
-        '2',
-        data.complete_paths
+        script=script,
+        words=('pip --cache-dir r'),
+        cword='2',
+        cwd=data.completion_paths,
     )
-    assert os.path.join('resources', '') in res.stdout,\
+    assert os.path.join('resources', '') in res.stdout, (
         "autocomplete function could not complete <dir> after options"
+    )
+    assert not any(out in res.stdout for out in (
+        'requirements.txt', 'README.txt', os.path.join('REPLAY', ''))), (
+            "autocomplete function completed <dir> when "
+            "it should not complete"
+    )
+    if sys.platform == 'win32':
+        assert os.path.join('replay', '') in res.stdout, (
+            "autocomplete function could not complete <dir> after options"
+        )
 
 
 def test_completion_subdirectories_after_option(script, data):
@@ -179,15 +212,16 @@ def test_completion_subdirectories_after_option(script, data):
     given path of a directory
     """
     res, env = setup_completion(
-        script,
-        ('pip --cache-dir ' + os.path.join('resources', '')),
-        '2',
-        data.complete_paths
+        script=script,
+        words=('pip --cache-dir ' + os.path.join('resources', '')),
+        cword='2',
+        cwd=data.completion_paths,
     )
     assert os.path.join('resources',
-                        os.path.join('images', '')) in res.stdout,\
-        "autocomplete function could not complete <dir>"\
+                        os.path.join('images', '')) in res.stdout, (
+        "autocomplete function could not complete <dir> "
         "given path of a directory after options"
+    )
 
 
 def test_completion_path_after_option(script, data):
@@ -196,13 +230,16 @@ def test_completion_path_after_option(script, data):
     given absolute path
     """
     res, env = setup_completion(
-        script,
-        ('pip install -e ' + os.path.join(data.complete_paths, 'R')),
-        '3'
+        script=script,
+        words=('pip install -e ' + os.path.join(data.completion_paths, 'R')),
+        cword='3',
     )
-    assert os.path.join(data.complete_paths, 'README.txt') in res.stdout,\
-        "autocomplete function could not complete <path>"\
+    assert all(os.path.normcase(os.path.join(data.completion_paths, out))
+               in res.stdout for out in (
+               'README.txt', os.path.join('REPLAY', ''))), (
+        "autocomplete function could not complete <path> "
         "after options in command given absolute path"
+    )
 
 
 @pytest.mark.parametrize('flag', ['--bash', '--zsh', '--fish'])

tests/data/completion_paths/REPLAY/video.mpeg

@@ -113,8 +113,8 @@ def reqfiles(self):
         return self.root.join("reqfiles")
 
     @property
-    def complete_paths(self):
-        return self.root.join("completepaths")
+    def completion_paths(self):
+        return self.root.join("completion_paths")
 
     @property
     def find_links(self):