Improve autocompletion function on file name completion. #4842

kianasun · 2017-11-05T22:06:49Z

No description provided.

pradyunsg · 2017-11-07T14:22:23Z

Hi @skx19952!

Thanks for this PR. Could you add a description to the PR to describe what issue this PR fixes?

Further, could you add some relevant content to the news file?

kianasun · 2017-11-07T16:50:00Z

Previous autocomplete function cannot autocomplete file names after options which have file, dir or path as metavar. For example, when typed pip install -r <Tab>, it should autocomplete all file names in current directory, or when typed pip --cache-dir <Tab>, it should autocomplete all directory names in current directory. Updated this function.

pradyunsg · 2017-11-12T14:25:47Z

Aha! That's an awesome improvement!

I don't have the time right now to review this. I'll definitely come around to this soon (feel free to ping me if you want :P)

pradyunsg

I like this change.

There's a comment about normalisation of paths, one comment about a 2 and a whole bunch of ✨ things I'd like to see. :)

(I'm a little picky when it comes to how things look. 🎨 ones -- you can skip if you want.)

pradyunsg · 2017-11-28T04:32:18Z

src/pip/_internal/__init__.py

+    :param opts: The available options to check
+    :return: path completion type(``file``, ``dir``, ``path`` or None)
+    """
+    if cword >= 2 and cwords[cword - 2].startswith('-'):


A comment here explaining why 2 would be nice.

if cword < 2 or not cwords[cword - 2].startswith('-'): return ...

It would reduce one level of indentation.

pradyunsg · 2017-11-28T04:32:48Z

src/pip/_internal/__init__.py

+    :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)


In general, the single line comments that are present in this function aren't helpful.

pradyunsg · 2017-11-28T04:35:07Z

tests/functional/test_completion.py

+    (e.g. ``pip install -r``)
+    """
+    res, env = setup_completion(
+        script, ('pip install -r r'),


It would be nice if you could pass the arguments as keyword arguments -- it'll be easier to follow what's happening without having open up the definition of the function.

For all the following tests as well...

pradyunsg · 2017-11-28T04:35:21Z

tests/functional/test_completion.py

+    res, env = setup_completion(
+        script, ('pip install -r r'),
+        '3',
+        data.complete_paths


🎨 final comma

For all the following tests as well...

pradyunsg · 2017-11-28T04:36:19Z

tests/lib/__init__.py

@@ -112,6 +112,10 @@ def indexes(self):
    def reqfiles(self):
        return self.root.join("reqfiles")

+    @property
+    def complete_paths(self):
+        return self.root.join("completepaths")


Maybe rename this folder and property to completion_paths?

pradyunsg · 2017-11-28T04:47:29Z

tests/functional/test_completion.py

@@ -113,14 +114,97 @@ def test_completion_for_default_parameters(script):

 def test_completion_option_for_command(script):
    """
-    Test getting completion for ``--`` in command (eg. pip search --)
+    Test getting completion for ``--`` in command (e.g. ``pip search --``)


This change is good but unrelated? But I mean, it doesn't add much noise so it's fine. :P

pradyunsg · 2017-11-28T04:49:37Z

tests/functional/test_completion.py

+        '3',
+        data.complete_paths
+    )
+    assert 'requirements.txt' in res.stdout,\


Using parenthesis around the string allow skipping the trailing \, which looks nicer. :)

assert 'requirements.txt' in res.stdout, ( "autocomplete function could not complete <file>" "after options in command" )

For all the following tests as well...

pradyunsg · 2017-11-28T04:53:57Z

src/pip/_internal/__init__.py

@@ -114,6 +114,14 @@ def autocomplete():
        options = [(x, v) for (x, v) in options if x not in prev_opts]
        # filter options by current input
        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)


🎨 move the ) to the next line with 1 level less indent and add a trailing comma.

pradyunsg · 2017-11-28T05:03:55Z

tests/functional/test_completion.py

+        ('pip install -e ' + os.path.join(data.complete_paths, 'R')),
+        '3'
+    )
+    assert os.path.join(data.complete_paths, 'README.txt') in res.stdout,\


Also, assert requirements.txt shows up, when normalisation of case may allow?

pradyunsg · 2017-11-28T05:05:05Z

tests/functional/test_completion.py

+        '2',
+        data.complete_paths
+    )
+    assert 'requirements.txt' not in res.stdout,\


Also, assert that README.txt doesn't show up, when normalisation of case might allow?

pradyunsg

I've requested changes above -- specifically about normalisation of path and some cleanups.

kianasun · 2017-12-03T23:18:50Z

I have made some changes. :)

pip uninstall no longer aborts if a package is not installed; instead it prints a warning that the package is not installed and it is skipping the uninstallation of it for this reason.

- Wheel doesn't have a public API - Reword warning about installing into a running interpreter

* Add a global option to disable colors This is a fix for issue pypa#2449 All it does is simply add a global option --no-color Internally it switches ColorizedStreamHandler to StreamHandler if this flag is detected. * Fix lint errors * not sure it makes the code more readable though ... * Fix typo * Choose logging class before assigning * As requested per review * Make the code shorter and easier to follow * Be polite to followers, add commas * Add functional test for the --no-color output * Better detection of windows * Fix fragile tests - can't trust script --quiet * The version found in Travis-CI does not respect this flag It added a prefix line and suffix line found if one does not add the flag --quiet (script from util-linux 2.26.2). As such the out put is: Script started on Fri 27 Oct 2017 07:17:30 AM CEST \x1b[31mCannot uninstall requirement noSuchPackage, not installed\x1b[0m\n Script done on Fri 27 Oct 2017 07:17:31 AM CEST With this change, the test should pass, and is hopefully more stable. * Simplify testing for color or no-color

… fix-completion

pradyunsg · 2018-03-29T04:04:35Z

@kianasun Why close the PR?

kianasun · 2018-03-29T04:08:47Z

I am sorry. I think I did some wrong operations.. I will reopen it soon...

pradyunsg · 2018-03-29T04:11:13Z

Ah, okay. Sure. Lemme know if you need any kind of help. :)

…

On Thu, 29 Mar 2018, 09:38 Kexuan Sun, ***@***.***> wrote: I am sorry. I think I did some wrong operations.. I will reopen it soon... — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4842 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADH7Seju85DswmAKOgkJIJfduY3nXdb9ks5tjF5SgaJpZM4QSjbT> .

kianasun · 2018-03-29T05:23:21Z

Sorry, I think I need to open a new pull request.. @pradyunsg

pradyunsg · 2018-03-29T05:24:49Z

Feel free to. :)

…

On Thu, 29 Mar 2018, 10:53 Kexuan Sun, ***@***.***> wrote: Sorry, I think I need to open a new pull request.. @pradyunsg <https://github.com/pradyunsg> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4842 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADH7SY-2gHV6QOZaXdQHnvAYhbshRIOPks5tjG_MgaJpZM4QSjbT> .

kianasun · 2018-03-29T07:36:03Z

Hi, the new pull request is #5125.

lock · 2019-06-02T14:06:54Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

kianasun force-pushed the fix-completion branch 4 times, most recently from 397c4e3 to 0453412 Compare November 7, 2017 03:44

pradyunsg added S: awaiting response Waiting for a response/more information type: enhancement Improvements to functionality labels Nov 7, 2017

kianasun force-pushed the fix-completion branch from 0453412 to 3b1cda0 Compare November 7, 2017 16:55

Improve autocompletion function on file name completion.

e0f4c2b

kianasun force-pushed the fix-completion branch from 3b1cda0 to e0f4c2b Compare November 7, 2017 18:19

pradyunsg removed the S: awaiting response Waiting for a response/more information label Nov 12, 2017

liujoey mentioned this pull request Nov 20, 2017

completion on file path in general sorin-ionescu/prezto#1511

Closed

pradyunsg added this to the 10.0 milestone Nov 28, 2017

pradyunsg reviewed Nov 28, 2017

View reviewed changes

pradyunsg previously requested changes Nov 28, 2017

View reviewed changes

kianasun force-pushed the fix-completion branch 9 times, most recently from 4fc2297 to 3c0c0e0 Compare December 3, 2017 18:04

Make changes on normalization of path and some cleanups

9b68237

kianasun force-pushed the fix-completion branch from 3c0c0e0 to 9b68237 Compare December 3, 2017 19:22

pradyunsg mentioned this pull request Dec 13, 2017

Add fallback to filename completion to Zsh completion, like for Bash #4916

Closed

pradyunsg and others added 18 commits March 28, 2018 15:42

Update distlib to 0.2.6

8e801ee

Update six to 1.11.0

0d416d8

Update pkg_resources (via setuptools) to 36.6.0.

70cc651

Freeze not installed (pypa#4292, pypa#4293)

b7a10e7

tests: fix freeze integration tests on Windows (pypa#4832)

96f8470

Use return values instead of attributes

c3a7150

Switch pip uninstall behaviour to be idempotent

2b712d9

pip uninstall no longer aborts if a package is not installed; instead it prints a warning that the package is not installed and it is skipping the uninstallation of it for this reason.

📰

b214c95

Documentation fixes (pypa#4831)

d91fdaa

- Wheel doesn't have a public API - Reword warning about installing into a running interpreter

tox: fix handling of flaky tests during CI builds

2371ffa

tests: github repositories should use https (pypa#4838)

ea8a1d4

tests: don't check the actual sequence in test

552775e

Improve autocompletion function on file name completion.

044deb5

Make changes on normalization of path and some cleanups

632fcca

Remove directory completepaths

d070c2b

Merge branch 'fix-completion' of https://github.com/kianasun/pip into…

e532786

… fix-completion

Merge branch 'master' into fix-completion

36330a0

pypa-bot removed the needs rebase or merge PR has conflicts with current master label Mar 28, 2018

kianasun closed this Mar 29, 2018

kianasun deleted the fix-completion branch March 29, 2018 04:00

lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 2, 2019

lock bot locked as resolved and limited conversation to collaborators Jun 2, 2019

Improve autocompletion function on file name completion. #4842

Improve autocompletion function on file name completion. #4842

Uh oh!

Conversation

kianasun commented Nov 5, 2017

Uh oh!

pradyunsg commented Nov 7, 2017

Uh oh!

kianasun commented Nov 7, 2017

Uh oh!

pradyunsg commented Nov 12, 2017

Uh oh!

pradyunsg left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pradyunsg Nov 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pradyunsg Nov 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pradyunsg left a comment

Choose a reason for hiding this comment

Uh oh!

kianasun commented Dec 3, 2017

Uh oh!

pradyunsg commented Mar 29, 2018

Uh oh!

kianasun commented Mar 29, 2018

Uh oh!

pradyunsg commented Mar 29, 2018 via email

Uh oh!

kianasun commented Mar 29, 2018

Uh oh!

pradyunsg commented Mar 29, 2018 via email

Uh oh!

kianasun commented Mar 29, 2018

Uh oh!

lock bot commented Jun 2, 2019

Uh oh!

Uh oh!

pradyunsg left a comment •

edited

Loading

pradyunsg Nov 28, 2017 •

edited

Loading

pradyunsg Nov 28, 2017 •

edited

Loading