o @s<dZddlmZddlmZddlmZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z dd l m Z dd l mZdd l mZdd l mZdd l mZddl mZddl mZddlmZddlmZddlmZddlmZddlZGdddeZGdddeZGdddeZGdddeZ dS)zGBackend stuff for the calliope.cli module. Not to be used by mortals. )absolute_import)division)unicode_literalsN)actions) arg_parsers)base)command_loading)display) exceptions)parser_arguments) parser_errors)parser_extensions) usage_text)handlers)log)metrics)textc@s*eZdZdZd ddZddZddZdS) _Notesz$Auto-generated NOTES section helper.NcCs.g|_|r|j|d|_dSd|_dS)NTF)_notesappendrstrip _paragraph)selfexplicit_notesr|s |durdSn |jrd|_|jd|j|dS)z7Adds a note line with preceding separator if not empty.NF)rrrr)rlinerrrAddLine:s z_Notes.AddLinecCs|jr d|jSdS)z.Returns the notes contents as a single string. N)rjoinrrrr GetContentsDsz_Notes.GetContentsN)__name__ __module__ __qualname____doc__rrr#rrrrr/s   rc@seZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZd9ddZddZddZdd Zd:d"d#Z d;d$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd CommandCommonzA base class for CommandGroup and Command. It is responsible for extracting arguments from the modules and does argument validation, since this is always the same for groups and commands. c Cs@|j|_||_|d|_|jdd|_td||j|d<||_d||_ ||_ ||_ ||j _ ||j _ t dd|jD|_|r|rKd|j _|rY|j jd urYd|j _|rc|j jd urgd |j _|rod|j _|rt|D] \}} |j j|| dd qzt|j d i|_||j j|j ||d d S)aCreate a new CommandCommon. Args: common_type: base._Common, The actual loaded user written command or group class. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. release_track: base.ReleaseTrack, The release track (ga, beta, alpha, preview) that this command group is in. This will apply to all commands under it. cli_generator: cli.CLILoader, The builder used to generate this CLI. parser_group: argparse.Parser, The parser that this command or group will live in. allow_positional_args: bool, True if this command can have positional arguments. parent_group: CommandGroup, The parent of this command or group. None if at the root. _-zLoaded Command Group: %s.cSsg|]}|tjkqSr)rGroup).0trrr z*CommandCommon.__init__..TNF)preserve_existing detailed_help) parser_groupallow_positional_args)!category _parent_groupnamereplacecli_namerdebug_pathr! dotted_name_cli_generator _common_type_release_trackany__mro__is_groupIsHidden _is_hiddenIsUniverseCompatible_universe_compatibleIsDefaultUniverseCompatible_default_universe_compatibleIsUnicodeSupported_is_unicode_supportedNoticessix iteritems AddNoticegetattrr4_ExtractHelpStringsr( _AssignParser) r common_typepath release_track cli_generatorr5r6 parent_grouptagmsgrrrrPsD       zCommandCommon.__init__cC |jS)z*Gets the notices of this command or group.)r@rMr"rrrrM zCommandCommon.NoticescCr[)z0Gets the release track of this command or group.)r@ ReleaseTrackr"rrrr]r\zCommandCommon.ReleaseTrackcCr[)z0Gets the hidden status of this command or group.)r@rEr"rrrrEr\zCommandCommon.IsHiddencCr[)z8Gets the auto generated status of this command or group.)r@IsAutoGeneratedr"rrrr^r\zCommandCommon.IsAutoGeneratedcCr[)z=Gets the universe compatible status of this command or group.)r@rGr"rrrrGr\z"CommandCommon.IsUniverseCompatiblecCr[)zEGets the default universe compatible status of this command or group.)r@rIr"rrrrIr\z)CommandCommon.IsDefaultUniverseCompatiblecCr[)z;Gets the unicode supported status of this command or group.)r@rKr"rrrrKr\z CommandCommon.IsUnicodeSupportedcCs|j S)z9Returns True if this is the root element in the CLI tree.)r8r"rrrIsRootszCommandCommon.IsRootcCs|r|S|jS)zGets the top group of this CLI.)r_r8_TopCLIElementr"rrrr`s zCommandCommon._TopCLIElementcst|\|_|_d|jvrtdd|jd|_|jr+|jds+|jd7_| rmdd t | d}|j d}|rVt|j|_|t||jd<|j|jkrd|j|7_n |j||j|_|j|_t|jdkr|jdr|jds|jd|jdd |_|jd dkr|jd d |_g}|jr|| r|t | |rd |dfd d }||j|_|jd s||j|_|j d}|rtd|s t|j|_|t||jd<d Sd Sd Sd S)a Extracts short help, long help and man page index from a docstring. Sets self.short_help, self.long_help and self.index_help and adds release track tags if needed. Args: docstring: The docstring from which short and long help are to be taken briefz\s r-z DESCRIPTIONrNr*cstdd|S)Nz^(\s*)z\1)resub)txtrYrr _InsertTagsz5CommandCommon._ExtractHelpStrings.._InsertTag#z^[ \n]*\{(description|index)\})rExtractHelpStrings short_help long_helpr4rerfstripendswithrMr!sortedvaluesgetdicttextwrapdedent index_helplenisupperlowerr]help_tagrextendkeys startswithmatch)r docstring all_notices descriptiontagsrirrhrrRsZ             z!CommandCommon._ExtractHelpStringsNc Cs|s|jd}t|}|r|d||j|}|rH|dt t |dd|d|D]}|d||dq9| S)z;Returns the NOTES section with explicit and generated help.NOTESz]This command is an internal implementation detail and may change or disappear without notice.z{} also available:zThis variant iszThese variants arerz $ ) r4rrrrErr] help_note#GetExistingAlternativeReleaseTracksformatr Pluralizerwr#)rcontentsnotes alternates alternaterrrGetNotesHelpSection s,    z!CommandCommon.GetNotesHelpSectionc Cs|stj|jd|j|d|_n|j|j|j|jd|j|d|_d|_t j |j| |j |d|_ |j j dt|dtjdd |j j d t|d dtjd d |j j d t|dd dtddd|dS)a!Assign a parser group to model this Command or CommandGroup. Args: parser_group: argparse._ArgumentGroup, the group that will model this command or group's arguments. allow_positional_args: bool, Whether to allow positional args for this group or not. F)radd_helpprogcalliope_command)helprrrrN)parser is_globalrWallow_positionalz-hTzPrint a summary help and exit.)action is_replicatedr7rz--helpzDisplay detailed help.z --documentrd ATTRIBUTESzTHIS TEXT SHOULD BE HIDDEN)rrnargsmetavartypehiddenr)r ArgumentParserrmr>_parser add_parserr;rl _sub_parserr ArgumentInterceptorr?ai add_argumentrShortHelpActionrCOMMONLY_USED_FLAGSRenderDocumentActionrArgDict _AcquireArgs)rr5r6rrrrS$s^      zCommandCommon._AssignParsercCs&|}|D] }||}|sdSqdS)a.Determines if the given sub command path is valid from this node. Args: command_path: [str], The pieces of the command path. Returns: True, if the given path parts exist under this command or group node. False, if the sub path does not lead to a valid command or group. FTLoadSubElement)r command_pathcurrentpartrrrIsValidSubPathes  zCommandCommon.IsValidSubPathcCsgSzGets all the sub elements of this group. Returns: set(str), The names of all sub groups or commands under this group. rr"rrrAllSubElementsvszCommandCommon.AllSubElementsFcCdS)Load all the sub groups and commands of this group. Args: recursive: bool, True to continue loading all sub groups, False, to just load the elements under the group. ignore_load_errors: bool, True to ignore command load failures. This should only be used when it is not critical that all data is returned, like for optimizations like static tab completion. Returns: int, The total number of elements loaded. rr)r recursiveignore_load_errorsrrrLoadAllSubElementss z CommandCommon.LoadAllSubElementscCr)Load a specific sub group or command. Args: name: str, The name of the element to load. allow_empty: bool, True to allow creating this group as empty to start with. release_track_override: base.ReleaseTrack, Load the given sub-element under the given track instead of that of the parent. This should only be used when specifically creating the top level release track groups. Returns: _CommandCommon, The loaded sub element, or None if it did not exist. Nr)rr9 allow_emptyrelease_track_overriderrrrszCommandCommon.LoadSubElementcCs*|}|D]}||}|durdSq|S)aLoad a specific sub group or command by path. If path is empty, returns the current element. Args: path: list of str, The names of the elements to load down the hierarchy. Returns: _CommandCommon, The loaded sub element, or None if it did not exist. Nr)rrUcurrrrrrLoadSubElementByPaths  z"CommandCommon.LoadSubElementByPathcCs|jSr$)r=r"rrrGetPathszCommandCommon.GetPathcCst||jSr$)rGetUsagerr"rrrrszCommandCommon.GetUsagecCiSr$rr"rrrGetSubCommandHelpsz CommandCommon.GetSubCommandHelpscCrr$rr"rrrGetSubGroupHelpsrzCommandCommon.GetSubGroupHelpsc Cs2|j|j|j|j|jr|jjjD] }|jj|q|jjjr[|jjs1|jt |jjjj D]#}z |jjj di|Wq7t j yZtdj|j|ddw|jD]*}|jrfq`|jrjq`|jrnq`z|j|Wq`tjytdj|j|jdw|jj|jjjdSdS)z>Calls the functions to register the arguments for this module.z-repeated concept in {command}: {concept_name}r9)command concept_namez"repeated flag in {command}: {flag})rflagNr)r@_FlagsrArgsr8 argumentsrconcept_handler add_conceptsrRuntimeHandler _all_concepts AddConceptRepeatedConceptNamer ArgumentExceptionrr>GetAllAvailableFlagsrdo_not_propagate is_requiredAddFlagActionFromAncestorsargparse ArgumentErroroption_strings display_infoAddLowerDisplayInfo)rargconcept_detailsrrrrrsR  zCommandCommon._AcquireArgsTcs0|jj|jj}rr|Sfdd|DS)Ncs$g|]}s |jss|js|qSr)r is_hiddenr/finclude_globalinclude_hiddenrrr1sz6CommandCommon.GetAllAvailableFlags..)r flag_argsancestor_flag_args)rrrflagsrrrrs  z"CommandCommon.GetAllAvailableFlagscCs|jj}|r|Sdd|DS)NcSsg|]}|js|qSr)rrrrrr1 r2z2CommandCommon.GetSpecificFlags..)rr)rrrrrrGetSpecificFlagsszCommandCommon.GetSpecificFlagsc Csg}|}|r |||j|}|r@|}tt|dddD]\}}||dd}|r?| s?|d |q$|S)zGets the names for the command in other release tracks. Args: value: str, Optional value being parsed after the command. Returns: [str]: The names for the command in other release tracks. cSs|djpdS)Nrr)prefix)xrrrszCCommandCommon.GetExistingAlternativeReleaseTracks..)keyrdNrb) rrr?%ReplicateCommandPathForAllOtherTracksr`rprNrOrrEr!) rvalueexisting_alternativesrUr top_elementr+ralternative_cmdrrrr s    z1CommandCommon.GetExistingAlternativeReleaseTracksr$FFFN)TT)T)r%r&r'r(rrMr]rEr^rGrIrKr_r`rRrrSrrrrrrrrrrrrrrrrrr)Is:O DA   7 r)cseZdZdZ  d$fdd ZddZdd Zd d Zd d ZddZ d%ddZ d&ddZ ddZ ddZ ddZddZddZddZd d!Zd"d#ZZS)' CommandGroupz+A class to encapsulate a group of commands.NFc  stj||||dd} tt|j| |||d||d||_i|_i|_i|_i|_ t |_ t ||\} } | | |j| |j | d|j} |j| g} | D]\}}}|rd|g|j |<qV|g|j|<qV|s|js|j st|std|j|dS)aCreate a new command group. Args: impl_paths: [str], A list of file paths to the command implementation for this group. path: [str], A list of group names that got us down to this command group with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. release_track: base.ReleaseTrack, The release track (ga, beta, alpha, preview) that this command group is in. This will apply to all commands under it. construction_id: str, A unique identifier for the CLILoader that is being constructed. cli_generator: cli.CLILoader, The builder used to generate this CLI. parser_group: the current argparse parser, or None if this is the root command group. The root command group will allocate the initial top level argparse parser. parent_group: CommandGroup, The parent of this group. None if at the root. allow_empty: bool, True to allow creating this group as empty to start with. Raises: LayoutException: if the module has no sub groups or commands F) is_commandrUrVrWr6r5rXr-z&Group {0} has no subgroups or commandsN)rLoadCommonTypesuperrr_construction_idgroupscommands_groups_to_load_commands_to_loadset_unloadable_elementsFindSubElements!_RemoveInitExtensionsFileIfNeededupdater!r=r?GetModulesByParentrrrB_GetMappedSubmodulesLayoutExceptionrr> SubParser)r impl_pathsrUrVconstruction_idrWr5rXrrT group_infos command_infos group_name added_modules module_namemodule_is_commandmodule_impl_path __class__rrr*sX$           zCommandGroup.__init__ccsXd|jdt|jddd}|jD]}|d|dr)|VqdS)z z5CommandGroup.CopyAllSubElementsTo..crrrrrrrrrN)rrrNrOr)r other_grouprrrrCopyAllSubElementsTos    z!CommandGroup.CopyAllSubElementsTocCs |js |jjtj|d|_|jS)zGets or creates the argparse sub parser for this group. Returns: The argparse subparser that children of this group should register with. If a sub parser has not been allocated, it is created now. )rr)rradd_subparsersr CommandGroupActionr"rrrrs zCommandGroup.SubParsercCst|jt|jBSr)rrr|rr"rrrrszCommandGroup.AllSubElementscCst||S)zDetermines if the given name is a valid sub group or command. Args: name: str, The name of the possible sub element. Returns: bool, True if the name is a valid sub element of this group. )r r)rr9rrrIsValidSubElements zCommandGroup.IsValidSubElementcCsfd}|D]*}z ||}|d7}Wnd}|s"td|Y|r0|r0||j||d7}q|S)rrrdNzError loading element %s)rr)rrrwarningr)rrrtotalr9elementrrrrs"    zCommandGroup.LoadAllSubElementsc Cs.|dd}|j|d}|s|j|d}|r|S||jvr!dSd}zT||jvrMt|j||j|g|p8||j |j | ||d}||j|j <W|S||j vrut|j ||j|g|pa||j |j | |d}||j|j <W|SW|Stjy}z|j|t|WYd}~|Sd}~ww)rr,r+N)rXr)rX)r:rrrrrrrr=r]rr?rr9rCommandr#ReleaseTrackNotImplementedExceptionaddrr<)rr9rrexistingrerrrrsV           zCommandGroup.LoadSubElementcCtdd|jDS)Ncss.|]}|jtj|j||jdfVqdS) help_textrrVNr;rHelpInforlrEr]r/itemrrr s  z2CommandGroup.GetSubCommandHelps..)rsrrqr"rrrr zCommandGroup.GetSubCommandHelpscCr!)Ncss0|]}|jtj|j||dfVqdSr"r$r&rrrr($s  z0CommandGroup.GetSubGroupHelps..)rsrrqr"rrrr#r)zCommandGroup.GetSubGroupHelpscCs(|jr |j|||||dS)a,Constructs and runs the Filter() method of all parent groups. This recurses up to the root group and then constructs each group and runs its Filter() method down the tree. Args: context: {}, The context dictionary that Filter() can modify. args: The argparse namespace. N)r8RunGroupFilterr@Filter)rcontextargsrrrr*0s zCommandGroup.RunGroupFiltercCst||Sr$)rGetCategoricalUsage_GroupSubElementsByCategoryr"rrrr.>sz CommandGroup.GetCategoricalUsagecC t|Sr$)rGetUncategorizedUsager"rrrr1C z"CommandGroup.GetUncategorizedUsagecCr0r$)r GetHelpHintr"rrrr3Fr2zCommandGroup.GetHelpHintcCs4dd}|i}||j|d<||j|d<|S)zCReturns dictionary mapping each category to its set of subelements.cSsLtt}|D]}|s#|jr||j|q |tj|q |S)z4Returns dictionary mapping specific to element type.) collections defaultdictrrqrEr7rrUNCATEGORIZED_CATEGORY)elementscategorized_dictrrrr%_GroupSubElementsOfSameTypeByCategoryLs  zWCommandGroup._GroupSubElementsByCategory.._GroupSubElementsOfSameTypeByCategoryr command_group)rrr)rr9 categoriesrrrr/Is z(CommandGroup._GroupSubElementsByCategorycCsd}||vr ||dSdS)aRemoves _init_extensions.py file from command_infos dict if present. It prevents loading _init_extensions.py as a command file. This additional file is used by CLI Autogen to extend the functionality of an __init__.py file by allowing to add no-auto-generated custom code. Args: command_infos: dict, A dictionary of command names to a list of file paths that implement that command. _init_extensionsN)pop)rrinit_extensions_filerrrr`s z.CommandGroup._RemoveInitExtensionsFileIfNeeded)NFrr)r%r&r'r(rrrrrrrrrrr*r.r1r3r/r __classcell__rrrrr's* V   9  rcs,eZdZdZ dfdd ZddZZS)rzAA class that encapsulates the configuration for a single command.Nc sLtj||||d|jd}tt|j||||d||d|jj||jddS)amCreate a new command. Args: impl_paths: [str], A list of file paths to the command implementation for this command. path: [str], A list of group names that got us down to this command with respect to the CLI itself. This path should be used for things like error reporting when a specific element in the tree needs to be referenced. release_track: base.ReleaseTrack, The release track (ga, beta, alpha, preview) that this command group is in. This will apply to all commands under it. construction_id: str, A unique identifier for the CLILoader that is being constructed. cli_generator: cli.CLILoader, The builder used to generate this CLI. parser_group: argparse.Parser, The parser to be used for this command. parent_group: CommandGroup, The parent of this command. T)ryaml_command_translatorr)rrN) rrr@rrrr set_defaultsr=) rrrUrVrrWr5rXrTrrrrss$  zCommand.__init__cCsti}|jr|j|||j||d}t|j|||}t j ||||j j d }t|jdkr@tj|jd|S)aRun this command with the given arguments. Args: cli: The cli.CLI object for this command line tool. args: The arguments for this command as a namespace. Returns: The object returned by the module's Run() function. Raises: exceptions.Error: if thrown by the Run() function. exceptions.ExitCodeNoError: if the command is returning with a non-zero exit code. )clir,)rr) exit_code)rLoadedr8r*r@r LogCommandr>Runr DisplayerrrDisplayRanrCr ExitCodeNoError)rrBr- tool_contextcommand_instance resourcesrrrrFs    z Command.Runr$)r%r&r'r(rrFr?rrrrrps  0r)!r( __future__rrrrr4rertgooglecloudsdk.callioperrrrr r r r r r googlecloudsdk.calliope.conceptsrgooglecloudsdk.corerrgooglecloudsdk.core.utilrrNobjectrr)rrrrrrs@                 aK