U hg?@sdZddlmZddlZddlZddlZddlZddlmZm Z m Z m Z m Z ddl mZddl mZe eeefZe eeje ee eegeffe eejejfZe egefZddd d d Zddd d dZejddGdddejZd(ddddddddZGdddejZ GdddejZ!GdddejZ"ejddGd d!d!eZ#Gd"d#d#e#Z$Gd$d%d%eZ%ejddGd&d'd'eZ&dS))aYClasses that define arguments for populating ArgumentParser. The argparse module's ArgumentParser.add_argument() takes several parameters and is quite customizable. However this can lead to bugs where arguments do not behave as expected. For better ease-of-use and better testability, define a set of classes for the types of flags used by LLM Magics. Sample usage: str_flag = SingleValueFlagDef(name="title", required=True) enum_flag = EnumFlagDef(name="colors", required=True, enum_type=ColorsEnum) str_flag.add_argument_to_parser(my_parser) enum_flag.add_argument_to_parser(my_parser) ) annotationsN)AnyCallableSequenceUnionTuple)llmfn_inputs_source) llmfn_outputs type[Any]str)xreturncCs*z|jWStk r$t|YSXdSN)__name__AttributeErrorr r rI/tmp/pip-unpacked-wheel-doshhd5e/google/generativeai/notebook/flag_def.py_get_type_name?sr)namer cCs$|s td|ddkr td|S)z.Validation for long and short names for flags.zCannot be emptyr-zCannot start with dash) ValueError)rrrr_validate_flag_nameFs  rT)frozenc@seZdZUdZded<dZded<dZded <eZd ed <dZ d ed <dZ ded<dZ ded<dZ ded<e jdddddZe jddddZddddZdddd Zd!d"ZdS)#FlagDefaAbstract base class for flag definitions. Attributes: name: Long name, e.g. "colors" will define the flag "--colors". required: Whether the flag must be provided on the command line. short_name: Optional short name. parse_type: The type that ArgumentParser should parse the command line argument to. dest_type: The type that the parsed value is converted to. This is used when we want ArgumentParser to parse as one type, then convert to a different type. E.g. for enums we parse as "str" then convert to the desired enum type in order to provide cleaner help messages. parse_to_dest_type_fn: If provided, this function will be used to convert the value from `parse_type` to `dest_type`. This can be used for validation as well. choices: If provided, limit the set of acceptable values to these choices. help_msg: If provided, adds help message when -h is used in the command line. r rFboolrequiredN str | None short_nameztype[_PARSETYPES] parse_typeztype[_DESTTYPES] | None dest_typez_PARSEFN | Noneparse_to_dest_type_fnzlist[_PARSETYPES] | Nonechoiceshelp_msgargparse.ArgumentParserNoneparserr cCsdS)zAdds this flag as an argument to `parser`. Child classes should implement this as a call to parser.add_argument() with the appropriate parameters. Args: parser: The parser to which this argument will be added. Nr)selfr'rrradd_argument_to_parserqszFlagDef.add_argument_to_parserr cCsdS)z.For child classes to do additional validation.Nrr(rrr_do_additional_validation|sz!FlagDef._do_additional_validationztype[_DESTTYPES]cCs|jdkr|jS|jS)z!Returns the final converted type.N)r rr+rrr_get_dest_typeszFlagDef._get_dest_type_PARSEFNcCs2|jdk r|jS|}||jkr*ddS|SdS)z;Returns a function to convert from parse_type to dest_type.NcSs|Srrrrrrz4FlagDef._get_parse_to_dest_type_fn..)r!r-r)r(r rrr_get_parse_to_dest_type_fns   z"FlagDef._get_parse_to_dest_type_fncCs*t|j|jdk rt|j|dSr)rrrr,r+rrr __post_init__s   zFlagDef.__post_init__)r __module__ __qualname____doc____annotations__rrr rr r!r"r#abcabstractmethodr)r,r-r1r2rrrrrOs          rFargparse.Namespacerr) namespacedest has_default default_valuer cCs$t||sdS|sdSt|||kS)aReturns true if `namespace.dest` is set to a non-default value. Args: namespace: The Namespace that is populated by ArgumentParser. dest: The attribute in the Namespacde to be populated. has_default: "None" is a valid default value so we use an additional `has_default` boolean to indicate that `default_value` is present. default_value: The default value to use when `has_default` is True. Returns: Whether namespace.dest is set to something other than the default value. FT)hasattrgetattr)r:r;r<r=rrr_has_non_default_values  r@cs>eZdZdZdddfdd Zddd d d d d dZZS)_SingleValueStoreActionz}Custom Action for storing a value in an argparse.Namespace. This action checks that the flag is specified at-most once. r r.r r!c s"tj||f|||_||_dSrsuper__init__ _dest_type_parse_to_dest_type_fnr(option_stringsr;r r!kwargs __class__rrrEsz _SingleValueStoreAction.__init__Nr$r9str | Sequence[Any] | Nonerr'r:values option_stringc Cst|tst|trtt||jt|dt|ddrHt |d |z| |d}WnDt k r}z&t |d |dt t||W5d}~XYnXt||jstd t |jt t|t||j|dS)Ndefaultr<r=Cannot set {} more than oncer!Error with value "{}", got {}: {}+Converted to wrong type, expected {} got {}) isinstancer bytesAssertionErrorr@r;r>r?argparse ArgumentErrorformatrG ExceptionrtyperF RuntimeErrorsetattr)r(r'r:rOrPconverted_valueerrr__call__s<    z _SingleValueStoreAction.__call__)Nrr3r4r5rErb __classcell__rrrKrrAsrAcs>eZdZdZdddfdd Zddd d d d d dZZS)_MultiValuesAppendActionz~Custom Action for appending values in an argparse.Namespace. This action checks that the flag is specified at-most once. r r.rBc s"tj||f|||_||_dSrrCrHrKrrrEsz!_MultiValuesAppendAction.__init__Nr$r9rMrrNc Cst|tst|trtt||j}|r:t|d||D]}z| |}WnDt k r}z&t|d|dt t ||W5d}~XYnXt||j std|j t |||krt|d|||q>dS)NrSrTrrUzDuplicate values "{}")rVr rWrXr?r;rYrZr[rGr\rr]rFr^append) r(r'r:rOrPZ curr_valuevaluer`rarrrrbs@    z!_MultiValuesAppendAction.__call__)NrcrrrKrresrecs6eZdZdZfddZd ddddd d d ZZS) _BooleanValueStoreActionzCustom Action for setting a boolean value in argparse.Namespace. The boolean flag expects the default to be False and will set the value to True. This action checks that the flag is specified at-most once. c stj||f|dSr)rDrE)r(rIr;rJrKrrrE5sz!_BooleanValueStoreAction.__init__Nr$r9rMrrNcCs6t||jdddr$t|d|t||jddS)NTFrRrS)r@r;rYrZr[r_)r(r'r:rOrPrrrrb=sz!_BooleanValueStoreAction.__call__)NrcrrrKrrh-s rhc@s^eZdZUdZGdddejZejZde d<dddd Z d d d d dZ d dddZ dS)SingleValueFlagDefa_Definition for a flag that takes a single value. Sample usage: # This defines a flag that can be specified on the command line as: # --count=10 flag = SingleValueFlagDef(name="count", parse_type=int, required=True) flag.add_argument_to_parser(argument_parser) Attributes: default_value: Default value for optional flags. c@seZdZdZdZdS)z SingleValueFlagDef._DefaultValuezSpecial value to represent "no value provided". "None" can be used as a default value, so in order to differentiate between "None" and "no value provided", create a special value for "no value provided". N)rr3r4r5NOT_SETrrrr _DefaultValue_srkz!_DESTTYPES | _DefaultValue | Noner=rr*cCs|jtjjkS)z2Returns whether `default_value` has been provided.)r=rirkrjr+rrr_has_default_valueksz%SingleValueFlagDef._has_default_valuer$r%r&c Csd|jg}|jdk r&|d|jg7}i}|r<|j|d<|jdk rP|j|d<|jdk rd|j|d<|j|t|j| | |j dd|dS)N--rrQr"help)actionr]r r!rnargs) rrrlr=r"r# add_argumentrArr-r1rr(r'argsrJrrrr)os*       z)SingleValueFlagDef.add_argument_to_parsercCsV|jr|r(tdn|s(td|rR|jdk rRt|j|sRtddS)Nz(Required flags cannot have default valuez(Optional flags must have a default valuez>Default value must be of the same type as the destination type)rrlrr=rVr-r+rrrr,s z,SingleValueFlagDef._do_additional_validationN) rr3r4r5enumEnumrkrjr=r6rlr)r,rrrrriQs   rics&eZdZdZddfdd ZZS) EnumFlagDefaFDefinition for a flag that takes a value from an Enum. Sample usage: # This defines a flag that can be specified on the command line as: # --color=red flag = SingleValueFlagDef(name="color", enum_type=ColorsEnum, required=True) flag.add_argument_to_parser(argument_parser) ztype[enum.Enum]) enum_typec st|tjstdd|kr$tdt|d<d|krsz(EnumFlagDef.__init__..) issubclassrurv TypeErrorrr r[rDrE)r(rxrtrJr rKrrrEs0    zEnumFlagDef.__init__)rr3r4r5rErdrrrKrrws rwc@s.eZdZdZdddddZdddd Zd S) MultiValuesFlagDefa*Definition for a flag that takes multiple values. Sample usage: # This defines a flag that can be specified on the command line as: # --colors=red green blue flag = MultiValuesFlagDef(name="colors", parse_type=str, required=True) flag.add_argument_to_parser(argument_parser) r$r%r&c Csd|jg}|jdk r&|d|jg7}i}|jdk r>|j|d<|jdk rR|j|d<|j|t|j|||j gdd|dS)Nrmrr"rn+)rpr]r r!rrQrq) rrr"r#rrrerr-r1rrsrrrr)s(       z)MultiValuesFlagDef.add_argument_to_parserr*cCsdSrrr+rrrr,sz,MultiValuesFlagDef._do_additional_validationN)rr3r4r5r)r,rrrrr}s r}c@s.eZdZdZddddZddddd Zd S) BooleanFlagDefzDefinition for a Boolean flag. A boolean flag is always optional with a default value of False. The flag does not take any values. Specifying the flag on the commandline will set it to True. r%r*cCs:|jdk rtd|jdk r$td|jdk r6tddS)Nz*dest_type cannot be set for BooleanFlagDefz6parse_to_dest_type_fn cannot be set for BooleanFlagDefz(choices cannot be set for BooleanFlagDef)r rr!r"r+rrrr,s    z(BooleanFlagDef._do_additional_validationr$r&cCs^d|jg}|jdk r&|d|jg7}i}|jdk r>|j|d<|j|ttdddd|dS)NrmrrnFr)rpr]rrQrq)rrr#rrrhrrsrrrr)s     z%BooleanFlagDef.add_argument_to_parserN)rr3r4r5r,r)rrrrrsr)FN)'r5 __future__rr7rYZ dataclassesrutypingrrrrrZ google.generativeai.notebook.librr r intfloatZ _PARSETYPESrvZLLMFnInputsSourceZLLMFnOutputsSinkZ _DESTTYPESr.rrZ dataclassABCrr@ActionrArerhrirwr}rrrrrsF     L;<$ D+&