a Sic@7@sdZddlZddlmZddlmZddlmZdejfddZdejfd d Zd ejfd d Z dejfddZ ejfddZ ejfddZ dejfddZ dejfddZddZdS)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. N) _exceptions) _flagvalues)_validators_classeszFlag validation failedcCs,t||\}}t|||}t||dS)aAdds 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 | FlagHolder, name or holder of the flag to be checked. Positional-only parameter. 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. ValueError: Raised when flag_values is non-default and does not match the FlagValues of the provided FlagHolder instance. N)rresolve_flag_refrSingleFlagValidator_add_validator) flag_namecheckermessage flag_valuesvr R/var/www/html/django/DPS/env/lib/python3.9/site-packages/absl/flags/_validators.pyregister_validator,s!rcsfdd}|S)aWA 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 :func:`register_validator` for the specification of checker function. Args: flag_name: str | FlagHolder, name or holder of the flag to be checked. Positional-only parameter. 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. cst|d|SNr r )rfunctionrr r r rdecoratems zvalidator..decorater )rr r rr rr validatorRsrzFlags validation failedcCs,t||\}}t|||}t||dS)aPAdds 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 | FlagHolder], a list of the flag names or holders to be checked. Positional-only parameter. 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. ValueError: Raised when multiple FlagValues are used in the same invocation. This can occur when FlagHolders have different `_flagvalues` or when str-type flag_names entries are present and the `flag_values` argument does not match that of provided FlagHolder(s). N)rresolve_flag_refsrMultiFlagsValidatorr) flag_namesZmulti_flags_checkerr r r r r rregister_multi_flags_validatorus!rcsfdd}|S)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 :func:`register_multi_flags_validator` for the specification of checker function. Args: flag_names: [str | FlagHolder], a list of the flag names or holders to be checked. Positional-only parameter. 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. cst|d|Sr)rrrr r r rrs z'multi_flags_validator..decorater )rr r rr rrmulti_flags_validatorsrcCsNt||\}}||jdur0tjd|ddt|ddd||ddS) 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 | FlagHolder, name or holder of the flag. Positional-only parameter. flag_values: flags.FlagValues, optional :class:`~absl.flags.FlagValues` instance where the flag is defined. Raises: AttributeError: Raised when flag_name is not registered as a valid flag name. ValueError: Raised when flag_values is non-default and does not match the FlagValues of the provided FlagHolder instance. 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! stacklevelcSs|duSNr )valuer r rz'mark_flag_as_required..z,Flag --{} must have a value other than None.r)rrdefaultwarningswarnrformat)rr r r rmark_flag_as_requiredsr(cCs|D]}t||qdS)aeEnsures 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 | FlagHolder], names or holders 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)r()rr rr r rmark_flags_as_requiredsr)Fcs\t|\}D]&}||jdurtjd|ddqfdd}t||ddS)aEnsures 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 | FlagHolder], names or holders of flags. Positional-only parameter. 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. Raises: ValueError: Raised when multiple FlagValues are used in the same invocation. This can occur when FlagHolders have different `_flagvalues` or when str-type flag_names entries are present and the `flag_values` argument does not match that of provided FlagHolder(s). 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.rrcsRtdd|D}|dks*s.|dkr.dStdr>dndd dS) Ncss|]}|durdVqdS)Nr .0valr r r %r#zTmark_flags_as_mutual_exclusive..validate_mutual_exclusion..r*rTz1{} one of ({}) must have a value other than None.ExactlyAt most, sumvaluesrValidationErrorr'joinZ flags_dictZ flag_countrrequiredr rvalidate_mutual_exclusion$szAmark_flags_as_mutual_exclusive..validate_mutual_exclusionr )rrr$r%r&r'r)rr9r rr:r r8rmark_flags_as_mutual_exclusivesr<csTt|\}D]}||jstd|qfdd}t||ddS)aEnsures that only one flag among flag_names is True. Args: flag_names: [str | FlagHolder], names or holders of flags. Positional-only parameter. 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. Raises: ValueError: Raised when multiple FlagValues are used in the same invocation. This can occur when FlagHolders have different `_flagvalues` or when str-type flag_names entries are present and the `flag_values` argument does not match that of provided FlagHolder(s). zbFlag --{} is not Boolean, which is required for flags used in mark_bool_flags_as_mutual_exclusive.csRtdd|D}|dks*s.|dkr.dStdr>dndd dS) Ncss|]}t|VqdSr )boolr+r r rr.Kr#zamark_bool_flags_as_mutual_exclusive..validate_boolean_mutual_exclusion..r*rTz{} one of ({}) must be True.r/r0r1r2r7r8r r!validate_boolean_mutual_exclusionJszNmark_bool_flags_as_mutual_exclusive..validate_boolean_mutual_exclusionr;N)rrbooleanrr5r'r)rr9r rr>r r8r#mark_bool_flags_as_mutual_exclusive0s r@cCs"|D]}||j|qdS)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)fvZvalidator_instancerr r rrVs r)__doc__r% absl.flagsrrrFLAGSrrrrr(r)r<r@rr r r rs2    & % ) (' / &