B/jSrSSKJr SSKJr SSKJr SSKrSSKJr SSKJr SSKJ r S \R4S jr S \R4S jr S \R4S jr S \R4Sjr\R4Sjr\R4SjrS\R4SjrS\R4SjrSrg)aModule to enforce different constraints on flags. Flags validators can be registered using following functions / decorators: flags.register_validator @flags.validator flags.register_multi_flags_validator @flags.multi_flags_validator Three convenience functions are also provided for common flag constraints: flags.mark_flag_as_required flags.mark_flags_as_required flags.mark_flags_as_mutual_exclusive flags.mark_bool_flags_as_mutual_exclusive See their docstring in this module for a usage manual. Do NOT import this module directly. Import the flags package and use the aliases defined at the package level instead. )absolute_import)division)print_functionN) _exceptions) _flagvalues)_validators_classeszFlag validation failedcH[R"XU5n[X45 g)a Adds a constraint, which will be enforced during program execution. The constraint is validated when flags are initially parsed, and after each change of the corresponding flag's value. Args: flag_name: str, name of the flag to be checked. checker: callable, a function to validate the flag. input - A single positional argument: The value of the corresponding flag (string, boolean, etc. This value will be passed to checker by the library). output - bool, True if validator constraint is satisfied. If constraint is not satisfied, it should either return False or raise flags.ValidationError(desired_error_message). message: str, error text to be shown to the user if checker returns False. If checker raises flags.ValidationError, message from the raised error will be shown. flag_values: flags.FlagValues, optional FlagValues instance to validate against. Raises: AttributeError: Raised when flag_name is not registered as a valid flag name. N)rSingleFlagValidator_add_validator) flag_namecheckermessage flag_valuesvs 1platform/bq/third_party/absl/flags/_validators.pyregister_validatorr.s4--i'J! c^^^UUU4SjnU$)aA function decorator for defining a flag validator. Registers the decorated function as a validator for flag_name, e.g. @flags.validator('foo') def _CheckFoo(foo): ... See register_validator() for the specification of checker function. Args: flag_name: str, name of the flag to be checked. message: str, error text to be shown to the user if checker returns False. If checker raises flags.ValidationError, message from the raised error will be shown. flag_values: flags.FlagValues, optional FlagValues instance to validate against. Returns: A function decorator that registers its function argument as a validator. Raises: AttributeError: Raised when flag_name is not registered as a valid flag name. c >[TUTTS9 U$Nrr)r)functionr rrs rdecoratevalidator..decoratefsy(&#.0 Or)r rrrs``` r validatorrLs4 /rzFlags validation failedcH[R"XU5n[X45 g)aAdds a constraint to multiple flags. The constraint is validated when flags are initially parsed, and after each change of the corresponding flag's value. Args: flag_names: [str], a list of the flag names to be checked. multi_flags_checker: callable, a function to validate the flag. input - dict, with keys() being flag_names, and value for each key being the value of the corresponding flag (string, boolean, etc). output - bool, True if validator constraint is satisfied. If constraint is not satisfied, it should either return False or raise flags.ValidationError. message: str, error text to be shown to the user if checker returns False. If checker raises flags.ValidationError, message from the raised error will be shown. flag_values: flags.FlagValues, optional FlagValues instance to validate against. Raises: AttributeError: Raised when a flag is not registered as a valid flag name. N)rMultiFlagsValidatorr ) flag_namesmulti_flags_checkerrrrs rregister_multi_flags_validatorr!ns!4--w0! rc^^^UUU4SjnU$)aA function decorator for defining a multi-flag validator. Registers the decorated function as a validator for flag_names, e.g. @flags.multi_flags_validator(['foo', 'bar']) def _CheckFooBar(flags_dict): ... See register_multi_flags_validator() for the specification of checker function. Args: flag_names: [str], a list of the flag names to be checked. message: str, error text to be shown to the user if checker returns False. If checker raises flags.ValidationError, message from the raised error will be shown. flag_values: flags.FlagValues, optional FlagValues instance to validate against. Returns: A function decorator that registers its function argument as a validator. Raises: AttributeError: Raised when a flag is not registered as a valid flag name. c >[TUTTS9 U$r)r!)rrrrs rr'multi_flags_validator..decorates":#++2/:< Orr)rrrrs``` rmulti_flags_validatorr%s: /rcXRb[R"SU-SS9 [USSR U5US9 g)aEnsures that flag is not None during program execution. Registers a flag validator, which will follow usual validator rules. Important note: validator will pass for any non-None value, such as False, 0 (zero), '' (empty string) and so on. If your module might be imported by others, and you only wish to make the flag required when the module is directly executed, call this method like this: if __name__ == '__main__': flags.mark_flag_as_required('your_flag_name') app.run() Args: flag_name: str, name of the flag flag_values: flags.FlagValues, optional FlagValues instance where the flag is defined. Raises: AttributeError: Raised when flag_name is not registered as a valid flag name. NzFlag --%s has a non-None default value; therefore, mark_flag_as_required will pass even if flag is not specified in the command line! stacklevelc USL$Nr)values r'mark_flag_as_required..s E%rz,Flag --{} must have a value other than None.r)defaultwarningswarnrformat)r rs rmark_flag_as_requiredr3sR,##/ MM # $  %<CCIN rc,UHn[X!5 M g)a.Ensures that flags are not None during program execution. If your module might be imported by others, and you only wish to make the flag required when the module is directly executed, call this method like this: if __name__ == '__main__': flags.mark_flags_as_required(['flag1', 'flag2', 'flag3']) app.run() Args: flag_names: Sequence[str], names of the flags. flag_values: flags.FlagValues, optional FlagValues instance where the flags are defined. Raises: AttributeError: If any of flag name has not already been defined as a flag. N)r3)rrr s rmark_flags_as_requiredr5s"i)1rFc^^TH8nX#RcM[R"SRU5SS9 M: UU4Sjn[ TXBS9 g)a Ensures that only one flag among flag_names is not None. Important note: This validator checks if flag values are None, and it does not distinguish between default and explicit values. Therefore, this validator does not make sense when applied to flags with default values other than None, including other false values (e.g. False, 0, '', []). That includes multi flags with a default value of [] instead of None. Args: flag_names: [str], names of the flags. required: bool. If true, exactly one of the flags must have a value other than None. Otherwise, at most one of the flags can have a value other than None, and it is valid for all of the flags to be None. flag_values: flags.FlagValues, optional FlagValues instance where the flags are defined. NzFlag --{} has a non-None default value. That does not make sense with mark_flags_as_mutual_exclusive, which checks whether the listed flags have a value other than None.r'r(c>[SUR555nUS:Xd T(dUS:Xag[R"SR T(aSOSSR T555e) Nc3.# UH ocMSv M g7f)Nr.0vals r Tmark_flags_as_mutual_exclusive..validate_mutual_exclusion..sI"53QQ"5s r9rTz1{} one of ({}) must have a value other than None.ExactlyAt most, sumvaluesrValidationErrorr2join flags_dict flag_countrrequireds rvalidate_mutual_exclusionAmark_flags_as_mutual_exclusive..validate_mutual_exclusionsdI*"3"3"5IIJQxJ!O   % %;BB!Iy$))J2G I JJrr)r/r0r1r2r!)rrJrr rKs`` rmark_flags_as_mutual_exclusiverNsS$i%%1mm 77=vi7H J!+Frc^^TH;nX#R(aM[R"SRU55e UU4Sjn[ TXBS9 g)aZEnsures that only one flag among flag_names is True. Args: flag_names: [str], names of the flags. required: bool. If true, exactly one flag must be True. Otherwise, at most one flag can be True, and it is valid for all flags to be False. flag_values: flags.FlagValues, optional FlagValues instance where the flags are defined. zbFlag --{} is not Boolean, which is required for flags used in mark_bool_flags_as_mutual_exclusive.c>[SUR555nUS:Xd T(dUS:Xag[R"SR T(aSOSSR T555e) Nc38# UHn[U5v M g7fr+)boolr:s rr=amark_bool_flags_as_mutual_exclusive..validate_boolean_mutual_exclusion..$s>*=3T#YY*=sr9rTz{} one of ({}) must be True.r?r@rArBrGs r!validate_boolean_mutual_exclusionNmark_bool_flags_as_mutual_exclusive..validate_boolean_mutual_exclusion#sd>**;*;*=>>JQxJ!O   % %&--!Iy$))J2G I JJrrMN)booleanrrEr2r!)rrJrr rTs`` r#mark_bool_flags_as_mutual_exclusiverWsYi  ! ) ) )  ' ' 117 1B DD J!3NrclUR5H nXRRU5 M" g)aRegister new flags validator to be checked. Args: fv: flags.FlagValues, the FlagValues instance to add the validator. validator_instance: validators.Validator, the validator to add. Raises: KeyError: Raised when validators work with a non-existing flag. N)get_flags_names validatorsappend)fvvalidator_instancer s rr r /s.&557iM##$678r)__doc__ __future__rrrr0 absl.flagsrrrFLAGSrrr!r%r3r5rNrWr rrrrbs('%""* 8#.#4#4!<":%++H,E/:/@/@!@#;&1&7&7$N2=1B1B F4?3D3D2*9>/:/@/@#FL>C4?4E4EN: 8r