With argument autocompletion, context is not passed properly #942

Activity

1. LuckyJosh commented on Mar 4, 2018

   

   LuckyJosh

   on Mar 4, 2018

   More actions

   Im currently not able to test my idea, so please excuse me if for just thinking out loud. 😉

   Instead of passing the settings dict to entrypoint you could try passing it to the context_settings kwarg of the .group or .command function.

   Refer to the documentation for details:
   http://click.pocoo.org/5/commands/#context-defaults
2. fqxp commented on Mar 4, 2018

   

   fqxp

   on Mar 4, 2018

   Author

   More actions

   @LuckyJosh: Thanks for the hint, but that won’t suffice as a workaround. In the above example, I provided completions as a static dictionary just for the sake of simplicity. In my case, a network connection object would be passed via the context, and the _complete function would use it to retrieve possible completions. I don’t think context_settings can be used for that.
3. LuckyJosh commented on Mar 5, 2018

   

   LuckyJosh

   on Mar 5, 2018

   Last edited by LuckyJosh

   More actions

   Alright, in that case I have another idea:
   Are you sure that the kwarg obj to entrypoint should get passed to the context?

   After having a glimps at the implementation of pass_context I would suspect, that obj={...} just get passed to the wrapped function and is not used any further. The context is passed as the first argument to the decorated function without any interaction with the other arguments it would seem.
   This would explain the missing (None) ctx.obj the ErrorMessage is about.

   The source code I am refering to is in decorators.py.
4. fdavis

   added

   bug

   on May 18, 2018
5. foresto commented on Jul 4, 2018

   

   foresto

   on Jul 4, 2018

   Last edited by foresto

   More actions

   I don't understand what LuckyJosh is trying to say.

   The custom context with obj attached is normally created in BaseCommand.main(). The problem is that in autocomplete mode, _bashcomplete() gets called before the context-creation code executes, and creates its own context (without obj) instead.

   It looks to me like we want BaseCommand.main() to create its context in all circumstances, and pass it to _bashcomplete(). Would there be any drawbacks to this?

   Possibly related: #930

   +1 on this issue. I, too, am trying to get autocomplete working with completions that come from network calls.

   👍React with 👍5Reacted by Juho Autio, MBrouns, Fevlake Team, David Alfonso and Sebastian Tramp
6. foresto commented on Jul 5, 2018

   

   foresto

   on Jul 5, 2018

   Last edited by foresto

   More actions

   To be clear, this issue limits the utility of #755. Until it is fixed, autocompletion callbacks have no clean way to access shared network resources.
7. maxandersen commented on Nov 18, 2018

   

   maxandersen

   on Nov 18, 2018

   More actions

   anyone found a workaround on this ?

   for now i'm doing things like this to at least init state based on env variables before calling out:

   def get_entities(ctx, args, incomplete):
       if not hasattr(ctx, 'server'):
           ctx.server = os.environ.get('HASS_SERVER', const.DEFAULT_SERVER)
       
       if not hasattr(ctx, 'token'):
           ctx.token = os.environ.get('HASS_TOKEN')
   
       if not hasattr(ctx, "timeout"):
           ctx.timeout = os.environ.get('HASS_TIMEOUT', const.DEFAULT_TIMEOUT)
   
       try:
           x = req(ctx, "get", "states")
       except HTTPError:
           x = None
   
       entities = []
   
       if x is not None:
           for entity in x:
               entities.append((entity["entity_id"], ''))
   
           return [c for c in entities if incomplete in c[0]]
       else:
           return entities
   

   this lets the autocompletion work but its unforunate I have to relist the defaults and env parameters here. would be so much nicer if there was a way click could pass the right context or i at least could call something to generate the proper config/context.

   thx!
8. diegoroccia commented on Oct 19, 2019

   

   diegoroccia

   on Oct 19, 2019 · Hidden as off-topic

   show commentMore actions
9. davidag commented on Oct 23, 2019

   

   davidag

   on Oct 23, 2019

   More actions

   I'm facing this issue too.

   For now, my workaround is to factor out the ctx.obj creation code and call it from both cli() and the corresponding autocomplete methods.

   # cli() function
   @click.group
   @click.pass_context
   def cli(ctx):
       ctx.obj = create_context_object()
   
   # example autocomplete function
   def get_completion(ctx, args, incomplete):
       if ctx.obj is None:
           ctx.obj = create_context_object()
10. davidism

    added

    shell completionShell tab completionShell tab completion

    on Feb 28, 2020
11. davidism

    added this to the 8.0.0 milestone on Oct 3, 2020
12. davidism

    closed this as completedin #1679on Oct 3, 2020
13. github-actions

    locked as resolved and limited conversation to collaborators on Nov 13, 2020