o k@sdZddlmZddlmZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl mZddl mZddl mZdd l mZdd l mZdd l mZdd l mZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddl!m"Z"ddl!m#Z#ddl!m$Z$ddl%Z%dZ&dZ'Gddde(Z)Gddde(Z*d3ddZ+d d!Z,Gd"d#d#e(Z-Gd$d%d%ej.Z/ej0e'de/d&d'd(Z1Gd)d*d*e(Z2Gd+d,d,e j3Z4d-d.Z5d3d/d0Z6Gd1d2d2e(Z7dS)4zDThe calliope CLI/API is a framework for building library interfaces.)absolute_import)division)unicode_literalsN)actions)backend)base)command_loading) exceptions) parser_errors)parser_extensions) argv_utils)config)log)metrics) properties)yaml) named_configs) console_attr)encoding)files) pkg_resourcesz.pyz---flag-file-line-c@s eZdZdZddZddZdS) _FlagLocationz&--flags-file (file,line_col) location.cCs||_|jd|_dS)N) file_nameline)selfrline_colr8/tmp/google-cloud-sdk/lib/googlecloudsdk/calliope/cli.py__init__<sz_FlagLocation.__init__cCsd|j|jS)Nz{}:{})formatrrrrrr__str__@sz_FlagLocation.__str__N)__name__ __module__ __qualname____doc__rr"rrrrr9s rc@s*eZdZdZd ddZddZddZdS) _ArgLocationsz"--flags-file (arg,locations) info.NcCs4||_|r |jddng|_|jt||dSN)arg locationsappendr)rr)rrr*rrrrGsz_ArgLocations.__init__cCsddd|jDS)N;cSg|]}t|qSr)six text_type).0locationrrr Mz)_ArgLocations.__str__..)joinr*r!rrrr"Lsz_ArgLocations.__str__cstfdd|jDS)z4Returns True if file_name is in the locations stack.csg|]}|jkqSrr)r0xr5rrr2Qr3z-_ArgLocations.FileInStack..)anyr*)rrrr5r FileInStackOsz_ArgLocations.FileInStackr()r#r$r%r&rr"r8rrrrr'Ds   r'c Cstjj}|r||rtd|||dkrtj }nt j |s-td||t |}|s=td||tj|dd}t|trK|n|g}|D]}t|jtsftd||jjd|t|jD]i\}} | j} t| } ||krt| jtr| jn| jg} | D]} t||| |}t|| |qqlt| td tfrd }nt| ttfrd}nd }d || }|t|t||| ||||r|| qlqPd S) z2Recursively append the flags file flags to inject.z{} recursive reference ({}).-z{} [{}] not found.z{} [{}] is empty.T)location_valuezJ{}:{}: {} file must contain a dictionary or list of dictionaries of flags.rNFz{}={}) calliope_baseFLAGS_FILE_FLAGnamer8r ArgumentErrorr sysstdinreadospathexistsrReadFileContentsrload isinstancelistvaluedictlcrr. iteritemsstrip_locationsr'_AddFlagsFileFlagstypeboolr+_FLAG_FILE_LINE_NAME)inject flags_fileparent_locationsflagcontentsdatagroupmemberr)objrrI file_listrCr*separate_value_argrrrrNTs^            rNcstjjdtfdd|Ds|Sd}g}|D])}|r(d}t||q|kr/d}q|r@t||tdq||q|S)a Applies FLAGS_FILE_FLAG in args and returns the new args. The basic algorithm is arg list manipulation, done before ArgParse is called. This function reaps all FLAGS_FILE_FLAG args from the command line, and recursively from the flags files, and inserts them into a new args list by replacing the --flags-file=YAML-FILE flag by its constituent flags. This preserves the left-to-right precedence of the argument parser. Internal _FLAG_FILE_LINE_NAME flags are also inserted into args. This specifies the flags source file and line number for each flags file flag, and is used to construct actionable error messages. Args: args: The original args list. Returns: A new args list with all FLAGS_FILE_FLAG args replaced by their constituent flags. =csg|] }|kp |qSr startswithr0r)rUflag_eqrrr2sz#_ApplyFlagsFile..FTN)r;r<r=r7rNr_lenr+)argspeeknew_argsr)rrar_ApplyFlagsFiles    rgc@s"eZdZdZdddZddZdS)RunHookzEncapsulates a function to be run before or after command execution. The function should take **kwargs so that more things can be passed to the functions in the future. NcCs||_|r|nd|_||_dS)aNConstructs the hook. Args: func: function, The function to run. include_commands: str, A regex for the command paths to run. If not provided, the hook will be run for all commands. exclude_commands: str, A regex for the command paths to exclude. If not provided, nothing will be excluded. z.*N)_RunHook__func_RunHook__include_commands_RunHook__exclude_commands)rfuncinclude_commandsexclude_commandsrrrrs  zRunHook.__init__cCs:t|j|s dS|jrt|j|rdS|j|ddS)zRuns this hook if the filters match the given command. Args: command_path: str, The calliope command path for the command that was run. Returns: bool, True if the hook was run, False if it did not match. F) command_pathT)rematchrjrkrirrorrrRuns  z RunHook.RunNN)r#r$r%r&rrsrrrrrhs  rhc@seZdZdZdddZdS)_SetFlagsFileLinez$FLAG_INTERNAL_FLAG_FILE_LINE action.NcCs8t|dst|dtt|j|jt |dS)Nflags_locations) hasattrsetattr collections defaultdictsetrvr)addr.r/)rparser namespacevalues option_stringrrr__call__s z_SetFlagsFileLine.__call__r()r#r$r%r&rrrrrrusruTz;Internal *--flags-file* flag, line number, and source file.defaultactionhiddenhelpc@seZdZdZedZ   d!ddZeddZ d"d d Z d"d d Z d dZ ddZ d#ddZ d#ddZddZddZddZ d$ddZddZdd ZdS)% CLILoaderzBA class to encapsulate loading the CLI and bootstrapping the REPL.z(?:([\w\.]+)\.)?([^\.]+)FNcCsr||_||_|jstd||_|ptj|_||_ ||_ ||_ g|_ g|_ g|_tt|_i|_i|_dS)aInitialize Calliope. Args: name: str, The name of the top level command, used for nice error reporting. command_root_directory: str, The path to the directory containing the main CLI module. allow_non_existing_modules: True to allow extra module directories to not exist, False to raise an exception if a module does not exist. logs_dir: str, The path to the root directory to store logs in, or None for no log files. version_func: func, A function to call for a top-level -v and --version flag. If None, no flags will be available. known_error_handler: f(x)->None, A function to call when an known error is handled. It takes a single argument that is the exception. yaml_command_translator: YamlCommandTranslator, An instance of a translator that will be used to load commands written as a yaml spec. Raises: backend.LayoutException: If no command root directory is given. z*You must specify a command root directory.N)_CLILoader__name"_CLILoader__command_root_directoryrLayoutException&_CLILoader__allow_non_existing_modulesr Pathslogs_dir_CLILoader__logs_dir_CLILoader__version_func_CLILoader__known_error_handler#_CLILoader__yaml_command_translator_CLILoader__pre_run_hooks_CLILoader__post_run_hooks_CLILoader__modulesryrzrH_CLILoader__modules_by_parent_CLILoader__missing_components_CLILoader__release_tracks)rr=command_root_directoryallow_non_existing_modulesr version_funcknown_error_handleryaml_command_translatorrrrrs"  zCLILoader.__init__cC|jSr()rr!rrrr*z!CLILoader.yaml_command_translatorcCs |jstd||f|j|<dS)aAdds a release track to this CLI tool. A release track (like alpha, beta...) will appear as a subgroup under the main entry point of the tool. All groups and commands will be replicated under each registered release track. You can implement your commands to behave differently based on how they are called. Args: release_track: base.ReleaseTrack, The release track you are adding. path: str, The full path the directory containing the root of this group. component: str, The name of the component this release track is in, if you want calliope to auto install it for users. Raises: ValueError: If an invalid track is registered. zLYou may only register alternate release tracks that have a different prefix.N)prefix ValueErrorr)r release_trackrC componentrrrAddReleaseTrack.szCLILoader.AddReleaseTrackcCs|j|||fdS)aAdds a module to this CLI tool. If you are making a CLI that has subgroups, use this to add in more directories of commands. Args: name: str, The name of the group to create under the main CLI. If this is to be placed under another group, a dotted name can be used. path: str, The full path the directory containing the commands for this group. component: str, The name of the component this command module is in, if you want calliope to auto install it for users. N)rr+)rr=rCrrrr AddModuleDszCLILoader.AddModulecCr)z'Returns modules added to this CLI tool.)rr!rrr GetModulesTrzCLILoader.GetModulescCr)aReturns info about added modules (if any) for each parent command group. Returns: {str: [(str, bool, str)]}, Mapping of parent group to list of (module_name, module_is_command, module_impl_path) tuples for each additional module. )rr!rrrGetModulesByParentXszCLILoader.GetModulesByParentcCt|||}|j|dS)aRegister a function to be run before command execution. Args: func: function, The function to run. See RunHook for more details. include_commands: str, A regex for the command paths to run. If not provided, the hook will be run for all commands. exclude_commands: str, A regex for the command paths to exclude. If not provided, nothing will be excluded. N)rhrr+rrlrmrnhookrrrRegisterPreRunHookb zCLILoader.RegisterPreRunHookcCr)aRegister a function to be run after command execution. Args: func: function, The function to run. See RunHook for more details. include_commands: str, A regex for the command paths to run. If not provided, the hook will be run for all commands. exclude_commands: str, A regex for the command paths to exclude. If not provided, nothing will be excluded. N)rhrr+rrrrRegisterPostRunHookprzCLILoader.RegisterPostRunHookcs$d|fddt|jDS)zGets the components that need to be installed to run the given command. Args: command_path: [str], The path of the command being run. Returns: [str], The component names of the components that should be installed. .cs*g|]\}}|ks|dr|qS)rr^)r0rCr path_stringrrr2s z9CLILoader.ComponentsForMissingCommand..)r4r.rLrrrrrrComponentsForMissingCommand~s  z%CLILoader.ComponentsForMissingCommandcCst|dkrgStj|d}|r||jvrd}|d}|r%|ddn|dd}|s/gSt}|jD] }|g|jg|||<q5|rQ||=|g||tjj<|S)aFinds other release tracks this command could be in. The returned values are not necessarily guaranteed to exist because the commands could be disabled for that particular release track. It is up to the caller to determine if the commands actually exist before attempting use. Args: command_path: [str], The path of the command being run. Returns: {ReleaseTrack: [str]}, A mapping of release track to command path of other places this command could be found. rNr)rcr; ReleaseTrack FromPrefixrrJrGA)rrotrackrootsub_pathresultstrrr%ReplicateCommandPathForAllOtherTrackss  z/CLILoader.ReplicateCommandPathForAllOtherTracksc Cs|jD]}\}}}|t}|r|dtt }tj|}|dd\}}|j||j d}t j j g|j D]I} |rad|jg| jrF| jgng|rQ|ddgng} |j| |||fq6|rd|jg| jro| jgng|ddg} ||j| <q6q|j|jdd}t|g|jgt j j tj|d} || td d |j D} t|j D]6\} \}}|j||j d}|r|g| j | j<| j!| jd | d }| j"|| d q|r||j|jd| j<q|#| }|S)zoUses the registered information to generate the CLI tool. Returns: CLI, The generated CLI tool. Nrr)rr_r9Fcss|]}|jVqdSr()r)r0rrrr sz%CLILoader.Generate..T) allow_emptyrelease_track_override)ignore)$rendswith_COMMAND_SUFFIXrcrPATH_RErqrX&_CLILoader__ValidateCommandOrGroupInforr;rrrr4rrreplacerr+rrr CommandGroupuuiduuid4hex!_CLILoader__AddBuiltinGlobalFlagsr{keysr.rL_groups_to_loadLoadSubElementCopyAllSubElementsTo_CLILoader__MakeCLI)rmodule_dot_pathmodule_dir_pathr is_commandrqrcmd_or_grp_name impl_pathrparent_group_name group_name top_group track_names module_dir track_groupclirrrGeneratesl        zCLILoader.GeneratecCs8tj|\}}t||s|rdStd||S)aGenerates the information necessary to be able to load a command group. The group might actually be loaded now if it is the root of the SDK, or the information might be saved for later if it is to be lazy loaded. Args: impl_path: str, The file path to the command implementation for this command or group. allow_non_existing_modules: True to allow this module directory to not exist, False to raise an exception if this module does not exist. Raises: LayoutException: If the module directory does not exist and allow_non_existing is False. Returns: impl_path or None if the module directory does not exist and allow_non_existing is True. Nz.The given module directory does not exist: {0})rBrCsplitr IsImportablerrr )rrr module_rootmodulerrr__ValidateCommandOrGroupInfos z&CLILoader.__ValidateCommandOrGroupInfoc Csvtj|jtj|jtj|j|jdur+|jjdddtjt |jdd|jjddtjd t j d |jjd ttjtjd t tjjjd |jjddt tjjjdd|jjddt tjjjdd|jjddt tjjjddd|jjddt tjjjddd|jjdt tjjjddd|jjddt tjjjdddt|jdS)aGAdds in calliope builtin global flags. This needs to happen immediately after the top group is loaded and before any other groups are loaded. The flags must be present so when sub groups are loaded, the flags propagate down. Args: top_element: backend._CommandCommon, The root of the command tree. Nz-vz --versionTzTPrint version information and exit. This flag is only available at the global level.)do_not_propagatecategoryrrz--configuration CONFIGURATIONa+ File name of the configuration to use for this command invocation. For more information on how to use configurations, run: `gcloud topic configurations`. You can also use the {0} environment variable to set the equivalent of this flag for a terminal session.)metavarrrz --verbosityz0Override the default verbosity for this command.)choicesrrrrz--user-output-enabledz*Print user intended output to the console.)rrrz --log-httpz5Log all HTTP server requests and responses to stderr.z--authority-selectorzTHIS ARGUMENT NEEDS HELP TEXT.rz--authorization-token-filez--credential-file-override)rrrz--http-timeout)r;r< AddToParserai FLATTEN_FLAG FORMAT_FLAGr add_argumentCOMMONLY_USED_FLAGSrFunctionExitActionr r CLOUDSDK_ACTIVE_CONFIG_NAMErOrderedVerbosityNamesDEFAULT_VERBOSITY_STRING StorePropertyrVALUEScore verbosityStoreBooleanPropertyuser_output_enabledlog_httpauthauthority_selectorauthorization_token_filecredential_file_override http_timeoutFLAG_INTERNAL_FLAG_FILE_LINE)r top_elementrrr__AddBuiltinGlobalFlagss     z!CLILoader.__AddBuiltinGlobalFlagscCs~dtjvs dtjvr$t|jttjd}|r$tj|}t |t j j j r1|jddt|j||j|j|j}|S)zGenerate a CLI object from the given data. Args: top_element: The top element of the command tree (that extends backend.CommandCommon). Returns: CLI, The generated CLI tool. _ARGCOMPLETE_ARGCOMPLETE_TRACET) recursive)rBenvironrAddFileLoggingrrGetEncodedValueVALID_VERBOSITY_STRINGSget SetVerbosityrrrdisable_command_lazy_loadingGetBoolLoadAllSubElementsCLIrrrr)rrverbosity_stringrrrrr __MakeCLIos     zCLILoader.__MakeCLI)FNNNNr(rt)F)r#r$r%r&rpcompilerrpropertyrrrrrrrrrrrrrrrrrrs0  .     /=  Zrcs0eZdZdZfddZddZddZZS)_CompletionFinderzCalliope overrides for argcomplete.CompletionFinder. This makes calliope ArgumentInterceptor and actions objects visible to the argcomplete monkeypatcher. cs*|j}|j|_tt|}|r||_|Sr()_parserr}superr_patch_argument_parser)rractive_parsers __class__rrrs z(_CompletionFinder._patch_argument_parsercCsx|}t}d|_z|jj|dd|dWn ty"Ynwd|_||||dd}||}| |||S)NTr)r~FcWdSr(r)rrrrsz4_CompletionFinder._get_completions..) rr Namespace completingrparse_known_args BaseExceptioncollect_completionsfilter_completionsquote_completions)r comp_words cword_prefixcword_prequotelast_wordbreak_posr parsed_args completionsrrr_get_completionss    z"_CompletionFinder._get_completionsc sd}d}d}d}d}|srfdd|D}|} n |dkr!|} n|} ttjd |vr/d } n |d krt|ddrj|} t|dkrj|dd| vrj|sj|dd7<|S)aReturns the completion (less aggressively) quoted for the shell. If the word under the cursor started with a quote (as indicated by a nonempty ``cword_prequote``), escapes occurrences of that quote character in the completions, and adds the quote to the beginning of each completion. Otherwise, escapes *most* characters that bash splits words on (``COMP_WORDBREAKS``), and removes portions of completions before the first colon if (``COMP_WORDBREAKS``) contains a colon. If there is only one completion, and it doesn't end with a **continuation character** (``/``, ``:``, or ``=``), adds a space after the completion. Args: completions: The current completion strings. cword_prequote: The current quote character in progress, '' if none. last_wordbreak_pos: The index of the last wordbreak. Returns: The completions quoted for the shell. z\();<>|&$* `"'z\`"$\z=/:)tcshfishzshcsg|] }|ddqS)rNrr0c)r#rrr2z7_CompletionFinder.quote_completions.."_ARGCOMPLETE_SHELL'cSsg|]}|ddqS)r1z'\''rr+rrrr2scsg|] }|dqS)r'r2r+)charrrr2r- append_spaceFrr )rrrBrgetattrrc) rr%r"r#no_quote_specialdouble_quote_specialsingle_quote_specialcontinuation_specialno_escaping_shells special_charscontinuation_charsr)r3r#rrs: z#_CompletionFinder.quote_completions)r#r$r%r&rr&r __classcell__rrrrrs  rcKsdtjvrdSd}d}z5tjj}tjtj_dtjvr$tj}dd}|t_t}||fddi|W|r8|tj_|r?|t_dSdS|rG|tj_|rL|t_w)zARuns argcomplete.autocomplete on a calliope argument interceptor.rNrcSrr(rrrrr_DisableMuteStderr sz(_ArgComplete.._DisableMuteStderralways_complete_optionsF)rBr argcompleteargparserr mute_stderrr)rkwargsrDr~r@ completerrrr _ArgCompletes8    rGc Cs~|d}|dd}|jtjurt||j|z|j|}Wnty;|d|jf}td|}t||w| ||\}}|rZt | tj gt |tj |dSdS)z>argparse._SubParsersAction.__call__ version 1.2.1 MonkeyPatch.rrNz, zunknown parser %r (choices: %s))destrCSUPPRESSrx_name_parser_mapKeyErrorr4rr>rvars setdefault_UNRECOGNIZED_ARGS_ATTRr7extend) rr}r~rr parser_name arg_stringstupmsgrrr_SubParsersActionCalls"    rTc@sReZdZdZddZddZeddZedd Zd d Z dddZ ddZ d S)r zA generated command line tool.cCs*||_|j|_||_||_||_||_dSr() _CLI__namer _CLI__parser_CLI__top_element_CLI__pre_run_hooks_CLI__post_run_hooks_CLI__known_error_handler)rr=r pre_run_hookspost_run_hooksrrrrr?s  z CLI.__init__cCrr(rWr!rrr _TopElementIszCLI._TopElementcCrr()rUr!rrrr=LrzCLI.namecCrr(r]r!rrrrPrzCLI.top_elementcCs |j|S)zChecks if given command exists. Args: cmd: [str], The command path not including any arguments. Returns: True, if the given command exist, False otherwise. )rWIsValidSubPath)rcmdrrrIsValidCommandTs zCLI.IsValidCommandNTc sRt|tjr tdtjt_tjdkrttj _ |rt j j |s)tdd}tj|tjjdtjrCdd|Dn|}d}d}z>zʈjt|}|jdur^|j|}d|| |j!durw|j!"t#$d}t#%d}t&tj'dkrtjj(j)*tj+tjj(j)dj,D]}|-q|j-|d j.D]}|-qtt/j0rfd d }|WWtj1tj2|durt#$||durt#%|SSt(3t4j5WWtj1tj2|dur t#$||durt#%|SSt6j7yL} z)| j8WYd} ~ Wtj1tj2|dur.rr)rrdc 3sNz D]}|VqWdSty&}z|WYd}~dSd}~ww)zActivates generator exceptions.N) Exception_HandleAllErrors)resourceexccommand_path_string resourcesrspecified_arg_namesrr_YieldszCLI.Execute.._Yield);rGr. string_typesrr/rCstr __version__rT_SubParsersActionrrGrWrr GetDecodedArgvrFLAG_OVERRIDE_STACK PushFromArgsrrPushInvocationValuesrUPY2rV parse_argsrg CONCEPT_ARGS ParseConcepts _GetCommandr4GetPathGetSpecifiedArgNamesCONCEPTSResetrSetUserOutputEnabledrrcGetInvocationStackr command_nameSetSetInvocationValuerXrsrYtypes GeneratorTypePopInvocationValuesPopCommandsr CLOUD_SDK_VERSIONr DryRunErrorrequestrcrd) rrdcall_arg_completeargvold_user_output_enabled old_verbositycalliope_commandrrkrfrrgrExecute_s                                           z CLI.ExecutecCsdtjvrtjddkr|dt|ddi}tt|dddd}|dur(||d <tj|tj||j|d tj||j||d t |||j dS) a@Handle all errors. Args: exc: Exception, The exception that was raised. command_path_string: str, The '.' separated command path. specified_arg_names: [str], The specified arg named scrubbed for metrics. Raises: exc or a core.exceptions variant that does not produce a stack trace. CLOUDSDK_CORE_DRY_RUN1 error_code exit_coderpayloadN status_codehttp_status_code)errorerror_extra_info)r) rBrr7rrr rrErrorr HandleErrorrZ)rrfrhrjrrrrrrds"   zCLI._HandleAllErrors)NT) r#r$r%r&rr^rr=rrarrdrrrrr <s    zr r()8r& __future__rrrrCryrBrpr?rrrBgooglecloudsdk.callioperrrr;rr r r googlecloudsdk.corer r rrrr"googlecloudsdk.core.configurationsrgooglecloudsdk.core.consolergooglecloudsdk.core.utilrrrr.rrQobjectrr'rNrgrhActionruArgumentrrCompletionFinderrrGrTr rrrrsl                      ?*' m $