o qoi.@s0dZddlZddlZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddl mZdd lmZdd lmZejZejZejZejZejZejZed Zed Zhd ZGdddejZGdddejZ dddej!ddde"dede"deej#deej$dej%de&dej'efddZ(dS)z5API to use command line flags with Fiddle Buildables.N)AnyOptionalTypeVar)flags)epath)config) legacy_flags)utils) auto_config) serializationz2^(config|config_file|config_str|fiddler|set):(.+)$_F>r config_str config_filec@s4eZdZdZdejfddZdejde fddZ d S) FiddleFlagSerializeraABSL serializer for a Fiddle config flag. This class can be provided to `FiddleFlag` as a serializer to serialize a fiddle config to a single command line argument. Example usage: ``` from absl import flags from fiddle import absl_flags as fdl_flags FLAGS = flags.FLAGS flags.DEFINE_flag( fdl_flags.FiddleFlag( name="config", default=None, parser=flags.ArgumentParser(), serializer=FiddleFlagSerializer(), help_string="My fiddle flag", ), flag_values=FLAGS, ) serialized_flag = FLAGS['config'].serialize() ``` Users will more commonly use `fdl_flags.DEFINE_fiddle_config` which provides this serializer by default. pyref_policycC ||_dSN) _pyref_policy)selfrrP/home/ubuntu/.local/lib/python3.10/site-packages/fiddle/_src/absl_flags/flags.py__init__Ks zFiddleFlagSerializer.__init__valuereturncCs"t}|j||jd}d|S)Nrz config_str:)r ZlibJSONSerializer serializer)rr serializer serializedrrrrNs zFiddleFlagSerializer.serializeN) __name__ __module__ __qualname____doc__r PyrefPolicyrr Buildablestrrrrrrr,srcseZdZdZdddddeejdedeej ffdd Z d e fd d Z d e jd e fddZddZdddZde d e ddfddZde ffdd ZeddZejddZZS) FiddleFlagaABSL flag class for a Fiddle config flag. This class is used to parse command line flags to construct a Fiddle `Config` object with certain transformations applied as specified in the command line flags. Most users should rely on the `DEFINE_fiddle_config()` API below. Using this class directly provides flexibility to users to parse Fiddle flags themselves programmatically. Also see the documentation for `DEFINE_fiddle_config()` below. Example usage where this flag is parsed from existing flag: ``` from fiddle import absl_flags as fdl_flags _MY_CONFIG = fdl_flags.DEFINE_multi_string( "my_config", "Name of the fiddle config" ) fiddle_flag = fdl_flags.FiddleFlag( name="config", default_module=my_module, default=None, parser=flags.ArgumentParser(), serializer=None, help_string="My fiddle flag", ) fiddle_flag.parse(_MY_CONFIG.value) config = fiddle_flag.value ``` NT)default_module allow_importsrr'r(rcs:||_||_||_d|_d|_g|_tj|i|dSr)r(r'r first_command_initial_config_expression_remaining_directivessuperr)rr'r(rargskwargs __class__rrrvszFiddleFlag.__init__ expressioncCs\tj|}|j}t|tjj|j|jd}t |r%|j |j i|j S||j i|j SNzCould not init a buildable from)r CallExpressionparse func_nameresolve_function_referenceImportDottedNameDebugContext BASE_CONFIGr'r(r is_auto_config as_buildabler-r.)rr1 call_expr base_namebase_fnrrr_initial_configs  zFiddleFlag._initial_configcfgcCsVtj|}|j}t|tjj|j|jd}||g|j Ri|j }|dur)|S|Sr2) r r3r4r5r6r7FIDDLERr'r(r-r.)rr?r1r;r<fiddlernew_cfgrrr_apply_fiddlers zFiddleFlag._apply_fiddlercCs,||}|j||jt|7_dSr)_parser+extendpresentlen)r arguments new_parsedrrrr4s  zFiddleFlag.parsercCs|j|_d|_g|_d|_dS)NTr)defaultrusing_default_valuer+rF)rrrrunparses zFiddleFlag.unparsecommandc Cs|jrtd|d|d|jd|jd ||_|dkr%|||_dS|dkrNt|}tj | |j d|_WddS1sGwYdS|dkrat }|j||j d|_dSdS) Nz2Only one base configuration is permitted. Received:z after z was already provided.rrrr )r* ValueErrorr)r>rrPathopenr load_jsonreadrr r deserialize)rrMr1frrrr _parse_configs6  " zFiddleFlag._parse_configcsttj||Sr)r,r MultiFlag _serializerrr/rrrXszFiddleFlag._serializecCs|jrf|jd}t|}|std|jd|\}}|jdur3|tvr0td|d||_|dks?|dks?|dkrF| ||n|d krRt |j |n|d kr_| |j ||_ ntd |js|j S) NrzAll flag values to zQ must begin with 'config:', 'config_file:', 'config_str:', 'set:', or 'fiddler:'.z|First flag command must specify the input config via either config or config_file or config_str commands. Received command: z instead.rrr setrAz&Internal error; should not be reached.)r+pop _COMMAND_RE fullmatchrOnamegroupsr)_BASE_CONFIG_DIRECTIVESrVr set_value_valuerCAssertionError)ritemmatchrMr1rrrrs6     "zFiddleFlag.valuecCrr)rbrYrrrrs )rN)rr r!r"rtypes ModuleTypeboolr r#rr%r>rr$rCr4rLrVrXpropertyrsetter __classcell__rrr/rr&Ts,$  %r&F)rJr'r flag_valuesrequiredr^rJ help_stringr'rrlrmrc Cs,tjt||||tt|d|d||dS)a0Declare and define a fiddle command line flag object. When used in a python binary, after the flags have been parsed from the command line, this command line flag object will have the `fdl.Config` object built. Example usage in a python binary: ``` .... other imports ... from fiddle import absl_flags as fdl_flags _MY_FLAG = fdl_flags.DEFINE_fiddle_config( "my_config", help_string="My binary's fiddle config handle", default_module=sys.modules[__name__], ) def base_config() -> fdl.Config: return some_import.fixture.as_buildable() def set_attributes(config, value: str): config.some_attr = value return config def main(argv) -> None: if len(argv) > 1: raise app.UsageError("Too many command-line arguments.") # _MY_FLAG.value contains the config object, built from `base_config()` # with any command line flags and overrides applied in the order passed in # the command line. some_import.do_something(_MY_FLAG.value.some_attr) if __name__ == "__main__": app.run(main) ``` Invoking the above binary with: python3 -m path.to.my.binary --my_config=config:base_config \ --my_config=fiddler:'set_attributes(value="float64")' \ --my_config=set:some_other_attr.enable=True results in the `_MY_FLAG.value` set to the built config object with all the command line flags applied in the order they were passed in. To load a Fiddle config from a serialized file: python3 -m path.to.my.binary --my_config=config_file:path/to/file Args: name: name of the command line flag. default: default value of the flag. help_string: help string describing what the flag does. default_module: the python module where this flag is defined. pyref_policy: a policy for importing references to Python objects. flag_values: the ``FlagValues`` instance with which the flag will be registered. This should almost never need to be overridden. required: bool, is this a required flag. This must be used as a keyword argument. Returns: A handle to defined flag. r)r^r'rJrparserrrn)rlrm)r DEFINE_flagr&ArgumentParserr)r^rJrnr'rrlrmrrrDEFINE_fiddle_configsG rr))r"rerftypingrrrabslretilsr fiddle._srcrfiddle._src.absl_flagsrr fiddle._src.experimentalr r apply_fiddlers_toapply_overrides_tocreate_buildable_from_flags flags_parserrewrite_fdl_argsfdl_flags_suppliedcompiler\r r`ArgumentSerializerrrWr&FLAGSr%rgr# FlagValuesrh FlagHolderrrrrrrsZ        (6