o v[ @sDdZddlmZddlmZddlmZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl mZddl mZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlZddlmZddgZGdddeZGdddeej Z Gdddeej!Z"GdddeZ#dddZ$ddZ%dZ&dZ'd Z(d!e(Z)d!e)Z*d"e*Z+e(e)e*e+d#Z,d d$d%d&d'd(d$d%d&d'd(d) Z-d*d*d+d+d,d,d-d-d.d.d/ Z.d0d1Z/d2d3Z0dd4d5Z1dd6d7Z2   8 . dd9d:Z3d;d<Z4dd=d>Z5 ? @  ?ddAdZ6    B .ddCdZ7dDZ8GdEdFdFe9Z:GdGdHdHe9Z;GdIdJdJe9Z   OddPdQZ?dRdSZ@dTdUZAdVdWZBdXdYZCdZd[ZDdd]d^ZEd_d`ZFddadbZGGdcdddde9ZHGdedfdfejIeHZJ 8ddgeKdheKdieKfdjdkZLdldmZMdndoZNdpdqZOGdrdsdsejIeHZPGdtduduejIeHZQdveRdweRdieRfdxdyZSGdzd{d{eQZTGd|d}d}eTZUGd~ddejVZWGdddeWZXGdddejYZZdddZ[GdddejVZ\ddZ]GdddejVZ^ddZ_GdddejIZ`Gddde9ZaGdddejbZcdddZdGdddejVZeGddde9ZfdS)aA module that provides parsing utilities for argparse. For details of how argparse argument pasers work, see: http://docs.python.org/dev/library/argparse.html#type Example usage: import argparse import arg_parsers parser = argparse.ArgumentParser() parser.add_argument( '--metadata', type=arg_parsers.ArgDict()) parser.add_argument( '--delay', default='5s', type=arg_parsers.Duration(lower_bound='1s', upper_bound='10s') parser.add_argument( '--disk-size', default='10GB', type=arg_parsers.BinarySize(lower_bound='1GB', upper_bound='10TB') res = parser.parse_args( '--names --metadata x=y,a=b,c=d --delay 1s --disk-size 10gb'.split()) assert res.metadata == {'a': 'b', 'c': 'd', 'x': 'y'} assert res.delay == 1 assert res.disk_size == 10737418240 )absolute_import)division)unicode_literalsN)tz)arg_parsers_usage_text) parser_errors)log) properties) console_attr) console_io)files)times)zipDuration BinarySizec@eZdZdZdS)Errorz+Exceptions that are defined by this module.N__name__ __module__ __qualname____doc__rr@/tmp/google-cloud-sdk/lib/googlecloudsdk/calliope/arg_parsers.pyrMrc@r)ArgumentTypeErrorz7Exceptions for parsers that are used as argparse types.NrrrrrrQrrc@r)ArgumentParsingErrorzRaised when there is a problem with user input. argparse.ArgumentError takes both the action and a message as constructor parameters. NrrrrrrUrrc@r)InvalidTypeErrorz=Error for when contributor provides incorrect type arguments.Nrrrrrr]rrcCs<|dur|S|s |dS|dur|d|Sdj|||dS)aConstructs an error message for an exception. Args: error: str, The error message that should be displayed. This message should not end with any punctuation--the full error message is constructed by appending more information to error. user_input: str, The user input that caused the error. error_idx: int, The index at which the error occurred. If None, the index will not be printed in the error message. Returns: str: The message to use for the exception. Nz; received empty stringz ; received: z2{error_message} at index {error_idx}: {user_input}) error_message user_input error_idx)format)errorrr rrr_GenerateErrorMessageas r#cCsdd|S)zConstructs an error message for exception thrown invalid input. Args: unit_scales: list, A list of strings with units that will be recommended to user. Returns: str: The message to use for the exception. zvgiven value must be of the form DECIMAL[UNITS] where units can be one of {0} and value must be a whole number of Bytes, )r!join) unit_scalesrrrInvalidInputErrorMessageys  r'z ^ # Beginning of input marker. (?P\d+\.?\d*) # Amount. ((?P[-/a-zA-Z]+))? # Optional scale and type abbr. $ # End of input marker. z&^(?P[0-9]+)(-(?P[0-9]+))?$<)smhdii@ll ) KMGTPKiMiGiTiPiTiBGiBMiBKiBB) PiBPBr;TBr<GBr=MBr>KBcCsXt|}|}t|s(|r(|tvr(|dt|}}t|s(|r(|tvs||fS)aConvert input value and units to a whole number of a lower unit. Args: amount: str, a number, for example '3.25' unit: str, a binary prefix, for example 'GB' or 'GiB' Returns: (decimal.Decimal(), str), a tuple of number and suffix, converted such that the number returned is an integer, or the value, in Bytes, of the amount input. For example (23, 'MiB'). Note that IEC binary prefixes are always assumed and returned. r/)decimalDecimalfloat is_integer_UnitToLowerUnitDict)amountunit return_amount return_unitrrrConvertToWholeNumbers rOcsfdd}|S)zCreate a completer to handle completion for comma separated lists. Args: individual_completer: A function that completes an individual element. Returns: A function that completes the last element of the list. csTd|dd}t|dkr|dd|d}||fi|}fdd|DS)Nr0,r(rcsg|]}|qSrr).0matchstartrr z=GetMultiCompleter..MultiCompleter..)rsplitlen)prefix parsed_argskwargslstmatchesindividual_completerrSrMultiCompleters   z)GetMultiCompleter..MultiCompleterr)r_r`rr^rGetMultiCompleters  racCsV|s|S|}t|}t|D]}|sn ||d|kr$|d8}q|d|S)z7Returns suffix with trailing type abbreviation deleted.r(N)upperrXreversed)suffix type_abbrr+icrrr_DeleteTypeAbbrs rhcCst||}t|S)awReturns the binary size per unit for binary suffix string. Args: suffix: str, A case insensitive unit suffix string with optional type abbreviation. type_abbr: str, The optional case insensitive type abbreviation following the suffix. Raises: ValueError for unknown units. Returns: The binary size per unit for a unit+type_abbr suffix. )rhrb_BINARY_SIZE_SCALESget)rdrerLrrrGetBinarySizePerUnits rkTcsjd fdd  fdddurdn dur%dn  fdd}|S) aA helper that returns a function that can parse values with units. Casing for all units matters. Args: scales: {str: int}, A dictionary mapping units to their magnitudes in relation to the lowest magnitude unit in the dict. default_unit: str, The default unit to use if the user's input is missing unit. lower_bound: str, An inclusive lower bound. upper_bound: str, An inclusive upper bound. strict_case: bool, whether to be strict on case-checking type_abbr: str, the type suffix abbreviation, e.g., B for bytes, b/s for bits/sec. suggested_binary_size_scales: list, A list of strings with units that will be recommended to user. Returns: A function that can parse values. NcsDttddd}durfdd|DSfdd|DS)z:Returns a list of the units in scales sorted by magnitude.cSs|d|dfS)Nr(rrvaluerrr)sz8_ValueParser..UnitsByMagnitude..)keyNcsg|]\}}|qSrrrQro_)rerrrU+z:_ValueParser..UnitsByMagnitude..cs$g|]\}}|vr|qSrrrp)suggested_binary_size_scalesrerrrU,s  )sortedsix iteritems)rs scale_items)scalesre)rsrUnitsByMagnitude&s z&_ValueParser..UnitsByMagnitudecstt|tj}|sttt|d|dpd}t|d|\}}t | s9ttt|dt |}t |}rN|}t }}n| }t  }tddD}|sp||krp|||S||vrz|||Sttdd|d) z;Parses value that can contain a unit and type abbreviation.rrdr0rKcSsg|] \}}||fqSr)rb)rQkvrrrrULz/_ValueParser..Parse..zunit must be one of {0}r$)rerR_VALUE_PATTERNVERBOSErr#r'grouprOrHrIintrhrbdictitemsr!r%)rmrRrdrKrL unit_casedefault_unit_case scales_case)ry default_unitrx strict_casersrerrParse2sP      z_ValueParser..Parsecd|durdS|}dur|krttd|ddur0|kr0ttd|d|Sz1Same as Parse except bound checking is performed.Nz*value must be greater than or equal to {0}rzz'value must be less than or equal to {0}rr#r!rm parsed_valuer lower_boundparsed_lower_boundparsed_upper_bound upper_boundrrParseWithBoundsCheckingbs(z-_ValueParser..ParseWithBoundsCheckingNr)rxrrrrrersrr) rryrrrrrxrrsrerr _ValueParser s &rcfdd}|S)aReturns a function that validates a string against a regular expression. For example: >>> alphanumeric_type = RegexpValidator( ... r'[a-zA-Z0-9]+', ... 'must contain one or more alphanumeric characters') >>> parser.add_argument('--foo', type=alphanumeric_type) >>> parser.parse_args(['--foo', '?']) >>> # SystemExit raised and the error "error: argument foo: Bad value [?]: >>> # must contain one or more alphanumeric characters" is displayed Args: pattern: str, the pattern to compile into a regular expression to check description: an error message to show if the argument doesn't match Returns: function: str -> str, usable as an argparse type cs$td|std||S)N$Bad value [{0}]: {1})r~rRrr!rl descriptionpatternrrrszRegexpValidator..Parser)rrrrrrRegexpValidatorysrcsfdd}|S)aReturns a function that validates the input by running it through fn. For example: >>> def isEven(val): ... return val % 2 == 0 >>> even_number_parser = arg_parsers.CustomFunctionValidator( isEven, 'This is not even!', parser=arg_parsers.BoundedInt(0)) >>> parser.add_argument('--foo', type=even_number_parser) >>> parser.parse_args(['--foo', '3']) >>> # SystemExit raised and the error "error: argument foo: Bad value [3]: >>> # This is not even!" is displayed Args: fn: str -> boolean description: an error message to show if boolean function returns False parser: an arg_parser that is applied to to value before validation. The value is also returned by this parser. Returns: function: str -> str, usable as an argparse type csRz r|n|}Wn tyYnw|r|St|}d|}t|)zDValidates and returns a custom object from an argument string value.r)rr SafeTextr!)rmr encoded_value formatted_errrfnparserrrrs   z&CustomFunctionValidator..Parser)rrrrrrrCustomFunctionValidators rr+0csDfdddurdnfdd}|S)aReturns a function that can parse time durations. See times.ParseDuration() for details. If the unit is omitted, seconds is assumed. The parsed unit is assumed to be seconds, but can be specified as ms or us. For example: parser = Duration() assert parser('10s') == 10 parser = Duration(parsed_unit='ms') assert parser('10s') == 10000 parser = Duration(parsed_unit='us') assert parser('10s') == 10000000 Args: default_unit: str, The default duration unit. lower_bound: str, An inclusive lower bound for values. upper_bound: str, An inclusive upper bound for values. parsed_unit: str, The unit that the result should be returned as. Can be 's', 'ms', or 'us'. Raises: ArgumentTypeError: If either the lower_bound or upper_bound cannot be parsed. The returned function will also raise this error if it cannot parse its input. This exception is also raised if the returned function receives an out-of-bounds input. Returns: A function that accepts a single time duration as input to be parsed an returns an integer if the parsed value is not a fraction; Otherwise, a float value rounded up to 4 decimals places. c sdkrd}ndkrd}n dkrd}nttdz!tj|d}|j|}t|}t|d }||}|r:|WS|WStjy\}zt | d }ttd j ||d d }~ww)z?Parses a duration from value and returns it in the parsed_unit.msiusi@Br+r(z%parsed_unit must be one of s, ms, us.)default_suffix.zFailed to parse duration: {0}rzN) rr#r ParseDuration total_secondsrroundrru text_typerstripr!) rm multiplierdurationrparsed_int_valueparsed_rounded_valuefractionemessage)r parsed_unitrrrs2   zDuration..ParseNcrrrrrrrrs$z)Duration..ParseWithBoundsCheckingr)rrrrrr)rrrrrrrrrs&r3c Cstt|||d||dS)aIReturns a function that can parse binary sizes. Binary sizes are defined as base-2 values representing number of bytes. Input to the parsing function must be a string of the form: DECIMAL[UNIT] The amount must be non-negative. Valid units are "B", "KB", "MB", "GB", "TB", "PB", "KiB", "MiB", "GiB", "TiB", "PiB". If the unit is omitted then default_unit is assumed. The result is parsed in bytes. For example: parser = BinarySize() assert parser('10GB') == 1073741824 Another example: parser = BinarySize() assert parser('2.5KB') == 2560 Args: lower_bound: str, An inclusive lower bound for values. upper_bound: str, An inclusive upper bound for values. suggested_binary_size_scales: list, A list of strings with units that will be recommended to user. default_unit: str, unit used when user did not specify unit. type_abbr: str, the type suffix abbreviation, e.g., B for bytes, b/s for bits/sec. Raises: ArgumentTypeError: If either the lower_bound or upper_bound cannot be parsed. The returned function will also raise this error if it cannot parse its input. This exception is also raised if the returned function receives an out-of-bounds input. Returns: A function that accepts a single binary size as input to be parsed. F)rrrrrers)rri)rrrsrrerrrrs0=c@sDeZdZdZddZeddZddZdd Zd d Z d d Z dS)RangezRange of integer values.cC||_||_dSrrTend)selfrTrrrr__init__X zRange.__init__cCsptt|}|std|t|d}|d}|dur"|}nt|}||kr3td|||t||S)z/Creates Range object out of given string value.zPExpected a non-negative integer value or a range of such values instead of "{0}"rTrNzCExpected range start {0} smaller or equal to range end {1} in "{2}")r~rR_RANGE_PATTERNrr!rrr) string_valuerRrTrrrrr\s$   z Range.ParsecCsN|jd|jks|j|jdkrtd||tt|j|jt|j|jS)z>Combines two overlapping or adjacent ranges, raises otherwise.r(zACannot combine non-overlapping or non-adjacent ranges {0} and {1})rrTrr!rminmaxrotherrrrCombineps z Range.CombinecCs&t|tr|j|jko|j|jkSdSNF) isinstancerrTrrrrr__eq__ws z Range.__eq__cCs$|j|jkr |j|jkS|j|jkSrrrrrr__lt__|s   z Range.__lt__cCs(|j|jkr t|jSd|j|jS)Nz{0}-{1})rTrrurr!rrrr__str__s  z Range.__str__N) rrrrr staticmethodrrrrrrrrrrUs  rc@s.eZdZdZdZdZddZed ddZd S) HostPortz.A class for holding host and port information.z/^(?P
[\w\d\.-]+)?(:|:(?P[\d]+))?$z2^(\[(?P
[\w\d:]+)\])(:|:(?P[\d]+))?$cCrr)hostport)rrrrrrrrzHostPort.__init__FcCsz|stddSttj|tj}|r(|s(ttj|tj}|s'ttd|dn |s2ttd|dt|d|dS)aParse the given string into a HostPort object. This can be used as an argparse type. Args: s: str, The string to parse. If ipv6_enabled and host is an IPv6 address, it should be placed in square brackets: e.g. [2001:db8:0:0:0:ff00:42:8329] or [2001:db8:0:0:0:ff00:42:8329]:8080 ipv6_enabled: boolean, If True then accept IPv6 addresses. Raises: ArgumentTypeError: If the string is not valid. Returns: HostPort, The parsed object. NzFailed to parse host and port. Expected format IPv4_ADDRESS_OR_HOSTNAME:PORT or [IPv6_ADDRESS]:PORT (where :PORT is optional).rzzlFailed to parse host and port. Expected format IPv4_ADDRESS_OR_HOSTNAME:PORT (where :PORT is optional).addressr) rr~rRIPV4_OR_HOST_PATTERNUNICODE IPV6_PATTERNrr#r)r+ ipv6_enabledrRrrrrs*  zHostPort.ParseNF) rrrrrrrrrrrrrrsrc@seZdZdZeddZdS)Dayz9A class for parsing a datetime object for a specific day.c CsR|sdSz t|dWStjy(}zttdt||dd}~ww)Nz%Y-%m-%dzFailed to parse date: {0}rz) r ParseDateTimedaterrr#r!rurr+rrrrrsz Day.ParseN)rrrrrrrrrrrsrc@s(eZdZdZeddZeddZdS)Datetimez&A class for parsing a datetime object.c CsL|sdSzt|WStjy%}zttdt||dd}~ww)z?Parses a string value into a Datetime object in local timezone.NzFailed to parse date/time: {0}rz)r rrrr#r!rurrrrrrs zDatetime.Parsec CsT|sdSz tj|tdWStjy)}zttdt ||dd}~ww)zBParses a string representing a time in UTC into a Datetime object.N)tzinfozFailed to parse UTC time: {0}rz) r rrtzutcrrr#r!rurrrrr ParseUtcTimeszDatetime.ParseUtcTimeN)rrrrrrrrrrrrs   rc@s$eZdZdZgdZeddZdS) DayOfWeekz&A class for parsing a day of the week.)SUNMONTUEWEDTHUFRISATcCsD|sdS|dd}|tjvr ttddtj|d|S)z7Validates and normalizes a string as a day of the week.Nz7Failed to parse day of week. Value should be one of {0}r$rz)rbrDAYSrr#r!r%)r+fixedrrrrs  zDayOfWeek.ParseN)rrrrrrrrrrrrs rFcsfdd}|S)aOReturns a function that can parse given type within some bound. Args: type_builder: A callable for building the requested type from the value string. type_description: str, Description of the requested type (for verbose messages). lower_bound: of type compatible with type_builder, The value must be >= lower_bound. upper_bound: of type compatible with type_builder, The value must be <= upper_bound. unlimited: bool, If True then a value of 'unlimited' means no limit. Returns: A function that can parse given type within some bound. csr|dkrdSz|}Wnty ttd|dwdur4|kr4ttd|ddurG|krGttd|d|S)aParses value as a type constructed by type_builder. Args: value: str, Value to be converted to the requested type. Raises: ArgumentTypeError: If the provided value is out of bounds or unparsable. Returns: Value converted to the requested type. unlimitedNzValue must be {0}rzz*Value must be greater than or equal to {0}z'Value must be less than or equal to {0}) ValueErrorrr#r!)rmr|r type_buildertype_descriptionrrrrrs4    z_BoundedType..Parser)rrrrrrrrr _BoundedTypes$rcOttdg|Ri|S)Nz an integer)rrargsr[rrr BoundedInt=rcOr)Nza floating point number)rrHrrrr BoundedFloatArrcCs,|sgS||s ||7}||ddS)N)endswithsplit) arg_valuedelimrrr _SplitOnDelimEs  rcCsddd}t|}g}tt|D]4}|dkr"||ddkr"q||}||vr>||}|r6|d|kr9dS|q||vrG||q| S) z1Checks whether the string contains balanced json.{[)}]rr(\rF)setvaluesrangerXpopappend) str_valueclosing_bracketsopening_bracketscurrent_bracketsrfchmatching_bracerrr_ContainsValidJSONMs    r cCsTg}d}|D]}|s |}n|||7}t|r||d}q|r(td||S)aRejoins json substrings that are part of the same json strings. For example: [ 'key={"a":"b"', '"c":"d"}' ] Is merged together into: ['key={"a":"b","c":"d"}'] Args: json_list: [str], list of json snippets delim: str, delim used to rejoin the json snippets arg_value: str, original value used to make json_list Returns: list of strings containing balanced json NzWInvalid entry "{}": missing opening brace ("{{" or "[") or closing brace ("}}" or "]").)r rrr!) json_listrrresultcurrent_substrtokenrrr_RejoinJSONStrsds   rrPcCs.|sgSt||}|r|dkr|St|||S)aTokenize an argument into a list. Deliminators that are inside json will not be split. Even when the json is nested, we will not split on the delimitor until we reach the json's closing bracket. For example: '{"a": [1, 2], "b": 3},{"c": 4}' with default delim (',') will be split only on the `,` separating the 2 json strings i.e. [ '{"a": [1, 2], "b": 3}', '{"c": 4}' ] This also works for strings that contain dictionary pattern. For example: 'key1={"a": [1, 2], "b": 3},key2={"c": 4}' with default delim (',') will be split on the delim (',') separating the two strings into [ 'key1={"a": [1, 2], "b": 3}', 'key2={"c": 4}' ] Args: arg_value: str, The raw argument. delim: str, The delimiter on which to split the argument string. includes_json: str, determines whether to ignore delimiter inside json Returns: [str], The tokenized list. rP)rr)rr includes_jsonstr_listrrr_TokenizeQuotedLists &   rcCs<|durg}t|tr|D]}t||q |S|||Sr)rlist _ConcatListr)existing_values new_values new_valuerrrrs   rcCs |rtsd|d|S|S)zReturns a help text for universes. Args: default: str, help text for argument. universe_help: str, additional specific help text for Universe. Returns: [str], The help text for argument. zUNIVERSE INFO:  r IsDefaultUniverse)default universe_helprrrUniverseHelpTexts r c@r)ArgTypezBase class for arg types.Nrrrrrr!rr!c@sNeZdZdZ   dddZddZedd Zd d Zd d Z dddZ dS) ArgBooleanzuInterpret an argument value as a bool. This should only be used to define the spec of a key of an ArgDict flag. NFcCs8||_|r ||_nddg|_|r||_dSddg|_dS)Ntrueyesfalseno)_case_sensitive_truthy_strings_falsey_strings)rtruthy_stringsfalsey_stringscase_sensitiverrrrs  zArgBoolean.__init__cCsN|js|}n|}||jvrdS||jvrdStd|d|j|j)NTFz/Invalid flag value [{0}], expected one of [{1}]r$)r'lowerr(r)rr!r%)rrnormalized_arg_valuerrr__call__s   zArgBoolean.__call__cCdSrrrrrrhiddenzArgBoolean.hiddencC~|Srrris_custom_metavarmetavarrrrGetUsageMetavarzArgBoolean.GetUsageMetavarcC~dS)Nbooleanrr shorthandrrrGetUsageExampler8zArgBoolean.GetUsageExamplecC ~~~dSrrr field_namerequired flag_namerrrGetUsageHelpTextzArgBoolean.GetUsageHelpTextNNFr) rrrrrr/propertyr1r7r=rCrrrrr"s  r"default_universenon_default_universereturncCstr|S|S)aiDetermines if the arg is required based on the universe domain. Args: default_universe: Whether the arg is required in the default universe. Defaults to False. non_default_universe: Whether the arg is required outside of the default universe. Defaults to True. Returns: bool, whether the arg is required in the current universe. r)rGrHrrrArgRequiredInUniverse srJcCs td|S)N^\S*\.(yaml|json)$)r~rRrrrr_CheckIfJSONFileFormat!s rMcCs t|Sr) FileContentsrLrrr _LoadFile% rOcCsddlm}||S)Nryaml)googlecloudsdk.corerRload)rrRrrr _LoadJSON)s  rUc@s>eZdZdZeddZddZddZd d d Zd d Z dS)ArgJSONa+Parses inline JSON or from a file. This is best for recursive values like struct fields of when any value can be passed. ArgObject is better for you want a specific format from the user. ArgObjet helps validate if the user provided value is valid and generates help text with examples. cCr0rrrrrrr1;r2zArgJSON.hiddencCr3rrr4rrrr7?r8zArgJSON.GetUsageMetavarcCr9)Nz{...}rr;rrrr=Cr8zArgJSON.GetUsageExampleNcCr>rrr?rrrrCGrDzArgJSON.GetUsageHelpTextcCs<t|ts td|t|rt|}t|S|}t|S)Nz4ArgJSON can only convert string values. Received {}.)rstrrr!rMrOrU)rrrrrrr/Ks zArgJSON.__call__r) rrrrrFr1r7r=rCr/rrrrrV1s   rVc@sbeZdZdZdZdZ       dddZd d Zd Ze d d Z ddZ ddZ dddZ dS)ArgListaInterpret an argument value as a list. Intended to be used as the type= for a flag argument. Splits the string on commas or another delimiter and returns a list. By default, splits on commas: 'a,b,c' -> ['a', 'b', 'c'] There is an available syntax for using an alternate delimiter: '^:^a,b:c' -> ['a,b', 'c'] '^::^a:b::c' -> ['a:b', 'c'] '^,^^a^,b,c' -> ['^a^', ',b', 'c'] rP^NrFc sL__|p g_rfdd}|_|_|_|_|_dS)aInitialize an ArgList. Args: element_type: (str)->str, A function to apply to each of the list items. min_length: int, The minimum size of the list. max_length: int, The maximum size of the list. choices: [element_type], a list of valid possibilities for elements. If None, then no constraints are imposed. custom_delim_char: char, A customized delimiter character. hidden_choices: [element_type], a subset of choices that should be hidden from documentation. includes_json: bool, whether the list contains any json Returns: (str)->[str], A function to parse the list of values in the argument. Raises: ArgumentTypeError: If the list is malformed. csDr|}n|}|vr tdj|dfddDd|S)Nz"{value} must be one of [{choices}]r$csg|] }|jvrt|qSr)hidden_choicesrW)rQrgrrrrUsz8ArgList.__init__..ChoiceType..)rmchoices)rr!r%) raw_value typed_valuer[ element_typerrr ChoiceTypes z$ArgList.__init__..ChoiceTypeN)r_r[rZ min_length max_lengthcustom_delim_charr) rr_rarbr[rcrZrr`rr^rrks   zArgList.__init__cst|tr|}nAt|tjstdt|j|jpj }| j rAj |ddvrA|dd j d\}}|sAtdt ||jd}t|jkrTtdjdurdt|jkrdtdjrpfdd|D}|S) N%Invalid type [{}] for flag value [{}]r(zInvalid delimeter. Please see `gcloud topic flags-file` or `gcloud topic escaping` for information on providing list or dictionary flag values with special characters.)rrznot enough argsz too many argscsg|]}|qSr)r_)rQargrrrrUsz$ArgList.__call__..)rrru string_typesrr!typerrcDEFAULT_DELIM_CHAR startswithALT_DELIM_CHARrrrrXrarbr_)rrarg_listrrrrr/s0     zArgList.__call__cCr0rrrrrrr1r2zArgList.hiddencCs~|jp|j}||g|j}|jr|j|j}nd}|dkr#d}n|dkr-d|}n|dkr8d||}nd||}|d d ||fD}t||jkrS|S|jdkr^d||S|jdkrid ||Sd ||S) aGet a specially-formatted metavar for the ArgList to use in help. An example is worth 1,000 words: >>> ArgList().GetUsageMetavar('FOO') '[FOO,...]' >>> ArgList(min_length=1).GetUsageMetavar('FOO') 'FOO,[FOO,...]' >>> ArgList(max_length=2).GetUsageMetavar('FOO') 'FOO,[FOO]' >>> ArgList(max_length=3).GetUsageMetavar('FOO') # One, two, many... 'FOO,[FOO,...]' >>> ArgList(min_length=2, max_length=2).GetUsageMetavar('FOO') 'FOO,FOO' >>> ArgList().GetUsageMetavar('REALLY_VERY_QUITE_LONG_METAVAR') 'REALLY_VERY_QUITE_LONG_METAVAR,[...]' Args: is_custom_metavar: unused in GetUsageMetavar metavar: string, the base metavar to turn into an ArgList metavar Returns: string, the ArgList usage metavar Nrr0r(z[{}]z [{0}{1}[{0}]]z [{}{}...]cSsg|]}|r|qSrr)rQxrrrrUrVz+ArgList.GetUsageMetavar..z {}{}[...]z{0}{1}...{1}[...])rcrhr%rarbr!rX_MAX_METAVAR_LENGTH)rr5r6 delim_charrA num_optionaloptionalmsgrrrr7s*        zArgList.GetUsageMetavarcCs~dSrrr;rrrr=r8zArgList.GetUsageExamplecCr>rrr?rrrrCrDzArgList.GetUsageHelpText)NrNNNNFr)rrrrrhrjrr/rorFr1r7r=rCrrrrrXZs&  5 :rXrmcharcCs0||r |dd}||r|dd}|S)z4Trims characters from the start and end of a string.r(Nr)rir)rmrtrrr_TrimCharacters    rucseZdZdZ          dfdd ZddZd d Zdd d ZdddZddZ fddZ e ddZ fddZ ddZdddZZS)ArgDictzInterpret an argument value as a dict. Intended to be used as the type= for a flag argument. Splits the string on commas to get a list, and then splits the items on equals to get a set of key-value pairs to get a dict. NrFc stt|j||| d|r|rtd||_||_||_||_|p"g|_| |_ |s-d|i}| D]} t | dkr@t d | q1dt|} dj t| d} t| tj|_||_d S) a6Initialize an ArgDict. Args: key_type: (str)->str, A function to apply to each of the dict keys. value_type: (str)->str, A function to apply to each of the dict values. spec: {str: (str)->str}, A mapping of expected keys to functions. The functions are applied to the values. If None, an arbitrary set of keys will be accepted. If not None, it is an error for the user to supply a key that is not in the spec. If the function specified is None, then accept a key only without '=value'. min_length: int, The minimum number of keys in the dict. max_length: int, The maximum number of keys in the dict. allow_key_only: bool, Allow empty values. required_keys: [str], Required keys in the dict. operators: operator_char -> value_type, Define multiple single character operators, each with its own value_type converter. Use value_type==None for no conversion. The default value is {'=': value_type} includes_json: bool, whether string parsed includes json cleanup_input: bool, whether to clean up the input string Returns: (str)->{str:str}, A function to parse the dict in the argument. Raises: ArgumentTypeError: If the list is malformed. ValueError: If both value_type and spec are provided. )rarbrz"cannot have both spec and sub_typerr(z$Operator [{}] must be one character.r0z([^{ops}]+)([{ops}]?)(.*))opsN)superrvrrkey_type value_typespecallow_key_only required_keys cleanup_inputkeysrXrr!r%ruiterkeysr~escapecompileDOTALL key_op_value operators)rryrzr{rarbr|r}rrr~oprwkey_op_value_pattern __class__rrrs4 &    zArgDict.__init__c Csb||jvr|j|dur|rtd|dS|j||Sttddt|j|d)NzKey [{0}] does not take a valuezvalid keys are [{0}]r$rz)r{rr!r#r%rtrrrormrrr _ApplySpecUs  zArgDict._ApplySpeccCs*|r |jr t|ts |S|}t|dS)N")r~rrWstripru)rrm removed_spacerrr _CleanupInputcs zArgDict._CleanupInputrcCs|r|dur|jstd||jr)z||}Wnty(td|w|jr4|jdd}nd}|j||}|rTz||}WntyStd|w|jdur_|||}||fS);Converts and validates and returns (key,value).NzBad syntax for dict arg: [{0}]. Please see `gcloud topic flags-file` or `gcloud topic escaping` for information on providing list or dictionary flag values with special characters.zInvalid key [{0}]rzInvalid value [{0}]) r|rr!ryrrrjr{r)rrormrdefault_convert convert_valuerrr_ValidateKeyValuejs0     zArgDict._ValidateKeyValuecCs&||||}}|j|||dS)rr)rr)rrormrr{r|rrr_CleanupAndValidateKeyValuesz#ArgDict._CleanupAndValidateKeyValuecCs&|jD] }||vrtd|qdS)Nz/Key [{0}] required in dict arg but not provided)r}rr!)rarg_dict required_keyrrr_CheckRequiredKeyss zArgDict._CheckRequiredKeysc st|tr"|}t}t|D]\}}|||\}}|||<qnPt|tjs3td t |j |t t ||}t}|D]0}|j|}|sRtd ||d|d|d}} }|j||| d\}}|||<qA|||S)NrdzInvalid flag value [{0}]r(rmrr)rr collections OrderedDictrurvrrfrr!rgrrxrvr/rrRrr) rrraw_dictrrormrkrerRrrrrr/s,     "  zArgDict.__call__cCr0rrrrrrr1r2zArgDict.hiddencs|jr|rtt|||Sg}tt|j}|D]\}}|dur1|js,td || |q|D]\}}|rJt |sJ| d || q4dd|d}|S)NzQKey [{0}] specified in spec without a function but allow_key_only is set to Falsez{0}={1}rz],[r)r{rxrvr7rtrurvr|rr!r usage_textIsHiddenrbr%)rr5r6msg_list spec_listspec_key spec_functionrsrrrr7s&    zArgDict.GetUsageMetavarcCsT~|jrdddt|jDS|jr|j}n|jpt}tj|j p%t|ddS)aReturns a string of usage examples. Generates an example of expected user input. For example, an ArgDict with spec={'x': int, 'y': str} will generate x=int,y=string An ArgDict with key_type=str and value_type=str will generate string=string Args: shorthand: unused bool, whether to display in shorthand (ArgDict is always parsed as shorthand) Returns: str, example text of usage rPcss$|] \}}tj||ddVqdS)Tr<NrGetNestedKeyValueExamplerQrormrrr s  z*ArgDict.GetUsageExample..T)ryrzr<) r{r%rtrr|rzrWrrry)rr<rzrrrr=s   zArgDict.GetUsageExamplecCr>rrr?rrrrCrDzArgDict.GetUsageHelpText) NNNrNFNNFF)rr)rrrrrrrrrrr/rFr1r7r=rC __classcell__rrrrrvs0=     'rvcseZdZdZdZddZddZ   d4fd d Zed d Z ddZ ddZ ddZ ddZ ddZddZfddZddZddZfd d!Zd"d#Zd$d%Zed&d'Zfd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd5d2d3ZZS)6 ArgObjecta Catch all arg type that will accept a file, json, or ArgDict. ArgObject is very similar to ArgDict with some extra functionality. ArgObject will first try to parse a value as an arg_dict if string contains '='. The type will then try to parse string as a file if string contains .yaml or .json. Finally, parser will parse the string as json. I. For example, with the following flag defintion: parser.add_argument( '--inputs', type=arg_parsers.ArgObject(key_type=str, value_type=int)) a caller can retrieve {"foo": 100} by specifying any of the following on the command line. (1) --inputs=foo=100 (2) --inputs='{"foo": 100}' (3) --inputs=path_to_json.(json|yaml) II. If we need the type return a list of messages, use the repeated arg. NOTE: when using repeated values, it is recommended to specify the action as arg_parsers.FlattenAction() For example, with the following flag defintion: parser.add_argument( '--inputs', type=arg_parsers.ArgObject(key_type=str, value_type=int), action=arg_parsers.FlattenAction() repeated=True) a caller can retrieve [{"foo": 1, "bar": 2}, {"bax": 3}] by specifying any of the following on the command line. (1) --inputs=foo=1,bar=2 --inputs=bax=3 (2) --inputs='[{"foo": 1, "bar": 2}, {"bax": 3}]' (3) --inputs=path_to_json.(json|yaml) III. If we need to parse non key-value pairs, do not provide key_type or spec. For example, with the following flag defintion: parser.add_argument( '--inputs', type=arg_parsers.ArgObject(value_type=int)) a caller can retrieve 100 by specifying the following on the command line. (1) --inputs=100 (2) --inputs=path_to_json.(json|yaml) IV. If we need to create nested objects, set value_type to another ArgObject type. ArgDict syntax is automatically disabled for the nested ArgObject type with enable_shorthand=False For example, with the following flag defintion: parser.add_argument( '--inputs', type=arg_parsers.ArgObject( key_type=str, value_type=arg_parsers.ArgObject( key_type=str, value_type=int, enable_shorthand=False))) a caller can retrieve {"foo": {"bar": 1}} by specifying any of the following on the command line. (1) --inputs='foo={bar=1}' (2) --inputs='{"foo": {"bar": 1}}' (3) --inputs=path_to_json.(json|yaml) rKcCst|tr d|_dSdSr)rr root_level)rarg_typerrr_UpdateAsNestedCs  zArgObject._UpdateAsNestedcCs|tkrtS|Sr)boolr")rrzrrr_JSONValueTypeGszArgObject._JSONValueTypeNFTc  s|r|n|r|D]} | q|o"fdd|D}ttj||||dd| d|_|_|dupB|du_ |_ |_ | _ | _ | _jraj sctdjdSdS)Ncsi|] \}}||qSr)rrrrr ^r}z&ArgObject.__init__..T)ryrzr{r}rr~r|zArgObject type listed required keys as {}. Keys can only be listed as required if `spec` or `key_type` arguments are provided to the ArgObject type.)rrrrxrrr help_textrepeated _keyed_values_hiddenenable_shorthandenable_file_upload_disable_key_descriptionrr}rr!)rryrzr{r}rrr1rrdisable_key_descriptionrr|rm spec_typerrrrPs6      zArgObject.__init__cCs |jo|jSr)rrrrrrparse_as_arg_dictss zArgObject.parse_as_arg_dictcCst|tr|jrg}|D] }|||}||q |St|tr>|jr>t}| D]\}}|||\}}|||<q,|S|d|\}}|S)aqApplies callback for arg_value. Arg_value can be a dictionary, list, or other value. Args: arg_value: can be a dictionary, list, or other value, callback: (key, val) -> key, val, function that accepts key and value and returns transformed values. Returns: dictionary, list, or value with callback operation performed on it. N) rrr_Maprrrrrr)rrcallbackrkrmrrorqrrrrws    zArgObject._MapcCsZ|dur|jrtd||durt|tst|}|dur)t|ts)t|}||fS)z$Returns string version of arguments.Nz*Expecting {} to be json or arg_dict format)rrr!rrWjsondumpsrrrr_StringifyValuess zArgObject._StringifyValuescCs|||jSr)rrrrrrr_StringifyDictValuesszArgObject._StringifyDictValuescCs|jot|Sr)rrMrrrr_CheckIfFileFormatszArgObject._CheckIfFileFormatcCs|ddlm}z,||}t|tr|r|}n|}t|ts"WdStdd|Dr0WdSWdS|j y=YdSw)z5Checks if arg_value can be loaded into a json object.rrQFcss|]}|duVqdSrrrQvalrrrrsz/ArgObject._CheckIfJSONObject..T) rSrRrTrrrrallrYAMLParseError)rrrR parsed_json json_dictrrr_CheckIfJSONObjects    zArgObject._CheckIfJSONObjectcCs$|js|jr t|}n|}||S)zLoads json string or file into a dictionary. Args: arg_value: str, path to a json or yaml file or json string Returns: Dictionary [str: str] where the value is a json string or other String value )rrrUr)rr json_valuerrrrUs  zArgObject._LoadJSONcs<t|tr|D] }tt||qdStt||dSr)rrrxrr)rrrmrrrrs zArgObject._CheckRequiredKeyscCs"|||j}|jr|||Sr)rrr}r)rrrrrr_ParseAndValidateJSONs zArgObject._ParseAndValidateJSONcCs*d|j}td|d|p|jS)N|())r%rrr~searchr|)rrrwrrr_ContainsArgDictszArgObject._ContainsArgDictcs~|}|dr$|dr$jr$t|dddd}fdd|DS|d r5|d r5|dd}n|}tt|S) Nrrr(rT)rcsg|] }|qSr) _ParseArgDictrrrrrrUsz+ArgObject._ParseArgDict..rr)rrirrrrxrr/)rrstripped_valuer arg_dict_strrrrrszArgObject._ParseArgDictcCs,|jsdSd}||kp||o|| S)NFr0)rrr)rrempty_obj_shorthandrrr_CheckIfArgDictFormats  zArgObject._CheckIfArgDictFormatcCst|ts td|||r t|}||}||}n||r+| |}n ||}||}|j r@t|t s@|g}|S)Nz6ArgObject can only convert string values. Received {}.) rrWrr!rrOrUrrrrr)rr file_contentrrmrrrr/s"        zArgObject.__call__cCsF|jdur|jS|jrtdd|jDSt|jp"t|jS)Ncss|]}t|VqdSr)rr)rQrmrrrrsz#ArgObject.hidden..)rr{rrrrryrzrrrrr1s   zArgObject.hiddencs|jr tt|||S|Sr)rrxrr7r4rrrr7 szArgObject.GetUsageMetavarc s|jrdS|o |j}|j}|j}|p| p||jdur;r dnd}fddt|jD}|dd|D}n t |j |j pCt }| pL|j }|rW|rWd|d}|ra|rad |d }|S) azReturns a string of usage examples. Recursively generates an example of expected user input. For example, an ArgObject with spec={'x': int, 'y': str} will generate... x=int,y=string (shorthand) and {"x": int, "y": "string"} (json) An ArgObject with key_type=str and value_type=str will generate... string=string (shorthand) and {"string": "string"} (json) An ArgObject with value_type=str will always generate... string (shorthand and json) Args: shorthand: bool, whether to display in shorthand Returns: str | None, example text of usage. None if hidden. NrPr$c3s"|] \}}t||VqdSrrrformat_as_shorthandrrrKs  z,ArgObject.GetUsageExample..cs|] }|dur|VqdSrrrQlinerrrrNrrrr)r1rrrr{rtrr%rrryrzrWr) rr<shorthand_enabled is_json_objis_arraycommaexampleusageinclude_bracketsrrrr=&s*       zArgObject.GetUsageExamplecCs|jdd}|js|jrd}|d|}n|j}|}tj|||d}tj||jddd}tj|dd}||kr?d||Sd |||S) z(Returns a string of user input examples.TrFrP)arg_namerr)rrzpath_to_file.(yaml|json)z)*Input Example:* {} *File Example:* {}zB*Shorthand Example:* {} *JSON Example:* {} *File Example:* {})r=rrrFormatCodeSnippetr!)rrBshorthand_snippetrsnippetshorthand_example json_example file_examplerrr_GetCodeExamples]s4   zArgObject._GetCodeExamplescCs^tj|||jd}|js|jst|jtjr|j||}nd}|r-||kr-|d|S|S)+Returns a string of help text for the flag.)rN ) rFormatHelpTextrr{ryrrz ArgTypeUsagerC)rr@rAroot_help_textadditional_help_textrrr_FormatRootHelpText~s  zArgObject._FormatRootHelpTextcsjg}jrfddtjD}|||Sjr3|tdj|tdjp0t |S)rc3s(|]\}}t|||jvVqdSr)rGetNestedUsageHelpTextr})rQrorrrrrs  z6ArgObject._GetKeyValueUsageHelpText..KEYVALUE) r{rtrextendryrrrrzrW)rrrrrr_GetKeyValueUsageHelpTexts     z#ArgObject._GetKeyValueUsageHelpTextcCsb|jrdSg}|||||js|||r'|tj||d dd|DS)a9Returns a string of usage help text. Recursively generates usage help text to provide the user with more information on valid flag values and the general schema. For example, ArgObject with... spec={ 'x': int, 'y': arg_parsers.ArgObject(help_text='Y help.', spec={'z': str}), } will generate the following by default... ``` *x* Sets `z` value. *y* Y help. *z* Sets `z` value. ``` Args: field_name: str | None, field the flag of this type is setting required: bool, whether the flag of this type is required flag_name: str | None, the name of the flag. If not none, will generate code examples. Returns: str | None, help text with schema and examples. None if hidden. Nrcsrrrrrrrrrz-ArgObject.GetUsageHelpText..) r1rrrrrr ASCII_INDENTrr%)rr@rArBrrrrrCs"zArgObject.GetUsageHelpText) NNNNNFNTTFTFr)rrrr_file_path_patternrrrrFrrrrrrrUrrrrrr/r1r7r=rrrrCrrrrrrsBH #        7!rc sPeZdZdZd ddZddddddddef fdd Zdd Zd d d ZZS) UpdateActiona=Create a single dict value from delimited or repeated flags. This class is intended to be a more flexible version of argparse._AppendAction. For example, with the following flag definition: parser.add_argument( '--inputs', type=arg_parsers.ArgDict(), action='append') a caller can specify on the command line flags such as: --inputs k1=v1,k2=v2 and the result will be a list of one dict: [{ 'k1': 'v1', 'k2': 'v2' }] Specifying two separate command line flags such as: --inputs k1=v1 \ --inputs k2=v2 will produce a list of dicts: [{ 'k1': 'v1'}, { 'k2': 'v2' }] The UpdateAction class allows for both of the above user inputs to result in the same: a single dictionary: { 'k1': 'v1', 'k2': 'v2' } This gives end-users a lot more flexibility in constructing their command lines, especially when scripting calls. Note that this class will raise an exception if a key value is specified more than once. To allow for a key value to be specified multiple times, use UpdateActionWithAppend. NcCsB|durd}n dt|t|g}t|td||d)Nr$z("{0}" cannot be specified multiple timesrz)r%rurargparse ArgumentErrorr#r!)rroexisting_valuerrrrrOnDuplicateKeyRaiseErrorsz%UpdateAction.OnDuplicateKeyRaiseErrorFc sz|dkrtd|dur|tjkrtdtj||_t|tr&t|}tt |j ||||||||| | d | |_ dS)Nrznargs for append actions must be > 0; if arg strings are not supplying the value to append, the append const action may be more appropriatez nargs must be %r to supply const) option_stringsdestnargsconstrrgr[rAhelpr6) rrOPTIONALr[rrrtrrxrronduplicatekey_handler rrrrrrrgr[rArr6rrrrrs(     zUpdateAction.__init__cCs&t||ddurt|||t||Sr)getattrsetattr)r namespacenamermrrr _EnsureValue6s  zUpdateAction._EnsureValuecCst|tr/t|||jt}t|D]\}}||vr)| |||||}|||<qn t|||jg}|D]}||vrI| ||q<| |qeZdZdZdddZddddddddef fdd ZZS) UpdateActionWithAppenda^Create a single dict value from delimited or repeated flags. This class provides a variant of UpdateAction, which allows for users to append, rather than reject, duplicate key values. For example, the user can specify: --inputs k1=v1a --inputs k1=v1b --inputs k2=v2 and the result will be: { 'k1': ['v1a', 'v1b'], 'k2': 'v2' } NcCs(|dur|St|tr||gS||gSr)rr)rrorrrrrOnDuplicateKeyAppendcs   z+UpdateActionWithAppend.OnDuplicateKeyAppendFc s*tt|j||||||||| | | d dS)N) rrrrrrgr[rArr6r)rxr rrrrrrks  zUpdateActionWithAppend.__init__r )rrrrrrrrrrrr Us  r cs8eZdZdZfddZddZddZdd ZZS) RemainderActiona0An action with a couple of helpers to better handle --. argparse on its own does not properly handle -- implementation args. argparse.REMAINDER greedily steals valid flags before a --, and nargs='*' will bind to [] and not parse args after --. This Action represents arguments to be passed through to a subcommand after --. Primarily, this Action provides two utility parsers to help a modified ArgumentParser parse -- properly. There is one additional property kwarg: example: A usage statement used to construct nice additional help. cs|dtjur tddj|dd|_d|vr6|dd|j7<d|vr6|dd |d7<|d=tt|j|i|dS) NrzFThe RemainderAction should only be used when nargs=argparse.REMAINDER.zhThe '--' argument must be specified between gcloud specific args on the left and {metavar} on the right.r6)r6rz + rz Example: )r REMAINDERrr! explanationrxrrrrr[rrrrszRemainderAction.__init__cCs&|d}|d|||ddfS)N--r()index)rr split_indexrrr _SplitOnDashs zRemainderAction._SplitOnDashcCs.d}d|vr ||\}}|d||||fS)z)Binds all args after -- to the namespace.Nr)r)rrrremainder_argsrrrParseKnownArgss  zRemainderAction.ParseKnownArgsc Csd|vr ||\}}d}ttt|t|D]\}\}}||kr*t||}nq||d} |d|}| rJd|jjd| d} t | |d|| ||fS)aParses the unrecognized args from the end of the remaining_args. This method identifies all unrecognized arguments after the last argument recognized by a parser (but before --). It then either logs a warning and binds them to the namespace or raises an error, depending on strictness. Args: remaining_args: A list of arguments that the parsers did not recognize. namespace: The Namespace to bind to. original_args: The full list of arguments given to the top parser, Raises: ArgumentError: If there were remaining arguments after the last recognized argument and this action is strict. Returns: A tuple of the updated namespace and unrecognized arguments (before the last recognized argument). rrNzunrecognized args: {args} r)r) r enumeraterrcrXrr!r%rUnrecognizedArgumentsError) rremaining_argsr original_argsrqrrfarg1arg2pass_through_argsrsrrrParseRemainingArgss*      z"RemainderAction.ParseRemainingArgs) rrrrrrrr rrrrrrs   rcsGfdddtj}|S)zCreates an action that concats flag values. Args: dedup: bool, determines whether values in generated list should be unique Returns: A custom argparse action that flattens the values before adding to namespace cseZdZdZdfdd ZdS)zFlattenAction..Actiona2Create a single list from delimited flags. For example, with the following flag defition: parser.add_argument( '--inputs', type=arg_parsers.ArgObject(repeated=True), action=FlattenAction(dedup=True)) a caller can specify on the command line flags such as: --inputs '["v1", "v2"]' --inputs '["v3", "v4"]' and the result will be one list of non-repeating values: ["v1", "v2", "v3", "v4"] Recommend using this action with ArgObject where `repeated` is set to True. This allows users to set the list either with append action or with one json list. For example, all below examples result in ["v1", "v2", "v3", "v4"] 1) --inputs v1 --inputs v2 --inputs v3 --inputs v4 2) --inputs '["v1", "v2", "v3", "v4"]' Nc sRt||jd}t||}r g}|D] }||vr||q|}t||j|dSr)rrrrr) rrrrr r all_valuesdeduped_valuesrmdeduprrr/ s  z&FlattenAction..Action.__call__r)rrrrr/rr#rrActionsr%rr%)r$r%rr#r FlattenActions 'r'cs2eZdZdZddZfddZd ddZZS) StoreOnceActionaAction that disallows repeating a flag. When using action='store' (the default), argparse allows multiple instances of a flag to be specified with the last one determining the value and the rest silently dropped. This is often undesirable if the command accepts only one value but users try to repeat the flag (either accidentally, or when mistakenly expecting the repeated values to be appended or merged somehow). In such cases, one can instead use StoreOnceAction which disallows specifying the same flag multiple times. So for instance, providing: --foo 123 --foo 456 will result in an error stating that --foo cannot be specified more than once. cCst|td|j)Nz1"{0}" argument cannot be specified multiple times)rrr#r!rrrrrOnSecondArgumentRaiseError% sz*StoreOnceAction.OnSecondArgumentRaiseErrorcs d|_tt|j|i|dSr)dest_is_populatedrxr(rrrrrr, zStoreOnceAction.__init__NcC&|jr|d|_t||j|dSNT)r*r)rrrrrrr rrrr/1 zStoreOnceAction.__call__r)rrrrr)rr/rrrrrr( s  r(cGfdddtjS)aEmits a warning message when a flag is specified more than once. The created action is similar to StoreOnceAction. The difference is that this action prints a warning message instead of raising an exception when the flag is specified more than once. Because it is a breaking change to switch an existing flag to StoreOnceAction, StoreOnceWarningAction can be used in the deprecation period. Args: flag_name: The name of the flag to apply this action on. Returns: An Action class. cs8eZdZdZfddZfddZd ddZZS) z&StoreOnceWarningAction..Actionz@Emits a warning message when a flag is specified more than once.cstddS)Nzt"{0}" argument is specified multiple times which will be disallowed in future versions. Please only specify it once.)rwarningr!rrBrrOnSecondArgumentPrintWarningL szCStoreOnceWarningAction..Action.OnSecondArgumentPrintWarningcs d|_t|j|i|dSr)r*rxrrr%rrrrQ r+z/StoreOnceWarningAction..Action.__init__NcSr,r-)r*r3rrr.rrrr/U r/z/StoreOnceWarningAction..Action.__call__r)rrrrr3rr/rrr%rBrrr%I s  r%r&r2rr5rStoreOnceWarningAction9 sr6c*eZdZdZfddZdddZZS)_HandleNoArgActionzFThis class should not be used directly, use HandleNoArgAction instead.c s&tt|jdi|||_||_dS)Nr)rxr8rnone_argdeprecation_message)rr9r:r[rrrrb s z_HandleNoArgAction.__init__NcCs:|durt|j|jrt||jdt||j|dSr-)rr1r:r9rr)rrrrmr rrrr/g s  z_HandleNoArgAction.__call__rrrrrrr/rrrrrr8_ s r8cr)aCreates an argparse.Action that warns when called with no arguments. This function creates an argparse action which can be used to gracefully deprecate a flag using nargs=?. When a flag is created with this action, it simply log.warning()s the given deprecation_message and then sets the value of the none_arg to True. This means if you use the none_arg no_foo and attach this action to foo, `--foo` (no argument), it will have the same effect as `--no-foo`. Args: none_arg: a boolean argument to write to. For --no-foo use "no_foo" deprecation_message: msg to tell user to stop using with no arguments. Returns: An argparse action. cstfi|Sr)r8)r[r:r9rrHandleNoArgActionInit sz0HandleNoArgAction..HandleNoArgActionInitr)r9r:r=rr<rHandleNoArgActionp sr>c@sHeZdZdZdddZeddZddZd d Zdd d Z ddZ d S)rNafCreates an argparse type that reads the contents of a file or stdin. This is similar to argparse.FileType, but unlike FileType it does not leave a dangling file handle open. The argument stored in the argparse Namespace is the file's contents. Attributes: binary: bool, If True, the contents of the file will be returned as bytes. default_help_text_disabled: bool, If True, the autogenerated help text will include additional information about how to use this file flag type. Returns: A function that accepts a filename, or "-" representing that stdin should be used as input. FcCrr)binarydefault_help_text_disabled)rr?r@rrrr rzFileContents.__init__cCr0rrrrrrr1 r2zFileContents.hiddencCs|s|jsdS|S)aProvides a more user friendly metavar for file contents. `PATH_TO_FILE` is used as the default metavar for file contents flags only when (1) a custom metavar is not provided and (2) the default help text is enabled. Args: is_custom_metavar: bool, True if the user provided a custom metavar. metavar: str, the metavar to use if a custom metavar was not provided. Returns: The metavar to use for this file contents flag. PATH_TO_FILE)r@r4rrrr7 s zFileContents.GetUsageMetavarcCr9)aVGenerates a usage example for file contents flags. This default usage example is used to generate example input values. This is currently just used to generate ArgObject help text examples. Args: shorthand: bool, unused for file contents flags. Returns: The example input value for this file contents flag. path_to_filerr;rrrr= s zFileContents.GetUsageExampleNcCs(~~|jstdd|}d|dSdS)aAutogenerates additional help text for file contents flags. Additional help text is only added when the default help text is enabled. Args: field_name: str, the name of the field this flag is associated with. required: bool, True if this flag is required. flag_name: str, the name of the flag this help text is associated with. Returns: Additional help text for this file contents flag. z _from_file$r0zDUse a full or relative path to a local file containing the value of rN)r@r~sub)rr@rArBsub_field_namerrrrC s zFileContents.GetUsageHelpTextc Cs6z tj||jdWStjy}zt|d}~ww)aSReturn the contents of the file with the specified name. If name is "-", stdin is read until EOF. Otherwise, the named file is read. Args: name: str, The file name, or '-' to indicate stdin. Returns: The contents of the file. Raises: ArgumentTypeError: If the file cannot be read or is too large. r?N)r ReadFromFileOrStdinr?r rrrrrrrrr/ s zFileContents.__call__)FFr) rrrrrrFr1r7r=rCr/rrrrrN s    rNc@s2eZdZdZd ddZddZddZd d ZdS) YAMLFileContentsaCreates an argparse type that reads the contents of a YAML or JSON file. This is similar to argparse.FileType, but unlike FileType it does not leave a dangling file handle open. The argument stored in the argparse Namespace is the file's contents parsed as a YAML object. Attributes: validator: function, Function that will validate the provided input file contents. Returns: A function that accepts a filename that should be parsed as a YAML or JSON file. NcCs|r t|s td||_dS)NzValidator must be callable)callabler validator)rrJrrrr s  zYAMLFileContents.__init__cCs6ddlm}||s||std|dSdS)NrrQzInvalid YAML/JSON Data [{}])rSrR dict_like list_likerr!)r yaml_datarRrrr_AssertJSONLike s z YAMLFileContents._AssertJSONLikecCspddlm}|dkrt}||}n||}dd|D}t|dkr*|dS|dkr3||S||S)aReturns the yaml data for a file or from stdin for a single document. YAML allows multiple documents in a single file by using `---` as a separator between documents. See https://yaml.org/spec/1.1/#id857577. However, some YAML-generating tools generate a single document followed by this separator before ending the file. This method supports the case of a single document in a file that contains superfluous document separators, but still throws if multiple documents are actually found. Args: name: str, The file path to the file or "-" to read from stdin. Returns: The contents of the file parsed as a YAML data object. rrQ-cSsg|]}|dur|qSrr)rQr.rrrrU$ rrz.r() rSrRr ReadStdinload_all load_all_pathrXrT load_path)rrrRstdinrMrrr_LoadSingleYamlDocument s      z(YAMLFileContents._LoadSingleYamlDocumentc Csnddlm}z||}|||jr ||s td||WS|j|jfy6}zt |d}~ww)aLoad YAML data from file path (name) or stdin. If name is "-", stdin is read until EOF. Otherwise, the named file is read. If self.validator is set, call it on the yaml data once it is loaded. Args: name: str, The file path to the file. Returns: The contents of the file parsed as a YAML data object. Raises: ArgumentTypeError: If the file cannot be read or is not a JSON/YAML like object. ValueError: If file content fails validation. rrQzInvalid YAML/JSON content [{}]N) rSrRrUrNrJrr!r FileLoadErrorr)rrrRrMrrrrr/1 s    zYAMLFileContents.__call__r)rrrrrrNrUr/rrrrrH s   'rHcs eZdZdZfddZZS)StoreTrueFalseActionaArgparse action that acts as a combination of store_true and store_false. Calliope already gives any bool-type arguments the standard and `--no-` variants. In most cases we only want to document the option that does something---if we have `default=False`, we don't want to show `--no-foo`, since it won't do anything. But in some cases we *do* want to show both variants: one example is when `--foo` means "enable," `--no-foo` means "disable," and neither means "do nothing." The obvious way to represent this is `default=None`; however, (1) the default value of `default` is already None, so most boolean actions would have this setting by default (not what we want), and (2) we still want an option to have this True/False/None behavior *without* the flag documentation. To get around this, we have an opt-in version of the same thing that documents both the flag and its inverse. cstt|j|ddi|dS)Nr)rxrWrrrrrre zStoreTrueFalseAction.__init__)rrrrrrrrrrrWR srWcr0)zReturns Action that stores both file content and file path. Args: binary: boolean, whether or not this is a binary file. Returns: An argparse action. cs0eZdZdZfddZdfdd ZZS)z.StoreFilePathAndContentsAction..ActionzStores both file content and file path. Stores file contents under original flag DEST and stores file path under DEST_path. cst|j|i|dSr)rxrrr4rrrz sz7StoreFilePathAndContentsAction..Action.__init__Nc s`z tj|d}Wntjy}zt|d}~wwt||j|d|j}t|||dS)z?Stores the contents of the file and the file name in namespace.rENz{}_path)r rFr rrrrr!)rrrrmr contentrnew_destrErrr/} s z7StoreFilePathAndContentsAction..Action.__call__rr;rr%r?rrr%s sr%r&rErr[rStoreFilePathAndContentsActioni s r\cr7)ExtendConstActionz*Extends the dest arg with a constant list.cstt|j|ddi|dS)Nrr)rxr]rrrrrr rXzExtendConstAction.__init__NcCs&t||jg}t||j||jdS)z%Extends the dest with the const list.N)rrrr)rrrrmr currrrr/ szExtendConstAction.__call__rr;rrrrr] s r]c@s"eZdZdZdddZddZdS) FilePathOrStdinContentsaCreates an argparse type that stores a file path or the contents of stdin. This is similar to FileContents above but only reads content from stdin, otherwise just stores the file/directory path. Attributes: binary: bool, If True, the contents of the file will be returned as bytes. Returns: A function that accepts a filename, or "-" representing that stdin should be used as input. FcCs ||_dSrrE)rr?rrrr rPz FilePathOrStdinContents.__init__c CsJz|dkrtj||jdWSt|WStjy$}zt|d}~ww)ajReturn the contents of stdin or the filepath specified. If name is "-", stdin is read until EOF. Otherwise, the named file path is returned. Args: name: str, The file name, or '-' to indicate stdin. Returns: The contents of stdin or the file path. Raises: ArgumentTypeError: If stdin cannot be read or is too large. rOrEN)r rFr?r ExpandHomeAndVarsrrrGrrrr/ s z FilePathOrStdinContents.__call__Nr)rrrrrr/rrrrr_ s r_r )r?)NNTr?Nr)r+rNr+)NNNr3r?rE)rPF)FT)Tr)gr __future__rrrrrr rFrr~dateutilrgooglecloudsdk.callioperrrrSrr googlecloudsdk.core.consoler r googlecloudsdk.core.utilr r ru six.movesr__all__ Exceptionrrrrrr#r'rr_SECOND_MINUTE_HOUR_DAY_DURATION_SCALESrirJrOrarhrkrrrrr_KV_PAIR_DELIMITERobjectrrrrrrrrrr rrrr r!rr"rrJrMrOrUrVrXrWrurvrr%rr  _StoreActionrr'r(r6r8r>rNrH_StoreTrueActionrWr\r]r_rrrrs "                o ( Z :27 = (0 3 ). ib~1 Y5%&dd !