o R" @sdZddlmZddlmZddlmZddlZddlmZddlZGddde ej e Z Gd d d e Z d d Zd Zd$ddZddZddZd%dededeedffddZd&ddZd%ddZddZd d!Zd%d"d#ZdS)'z@Utilities for adding help text for flags with an argparser type.)absolute_import)division)unicode_literalsN)Unionc@sLeZdZdZeejddZejddZejddZ ejdd Z d S) ArgTypeUsagezEInterface for flags types that need to provide additional usage info.cCdS)zWhether the argument is hidden.NselfrrK/tmp/google-cloud-sdk/lib/googlecloudsdk/calliope/arg_parsers_usage_text.pyhiddenzArgTypeUsage.hiddencCr)z,Returns the metavar for flag with type self.Nr)r is_custom_metavarmetavarrrr GetUsageMetavar#r zArgTypeUsage.GetUsageMetavarcCr)z=Returns the example user input value for flag with type self.Nr)r shorthandrrr GetUsageExample'r zArgTypeUsage.GetUsageExamplecCr)z.Returns the help text for flag with type self.Nr)r field_namerequired flag_namerrr GetUsageHelpText+r zArgTypeUsage.GetUsageHelpTextN) __name__ __module__ __qualname____doc__propertyabcabstractmethodr rrrrrrr rs   rcsPeZdZdZfddZeddZeddZdd Zd d Z d d Z Z S)DefaultArgTypeWrapperzBase class for processing arg_type output but maintaining usage help text. Attributes: arg_type: type function used to parse input string into correct type ie ArgObject(value_type=int, repeating=true), int, bool, etc cstt|||_dSN)superr__init__arg_type)r r" __class__rr r!8s zDefaultArgTypeWrapper.__init__cCs t|jtSr) isinstancer"rr rrr _is_usage_type<s z$DefaultArgTypeWrapper._is_usage_typecCs|jr|jjSdSr)r&r"r r rrr r @szDefaultArgTypeWrapper.hiddencO|jr |jj|i|SdS)z,Forwards default usage metavar for arg_type.N)r&r"rr argskwargsrrr rGz%DefaultArgTypeWrapper.GetUsageMetavarcOr')z,Forwards default usage example for arg_type.N)r&r"rr(rrr rNr+z%DefaultArgTypeWrapper.GetUsageExamplecOr')z(Forwards default help text for arg_type.N)r&r"rr(rrr rUr+z&DefaultArgTypeWrapper.GetUsageHelpText) rrrrr!rr&r rrr __classcell__rrr#r r0s   rcCst|tr|jp dS)zReturns whether arg_type is hidden. Args: arg_type: Callable, arg type that may contain hidden attribute Returns: bool, whether the type is considered hidden F)r%rr r"rrr IsHidden]s r.z:: cCsd|}|t|tS)z3Tabs over all lines in text using ascii doc syntax.:)replace ASCII_INDENT)textdepthadditional_tabsrrr IndentAsciiDoclsr5cCs>|sdSt|tr |S|turdS|turdS|turdSdS)zReturns a user friendly name of a primitive arg_type. Args: arg_type: type | str | None, expected user input type Returns: String representation of the type Nintfloatbooleanstring)r%strr6r7boolr-rrr _FormatBasicTypeStrrs  r<cCs|}|dr |S|dS)z5Adds punctuation to text if it doesn't already exist..)rstripendswith)r2 clean_textrrr _Punctuates rAFr2ignorereturncCs$|r|r|S|d|ddS)zCapitalizes the first letter of text. Args: text: The text to capitalize. ignore: Whether to ignore the capitalization request. Returns: The capitalized text. rN)upper)r2rBrrr _Capitalizes rFcCs@|rt|}n|rtd||}ntd|}|rd|S|S)a-Defaults and formats specific attribute of help text. Args: field_name: None | str, attribute that is being set by flag required: bool, whether the flag is required help_text: None | str, text that describes the flag Returns: help text formatted as `{type} {required}, {help}` zsets `{}` value.z sets value.z Required, {})rArFformat)rr help_textdefaulted_help_textrrr FormatHelpTexts    rJcCs<d|vr d||}nd||}|rdj|dSd|S)zFormats flag in markdown code snippet. Args: arg_name: str, name of the flag in snippet arg_value: str, flag value in snippet append: bool, whether to use append syntax for flag Returns: markdown string of example user input  z{}='{}'z{}={}z``` {input} {input} ```)inputz ``` {} ```)rG)arg_name arg_valueappend example_flagrrr FormatCodeSnippets     rQcCsX|sdSt|tr|j|d}nt|}t|t}|ttk}|s*|s%|r*d|S|S)a Gets an example input value for flag of arg_type. Args: arg_type: Callable[[str], Any] | str | None, expected user input type shorthand: bool, whether to display example in shorthand Returns: string representation of user input for type arg_type N)rz"{}")r%rrr<r:rG)r"rarg_stris_string_literalis_string_typerrr _GetNestedValueExamples      rUcCsdt||}t||}t|st|rdS|r|s|p|S|r+|dkr)|d|S|S|d|S)aFormats example key-value input for flag of arg_type. If key_type and value_type are callable types str, returns string=string (shorthand) or "string": "string" (non-shorthand) If key_type is a static string value such as x, returns x=string (shorthand) or "x": "string" (non-shorthand). If key_type or value_type are None, returns string representation of key or value Args: key_type: Callable[[str], Any] | str | None, type function for the key value_type: Callable[[str], Any] | None, type function for the value shorthand: bool, whether to display the example in shorthand Returns: str, example of key-value pair Nz{}=z: )rUr.)key_type value_typerkey_str value_strrrr GetNestedKeyValueExamples  r[cCsft||}t|tr|jrd}nt|tr"|js"|j||dp |}n|}|r1d|tt|ddSdS)aReturns help text for flag with arg_type. Generates help text based on schema such that the final output will look something like... *Foo* Required, Foo help text Args: field_name: str, attribute we are generating help text for arg_type: Callable[[str], Any] | None, type of the attribute we are getting help text for required: bool, whether the attribute is required Returns: string help text for specific attribute N)rz*{}*{}{}rD)r3)rJr%rr rrGr1r5)rr"r default_usageusagerrr GetNestedUsageHelpTexts r^)r)Fr)r __future__rrrrtypingrsixwith_metaclassABCMetaobjectrrr.r1r5r<rAr:r;rFrJrQrUr[r^rrrr s(    -   %