o tf@sdZddlmZddlmZddlmZddlZddlmZddlmZddlm Z dd l m Z d d Z d d Z ddZGdddeZGdddeZdS)zCalliope argparse argument intercepts and extensions. Refer to the calliope.parser_extensions module for a detailed overview. )absolute_import)division)unicode_literalsN)base) display_info) parser_errors)completion_cachecC*|dkpt|tjpt|tot|tjS)N store_true) isinstanceargparse_StoreTrueActiontype issubclassactionrE/tmp/google-cloud-sdk/lib/googlecloudsdk/calliope/parser_arguments.py_IsStoreTrueAction"    rcCr )N store_false)r r _StoreFalseActionrrrrrr_IsStoreFalseAction*rrcCst|pt|SN)rrrrrr_IsStoreBoolAction1rc@s:eZdZdZ    d ddZeddZed d ZdS) ArgumentaParsed argument base class with help generation attributess. Attributes: arguments: [ArgumentInterceptor], The group argument list if is_group is true. category: str, The argument help category name. help: str, The argument help text. is_global: bool, The argument is global to all commands. is_hidden: bool, The argument help text is hidden. is_group: bool, The argument is a group with arguments in self.arguments. is_mutex: bool, This is a mutex argument group; at most one argument in arguments may be specified. is_positional: bool, The argument is a positional argument. is_required: bool, The argument is required. sort_args: bool, Whether to sort the arguments in this group when displaying help/usage text. Applies only to this arg group (does not propagate to nested groups). disable_default_heading: bool, The default help heading text is hidden. NFTc CsN|pg|_|p||_||_||_||_d|_||_||_||_| |_ | |_ dS)NF) argumentsis_group is_global _is_hiddenis_mutex is_positional is_requiredhelpcategory _sort_argsdisable_default_heading) selfrhiddenrrmutexrequiredr$r% sort_argsr'rrr__init__Ks   zArgument.__init__cC|jSr)r r(rrr is_hidden[zArgument.is_hiddencCr.rr&r/rrrr,_r1zArgument.sort_args) NFFFFFNNTF)__name__ __module__ __qualname____doc__r-propertyr0r,rrrrr5s  rcsneZdZdZGdddeZ  dEfdd Zedd Zed d Z ed d Z eddZ eddZ eddZ eddZeddZeddZeddZeddZeddZed d!Zed"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-ZdFd.d/Z 0 dGfd1d2 ZdHd3d4ZdHd5d6Zd7d8Zd9d:Z d;d<Z!d=d>Z"d?d@Z#dAdBZ$dCdDZ%Z&S)IArgumentInterceptoradArgumentInterceptor intercepts calls to argparse parsers. The argparse module provides no public way to access the arguments that were specified on the command line. Argparse itself does the validation when it is run from the command line. Attributes: allow_positional: bool, Whether or not to allow positional arguments. defaults: {str:obj}, A dict of {dest: default} for all the arguments added. dests: [str], A list of the dests for all arguments. flag_args: [argparse.Action], A list of the flag arguments. parser: argparse.Parser, The parser whose methods are being intercepted. positional_args: [argparse.Action], A list of the positional arguments. required: [str], A list of the dests for all required arguments. Raises: ArgumentException: if a positional argument is made when allow_positional is false. c@seZdZdZddZdS)zArgumentInterceptor.ParserDataaParser data for the entire command. Attributes: allow_positional: bool, Allow positional arguments if True. ancestor_flag_args: [argparse.Action], The flags for all ancestor groups in the cli tree. cli_generator: cli.CLILoader, The builder used to generate this CLI. command_name: [str], The parts of the command name path. concept_handler: calliope.concepts.handlers.RuntimeHandler, a handler for concept args. defaults: {dest: default}, For all registered arguments. dests: [str], A list of the dests for all arguments. display_info: [display_info.DisplayInfo], The command display info object. flag_args: [ArgumentInterceptor], The flag arguments. positional_args: [ArgumentInterceptor], The positional args. positional_completers: {Completer}, The set of completers for positionals. required: [str], The dests for all required arguments. cCsX||_||_||_g|_d|_d|_i|_g|_t |_g|_ g|_ t |_ g|_dSr) command_name cli_generatorallow_positionalancestor_flag_argsconcept_handlerconceptsdefaultsdestsr DisplayInfo flag_argspositional_argssetpositional_completersr+)r(r9r:r;rrrr-s  z'ArgumentInterceptor.ParserData.__init__N)r3r4r5r6r-rrrr ParserDatays rFNTc srtt|jdddi||dd|_|dd|_||_|r#||_|r*||_dStj |jj ||d|_dS)NrTr*Fr$)r9r:r;r) superr8r-popr!r$parseraidatarF_calliope_commandGetPath)r(rIr:r;rKkwargs __class__rrr-s   zArgumentInterceptor.__init__cC|jjSr)rKr;r/rrrr;z$ArgumentInterceptor.allow_positionalcCrQr)rKr:r/rrrr:rRz!ArgumentInterceptor.cli_generatorcCrQr)rKr9r/rrrr9rRz ArgumentInterceptor.command_namecCrQr)rKr?r/rrrr?rRzArgumentInterceptor.defaultscCrQr)rKrr/rrrrrRz ArgumentInterceptor.display_infocCrQr)rKr+r/rrrr+rRzArgumentInterceptor.requiredcCrQr)rKr@r/rrrr@rRzArgumentInterceptor.destscCrQr)rKrCr/rrrrCrRz#ArgumentInterceptor.positional_argsc Cs||jrdSz tdd|jDWdSty=g}|jD] }t|dr*||j7}qtdd |j |j d |w) NTcss|]}|js|VqdSr)r0).0arrr sz0ArgumentInterceptor.is_hidden..Foption_stringszvGroups with arguments and subgroups that are all hidden should be marked hidden. Command: [{}] Group: [{}] Flags: [{}].z, ) r nextr StopIterationhasattrrVrArgumentExceptionformatjoinr9r$)r(flagsargrrrr0s$    zArgumentInterceptor.is_hiddencCrQr)rKrBr/rrrrBrRzArgumentInterceptor.flag_argscCrQr)rKrEr/rrrrErRz)ArgumentInterceptor.positional_completerscCrQr)rKr<r/rrrr<rRz&ArgumentInterceptor.ancestor_flag_argscCrQr)rKr=r/rrrr=rRz#ArgumentInterceptor.concept_handlercCrQr)rKr>r/rrrr>rRzArgumentInterceptor.conceptscCs@ddlm}t||jr||j_dS|jjrtd||j_dS)Nr)concept_managerszCIt is not permitted to add two runtime handlers to a command class.)#googlecloudsdk.command_lib.conceptsr`r RuntimeParserrKr>r=AttributeError)r(handlerr`rrr add_conceptss   z ArgumentInterceptor.add_conceptscOs|d}|dd}|dd}|d}|d}|s'||jjdd}|d d }|d d p5|j} |d } | sEtd || | t j krQtd||dd} |dd } |j pa| } |d}|dd }|dd}|duryg}|dd}|j r|t j krd}|d }|r|jstd|d|jjd|vrtd|d|jj|rtd|d|jj|rtd|d|jj||j|<|r|j||j||rd|vr||d<|dt jur|jj|i|}n |jj|i|}||||| |_| |_ d |_| |_ ||_!||_"| r3|j#|_$t j |_#|rf|rGtd|d|jj|dus\|dks\t%|t&r_|dkr_d|_!|j'|nw|rz|rztd|d|jj|dkrtd |d|jj||_(||_)| |_*||_+t%|j,t-rt.|d!|j,t/|j,0|_,|durt.|d||j1||2||||}|r||_(||_)| |_*| |_ |j1|t3|dd rt4|jd"kr|j5||S)#z?add_argument intercepts calls to the parser to track arguments.rr%N completerdefaultdest-_do_not_propagateFr)r$z*Argument {} requires help text [hidden={}]z@Argument {} needs hidden=True instead of help=argparse.SUPPRESS.require_coverage_in_testsT is_replicatednargsr+suggestion_aliaseshidden_choicesGLOBALz3Illegal positional argument [{0}] for command [{1}]rWzSPositional arguments cannot contain a '-'. Illegal argument [{0}] for command [{1}]zAPositional argument [{0}] cannot have a category in command [{1}]zIPositional argument [{0}] cannot have suggestion aliases in command [{1}]metavar+z;Required flag [{0}] cannot have a category in command [{1}]REQUIREDz;Flag [{0}] cannot have category='REQUIRED' in command [{1}] choices_help)6rHgetlstriprI prefix_charsreplacer ValueErrorr\r SUPPRESSrrCOMMONLY_USED_FLAGS startswithr;rr[r]rKr9r?r+appendr@upper REMAINDERAddRemainderArgument add_argument_AttachCompleterrlrr0r#r"r$ hidden_helpr intrCr%rkrmrochoicesdictsetattrsortedkeysrB"_AddInvertedBooleanFlagIfNecessarygetattrlenr)r(argsrNnamer%rfrgrhrkr) help_textrlrmrrnr+rorp positionaladded_argument inverted_flagrrrr s                              z ArgumentInterceptor.add_argumentcCs|j|||Sr)rIregister)r( registry_namevalueobjectrrrrrzArgumentInterceptor.registercKs|jjdi|S)Nr)rI set_defaults)r(rNrrrrsz ArgumentInterceptor.set_defaultscCs |j|Sr)rI get_default)r(rhrrrrs zArgumentInterceptor.get_defaultcCs|jj||dS)z;Hooks ArgumentInterceptor into the argcomplete monkeypatch.)r namespace)rIparse_known_args)r(rrrrrrsz$ArgumentInterceptor.parse_known_argsFc  std|vsd|vr tdtt|j|j}td||j|j|j |j |||||p+|j |d |} |j | | S)aAdds an argument group with mutex/required attributes to the parser. Args: help: str, The group help text description. category: str, The group flag category name, None for no category. mutex: bool, A mutually exclusive group if True. required: bool, A required group if True. hidden: bool, A hidden group if True. sort_args: bool, Whether to sort the group's arguments in help/usage text. NOTE - For ordering consistency across gcloud, generally prefer using argument categories to organize information (instead of unsetting the argument sorting). **kwargs: Passed verbatim to ArgumentInterceptor(). Returns: The added argument object. descriptiontitlezVparser.add_group(): description or title kwargs not supported -- use help=... instead.) rIrr:r;rKr$r%r*r+r)r,Nr)rr[rGrrIadd_argument_groupr8rr:r;rKr rr) r(r$r%r*r+r)r,rN new_parsergrouprOrr add_groups*  zArgumentInterceptor.add_groupcKs|jdd|i|S)Nr$rrr(r$rNrrrrsz&ArgumentInterceptor.add_argument_groupcKs|jd|dd|S)NT)r$r*rrrrrradd_mutually_exclusive_groupsz0ArgumentInterceptor.add_mutually_exclusive_groupcKs~||d<d|vr||d<||d<|jjd d|i|}|j|_d|_|dd|_d|_d|_ |j ||j ||S) aAdd a positional argument that adds new args on the fly when called. Args: name: The name/dest of the positional argument. action: The argparse Action to use. It must be a subclass of parser_extensions.DynamicPositionalAction. **kwargs: Passed verbatim to the argparse.ArgumentParser.add_subparsers method. Returns: argparse.Action, The added action. rhrr parent_airFr)TNr) rrIadd_subparsers Completionsrfrrwr0r"r#rCrr)r(rrrNrrrAddDynamicPositionals    z(ArgumentInterceptor.AddDynamicPositionalcCs |jD] }||jvr dSqdS)z,If flag with the given option_string exists.TF)rBrV)r( option_stringrrrr_FlagArgExistss  z"ArgumentInterceptor._FlagArgExistscCsBdD]}||r||jvrdSq|j||jj|dS)zAdd a flag action to this parser, but segregate it from the others. Segregating the action allows automatically generated help text to ignore this flag. Args: action: argparse.Action, The action for the flag being added. )z --projectz--billing-projectz--universe-domainz--formatN)rrVrI _add_actionrKr<r)r(rflagrrrAddFlagActionFromAncestorss   z.ArgumentInterceptor.AddFlagActionFromAncestorscCs|d}t|dd}|dur|}|}|||\}} |sdS|dd} | r-t| j} n| dvr4d} n | r;t| } nd} t|} t|rHd}nt|rNd}|duraGd d d |} | || }|| d<| d sn|| d <|j j | d d dfi| }| rt |ddd|_ |j|_|S)aDetermines whether to create the --no-* flag and adds it to the parser. Args: added_argument: The argparse argument that was previously created. name: str, The name of the flag. dest: str, The dest field of the flag. original_kwargs: {str: object}, The original set of kwargs passed to the ArgumentInterceptor. Returns: The new argument that was added to the parser or None, if it was not necessary to create a new argument. rwrapped_actionNrgFTNrr c@s eZdZdS)zIArgumentInterceptor._AddInvertedBooleanFlagIfNecessary..NewActionN)r3r4r5rrrr NewActionGsrrh----no-rvinverted_synopsisT)rwr_ShouldInvertBooleanFlagboolrgrrrSetWrappedActionrIrrzrr0r#)r(rrrhoriginal_kwargsrraction_wrapper should_invertproprgrrNrinverted_argumentrrrrsL         z6ArgumentInterceptor._AddInvertedBooleanFlagIfNecessarycCsj|dsdS|drdSd|dd|jjvrdSt|r"dSt|dd\}}}|r3|d k|fSdS) aChecks if flag name with action is a Boolean flag to invert. Args: name: str, The flag name. action: argparse.Action, The argparse action. Returns: (False, None) if flag is not a Boolean flag or should not be inverted, (True, property) if flag is a Boolean flag associated with a property, (False, property) if flag is a non-Boolean flag associated with a property otherwise (True, None) if flag is a pure Boolean flag. r)FNrNrstore_property)NNNr)r~rI_option_string_actionsrr)r(rrrkindrjrrrrZs   z,ArgumentInterceptor._ShouldInvertBooleanFlagcCsZddlm}|s dSt|tr(|rt|tjr|jj ||j ||d|_ dS||_ dS)zAttaches a completer to arg if one is specified. Args: arg: The argument to attach the completer to. completer: The completer Completer class or argcomplete function object. positional: True if argument is a positional. r)parser_completerN)argument) googlecloudsdk.callioperr rrr CompleterrKrEaddArgumentCompleterrf)r(r_rfrrrrrrws   z$ArgumentInterceptor._AttachCompletercCs ||_dS)aFSets whether or not to sort this group's arguments in help/usage text. NOTE - For ordering consistency across gcloud, generally prefer using argument categories to organize information (instead of unsetting the argument sorting). Args: sort_args: bool, If arguments in this group should be sorted. Nr2)r(r,rrr SetSortArgss zArgumentInterceptor.SetSortArgs)NTN)NN)NNFFFTr)'r3r4r5r6rrFr-r7r;r:r9r?rr+r@rCr0rBrEr<r=r>rerrrrrrrrrrrrrrr __classcell__rrrOrr8dsj%                ) Kr8)r6 __future__rrrr rrrrgooglecloudsdk.core.cacherrrrrrr8rrrrs       /