o Pεi@sUddlZddlZddlZddlZddlZddlmZddlmZ ddlm Z m Z m Z m Z mZmZddlmZddlmZddlmZmZmZmZmZmZmZmZmZedZd Zeed <Gd d d eeZeeeefZ eZ!e ed <dede"fddZ#dede"fddZ$dede"fddZ%dede"fddZ&de"fddZ'dedefddZ(de fddZ)de"fd d!Z*d"d#Z+d$d%Z,dedefd&d'Z-ded(edefd)d*Z.ded(edefd+d,Z/dee0e1e2e"fd(edee0e1e2e"ffd-d.Z3ded(edefd/d0Z4d1d2Z5d3d4Z6d5d6Z7d7d8Z8e Gd9d:d:Z9d;d<Z: = = >dNd?d@Z;e GdAdBdBe9eZ< >     >  CdOdDe"dEe2dFe=dGe1dHe1dIe"dJe2dKe"ddfdLdMZ>dS)PN)MutableMapping)MISSING)Fieldasdict dataclassfields is_dataclassreplace)Path)pprint) AnyDictGenericListOptionalTypeTypeVarUnionget_type_hintsT???rc@s eZdZdS) _NoDefaultN)__name__ __module__ __qualname__rrA/home/ubuntu/.local/lib/python3.10/site-packages/coqpit/coqpit.pyrsr no_defaultarg_typereturnc Cs0z t|ttttfWSttfyYdSw)zCheck if the input type is one of `int, float, str, bool`. Args: arg_type (typing.Any): input type to check. Returns: bool: True if input type is one of `int, float, str, bool`. F) isinstanceintfloatstrboolAttributeError TypeErrorrrrris_primitive_types  r(cCs<z|tup|tup|jtup|jtuWStyYdSw)zCheck if the input type is `list` Args: arg_type (typing.Any): input type. Returns: bool: True if input type is `list` F)listr __origin__r%r'rrris_list(s  & r+cCs2z|tup |tup |jtuWStyYdSw)zCheck if the input type is `dict` Args: arg_type (typing.Any): input type. Returns: bool: True if input type is `dict` F)dictr r*r%r'rrris_dict7s   r-cCs$zt|jtWStyYdSw)zCheck if the input type is `Union`. Args: arg_type (typing.Any): input type. Returns: bool: True if input type is `Union` F)safe_issubclassr*rr%r'rrris_unionFs   r/cCs,zt||}W|Sty||uYSw)zCheck if the input type is a subclass of the given class. Args: cls (type): input type. classinfo (type): parent class. Returns: bool: True if the input type is a subclass of the given class ) issubclass Exception)cls classinforrrrr.Us   r.objcCs&t|tr t|Stdt|j)NzCan't encode object of type )r r r#r&typer)r5rrr_coqpit_json_defaultgs r7xcCs0|jttfvr |jS|jttfvr|S|jS)zReturn the default value of the input Field. Args: x (Field): input Field. Returns: object: default value of the input Field. )defaultr_MISSINGdefault_factoryr8rrr_default_valuems  r=cCstdt|jdvS)zCheck if the input field is optional. Args: field (Field): input Field to check. Returns: bool: True if the input field is optional. N__args__)r6getattr)fieldrrr_is_optional_field}s rAcCs>i}|jjD]}|tkrn|t|q|t||S)zCustom `get_type_hints` dealing with https://github.com/python/typing/issues/737 Returns: [dataclass]: dataclass to get the type hints of its fields. ) __class__ __bases__objectupdatemy_get_type_hintsr)r2r_dictbaserrrrFs rFcCst|tr t|St|trdd|DSt|tr#dd|DSt|ts/tt|tr3| St|trBt|trB| |S|S)zPick the right serialization for the datatype of the given input. Args: x (object): input object. Returns: object: serialized object. cSsi|] \}}|t|qSr _serialize).0kvrrr sz_serialize..cSsg|]}t|qSrrIrKxirrr sz_serialize..) r r r#r,itemsr) Serializabler0r6 serializer<rrrrJs    rJcCs>i}|D]\}}|durd||<qt|t|||<q|S)zDeserialize dict. Args: x (Dict): value to deserialized. Returns: Dict: deserialized dictionary. N)rR _deserializer6)r8out_dictrLrMrrr_deserialize_dicts   rW field_typecszd}t|dr|jr|j}n t|dr|jr|j}|r;t|dkr%td|dttr2t|fdd|DS|S) aDeserialize values for List typed fields. Args: x (List): value to be deserialized field_type (Type): field type. Raises: ValueError: Coqpit does not support multi type-hinted lists. Returns: [List]: deserialized list. Nr>__parameters__5 [!] Coqpit does not support multi-type hinted 'List'rcsg|]}t|qSr)rUrO field_argrrrQsz%_deserialize_list..)hasattrr>rYlen ValueErrorr rr6)r8rX field_argsrr\r_deserialize_lists   rbc Cs4|jD]}z t||}W|StyYqw|S)zDeserialize values for Union typed fields Args: x (Any): value to be deserialized. field_type (Type): field type. Returns: [Any]: desrialized value. )r>rUr`)r8rXargrrr_deserialize_unions   rdcCsLt|ttfr |St|ttfr$|tdks|tdkr|S||}|SdS)auDeserialize python primitive types (float, int, str, bool). It handles `inf` values exclusively and keeps them float against int fields since int does not support inf values. Args: x (Union[int, float, str, bool]): value to be deserialized. field_type (Type): field type. Returns: Union[int, float, str, bool]: deserialized value. infz-infN)r r#r$r!r"r8rXrrr_deserialize_primitive_typess rgcCszt|rt|St|rt||St|rt||St|tr$||St |r-t ||St dt |d|d|d)aPick the right desrialization for the given object and the corresponding field type. Args: x (object): object to be deserialized. field_type (type): expected type after deserialization. Returns: object: deserialized object  [!] 'z' value type of 'z' does not match 'z ' field type.) r-rWr+rbr/rdr0rSdeserialize_immutabler(rgr`r6rfrrrrU s       rUcCsHdd}|d\}}}|r|nt}||rt||||S|||S)NcSst|t||SN)operatorsetitemr!)r5attrvalrrr_setitem(szrsetattr.._setitem.) rpartition isnumericsetattrrgetattr)r5rmrnropre_postsetfuncrrrrsetattr's rycs2fddfdd}t||g|dS)Ncstj|t|gRSrj)rkgetitemr!r5rmargsrr_getitem3szrgetattr.._getitemcs"|rnt}|||gRSrj)rrr?)r5rmgetfuncr~r}rr_getattr6szrgetattr.._getattrrp functoolsreducesplit)r5rmr}rrrrrt2s rtcCs2|d\}}}t|rt||||S|||S)Nrp)rqrkrlrgetitem)r5rmrnrurvrwrrrrsetitem>s"rcs$fdd}t||g|dS)Ncs$tj||r t|n|gRSrj)rkrzrrr!r{r|rrr~Es$zrgetitem.._getitemrpr)r5rmr}r~rr|rrDs rc@sleZdZdZddZddZddZdefd d Zdefd d Z d eddfddZ e d eddfddZ dS)rSz8Gives serialization ability to any inheriting dataclass.cCs8||jD]\}}|turtd|dq dS)Nz'__init__ missing 1 required argument: '')_validate_contracts__dict__rRrr&)selfkeyvaluerrr __post_init__Os zSerializable.__post_init__cCst|}|D]8}t||j}|durt|st|jd|jdd}|dur>|dur>||s>td|jd|jj qdS)Nz is not optionalcontractzbreak the contract for z, ) rr?namerAr&metadatagetr`rBr)rdataclass_fieldsr@rrrrrrUs z Serializable._validate_contractsc Cs4|||jtt|krtddS)z9validate if object can serialize / deserialize correctly.z)could not be deserialized with same valueN)rrB deserializejsonloadsdumpsrTr`rrrrvalidatefs zSerializable.validatercCs,t|}i}|D] }t||j||j<q|S)z&Transform serializable object to dict.)rr?r)r cls_fieldso cls_fieldrrrto_dictns zSerializable.to_dictcCsHt|stdt|}i}|D]}t||j}t|}|||j<q|S)z8Serialize object to be json serializable representation.z!need to be decorated as dataclass)rr&rr?rrJ)rrrr@rrrrrTvs  zSerializable.serializedatacCst|tst|}i}t|D]P}|j|vr4|jt|vr+t||j||j<qtd|jd||jt|}|durG|||j<q|t krWtd|jd|j t ||j }|||j<q| D] \}}t|||qg|S)zParse input dictionary and desrialize its fields to a dataclass. Returns: self: deserialized `self`.  [!] Missing required field ""Nz$deserialized with unknown value for  in )r r,r`copyrrvarsrr=rrrUr6rRrs)rr init_kwargsr@rrLrMrrrrs*      zSerializable.deserializecCst|tst|}i}t|D]`}|j|vrD|jt|vr+t||j||j<qt|}|tt fvr;|||j<qtd|jd| |jt|}|durW|||j<q|tkrgtd|jd|j t ||j }|||j<q|di|S)zParse input dictionary and desrialize its fields to a dataclass. Returns: Newly created deserialized object. rrNz$Deserialized with unknown value for rr)r r,r`rrrrr=rr:rrrUr6)r2rrr@ default_valuerrrrris.        z"Serializable.deserialize_immutableN) rrr__doc__rrrr,rrTr classmethodrirrrrrSKsrScCs*z|jd}W|Styd}Y|Sw)Nhelp)rKeyError)r@ field_helprrr _get_helps  rrFc  Cs,d} d} |r d} |} n |dtfvrd} |} | s"t|s"t|s"|S|dkr(|n|d|}|dkr5|n|d|}t|rV|jd|||rNt|ndtjd|St|rt|drrt |j d krl|slt d |j d } nt d t| r~|r~|S| r|t urt| s|st d |jd|d| d|d|St| D]\} } t|t| | | |d|d||d }q|St|r|st d|St|tr| j||||dSt|trdd}|jd|||d|dd|St|r |jd|||d|d|S|st d|d|S)NFTrrpz - z--)destr9r6r>rZr[rz- [!] Coqpit does not support un-hinted 'List'zI [!] Empty list with non primitive inner type is currently not supported.*zCoqpit Field: )nargsr6r)r help_prefix arg_prefixrelaxed_parserzX [!] Parsing `Union` field from argparse is not yet implemented. Please create an issue.)rrrcSs |dvr td|d|dkS)N)truefalsezD [!] Value for boolean field must be either "true" or "false". Got "z".r)r`r<rrr parse_bool%sz"_init_argparse..parse_boolz true/false)r6r9rmetavar)r9r6rrhz;' is not supported by arg_parser. Please file a bug report.)r:r(r+r- add_argumentrrrr^r_r>r`r)NotImplementedError enumerate_init_argparser#r/r0rS init_argparser r$)parser field_namerX field_defaultfield_default_factoryrrrr has_defaultr9list_field_typeidxfvrrrrrs  O     7-    rcs$eZdZdZdZddZddZddZd d Zd e d e fd dZ d e fddZ d e fddZ ddZd e ffdd Zd e fddZdKde de fddZddZd ededffd!d"Zd#d$Zd e d%efd&d'Zd(d)ZdLd*ed%dfd+d,ZdMd-d.Zd%efd/d0Zd1ed%dfd2d3Zed4e d1ed%dfd5d6Z!d%e fd7d8Z"d9e d%dfd:d;Z#d9e d%dfddNd?e%ee&j'ee fd@e d%dfdAdBZ( >dNd?e%ee&j'ee fd@e d%dfdCdDZ)  > dOd?e%ee&j'ee fd@e d%ee fdEdFZ*  > G dPdHe%e&j+d%e&j+fdIdJZ,Z-S)QCoqpita\Coqpit base class to be inherited by any Coqpit dataclasses. It overrides Python `dict` interface and provides `dict` compatible API. It also enables serializing/deserializing a dataclass to/from a json file, plus some semi-dynamic type and value check. Note that it does not support all datatypes and likely to fail in some cases. FcCsdt|vo|jS)zCheck if Coqpit is initialized. Useful to prevent running some aux functions at the initialization when no attribute has been defined. _initialized)rrrrrr_is_initializedMszCoqpit._is_initializedcCs*d|_z|WdStyYdSw)NT)r check_valuesr%rrrrrRs  zCoqpit.__post_init__cC tt|Srj)iterrrrrr__iter__[ zCoqpit.__iter__cCrrj)r_rrrrr__len__^rzCoqpit.__len__rcrcCst|||dSrj)rsrrcrrrr __setitem__aszCoqpit.__setitem__cCs |j|S)z'Access class attributes with ``[arg]``.)rrrcrrr __getitem__d zCoqpit.__getitem__cCst||dSrj)delattrrrrr __delitem__hzCoqpit.__delitem__cCs|Srjr)rrrrr _keytransformkzCoqpit._keytransformcs2t|}t|tr|dkrtd|d|S)z:Check if the mandatory field is defined when accessing it.rz [!] MISSING field z must be defined.)super__getattribute__r r#r%rrBrrrps zCoqpit.__getattribute__cCs ||vSrj)rrrrr __contains__wrzCoqpit.__contains__Nrr9cCs||r t||S|Srj)hasr)rrr9rrrrzs  z Coqpit.getcCs t|Srj)rrRrrrrrRrz Coqpit.itemscoqpitscs8fdd}t|tr|D]}||q dS||dS)aMerge a coqpit instance or a list of coqpit instances to self. Note that it does not pass the fields and overrides attributes with the last Coqpit instance in the given List. TODO: find a way to merge instances with all the class internals. Args: coqpits (Union[Coqpit, List[Coqpit]]): coqpit instance or list of instances to be merged. cs.j|jj|jj|jdSrj)rrE__annotations____dataclass_fields__)coqpitrrr_mergeszCoqpit.merge.._mergeN)r r))rrrrrrrmerges   z Coqpit.mergecCsdSrjrrrrrrrzCoqpit.check_valuesrcCs |t|vSrj)rrrrrrrz Coqpit.hascCst|Srj)r rrrrrsz Coqpit.copynewcCsL|D]\}}|rt|||qt||rt|||qtd|dS)zUpdate Coqpit fields by the input ```dict```. Args: new (dict): dictionary with new values. allow_new (bool, optional): allow new fields to add. Defaults to False. z [!] No key - N)rRrsr^r)rr allow_newrrrrrrEs z Coqpit.updatecCstt|dS)z Print Coqpit fields in a format.N)r rrrrrr sz Coqpit.pprintcCs|Srj)rTrrrrrszCoqpit.to_dictrcCs||}dSrj)r)rrrrr from_dictrzCoqpit.from_dictr2cCs ||Srj)ri)r2rrrr new_from_dictrzCoqpit.new_from_dictcCstjt|dtdS)z%Returns a JSON string representation.)indentr9)rrrr7rrrrto_jsonszCoqpit.to_json file_namecCsHt|ddd}tjt||ddWddS1swYdS)znSave Coqpit to a json file. Args: file_name (str): path to the output json file. wutf8encodingr)rN)openrdumpr)rrfrrr save_jsons"zCoqpit.save_jsoncCsVt|ddd}|}t|}Wdn1swY||}|dS)aLoad a json file and update matching config fields with type checking. Non-matching parameters in the json file are ignored. Args: file_name (str): path to the json file. Returns: Coqpit: new Coqpit with updated config fields. r4rrN)rreadrrrr)rrr input_str dump_dictrrr load_jsons     zCoqpit.load_jsonrr}rcCs|s |j||d}|}t|tr|j||d}||}i}t|}|D]9}d}d}|jtur4|jnd} |jtur>|jnd} | rGd}| }n| rNd}| }|r_t|j rZt |j r_|||j <q&t |} | D]\} } | |dr| t|dd} t|| | qh|di|S)aCreate a new Coqpit instance from argparse input. Args: args (namespace or list of str, optional): parsed argparse.Namespace or list of command line parameters. If unspecified will use a newly created parser with ```init_argparse()```. arg_prefix: prefix to add to CLI parameters. Gets forwarded to ```init_argparse``` when ```args``` is not passed. rFNTrpr)r parse_argsr r)rr9r:r;r(r6r+rrrR startswithr_r)r2r}rrargs_with_lists_processed class_fieldsr@rr9rr args_dictrLrMrrrinit_from_argparses8    zCoqpit.init_from_argparsec Cs|s |j|d}|}t|tr|j|d}||}t|}|D]<\}}||dr;|t|dd}zt||Wnt t fyY}z t d|d|d}~wwt |||q$| dS)uUpdate config values from argparse arguments with some meta-programming ✨. Args: args (namespace or list of str, optional): parsed argparse.Namespace or list of command line parameters. If unspecified will use a newly created parser with ```init_argparse()```. arg_prefix: prefix to add to CLI parameters. Gets forwarded to ```init_argparse``` when ```args``` is not passed. rrpNrhz&' not exist to override from argparse.)rrr r)rrRrr_rtr&r%r1ryr)rr}rrrrLrMerrrrs$     zCoqpit.parse_argscCsR|s|j||d}|\}}t|tr"|j||d}||\}}|||S)aUpdate config values from argparse arguments. Ignore unknown arguments. This is analog to argparse.ArgumentParser.parse_known_args (vs parse_args). Args: args (namespace or list of str, optional): parsed argparse.Namespace or list of command line parameters. If unspecified will use a newly created parser with ```init_argparse()```. arg_prefix: prefix to add to CLI parameters. Gets forwarded to ```init_argparse``` when ```args``` is not passed. relaxed_parser (bool, optional): If True, do not force all the fields to have compatible types with the argparser. Defaults to False. Returns: List of unknown parameters. )rr)rparse_known_argsr r)r)rr}rrrunknownrrrr.s   zCoqpit.parse_known_argsrrc Cs|st}t|}|D]2}|jt|vrt||j}n |jtur%|jnd}|j}|j} t |} t ||j||| | ||| q |S)aPass Coqpit fields as argparse arguments. This allows to edit values through command-line. Args: parser (argparse.ArgumentParser, optional): argparse.ArgumentParser instance. If unspecified a new one will be created. arg_prefix (str, optional): Prefix to be used for the argument name. Defaults to 'coqpit'. help_prefix (str, optional): Prefix to be used for the argument description. Defaults to ''. relaxed_parser (bool, optional): If True, do not force all the fields to have compatible types with the argparser. Defaults to False. Returns: argparse.ArgumentParser: parser instance with the new arguments. N) argparseArgumentParserrrrr9r:r6r;rr) rrrrrrr@rrXrrrrrrKs, zCoqpit.init_argparserj)F)rN)Nr)NrF)NrrF).rrrrrrrrrr#r rrrrrrrrRrrrrr$rrr,rEr rrrrSrrrrrr Namespacerrrrr __classcell__rrrrrCs    1 " rTis_path prerequest enum_listmax_valmin_val restricted alternative allow_nonec s| r |dur dS| s|dusJd|dt|tr/|r/|vs/Jd|dt|trKtfdd|DsJJd|d |d n|dus`|vs`Jd|d |d |rwtj|swJd |d |d |vr|durdS|vr|dur||ksJd|d||dur||ksJd|d||durɈ||vsJd|ddSdSdS)a'Simple type and value checking for Coqpit. It is intended to be used under ```__post_init__()``` of config dataclasses. Args: name (str): name of the field to be checked. c (dict): config dictionary. is_path (bool, optional): if ```True``` check if the path is exist. Defaults to False. prerequest (list or str, optional): a list of field name that are prerequestedby the target field name. Defaults to ```[]```. enum_list (list, optional): list of possible values for the target field. Defaults to None. max_val (float, optional): maximum possible value for the target field. Defaults to None. min_val (float, optional): minimum possible value for the target field. Defaults to None. restricted (bool, optional): if ```True``` the target field has to be defined. Defaults to False. alternative (str, optional): a field name superceding the target field. Defaults to None. allow_none (bool, optional): if ```True``` allow the target field to be ```None```. Defaults to False. Example: >>> num_mels = 5 >>> check_argument('num_mels', c, restricted=True, min_val=10, max_val=2056) >>> fft_size = 128 >>> check_argument('fft_size', c, restricted=True, min_val=128, max_val=4058) Nz# [!] None value is not allowed for rpz [!] z not defined in config.jsonc3s|] }|vVqdSrj)keys)rKrcrr s  z!check_argument..z [!] prequested fields z for z are not defined.z [!] path for z ("z") does not exist.z is larger than max value z is smaller than min value z is not a valid value) r r$r r)anyospathexistslower) rrrrrrrr r r rr rcheck_argumentys:$   *    r)rrF)FNNNNFNT)?rrrrkrcollections.abcr dataclassesrr:rrrrrr pathlibr r typingr r rrrrrrrrrr NoDefaultVarrr$r(r+r-r/r.r7r=rArFrJrWrbrdr!r"r#rgrUryrtrrrSrrrr)rrrrrs      ,  .  } r: