✨ Upgrade autocompletion functionality for compatibility with shell_complete
#1006
Conversation
…s through CompletionItem return values, fix args to match what it was in click 7
|
📝 Docs preview for commit 249b70e at: https://6ae37f21.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit c5aab0a at: https://9a5f770f.typertiangolo.pages.dev Modified Pages |
svlandeg
changed the title
autocompletion functionality for compatibility with shell_complete
|
Thanks for the PR! We'll get this reviewed and get back to you 🙏 |
|
📝 Docs preview for commit 340c459 at: https://985aa99d.typertiangolo.pages.dev Modified Pages |
|
@bckohan: the tests are failing because there isn't a 100% code coverage with the new commits. Could you look into this? 🙏 |
|
📝 Docs preview for commit 26581c0 at: https://9afeb588.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit 1037702 at: https://c58d58a9.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit 8b300ba at: https://9a9692fe.typertiangolo.pages.dev Modified Pages |
|
📝 Docs preview for commit 00e6af5 at: https://b52048c2.typertiangolo.pages.dev Modified Pages |
|
@svlandeg I've updated the docs and added the necessary tests. Should be good to go! |
Cf issue: #949
Note, this includes (and supersedes) the changes from #974 and implements these suggestions #949 (comment), with a few differences.
I attempted to push these changes to #974 but was asked to open a new PR here instead.
This PR does 3 things:
Allows autocompletion functions to accept a
click.core.Parameterargument. I think this is necessary because without it you can't define generic completer functions that don't know what CLI options or arguments they may be attached to and that need to alter their behavior based on how click has processed the arguments before the incomplete argument. Concrete example: you have an option or argument that accepts multiple values but you do not wish those values to be repeated.Allows CompletionItems to be returned in addition to strings and 2-tuples from autocompletion functions.
Fixes arg: List[str] parameter to be passed what it used to be given in click 7 (i.e. the raw command line string minus the script and incomplete string). In click 7 this parameter was being set to the arguments passed in the environment variables via the completion scripts installed on the system that are invoked when you hit tab. These parameters do not show up in ctx.args or sys.argv. Click has a general purpose obj attribute on the context that is available for downstream use. This PR sets that object to a dictionary in the completer classes and attaches the args from the environment variables to it. If obj is already defined it'll just not do that and nothing will break accept the args will be passed as an empty list to the autocompletion functions - which is what the original PR was doing anyway even though the tutorial docs said otherwise.
I think numbers 1 and 2 are important. Number 3 is mostly for backwards compatibility but I don't think its that critical - I just wanted to show that there is a way to do it using public Click 8 interfaces.
A reusable completer function tutorial has been added to the autocompletion tutorials