B 5d@@sdZddlmZddlmZddlmZddlZddlZddlZddlm Z ddl Z d dd Z d!d d Z d"d d Z d#ddZd$ddZddZd%ddZddZd&ddZddZddZdS)'z?Provides tab completion functionality for CLIs built with Fire.)absolute_import)division)print_functionN) inspectutilsbashcCs(|dkrt|t||St|t||S)NZfish) _FishScript _Commands _BashScript)name componentdefault_optionsshellr3/tmp/pip-unpacked-wheel-1kz5bvl4/fire/completion.pyScriptsrc s|pt}t||\}}}d}d}d}ddfdd} g} t} | | t|} | t|} xH| D]@} | | jdt|| || d } | |j| | d q~Wd | }|j|d }|j|d| d d dd ddd|dS)aXReturns a Bash script registering a completion function for the commands. Args: name: The first token in the commands, also the name of the command. commands: A list of all possible commands that tab completion can complete to. Each command is a list or tuple of the string tokens that make up that command. default_options: A dict of options that can be used with any command. Use this if there are flags that can always be appended to a command. Returns: A string which is the Bash script. Source the bash script to enable tab completion in Bash. a# bash completion support for {name} # DO NOT EDIT. # This script is autogenerated by fire/completion.py. _complete-{identifier}() {{ local cur prev opts lastcommand COMPREPLY=() prev="${{COMP_WORDS[COMP_CWORD-1]}}" cur="${{COMP_WORDS[COMP_CWORD]}}" lastcommand=$(get_lastcommand) opts="{default_options}" GLOBAL_OPTIONS="{global_options}" {checks} COMPREPLY=( $(compgen -W "${{opts}}" -- ${{cur}}) ) return 0 }} get_lastcommand() {{ local lastcommand i lastcommand= for ((i=0; i < ${{#COMP_WORDS[@]}}; ++i)); do if [[ ${{COMP_WORDS[i]}} != -* ]] && [[ -n ${{COMP_WORDS[i]}} ]] && [[ ${{COMP_WORDS[i]}} != $cur ]]; then lastcommand=${{COMP_WORDS[i]}} fi done echo $lastcommand }} filter_options() {{ local opts opts="" for opt in "$@" do if ! option_already_entered $opt; then opts="$opts $opt" fi done echo $opts }} option_already_entered() {{ local opt for opt in ${{COMP_WORDS[@]:0:COMP_CWORD}} do if [ $1 == $opt ]; then return 0 fi done return 1 }} is_prev_global() {{ local opt for opt in $GLOBAL_OPTIONS do if [ $opt == $prev ]; then return 0 fi done return 1 }} complete -F _complete-{identifier} {command} z; case "${{lastcommand}}" in {lastcommand_checks} esaczQ {command}) {opts_assignment} opts=$(filter_options $opts) ;;z if is_prev_global; then opts="${{GLOBAL_OPTIONS}}" else opts="{options} ${{GLOBAL_OPTIONS}}" fiz, opts="{options} ${{GLOBAL_OPTIONS}}" cs|kr SSdS)Nr)command)r %opts_assignment_main_command_template#opts_assignment_subcommand_templaterr_GetOptsAssignmentTemplatesz/_BashScript.._GetOptsAssignmentTemplate )options)ropts_assignment )lastcommand_checks/.,)r rchecksr identifierglobal_options) set_GetMapsaddunionkeysformatjoinsortedappendreplace)r commandsr r options_mapsubcommands_mapZbash_completion_templateZ check_wrapperZlastcommand_check_templaterlinesZ commands_setrrrrr)r rrrr #s@ N   r c Cs|pt}t|||\}}}d}d}d}d} xt|t|D]n} x$|| D]} ||j|| | d7}qVWxB|| |D]0} | |k} ||j|| | r| nd| dd7}qWqHW|jd d d |Dd S) aXReturns a Fish script registering a completion function for the commands. Args: name: The first token in the commands, also the name of the command. commands: A list of all possible commands that tab completion can complete to. Each command is a list or tuple of the string tokens that make up that command. default_options: A dict of options that can be used with any command. Use this if there are flags that can always be appended to a command. Returns: A string which is the Fish script. Source the fish script to enable tab completion in Fish. aLfunction __fish_using_command set cmd (commandline -opc) for i in (seq (count $cmd) 1) switch $cmd[$i] case "-*" case "*" if [ $cmd[$i] = $argv[1] ] return 0 else return 1 end end end return 1 end function __option_entered_check set cmd (commandline -opc) for i in (seq (count $cmd)) switch $cmd[$i] case "-*" if [ $cmd[$i] = $argv[1] ] return 1 end end end return 0 end function __is_prev_global set cmd (commandline -opc) set global_options {global_options} set prev (count $cmd) for opt in $global_options if [ "--$opt" = $cmd[$prev] ] echo $prev return 0 end end return 1 end zJcomplete -c {name} -n '__fish_using_command {command}' -f -a {subcommand} z}complete -c {name} -n '__fish_using_command {command};{prev_global_check} and __option_entered_check --{option}' -l {option} z and __is_prev_global;)r r subcommandrz--)r rprev_global_checkoptionrcss|]}dj|dVqdS)z "{option}")r1N)r&).0r1rrr sz_FishScript..)r )r!r"r%r$r&lstripr')r r+r r r,r-Z fish_sourceZsubcommand_templateZ flag_templater0rr/r1Z check_neededrrrrs0 .  rFcCs$t|tjr|drdS|r"dS|tks:|tks:|tkr>dSt|ttrVtjrVdSt |rl|tkrldSt |r|dkrt |pi}||}|r|jdkrdSttdtd}t|j|rdStjrt |r|dkrdStjrt |r|dkrdSt|tjr |d  SdS) aReturns whether a member should be included in auto-completion or help. Determines whether a member of an object with the specified name should be included in auto-completion or help text(both usage and detailed help). If the member name starts with '__', it will always be excluded. If it starts with only one '_', it will be included for all non-string types. If verbose is True, the members, including the private members, are included. When not in verbose mode, some modules and functions are excluded as well. Args: component: The component containing the member. name: The name of the member. member: The member itself. class_attrs: (optional) If component is a class, provide this as: inspectutils.GetClassAttrsDict(component). If not provided, it will be computed. verbose: Whether to include private members. Returns A boolean value indicating whether the member should be included. __FTN)methodpropertyZ _tuplegetter)Z func_closure func_codeZ func_defaultsZ func_dictZfunc_docZ func_globals func_name)Zim_classZim_funcZim_self_) isinstancesix string_types startswithrrrtypePY34inspectismoduleisclassrGetClassAttrsDictgetkindgetattr collectionsobjectPY2 isfunctionismethod)r r member class_attrsverboseZ class_attrZ tuplegetterrrr MemberVisible s>      rPcsFttr}n t}dkr0tfdd|DS)aReturns a list of the members of the given component. If verbose is True, then members starting with _ (normally ignored) are included. Args: component: The component whose members to list. class_attrs: (optional) If component is a class, you may provide this as: inspectutils.GetClassAttrsDict(component). If not provided, it will be computed. If provided, this determines how class members will be treated for visibility. In particular, methods are generally hidden for non-instantiated classes, but if you wish them to be shown (e.g. for completion scripts) then pass in a different class_attr for them. verbose: Whether to include private members. Returns: A list of tuples (member_name, member) of all members of the component. Nc s*g|]"\}}t||dr||fqS))rNrO)rP)r2 member_namerM)rNr rOrr zs z"VisibleMembers..)r;dictitemsrA getmembersrrD)r rNrOmembersr)rNr rOrVisibleMembers_s     rWcCs4g}x*|D]"}|dd}|dj|dq W|S)zTakes a list of fn args and returns a list of the fn's completion strings. Args: fn_args: A list of the args accepted by a function. Returns: A list of possible completion strings for that function. r:-z--{arg})arg)r*r)r&)Zfn_argsZ completionsrYrrr_CompletionsFromArgss   rZcCsvt|st|r.t|}t|j|jSt|t t frRddt t |DSt |r`gSddt||dDS)aGives possible Fire command completions for the component. A completion is a string that can be appended to a command to continue that command. These are used for TAB-completions in Bash for Fire CLIs. Args: component: The component whose completions to list. verbose: Whether to include all completions, even private members. Returns: A list of completions for a command that would so far return the component. cSsg|] }t|qSr)str)r2indexrrrrRszCompletions..cSsg|]\}}t|qSr)_FormatForCommand)r2rQr:rrrrRs)rO)rA isroutinerCrZGetFullArgSpecrZargs kwonlyargsr;tuplelistrangelen isgeneratorrW)r rOspecrrr Completionss   rgcCs.t|tjst|}|dr"|S|ddS)aReplaces underscores with hyphens, unless the token starts with a token. This is because we typically prefer hyphens to underscores at the command line, but we reserve hyphens at the start of a token for flags. This becomes relevant when --verbose is activated, so that things like __str__ don't get transformed into --str--, which would get confused for a flag. Args: token: The token to transform. Returns: The transformed token. r:rX)r;r<r=r[r>r*)tokenrrrr]s  r]ccst|st|r2xt|ddD] }|fVq"Wt|r@dS|dkrLdSxNt|iddD]<\}}t|}|fVx"t||dD]}|f|VqWq\WdS)a Yields tuples representing commands. To use the command from Python, insert '.' between each element of the tuple. To use the command from the command line, insert ' ' between each element of the tuple. Args: component: The component considered to be the root of the yielded commands. depth: The maximum depth with which to traverse the member DAG for commands. Yields: Tuples, each tuple representing one possible command for this CLI. Only traverses the member DAG up to a depth of depth. F)rON)rNrO)rAr^rCrgrWr]r)r depth completionrQrMrrrrrs  rcCs |dS)NrX)r>)rYrrr _IsOptionsrmc st}tfdd}tt}x|D]}t|dkrlt|drX||dq|||dq,|r,|d}t|d}t|r|} n|} | ||| |dd|q,W|||fS) aReturns sets of subcommands and options for each command. Args: name: The first token in the commands, also the name of the command. commands: A list of all possible commands that tab completion can complete to. Each command is a list or tuple of the string tokens that make up that command. default_options: A dict of options that can be used with any command. Use this if there are flags that can always be appended to a command. Returns: global_options: A set of all options of the first token of the command. subcommands_map: A dict storing set of subcommands for each command/subcommand. options_map: A dict storing set of options for each subcommand. cs tS)N)copyr)r rrz_GetMaps..rjrr:rX) rnrH defaultdictr!rdrmr#r]r*) r r+r r r,r-rr/rYZargs_mapr)r rr"s"      r")Nr)N)N)NF)NF)F)ri)__doc__ __future__rrrrHrnrAZfirerr<rr rrPrWrZrgr]rrmr"rrrrs(       ` ? !  #