o wi@sUdZddlZddlZddlZddlZddlZddlZddlZddlm Z ddl m Z ddl m Z ddlmZddlmZmZmZmZmZmZmZmZmZmZmZmZmZddlZdd lm Z m!Z!m"Z"dd l#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9dd l:m;Z;mZ>m?Z?dd l@mAZAdd lBmCZCmDZDmEZEmFZFddlGmHZHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPdZQeeRd<edefZSdeTdefddZUdeTdefddZVd4ddZWGdddZXeWe de=deeeTeTfdeeeeYeeYfdee=ddffdd ZZe de=dee=ddffd!d"Z[e ded?Z)ed@edAeddfdBdCZ*ed8e+dDee ddfdEdFZ,ed8e+dee fdGdHZ-ed8e.dDee ddfdIdJZ/ed8e.dee fdKdLZ0ed8edMee ee fdefdNdOZ1eddde2j3dPdQede dRe dSe dTe2dee eefeede eff dUdVZ4edQedee eefeede effdWdXZ5edQedYede fdZd[Z6edd\edYeee7e fde fd]d^Z8edede fd_d`Z9edede fdadbZ:edede fdcddZ;eddedYee deee ddgddmdQe.dYe dDedne doe ddf dpdqZ?edddrdQede dse de fdtduZ@edQe.ddfdvdwZAedQedeBe fdxdyZCeeddfdedeedee e e fdeeeffdzd{ZDed|edeewY|rKt |d|S)a^ Merge a list of previously created configs into a single one This is much faster than OmegaConf.merge() as the input configs are not copied. However, the input configs must not be used after this operation as will become inconsistent. :param configs: Input configs :return: the merged config object. rrno_deepcopy_set_nodesFTrN) rrrprrrrrrNrrrErErG unsafe_merges zOmegaConf.unsafe_mergenameresolvercCstjtdddt||S)Nz register_resolver() is deprecated. See https://github.com/omry/omegaconf/issues/426 for migration instructions. ) stacklevel)warningswarnrrNlegacy_register_resolverrrrErErGregister_resolver<s zOmegaConf.register_resolverc sptsJdtjvsJdddtdtdtdttdfd ttdfd tf fd d }|tj<dS) Nresolver must be callable resolver '' is already registeredrr]nodeargs.args_strrBc st|}dd|D}z tdd|D}Wn ty"Yn wtdd|d|}||vr8||n|} | ||<| S)NcSs g|] }|ddddqS)z\  z\,,)replace).0xrErErG [s zPOmegaConf.legacy_register_resolver..resolver_wrapper..css|] }d|vr|VqdS)rCNrE)rirErErG aszOOmegaConf.legacy_register_resolver..resolver_wrapper..z Resolver 'z' was called with argument 'a' that appears to be an interpolation. Nested interpolations are not supported for resolvers registered with `[legacy_]register_resolver()`, please use `register_new_resolver()` instead (see https://github.com/omry/omegaconf/issues/426 for migration instructions).)rN get_cachenext StopIteration ValueError) rr]rrrcache args_unescbad_argkeyvalrrErGresolver_wrapperRs z.resolver_wrapper)callabler2 _resolversr/rrrq)rrrrErrGrJs$     z"OmegaConf.legacy_register_resolver)r use_cacherrc ststdstd|strtddztWn ty/dYnwdtdtffdd }|d |d |d d t dt dt dt t dfdt tdfdt f fdd }|t j<dS)a Register a resolver. :param name: Name of the resolver. :param resolver: Callable whose arguments are provided in the interpolation, e.g., with ${foo:x,0,${y.z}} these arguments are respectively "x" (str), 0 (int) and the value of ``y.z``. :param replace: If set to ``False`` (default), then a ``ValueError`` is raised if an existing resolver has already been registered with the same name. If set to ``True``, then the new resolver replaces the previous one. NOTE: The cache on existing config objects is not affected, use ``OmegaConf.clear_cache(cfg)`` to clear it. :param use_cache: Whether the resolver's outputs should be cached. The cache is based only on the string literals representing the resolver arguments, e.g., ${foo:${bar}} will always return the same value regardless of the value of ``bar`` if the cache is enabled for ``foo``. rz!cannot use an empty resolver namerrNspecialrBcs,duo|jv}|rrtd||S)Nz?use_cache=True is incompatible with functions that receive the ) parametersr)rr)sigrrErG _should_passs z5OmegaConf.register_new_resolver.._should_pass_parent__node__root_rr]rr.rcsvrt|}z||WStyYnwi}r ||d<r&||d<r,||d<|i|}r9|||<|S)Nrrr)rNrKeyError)rr]rrrrkwargsr)r pass_node pass_parent pass_rootrrrErGrs$  z9OmegaConf.register_new_resolver..resolver_wrapper)rr|rrN has_resolverinspect signaturerqboolr2r.r/rrr)rrrrrrrE)rrrrrrrrGrOts:   zOmegaConf.register_new_resolvercCs||duSr_) _get_resolverclsrrErErGrszOmegaConf.has_resolvercCsit_tdS)zh Clear(remove) all OmegaConf resolvers, then re-register OmegaConf's default resolvers. N)r2rrXrErErErGclear_resolverss zOmegaConf.clear_resolverscCs||r tj|dSdS)ap Clear(remove) any resolver only if it exists. Returns a bool: True if resolver is removed and False if not removed. .. warning: This method can remove deafult resolvers as well. :param name: Name of the resolver. :return: A bool (``True`` if resolver is removed, ``False`` if not found before removing). TF)rr2rpoprrErErGclear_resolvers zOmegaConf.clear_resolverrcCs|jjSr_) _metadataresolver_cacherrErErGrszOmegaConf.get_cachercCst||j_dSr_)rrrr)rrrErErG set_cacheszOmegaConf.set_cachecCst|ttidSr_)rNrrrUrrErErG clear_cachezOmegaConf.clear_cache from_config to_configcCst|t|dSr_)rNrr)rrrErErG copy_cacherzOmegaConf.copy_cachevaluecC|d|dSNr _set_flagrrrErErGrzOmegaConf.set_readonlycC |dSrrrrErErG is_readonly zOmegaConf.is_readonlycCrNstructrrrErErG set_structrzOmegaConf.set_structcCrrrrrErErG is_structrzOmegaConf.is_structrVcCsPddlm}t||stdt|tr|g}dd|jd|dD}||dS) z Create a masked copy of of this config that contains a subset of the keys :param conf: DictConfig object :param keys: keys to preserve in the copy :return: The masked ``DictConfig`` object. rrz,masked_copy is only supported for DictConfigcSsi|]\}}||qSrErE)rrrrErErG z)OmegaConf.masked_copy..F)rrV)content) dictconfigrrprrqitems_ex)rrVrrrErErG masked_copy s   zOmegaConf.masked_copyrthrow_on_missing enum_to_strstructured_config_modecfgrrrcCs6t|stdtt|dtj|||||dS)a Resursively converts an OmegaConf config to a primitive container (dict or list). :param cfg: the config to convert :param resolve: True to resolve all values :param throw_on_missing: When True, raise MissingMandatoryValue if any missing values are present. When False (the default), replace missing values with the string "???" in the output container. :param enum_to_str: True to convert Enum keys and values to strings :param structured_config_mode: Specify how Structured Configs (DictConfigs backed by a dataclass) are handled. - By default (``structured_config_mode=SCMode.DICT``) structured configs are converted to plain dicts. - If ``structured_config_mode=SCMode.DICT_CONFIG``, structured config nodes will remain as DictConfig. - If ``structured_config_mode=SCMode.INSTANTIATE``, this function will instantiate structured configs (DictConfigs backed by a dataclass), by creating an instance of the underlying dataclass. See also OmegaConf.to_object. :return: A dict or a list representing this config as a primitive container. z-Input cfg is not an OmegaConf config object ()r)rN is_configrr,rr2 _to_contentrrrrrrErErG to_containers zOmegaConf.to_containercCstj|dddtjdS)a Resursively converts an OmegaConf config to a primitive container (dict or list). Any DictConfig objects backed by dataclasses or attrs classes are instantiated as instances of those backing classes. This is an alias for OmegaConf.to_container(..., resolve=True, throw_on_missing=True, structured_config_mode=SCMode.INSTANTIATE) :param cfg: the config to convert :return: A dict or a list or dataclass representing this config. TFr)rNrr0 INSTANTIATErrErErG to_objectEs zOmegaConf.to_objectrc CsZt|tsJz||}|durWdSt|tsJ|WStttfy,YdSwNF)rpr. _get_childr/ _is_missingr5rAttributeError)rrrrErErG is_missingZs  zOmegaConf.is_missingrcCsH|durt|ts J||}n|}|dur"t|tsJ|SdSr )rpr.r r/_is_interpolation)rrrrErErGis_interpolationfs zOmegaConf.is_interpolationcCddlm}t||S)Nrr)rrp)r\rrErErGis_listr  zOmegaConf.is_listcCr)Nrr)rrrp)r\rrErErGis_dictxrzOmegaConf.is_dictcCr)Nr)r.)rr.rp)r\r.rErErGr~rzOmegaConf.is_configcCs"|dur ||}n|}t|Sr_)r rN _get_obj_type)r\rcrErErGget_types  zOmegaConf.get_typeT)defaultthrow_on_resolution_failurerrrc Cs^ddlm}z ||||||dWSty.}zt||d|t|dWYd}~dSd}~ww)a :param cfg: Config node to select from :param key: Key to select :param default: Default value to return if key is not found :param throw_on_resolution_failure: Raise an exception if an interpolation resolution error occurs, otherwise return None :param throw_on_missing: Raise an exception if an attempt to select a missing key (with the value '???') is made, otherwise return None :return: selected value or None if not found. r) select_value)rrrrrN)rrrcausemsg)_implr Exceptionrrq)rrrrrrerErErGrTs $zOmegaConf.select)r force_addrr"c Cst|}|}tt|dD]9}||}t||dd\} } t| tsC|r?t|dd i|| <Wdn1s9wYni|| <|| }q|d} t|ts[Jdt|j| } t|t rft | } |rnt|ddnt } | j|rt |st|rt|tsJ|| }t |rt|tsJ|| WddSt |rt| tsJ|| |nt |rt| t sJ|| |n JWddSWddS1swYdS)a5 Updates a dot separated key sequence to a value :param cfg: input config to update :param key: key to update (can be a dot separated path) :param value: value to set, if value if a list or a dict it will be merged or set depending on merge_config_values :param merge: If value is a dict or a list, True (default) to merge into the destination, False to replace the destination. :param force_add: insert the entire path regardless of Struct flag or Structured Config nodes. rF)rrNzUnexpected type for root: )r+ranger _select_onerpr.rrrrintr*rNrr$r2r rrrq __setattr__r __setitem__)rrrrr"splitrootrk next_rootkey_lastlast_keyctxrrErErGupdatesV         "zOmegaConf.update)r sort_keysr2cCs.t|}tj||dd}tj|dd|tdS)a returns a yaml dump of this config object. :param cfg: Config object, Structured Config type or instance :param resolve: if True, will return a string with the interpolations resolved, otherwise interpolations are preserved :param sort_keys: If True, will print dict keys in sorted order. default False. :return: A string containing the yaml representation. T)rrF)default_flow_style allow_unicoder2Dumper)rrNrrydumpr)rrr2 containerrErErGrs zOmegaConf.to_yamlcCs8ddl}t|stdt|jd|j|dS)z Resolves all interpolations in the given config object in-place. :param cfg: An OmegaConf container (DictConfig, ListConfig) Raises a ValueError if the input object is not an OmegaConf container. rNzInvalid config type (z"), expected an OmegaConf Container)omegaconf._implrNrrrrr_resolve)r omegaconfrErErGrs  zOmegaConf.resolvecs2t|}tdtddffdd |S)aA Returns a set of missing keys in a dotlist style. :param cfg: An ``OmegaConf.Container``, or a convertible object via ``OmegaConf.create`` (dict, list, ...). :return: set of strings of the missing keys. :raises ValueError: On input not representing a config. _cfgrBNcsbt|tr tt|}n|}|D]}t||r!||qt||r.||qdSr_) rprr$rrNradd _get_full_keyr)r;itrrgathermissingsrErGr@ s   z&OmegaConf.missing_keys..gather)rsetr.rrEr?rG missing_keyss   zOmegaConf.missing_keysc Cszddlm}ddlm}ddlm}|turi}t|trUt j ||d}|dur3t j i||dWSt|trCt j |di||dWSt|t tfsLJt j |||dWSt|sft |sft|sf|durt||r||||jj|jj|jj|jj|dWSt |}t|\}}||||||dWSt|st |rt||r||||jj|jj|jj|d WSt |}t|}||||td |d WSt|trtd |jd td t|jdt y} z t!dddt| | dJd} ~ ww)Nrrerrrk)r]r^)rr]ref_type is_optionalkey_type element_typer^)rr]rFrGr^)rr]rGrDrEr^Tz Input class 'zK' is not a structured config. did you forget to decorate it as a dataclass?zObject of unsupported type: '')rrrrr)"rorfrr listconfigrrrprqryrzrNrPr}rUr%rr'rrDoptionalrFrGrrr&rrrrr6rr4r) r\r]r^rfrrobj_typerFrGr!rErErGrc2s           zOmegaConf._create_implrcCst|rt|S|durdSt|tr+|rdS|rdSt|jjr)|jjStSt|t r2t St|t r=t | St|trHt t|St|trOtSt|t tfrXt St|Sr_)r'rrpr_is_noner r object_typerUrr}r?r_valuer1rtuple)rrErErGrs.        zOmegaConf._get_obj_typecCs|tjvr tj|SdSr_)r2r)rrErErGrs zOmegaConf._get_resolverrBN)NN)NNN)Fr_)Hr __module__ __qualname____doc__r[ staticmethodrr r2r rqrrarrrrrPr rrrrrsrrzrrrrrrResolverrrrO classmethodrrrrrrrr/rrr.rrrr0DICTrr rr&rrrrrrrTr1rrrrCrcrrrrErErErGrNqs2      ,        " ) Q  $ &. & &  ?$  TrNrnamesrWc #spt|tr |g}|dust|tr|g}fdd|D}z||VW||dS||w)Ncsg|]}|qSrE)_get_node_flag)rrrrErGrrz!flag_override..)rprqrr)rrXrW prev_statesrErZrGrs  rc c@|d}zt|d|VWt||dSt||w)NrF)rYrNrr prev_staterErErG read_write   r_c cr\)NrF)rYrNrr]rErErG open_dictr`rar]rErrrDc CsVt|s t|r|turt|\}}t|||||||d}|St|s3t|s3t|tt fvrC|turCt |}t ||||||d}|St |sKt |r^t|\}}t|||||||d}|St |rmt|||||d}|S|tksu|dur~t|||d}|St|trt|trt|||||d}|S|tkrt||||d}|S|tkrt||||d}|S|tkrt||||d}|S|tkrt||||d}|S|tkrt||||d}|S|tjkrt ||||d}|S|dur"|!dd ur"t|tt fvr t |||||d }|St|rt|||||d }|St|||d}|St"d t#|) N)rrr]rDrErFrG)rrr]rErGrD)rDrErrr]rFrG)rrDrErr])rrr]) enum_typerrr]rE)rrr]rE allow_objectsT)rrr]rDrEzUnexpected type annotation: )$r!r%rrrr#r(rr}rOrrr'r)r1r7rp issubclassrr:r&r<floatr;rr8rqr>bytesr9rrrsr=rr6r,)r]rErrrDrFrGrrErErG _node_wraps TG =3+)!   rgcCs4t|tr|||||St|||||dS)N)rDr]rErr)rpr/_set_key _set_parentrg)rDrrrEr]rErErG _maybe_wrapCs  rjTrrthrow_on_type_errorcCsDddlm}ddlm}|}t|tsJd||r"d|fSt||r6t|ts.J|j|dd}n>t||rrt|tsBJt |sY|rVt d|dt |j d d}nt |}|d ksi|dt|krld}n||}nJ|durt|tsJ|r|rtd ||||fS|dust|tsJ||fS) NrrrzUnexpected type: F)validate_accesszIndex 'z' (z) is not an intrzMissing mandatory value: )rrrIrrpr.rLrqr r"r|rrr&rr/r r3r=)rrrrkrrret_keyrrErErGr%Zs@     r%rP)T)arSrrrtrvrrrr collectionsr contextlibrenumrtextwraprtypingrrrr r r r r rrrrrryrrrrrorrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,baser-r.r/r0r1 basecontainerr2errorsr3r4r5r6nodesr7r8r9r:r;r<r=r>r?r@__annotations__rUrqrHrIrXrNrrr_rargrjr&r%rErErErGs    <` ,   I    a