o X@sdZddlmZddlmZddlmZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z dd l mZdd l mZdd lmZddlZGd d d eZddZddZddZddZddZ ddZd(ddZddZd(ddZd d!d"d!d#d$d%dfd&d'ZdS))z'argparse Actions for use with calliope.)absolute_import)division)unicode_literalsN)base) parser_errors)log)metrics) properties) console_ioc@seZdZdZddZdS)_AdditionalHelpz=Simple class for passing additional help messages to Actions.cCs||_||_dSN)labelmessage)selfr rr.Actionz*The action created for FunctionExitAction.cs"d|d<t|jdi|dSNrnargsrsuperrrkwargsAction __class__rrrbsz+FunctionExitAction..Action.__init__Ncs*t|j|ttddS)Nr)r LogCommandprogrLoadedsysexitrparser namespacevalues option_stringfuncrr__call__fsz+FunctionExitAction..Action.__call__r rrrrrr; __classcell__rr-r:r.rr-_sr-rr-r9rr>rFunctionExitActionUs  rAcr%)aGet an argparse action that stores a value in a property. Also stores the value in the namespace object, like the default action. The value is stored in the invocation stack, rather than persisted permanently. Args: prop: properties._Property, The property that should get the invocation value. Returns: argparse.Action, An argparse action that routes the value correctly. cs<eZdZdZddfZfddZdfdd ZZS)zStoreProperty..Actionz%The action created for StoreProperty.Ncs\t|j|i||d}|r|d}nd}tjd|dtjvr,tj |_ dSdS)Noption_stringsr _ARGCOMPLETE) r)rgetr VALUESSetInvocationValueosenvironr _StoreAction _orig_classrargsr+rBr8r-r.proprrrs    z&StoreProperty..Action.__init__cs"tj||t||j|dSr r rErFsetattrdestr4rNrrr;z&StoreProperty..Action.__call__r rrrrstore_propertyrr;r=rr-rNr?rr-}s   r-r@rRrrVr StorePropertyosrWcr%)aGet an argparse action that stores a value in a Boolean property. Handles auto-generated --no-* inverted flags by inverting the value. Also stores the value in the namespace object, like the default action. The value is stored in the invocation stack, rather than persisted permanently. Args: prop: properties._Property, The property that should get the invocation value. Returns: argparse.Action, An argparse action that routes the value correctly. cs<eZdZdZddfZfddZdfdd ZZS) z$StoreBooleanProperty..Actionz,The action created for StoreBooleanProperty.boolNcst|}d|vr d|d<|d}|r|d}nd}|r1|dr1d|_d|d<d|d<d|d<nd|_t|j|i|tjd|d t j vrRt j |_ dSdS) Nr'rrBz--no-TconstchoicesFrC)dictrD startswith _invertedr)rr rErFrGrHrrIrJrKrMrrrs$     z-StoreBooleanProperty..Action.__init__csL|jr|dgfvr d}n d}n|gkrd}tj||t||j|dS)Ntruefalse)r]r rErFrPrQr4rRrrr;s z-StoreBooleanProperty..Action.__call__r rTrrVr?rr-s  r-r@rRrrVrStoreBooleanPropertys*r`cGfdddtjS)aGet an argparse action that stores a constant in a property. Also stores the constant in the namespace object, like the store_true action. The const is stored in the invocation stack, rather than persisted permanently. Args: prop: properties._Property, The property that should get the invocation value. const: str, The constant that should be stored in the property. Returns: argparse.Action, An argparse action that routes the value correctly. cs<eZdZdZdfZfddZdfdd ZZS) z"StoreConstProperty..Actionz*The action created for StoreConstProperty.valuecs@t|}d|d<t|j|i|dtjvrtj|_dSdS)Nrr'rC)r[r)rrGrHr_StoreConstActionrJ)rrLr+r,rrrs   z+StoreConstProperty..Action.__init__Ncs"tj|t||jdSr rOr4)rYrNrrr;rSz+StoreConstProperty..Action.__call__r rTrr-rYrNr?rr-s  r-r@)rNrYrrdrStoreConstPropertysrecsfdd}t|S)zGet an argparse.Action that prints a short help. Args: command: calliope._CommandCommon, The command object that we're helping. Returns: argparse.Action, the action to use. cs"tjdtjdS)Nz-h)rHelp dotted_nameroutwriteGetUsagercommandrrFuncszShortHelpAction..Func)rA)rlrmrrkrShortHelpActions rncra)aGet an argparse.Action that renders a help document from markdown. Args: command: calliope._CommandCommon, The command object that we're helping. default_style: str, The default style if not specified in flag value. Returns: argparse.Action, The action to use. cs4eZdZdZfddZdfdd ZZS)z$RenderDocumentAction..Actionz,The action created for RenderDocumentAction.cs&rd|d<t|jdi|dSr&r(r*)r-r. default_stylerrrsz-RenderDocumentAction..Action.__init__Nc sRddlm}ddlm}t|j|rt}d}d} |D](} t | D] \} } | dkr3| }q(| dkr:| }q(| dkrA| } q(t d | q!| durQj} tj||d vr^d }t|} tjd d rptnd}|d kr{t}nd}|dkr}nd}|j|| |ptj|| ||dt|rt|tddS)a<Render a help document according to the style in values. Args: parser: The ArgParse object. namespace: The ArgParse namespace. values: The --document flag ArgDict() value: style=STYLE The output style. Must be specified. title=DOCUMENT TITLE The document title. notes=SENTENCES Inserts SENTENCES into the document NOTES section. option_string: The ArgParse flag string. Raises: parser_errors.ArgumentError: For unknown flag value attribute name. r)markdownrender_documentNnotesstyletitlez Unknown document attribute [{0}])z--helphelptopictextT)outputlinterdevsite)rhrsrucommand_metadata command_node)googlecloudsdk.callioperp&googlecloudsdk.core.document_renderersrrrr/r0rr1six iteritemsr ArgumentErrorr!rgrfioStringIOMarkdownr IsInteractiveGetCommandMetaDataRenderDocumentrrhRanMoregetvaluer2r3)rr5r6r7r8rprrrtrsru attributesnamerbmdrh meta_datar}rlrorrr;s\     z-RenderDocumentAction..Action.__call__r r<rr-rlror?rr-sr-r@rrrrRenderDocumentActions WrcCs^ddlm}|}|D]}|jD]}|j|t|tj r'|j |qq|j |_ |S)Nrrq) rrrCommandMetaDataGetAllAvailableFlagsrBflagsappend isinstancerrc bool_flagsis_group)rlrrr|argarg_namerrrrs      rcsPtstdttjsttjstdGfdddtjS)a(Allows an function hook to be injected before an Action executes. Wraps an Action in another action that can execute an arbitrary function on the argument value before passing invocation to underlying action. This is useful for: - Chaining actions together at runtime. - Adding additional pre-processing or logging to an argument/flag - Adding instrumentation to runtime execution of an flag without changing the underlying intended behavior of the flag itself Args: action: action class to be wrapped. Either a subclass of argparse.Action or a string representing one of the built in arg_parse action types. If None, argparse._StoreAction type is used as default. func: callable, function to be executed before invoking the __call__ method of the wrapped action. Takes value from command line. additional_help: _AdditionalHelp, Additional help (label, message) to be added to action help Returns: argparse.Action, wrapper action to use. Raises: TypeError: If action or func are invalid types. z1func should be a callable of the form func(value)zwaction should be either a subclass of argparse.Action or a string representing one of the default argparse Action TypescsHeZdZdZZeddZddZfddZd d d Z Z S) z_PreActionHook..ActionzAction Wrapper Class.cSs ||_dSr )wrapped_action)clsrrrrSetWrappedAction.s z/_PreActionHook..Action.SetWrappedActioncSs&t|jtjrt|j}|S|j}|Sr )rrr string_typesr$)rr#rrr_GetActionClass4s  z._PreActionHook..Action._GetActionClasscsr|dd}dj|j|d<||i||_|_|jj|d<|jj |d<|jj |d<|jj |d<t |j |i|dS)Nrvz {0} {1} + {2}r'rYrZrB)rDrstripr!r rr_wrapped_actionr:r'rYrZrBr)r)rrLr+ original_help)r-r.additional_helpr:rrr;s     z'_PreActionHook..Action.__init__NcSsbt||jd}t|trt|dkr||n|s"||jjn|||||||dS)N)getattrrQrlistlenr:rrY)rr5r6rbr8 flag_valuerrrr;Os    z'_PreActionHook..Action.__call__r ) rrrrr classmethodrrrr;r=rr-rrr:r?rr-)s r-)callable TypeErrorrrr issubclassrr-)rr:rrrr_PreActionHooks4rcCdSNTr_rrrbrcCrrrrrrrrcrzFlag {flag_name} is deprecated.z"Flag {flag_name} has been removed.Fcs^r td|j|dn td|j|d|sd}fdd}|r)t||St||dS)a4Prints a warning or error message for a flag that is being deprecated. Uses a _PreActionHook to wrap any existing Action on the flag and also adds deprecation messaging to flag help. Args: flag_name: string, name of flag to be deprecated show_message: callable, boolean function that takes the argument value as input, validates it against some criteria and returns a boolean. If true deprecation message is shown at runtime. Deprecation message will always be appended to flag help. show_add_help: boolean, whether to show additional help in help text. warn: string, warning message, 'flag_name' template will be replaced with value of flag_name parameter error: string, error message, 'flag_name' template will be replaced with value of flag_name parameter removed: boolean, if True warning message will be printed when show_message fails, if False error message will be printed action: argparse.Action, action to be wrapped by this action Returns: argparse.Action, deprecation action to use. z (REMOVED)) flag_namez (DEPRECATED)storecs,|rr tjtjdSdSr )rrrrwarning)rbadd_helpremoved show_messagerrDeprecationFuncs  z*DeprecationAction..DeprecationFuncN)r r!r)rr show_add_helpwarnrrrrrrrDeprecationAction`s   rr )r __future__rrrrrrGr2r~rrgooglecloudsdk.corerrr googlecloudsdk.core.consoler robjectr r$rArWr`rernrrrrrrrrsD         )'=&m e _