B Afxac1@sdZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z m Z ddlmZddlmZddlmZddlmZdd lmZdd lmZmZdd lmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*d d l+m,Z,m-Z-d dl.m/Z/m0Z0d dl1m2Z2m3Z3m4Z4d dl5m6Z6m7Z7d dl8m9Z9m:Z:d dl;mZ>m?Z?m@Z@d dlAmBZBmCZCmDZDmEZEd dlFmGZGd dl-mHZHmIZId dlJmKZKmLZLmMZMmNZNmOZOmPZPmQZQmRZRmSZSmTZTmUZUmVZVerd dl.mWZWd dlXmYZYd dlZm[Z[d dlZmMZ\e2rddl]Z]e]j^Z^ndZ^e)dZ_e `dZaebddZcGdd d edZeGd!d"d"ZfGd#d$d$Zge(e*eheefZieejgejfZkGd%d&d&eed'ZlGd(d)d)elZmGd*d+d+elZnGd,d-d-elZoGd.d/d/eoenemZpGd0d1d1ZqGd2d3d3ZrdS)4a pint.registry ~~~~~~~~~~~~~ Defines the Registry, a class to contain units and their relations. The module actually defines 5 registries with different capabilities: - BaseRegistry: Basic unit definition and querying. Conversion between multiplicative units. - NonMultiplicativeRegistry: Conversion between non multiplicative (offset) units. (e.g. Temperature) * Inherits from BaseRegistry - ContextRegisty: Conversion between units with different dimensions according to previously established relations (contexts) - e.g. in spectroscopy, conversion between frequency and energy is possible. May also override conversions between units on the same dimension - e.g. different rounding conventions. * Inherits from BaseRegistry - SystemRegistry: Group unit and changing of base units. (e.g. in MKS, meter, kilogram and second are base units.) * Inherits from BaseRegistry - UnitRegistry: Combine all previous capabilities, it is exposed by Pint. :copyright: 2016 by Pint Authors, see AUTHORS for more details. :license: BSD, see LICENSE for more details. ) annotationsN)ChainMap defaultdict)contextmanager)Decimal)Fraction)StringIO)Number)NAMENUMBER) TYPE_CHECKINGAnyCallableContextManagerDict FrozenSetIterableIteratorListOptionalSetTupleTypeTypeVarUnion)registry_helperssystems)FQuantityOrUnitLike) HAS_BABEL babel_parse tokenizer)Context ContextChain)LogarithmicConverterScaleConverter)AliasDefinition DefinitionDimensionDefinitionPrefixDefinitionUnitDefinition)DefinitionSyntaxErrorDimensionalityErrorRedefinitionErrorUndefinedUnitError)build_eval_tree)GroupSystem) ParserHelperSourceIteratorUnitsContainer_is_dimfind_connected_nodesfind_shortest_pathgetattr_maybe_raiselogger pi_theoremsolve_dependenciesstring_preprocessorto_units_container)UnitLike)Quantity)Unit)r5Tz[ (]cCs(t|dr|j}tdd|}t|S)Nfinditerz{(\w+)}z3(?P<\1>[+-]?[0-9]+(?:.[0-9]+)?(?:[Ee][+-]?[0-9]+)?))hasattrpatternresubcompile)rErI,lib/python3.7/site-packages/pint/registry.pypattern_to_regex{s   rKcs eZdZdZfddZZS) RegistryMetazuThis is just to call after_init at the right time instead of asking the developer to do it when subclassing. cstj||}||S)N)super__call__ _after_init)selfargskwargsobj) __class__rIrJrNszRegistryMeta.__call__)__name__ __module__ __qualname____doc__rN __classcell__rIrI)rTrJrLsrLc@seZdZdZddddZdS) RegistryCachez!Cache to speed up unit registriesNone)returncCsi|_i|_i|_i|_dS)N)dimensional_equivalents root_unitsdimensionality parse_unit)rPrIrIrJ__init__szRegistryCache.__init__N)rUrVrWrXrarIrIrIrJrZsrZc@s eZdZdZdddddZdS)ContextCacheOverlayzLayer on top of the base UnitRegistry cache, specific to a combination of active contexts which contain unit redefinitions. rZr[)registry_cacher\cCs"|j|_i|_|j|_|j|_dS)N)r]r^r_r`)rPrcrIrIrJraszContextCacheOverlay.__init__N)rUrVrWrXrarIrIrIrJrbsrbc @seZdZUdZdZded<dZded<dddd ddded f d d d d d ddd dddZddddZ ddddZ ddddZ ddddZ ddddZ d d!Zd"d#Zd dd$d%Zd&dd'd(Zd)dd*d+Zddd,d-d.Zd/dd0d1Zed dd2d3Zejd d4d5d3Zd6dd7d8d9Zd:d;d7dd?Zd@dAZdBdCZdDdEZdd ddFdGdHZdddIdJZdd dKd dLdMdNZ dd dKd dLdOdPZ!d d dQdRdSZ"d/ddTdUZ#dVd/dWdXdYZ$dZd[Z%d\d]Z&dd^d d_d`dadbZ'ddcddZ(ddedfZ)dgdhZ*ddiddjdkZ+dldmZ,dndndod dpdqdrZ-ddsdtdtd dsdudvdwZ.ddxdyZ/dd dKdzd{d|d}Z0dd dKd~d{ddZ1e2ddzdddZ3dd dKdKddddZ4dddZ5dddZ6dd d dKd d ddddZ7dd dKd ddddZ8e8Z9dS) BaseRegistrya]Base class for all registries. Capabilities: - Register units, prefixes, and dimensions, and their relations. - Convert between units. - Find dimensionality of a unit. - Parse units with prefix and/or suffix. - Parse expressions. - Parse a definition file. - Allow extending the definition file parser by registering @ directives. Parameters ---------- filename : str or None path of the units definition file to load or line iterable object. Empty to load the default definition file. None to leave the UnitRegistry empty. force_ndarray : bool convert any input, scalar or not to a numpy.ndarray. force_ndarray_like : bool convert all inputs other than duck arrays to a numpy.ndarray. on_redefinition : str action to take in case a unit is redefined: 'warn', 'raise', 'ignore' auto_reduce_dimensions : If True, reduce dimensionality on appropriate operations. preprocessors : list of callables which are iteratively ran on any input expression or unit string fmt_locale : locale identifier string, used in `format_babel` non_int_type : type numerical type used for non integer values. (Default: float) case_sensitive : bool, optional Control default case sensitivity of unit parsing. (Default: True) Nz+Dict[str, Callable[[SourceIterator], None]]_parserszOptional[Locale] fmt_localeFwarnTboolstrz Optional[List[PreprocessorType]]z Optional[str] NON_INT_TYPE) force_ndarrayforce_ndarray_likeon_redefinitionauto_reduce_dimensions preprocessorsrf non_int_typecase_sensitivec Cs||||_||_||_|p(g|_||_||_||||_ | |_ i|_ i|_ i|_ tt|_dtddddi|_ddd|_t|_d|_dS)NrgrIr)rgsF)_register_parsers_init_dynamic_classes _filenamerlrmrp_on_redefinitionroset_fmt_localerqrr _defaults _dimensions_unitsrset _units_caseir* _prefixes _suffixesrZ_cache _initialized) rPfilenamerlrmrnrorprfrqrrrIrIrJras&     zBaseRegistry.__init__r[)r\cCsFddlm}|||_ddlm}|||_ddlm}|||_dS)z6Generate subclasses on the fly and attach them to selfr)build_unit_class)build_quantity_class)build_measurement_classN) unitrrAquantityrr@Z measurementr Measurement)rPrrrrIrIrJrus      z"BaseRegistry._init_dynamic_classescCs@|jdkr|ddn|jdk r.||j|d|_dS)z(This should be called after all __init__rgzdefault_en.txtTN)rvload_definitions _build_cacher)rPrIrIrJrO-s    zBaseRegistry._after_initcCs|d|jdS)Nz @defaults)_register_parser_parse_defaults)rPrIrIrJrt8szBaseRegistry._register_parserscCsBt|x4|D](\}}|d\}}||j|<qWdS)zLoader for a @default section.=N)next block_itersplitstripry)rPifilelinenopartkvrIrIrJr;szBaseRegistry._parse_defaultsz'BaseRegistry'cCs*tt|}t|j||_||S)N)object__new__typecopydeepcopy__dict__ru)rPmemonewrIrIrJ __deepcopy__BszBaseRegistry.__deepcopy__cCst||||S)N)r9rA)rPitemrIrIrJ __getattr__Hs zBaseRegistry.__getattr__cCstd||S)Nz~Calling the getitem method from a UnitRegistry is deprecated. use `parse_expression` method or use the registry as a callable.)r:warningparse_expression)rPrrIrIrJ __getitem__LszBaseRegistry.__getitem__cCs(y||dStk r"dSXdS)z6Support checking prefixed units with the `in` operatorTFN)rr/)rPrrIrIrJ __contains__Ss  zBaseRegistry.__contains__z List[str]cCst|jtt|S)N)listr{keysr__dir__)rPrIrIrJr[szBaseRegistry.__dir__z Iterator[str]cCstt|jS)zAllows for listing all units in registry with `list(ureg)`. Returns ------- Iterator over names of all units in registry, ordered alphabetically. )itersortedr{r)rPrIrIrJ__iter__`szBaseRegistry.__iter__)locr\cCs0t|tr&|dkrtd}t|||_dS)zChange the locale used by default by `format_babel`. Parameters ---------- loc : str or None None` (do not translate), 'sys' (detect the system locale) or a locale id string. sysrN) isinstancerjlocalegetdefaultlocaler!rf)rPrrIrIrJrxis   zBaseRegistry.set_fmt_localeUnitsContainerTcOst|d|ji|S)Nrq)r5rq)rPrQrRrIrIrJr5zszBaseRegistry.UnitsContainercCs|jjS)z)Default formatting string for quantities.)r@default_format)rPrIrIrJr}szBaseRegistry.default_format)valuecCs||j_||j_||j_dS)N)rArr@r)rPrrIrIrJrszUnion[str, Definition]) definitionr\cCsBt|tr4x2|dD]}|t||jqWn ||dS)zAdd unit to the registry. Parameters ---------- definition : str or Definition a dimension, unit or prefix definition.  N)rrjr_definer( from_stringrq)rPrlinerIrIrJdefines zBaseRegistry.definer(zTuple[Definition, dict, dict]c Cst|tr|jd}}nt|tr|j|j}}|jrx|jD]8}||jkrb|dkrBt dqB| t|dddddqBWn\t|t r|j d}}nDt|t r|j|j}}||||||j||fStd|t|jd d d kr|jd rd |jd d}n d|j}|jr0d|j}nd}tdd|jDtdd|jD}|dd|jD}t|||t|jj||j} n|} || |||||fS)aAdd unit to the registry. This method defines only multiplicative units, converting any other type to `delta_` units. Parameters ---------- definition : Definition a dimension, unit or prefix definition. Returns ------- Definition, dict, dict Definition instance, case sensitive unit dict, case insensitive unit dict. Nz[]z.Only one unit per dimension can be a base unitrgrIT)is_basez{} is not a valid definition.offsetr[z[delta_rdelta_uΔcss|]}d|VqdS)uΔNrI).0aliasrIrIrJ sz'BaseRegistry._define..css|]}d|VqdS)rNrI)rrrIrIrJrscSsi|]\}}||qSrIrI)rrefrrIrIrJ sz(BaseRegistry._define..)rr)rzr+r{r}r referencerr,rr*r~r' _define_aliasname TypeErrorformatgetattr converter startswithsymboltuplealiasesr5itemsr&scale _define_adder) rPrddiZ dimensionZd_nameZd_symbolZ d_aliasesZ d_referenceZd_defrIrIrJrsR         zBaseRegistry._definecCsd||j||||jr*||j|||x4|jD]*}d|krLtd||||||q2WdS)zHelper function to store a definition in the internal dictionaries. It stores the definition under its name, symbol and aliases.  zAlias cannot contain a space: N)_define_single_adderrZ has_symbolrrr:rh)rPr unit_dictcasei_unit_dictrrIrIrJrs zBaseRegistry._define_addercCsh||krB|jdkr"t|t|n |jdkrBtd|t|f|||<|dk rd|||dS)z~Helper function to store a definition in the internal dictionaries. It warns or raise error on redefinition. raiserhzRedefining '%s' (%s)N)rwr.rr:rloweradd)rPkeyrrrrIrIrJrs  z!BaseRegistry._define_single_addercCsD||j}|j|jx(|jD]}|||<|||qWdS)N)rZ add_aliasesrrr)rPrrrrrrIrIrJrs    zBaseRegistry._define_aliascCs8|jdkri|_|r,|ddkr,||j|<ntddS)a8Register a loader for a given @ directive.. Parameters ---------- prefix : string identifying the section (e.g. @context) parserfunc : SourceIterator -> None A function that is able to parse a Definition section. Returns ------- Nr@z%Prefix directives must start with '@')re ValueError)rPprefixZ parserfuncrIrIrJrs   zBaseRegistry._register_parser) is_resourcer\c Cst|tryL|r4tjt|}|t|d|St |dd}|||SQRXWn~t t fk r}z|j dkr|||_ |Wdd}~XYnFt k r}z(t|ddpt|}td||Wdd}~XYnXt|}x|D]\}} | dr| ds| d r|r,| d d} nTytj|j} Wntk r\t} YnXtj| tj| d d} || |nt| } |jr|j| d dnd} | dkrt d | |d y | |Wn:t k r} z| j dkr|| _ | Wdd} ~ XYnXqy|!t"#| |j$Wqt k rl} z| j dkrX|| _ | Wdd} ~ XYqt k r} zt%&d|| | Wdd} ~ XYqXqWdS)auAdd units and prefixes defined in a definition text file. Parameters ---------- file : can be a filename or a line iterable. is_resource : used to indicate that the file is a resource file and therefore should be loaded from the package. (Default value = False) Returns ------- zutf-8)encodingNmessagergzWhile opening {} {}rz@aliasz@importrzUnknown directive %s)rzIn line {}, cannot add '{}' {})'rrj importlibZ resourcesZ read_binary __package__rrdecodeopenr.r,r Exceptionrrrr4rrospathdirnamerAttributeErrorgetcwdjoinnormpath _BLOCK_RErregetrrr(rrqr:error)rPfilerZrbytesfpemsgrnorrpartsloaderexrIrIrJr,s\  " "     zBaseRegistry.load_definitionsc Cst|_dd|jD}xt|D]}x|D]}d|kr>q0||}|r\|d\}}}n d|}}yft||j}| |} | |} | |jj |<| |jj |<|s|jj | t} | |j|jWq0tk r} ztd|d| Wdd} ~ XYq0Xq0Wq&WdS) z/Build a cache of dimensionality and base units.cSs(i|] \}}|jr|jnt|qSrI)rrr|)rrrrIrIrJr{sz-BaseRegistry._build_cache..rrrgzCould not resolve z: N)rZrr{rr<parse_unit_namer3Z from_wordrq_get_root_units_get_dimensionalityr^r_r] setdefaultr|r_namerr:r) rPZdepsZ unit_names unit_nameZ parsed_namesr base_name_ZucburZ dimeq_setexcrIrIrJrws.        zBaseRegistry._build_cachezOptional[bool]) name_or_aliasrrr\c Cs|dkr dSy |j|jStk r,YnX|||}|sHt|nr)rP input_unitsrIrIrJget_dimensionalityszBaseRegistry.get_dimensionalityzOptional[UnitsContainerT])r r\cCsz|s |S|jj}y||Stk r0YnXtt}||d|d|krV|d=|dd|D}|||<|S)z,Convert a UnitsContainer to base dimensions.rz[]cSsi|]\}}|dkr||qS)rrI)rrrrIrIrJrsz4BaseRegistry._get_dimensionality..)r5rr_rrint_get_dimensionality_recurser)rPr cache accumulatorZdimsrIrIrJrsz BaseRegistry._get_dimensionalitycCsx|D]}|||}t|r\|j|}|jr@|||7<q|jdk r||j||q|j||}|jdk r||j||qWdS)N)r6rzrrrr{r )rPrexprrexp2regrIrIrJrs     z(BaseRegistry._get_dimensionality_recursecs~||kr dSfdd||fD\}|r>r>|krBdSfdd|D}t|tfdd|DrzSdS)aGet the exponential ratio between two units, i.e. solve unit2 = unit1**x for x. Parameters ---------- unit1 : UnitsContainer compatible (str, Unit, UnitsContainer, dict) first unit unit2 : UnitsContainer compatible (str, Unit, UnitsContainer, dict) second unit Returns ------- number or None exponential proportionality or None if the units cannot be converted rc3s|]}|VqdS)N)r )rr)rPrIrJr sz9BaseRegistry._get_dimensionality_ratio..Nc3s|]\}}||VqdS)NrI)rrval)dim2rIrJr$sc3s|]}|kVqdS)NrI)rr)firstrIrJr&s)rrrall)rPZunit1Zunit2Zdim1ZratiosrI)rrrPrJ_get_dimensionality_ratio sz&BaseRegistry._get_dimensionality_ratior?zTuple[Number, Unit])r  check_nonmultr\cCs(t||}|||\}}|||fS)a[Convert unit or dict of units to the root units. If any unit is non multiplicative and check_converter is True, then None is returned as the multiplicative factor. Parameters ---------- input_units : UnitsContainer or str units check_nonmult : bool if True, None will be returned as the multiplicative factor if a non-multiplicative units is found in the final Units. (Default value = True) Returns ------- Number, pint.Unit multiplicative factor, base units )r>rrA)rPr rfunitsrIrIrJget_root_units*s zBaseRegistry.get_root_unitscs|sdfSjj}y||Stk r4YnXdttg}|d||d}dd|dD}|rtfdd|Drd}||f||<||fS)aWConvert unit or dict of units to the root units. If any unit is non multiplicative and check_converter is True, then None is returned as the multiplicative factor. Parameters ---------- input_units : UnitsContainer or dict units check_nonmult : bool if True, None will be returned as the multiplicative factor if a non-multiplicative units is found in the final Units. (Default value = True) Returns ------- number, Unit multiplicative factor, base units rrcSsi|]\}}|dkr||qS)rrI)rrrrIrIrJrjsz0BaseRegistry._get_root_units..c3s|]}j|jj VqdS)N)r{ris_multiplicative)rr)rPrIrJrosz/BaseRegistry._get_root_units..N) r5rr^rrr _get_root_units_recurserany)rPr rr accumulatorsfactorrrI)rPrJrGs"   zBaseRegistry._get_root_unitscCs |||S)aConvert unit or dict of units to the base units. If any unit is non multiplicative and check_converter is True, then None is returned as the multiplicative factor. Parameters ---------- input_units : UnitsContainer or str units check_nonmult : bool If True, None will be returned as the multiplicative factor if non-multiplicative units are found in the final Units. (Default value = True) system : (Default value = None) Returns ------- Number, pint.Unit multiplicative factor, base units )r)rPr rsystemrIrIrJget_base_unitsuszBaseRegistry.get_base_unitscCsxz|D]r}|||}||}|j|}|jrF|d||7<q|d|jj|9<|jdk r||j||qWdS)Nrr)r r{rZ _converterrrr)rPrrr!rrrrIrIrJrs     z$BaseRegistry._get_root_units_recursezFrozenSet['Unit']cs*t|}||}tfdd|DS)rc3s|]}|VqdS)N)rA)req)rPrIrJrsz4BaseRegistry.get_compatible_units..)r>_get_compatible_units frozenset)rPr group_or_systemZequivrI)rPrJget_compatible_unitss z!BaseRegistry.get_compatible_unitscCs |s tS||}|jj|S)r)r'rrr])rPr r(src_dimrIrIrJr&s z"BaseRegistry._get_compatible_unitsr zUnion[str, Context])obj1obj2contextsr\cOsZt||j|jfr$|j|f||St|trF||j|f||St||j|jf S)acheck if the other object is compatible Parameters ---------- obj1, obj2 The objects to check against each other. Treated as dimensionless if not a Quantity, Unit or str. *contexts : str or pint.Context Contexts to use in the transformation. **ctx_kwargs : Values for the Context/s Returns ------- bool )rr@rAis_compatible_withrjr)rPr+r,r-Z ctx_kwargsrIrIrJr.s   zBaseRegistry.is_compatible_withrBr)rsrcdstinplacer\cCs0t||}t||}||kr |S|||||S)aConvert value from some source to destination units. Parameters ---------- value : value src : pint.Quantity or str source units. dst : pint.Quantity or str destination units. inplace : (Default value = False) Returns ------- type converted value )r>_convert)rPrr/r0r1rIrIrJconverts   zBaseRegistry.convertc Cs|r.||}||}||kr.t|||||||\}} t|trXtt|}nt|trntt|}|r|||9}n||}|S)aConvert value from some source to destination units. Parameters ---------- value : value src : UnitsContainer source units. dst : UnitsContainer destination units. inplace : (Default value = False) check_dimensionality : (Default value = True) Returns ------- type converted value )rr-rrrrjr) rPrr/r0r1Zcheck_dimensionalityr*dst_dimr"rrIrIrJr2s      zBaseRegistry._convertz Tuple[Tuple[str, str, str], ...])rrrr\cCs||j||dS)amParse a unit to identify prefix, unit name and suffix by walking the list of prefix and suffix. In case of equivalent combinations (e.g. ('kilo', 'gram', '') and ('', 'kilogram', ''), prefer those with prefix. Parameters ---------- unit_name : case_sensitive : bool or None Control if unit lookup is case sensitive. Defaults to None, which uses the registry's case_sensitive setting Returns ------- tuple of tuples (str, str, str) all non-equivalent combinations of (prefix, unit name, suffix) )rr)_dedup_candidates_parse_unit_name)rPrrrrIrIrJr szBaseRegistry.parse_unit_namezIterator[Tuple[str, str, str]]c cs|dkr|jn|}|j}|j}xt|j|jD]\}}||r0||r0|t|d}|r||dt| }t|dkr|q0|r||jkr|j|j |j|j |j|fVq0x<|j | dD]&}|j|j |j|j |j|fVqWq0WdS)zHelper of parse_unit_name.NrrI) rrrendswith itertoolsproductrr~rr{rr}rr) rPrrrZstwZedwsuffixrrZ real_namerIrIrJr69s&      zBaseRegistry._parse_unit_namezIterable[Tuple[str, str, str]])rr\cCspt|}x\t|D]P\}}}t|ts,tt|ts:t|dkrJtd|r|d||dfdqWt|S)zHelper of parse_unit_name. Given an iterable of unit triplets (prefix, name, suffix), remove those with different names but equal value, preferring those with a prefix. e.g. ('kilo', 'gram', '') and ('', 'kilogram', '') rgznon-empty suffixN) dictfromkeysrrrjAssertionErrorNotImplementedErrorpopr)rZcpZcucsrIrIrJr5Xs zBaseRegistry._dedup_candidatesrA) input_stringas_deltarrr\cCs0x|jD] }||}qW||||}||S)aParse a units expression and returns a UnitContainer with the canonical names. The expression can only contain products, ratios and powers of units. Parameters ---------- input_string : str as_delta : bool or None if the expression has multiple units, the parser will interpret non multiplicative units as their `delta_` counterparts. (Default value = None) case_sensitive : bool or None Control if unit parsing is case sensitive. Defaults to None, which uses the registry's setting. Returns ------- pint.Unit )rp _parse_unitsrA)rPrArBrrprrIrIrJ parse_unitsms  zBaseRegistry.parse_unitsc Cs|jj}|r&||kr&||jkr&||S|s2|S|}t||j}|jdkrZt di}t |dk}x\|D]T}|j ||d} ||} | sqp|r|s|s| dkr|j| } | j sd| } | || <qpW||}|r|||<|S)z_Parse a units expression and returns a UnitContainer with the canonical names. rz-Unit expression cannot have a scaling factor.)rrr) rr`r{r5rr3rrqrrrr r) rPrArBrrrrretmanyrZcnamerrrIrIrJrCs2      zBaseRegistry._parse_unitsc Ks|r td|d}|d}|tkrn|dkr6d|jS||krL|||S|d||j||ddiSn |tkrtj||j dSt ddS)Nz`use_decimal` is deprecated, use `non_int_type` keyword argument when instantiating the registry. >>> from decimal import Decimal >>> ureg = UnitRegistry(non_int_type=Decimal)rrr)rr)rqzunknown token type) DeprecationWarningr rr@r5r r r3Z eval_tokenrqr)rPtokenrr use_decimalvalues token_typeZ token_textrIrIrJ _eval_tokens" zBaseRegistry._eval_tokenzUnion[List[str], str, None])rArErrrJrGr\c Cs|s|r gSdSt|}t||}g}x`|D]X}|}g} x0|D]$\} } | t| || ||qHW|| |s.|dSq.W|S)aParse a string with a given regex pattern and returns result. Parameters ---------- input_string : pattern_string: The regex parse string case_sensitive : (Default value = None, which uses registry setting) use_decimal : (Default value = False) many : Match many results (Default value = False) Returns ------- Nr)rKrFrC groupdictrappendfloatr) rPrArErrrJrGZmatchedresultsmatchrrrrIrIrJ parse_patterns      zBaseRegistry.parse_patternr@)rArrrJr\c s\|r td|sdSxjD] }||}q"Wt|}t|}t|fddS)aParse a mathematical expression including units and return a quantity object. Numerical constants can be specified as keyword arguments and will take precedence over the names defined in the registry. Parameters ---------- input_string : case_sensitive : (Default value = None, which uses registry setting) use_decimal : (Default value = False) **values : Returns ------- z`use_decimal` is deprecated, use `non_int_type` keyword argument when instantiating the registry. >>> from decimal import Decimal >>> ureg = UnitRegistry(non_int_type=Decimal)rcsj|fdiS)Nrr)rM)x)rrrPrKrIrJ=z/BaseRegistry.parse_expression..)rHr@rpr=r"r0Zevaluate)rPrArrrJrKrDgenrI)rrrPrKrJrs   zBaseRegistry.parse_expression)F)N)N)T)T)TN)N)F)FT)N)N)NN)TN)NF)NFF)NF):rUrVrWrXre__annotations__rfrPrarurOrtrrrrrrrrxr5propertyrsetterrrrrrrrrr rr r rrrrrr$rr)r&r.r3r2rr6 staticmethodr5rErCrMrSrrNrIrIrIrJrds~ $   7  VK&(  .   " 4 * !:,rd) metaclasscseZdZdZddddddfdd Zdd d d d fdd Zddfdd ZddddZddZddZ dfdd Z Z S) NonMultiplicativeRegistryaHandle of non multiplicative units (e.g. Temperature). Capabilities: - Register non-multiplicative units and their relations. - Convert between non-multiplicative units. Parameters ---------- default_as_delta : bool If True, non-multiplicative units are interpreted as their *delta* counterparts in multiplications. autoconvert_offset_to_baseunit : bool If True, non-multiplicative units are converted to base units in multiplications. TFrir r[)default_as_deltaautoconvert_offset_to_baseunitrRr\c stjf|||_||_dS)N)rMrar^r_)rPr^r_rR)rTrIrJraUsz"NonMultiplicativeRegistry.__init__NrjzOptional[bool])rArBrrcs|dkr|j}t|||S)rN)r^rMrC)rPrArBrr)rTrIrJrCesz&NonMultiplicativeRegistry._parse_unitszUnion[str, Definition])rcs<t|\}}}t|jdddkr2|||||||fS)aAdd unit to the registry. In addition to what is done by the BaseRegistry, registers also non-multiplicative units. Parameters ---------- definition : str or Definition A dimension, unit or prefix definition. Returns ------- Definition, dict, dict Definition instance, case sensitive unit dict, case insensitive unit dict. rr)rMrrrr)rPrrr)rTrIrJrqsz!NonMultiplicativeRegistry._define)r\cCsl||jkr|j|jS||}t|dks0t|d\}}}y |j|jStk rft|YnXdS)Nrr)r{rrrr=rr/)rPunamesrrrIrIrJ_is_multiplicatives    z,NonMultiplicativeRegistry._is_multiplicativecsvfdd|D}t|dkr,tdnFt|dkrr|\}}|dkrTtdt|dkrnjsntd|SdS)Ncs"g|]\}}|s||fqSrI)rb)rr`r)rPrIrJ szCNonMultiplicativeRegistry._validate_and_extract..rzmore than one offset unit.zoffset units in higher order.z+offset unit used in multiplicative context.)rrrr?r_)rPrZ nonmult_unitsZ nonmult_unitZexponentrI)rPrJ_validate_and_extracts    z/NonMultiplicativeRegistry._validate_and_extractcCsP|j|}t|jtrL|j}|tkrLdd|D\}}|||S|S)NcSsg|]\}}||fqSrIrI)rr`rrIrIrJrcszBNonMultiplicativeRegistry._add_ref_of_log_unit..) r{rrr%rr5rr?r)rPZ offset_unit all_unitsZ slct_unitZslct_refr`rrIrIrJ_add_ref_of_log_units    z.NonMultiplicativeRegistry._add_ref_of_log_unitc sRy||}Wn6tk rD}zt||d|dWdd}~XYnXy||}Wn6tk r}zt||d|dWdd}~XYnX|s|st||||S||}||} || krt|||| |r|j|j||}| |g}| ||}|r | |g}| ||}t||||d}|rN|j|j ||}|S)aConvert value from some source to destination units. In addition to what is done by the BaseRegistry, converts between non-multiplicative units. Parameters ---------- value : value src : UnitsContainer source units. dst : UnitsContainer destination units. inplace : (Default value = False) Returns ------- type converted value z - In source units, )Z extra_msgNz - In destination units, F) rdrr-rMr2rr{rZ to_referenceremoverfZfrom_reference) rPrr/r0r1Zsrc_offset_unitrZdst_offset_unitr*r4)rTrIrJr2s6&$       z"NonMultiplicativeRegistry._convert)TF)NN)F) rUrVrWrXrarCrrbrdrfr2rYrIrI)rTrJr]Csr]cseZdZdZdddfdd Zddfdd Zddd d Zd dd ddZdd dddZddfdd Z ddddZ dddddZ dddddZ d0d!dd"d#d$Z ed%dd&d'Zd(dd)d*Zd1fd,d- Zfd.d/ZZS)2ContextRegistryaRHandle of Contexts. Conversion between units with different dimensions according to previously established relations (contexts). (e.g. in the spectroscopy, conversion between frequency and energy is possible) Capabilities: - Register contexts. - Enable and disable contexts. - Parse @context directive. r r[)rRr\c s8i|_t|_i|_i|_tjf|t|j|_dS)N) _contextsr$ _active_ctx_caches_context_unitsrMrarr{)rPrR)rTrIrJras zContextRegistry.__init__)r\cst|d|jdS)Nz@context)rMrtr_parse_context)rP)rTrIrJrt.s z!ContextRegistry._register_parsersc CsZy"|tj||j|jdWn2tk rT}ztd|dWdd}~XYnXdS)N)rqzunknown dimension z in context) add_contextr# from_linesrr rqrr,)rPrrrIrIrJrm2szContextRegistry._parse_contextr#)contextr\cCsj|jstd|j|jkr(td|j||j|j<x0|jD]&}||jkrXtd|j||j|<qs     zContextRegistry.add_contextrj)rr\cCs0|j|}|j|j=x|jD] }|j|=qW|S)zRemove a context from the registry and return it. Notice that this methods will not disable the context; see :meth:`disable_contexts`. )rirr)rPrrprrIrIrJremove_contextUs     zContextRegistry.remove_contextcst|j|jd<dS)NrI)rMrrrk)rP)rTrIrJrcs zContextRegistry._build_cachecCs|jjdd=tdd|jjD}|s8|jd|_dS|j}y&|j||_|jjd|j |Wnt k r|YnX|jd}t ||j|<|_i|j |<}|jjd||j }d|_ z4x.t |jjD]}x|jD]}||qWqWWd||_ XdS)aAIf any of the active contexts redefine units, create variant self._cache and self._units specific to the combination of active contexts. The next time this method is invoked with the same combination of contexts, reuse the same variant self._cache and self._units as in the previous time. Ncss|] }|jVqdS)N) redefinitions)rctxrIrIrJrnszBContextRegistry._switch_context_cache_and_units..rIrignore)r{mapsr rjr-rkrZhashableinsertrlrrbrwreversedrs _redefine)rPZ units_overlayrZ base_cacheZon_redefinition_backuprtrrIrIrJ_switch_context_cache_and_unitsgs,     z/ContextRegistry._switch_context_cache_and_unitsr+)rr\c Cs||j}|st|jdd|D}|s.z%Can't redefine a unit with a prefix: rrz+Can't redefine a base unit to a derived onezCan't change dimensionality of z from z to z in a contextF)rrrrrrN)rrr/rrr=r{rrrrr+rrrr) rPrrZcandidates_no_prefixrrZbasedefZdims_oldZdims_newrIrIrJrys6     zContextRegistry._redefinezUnion[str, Context])names_or_contextsr\c sjjrtjjffdd|D}x||D]t}|jr.Tc3s|]}tj|fVqdS)N)r#Z from_context)rrt)rRrIrJrsz2ContextRegistry.enable_contexts..N) rjdefaultsr;checkedZfuncsrrZremove_transformationZadd_transformationrZinsert_contextsrz) rPr|rRZctxsrtZ funcs_copyr/r0funcZsrc_Zdst_r-rI)rRrPrJenable_contextss$        zContextRegistry.enable_contextsNr )nr\cCs|j||dS)zDisable the last n enabled contexts. Parameters ---------- n : int Number of contexts to disable. Default: disable all contexts. N)rjZremove_contextsrz)rPrrIrIrJdisable_contextss z ContextRegistry.disable_contextszContextManager[Context]c os,|j||z |VWd|t|XdS)aHUsed as a context manager, this function enables to activate a context which is removed after usage. Parameters ---------- *names : name(s) of the context(s). **kwargs : keyword arguments for the contexts. Examples -------- Context can be called by their name: >>> import pint >>> ureg = pint.UnitRegistry() >>> ureg.add_context(pint.Context('one')) >>> ureg.add_context(pint.Context('two')) >>> with ureg.context('one'): ... pass If a context has an argument, you can specify its value as a keyword argument: >>> with ureg.context('one', n=1): ... pass Multiple contexts can be entered in single call: >>> with ureg.context('one', 'two', n=1): ... pass Or nested allowing you to give different values to the same keyword argument: >>> with ureg.context('one', n=1): ... with ureg.context('two', n=2): ... pass A nested context inherits the defaults from the containing context: >>> with ureg.context('one', n=1): ... # Here n takes the value of the outer context ... with ureg.context('two'): ... pass N)rrr)rPrarRrIrIrJrps/  zContextRegistry.contextzCallable[[F], F]c sfdd}|S)aVDecorator to wrap a function call in a Pint context. Use it to ensure that a certain context is active when calling a function:: Parameters ---------- name : name of the context. **kwargs : keyword arguments for the context Returns ------- callable the wrapped function. Example ------- >>> @ureg.with_context('sp') ... def my_cool_fun(wavelength): ... print('This wavelength is equivalent to: %s', wavelength.to('terahertz')) csVtfddtjD}tfddtjD}tj||dfdd}|S)Nc3s|]}t|r|VqdS)N)rD)rattr)rrIrJrGszBContextRegistry.with_context..decorator..c3s|]}t|r|VqdS)N)rD)rr)rrIrJrJs)assignedupdatedc s$jf ||SQRXdS)N)rp)rKZwrapper_kwargs)rrRrrPrIrJwrapperMsz@ContextRegistry.with_context..decorator..wrapper)r functoolsWRAPPER_ASSIGNMENTSWRAPPER_UPDATESwraps)rrrr)rRrrP)rrJ decoratorEs "z/ContextRegistry.with_context..decoratorrI)rPrrRrrI)rRrrPrJ with_context+szContextRegistry.with_contextFc s|jr||}||}t|jj||}|r|||}x8t|dd|ddD]\}} |j|| ||}qVW|j|j}}t ||||S)a3Convert value from some source to destination units. In addition to what is done by the BaseRegistry, converts between units with different dimensions by following transformation rules defined in the context. Parameters ---------- value : value src : UnitsContainer source units. dst : UnitsContainer destination units. inplace : (Default value = False) Returns ------- callable converted value Nrrr) rjrr8graphr@zipZ transformZ _magnituder{rMr2) rPrr/r0r1r*r4rab)rTrIrJr2Vs   $zContextRegistry._convertcsZ||}t||}|jrV|}t|jj|}|rVx|D]}||jj|O}q>W|S)N) rrMr&rjrr7rrr])rPr r(r*rFZnodesZnode)rTrIrJr&s  z%ContextRegistry._get_compatible_units)N)F)rUrVrWrXrartrmrnrqrrzryrrrrprr2r&rYrIrI)rTrJrhs  %*0 :+)rhcseZdZdZd/fdd Zddfdd Zddfd d Zddfd d Zddd dZddddZ d0ddddddZ e ddZ e ddddZ e jddZ d1ddddddZfd d!Zd2d"dd#d$d%d&d'Zd3d(dd#d)d*d+Zd,dfd-d. ZZS)4SystemRegistryaHandle of Systems and Groups. Conversion between units with different dimensions according to previously established relations (contexts). (e.g. in the spectroscopy, conversion between frequency and energy is possible) Capabilities: - Register systems and groups. - List systems - Get or get the default system. - Parse @system and @group directive. Nc s<tjf|i|_t|_i|_|d|jd<||_dS)Nroot)rMra_systemsr;_base_units_cache_groupsr1_default_system)rPr#rR)rTrIrJras zSystemRegistry.__init__r[)r\cs&tt||_t||_dS)N)rMrurZbuild_group_classr1Zbuild_system_classr2)rP)rTrIrJrus  z$SystemRegistry._init_dynamic_classescsttd|jkrZ||jdd}tdd|jD}|ddj}|j|||j pl|j dd|_ dS) zInvoked at the end of ``__init__``. - Create default group and add all orphan units to it - Set default system groupTcSs&g|]}|jdkr|jD]}|qqS)r)rmembers)rrmemberrIrIrJrcs z.SystemRegistry._after_init..rFr#N) rMrOry get_groupr'rrKr add_unitsrr)rPZgrpZ group_unitsre)rTrIrJrOs   zSystemRegistry._after_initcs*t|d|j|d|jdS)Nz@groupz@system)rMrtr _parse_group _parse_system)rP)rTrIrJrts z SystemRegistry._register_parserscCs|j||j|jdS)N)r1rorrrq)rPrrIrIrJrszSystemRegistry._parse_groupcCs|j||j|jdS)N)r2rorrrq)rPrrIrIrJrszSystemRegistry._parse_systemTrjrir1)rcreate_if_neededr\cCs.||jkr|j|S|s$td|||S)aIReturn a Group. Parameters ---------- name : str Name of the group to be create_if_needed : bool If True, create a group if not found. If False, raise an Exception. (Default value = True) Returns ------- type Group zUnknown group %s)rrr1)rPrrrIrIrJrs    zSystemRegistry.get_groupcCs t|jS)N)rZListerr)rPrIrIrJrszSystemRegistry.sysr2cCs|jS)N)r)rPrIrIrJdefault_systemszSystemRegistry.default_systemcCs*|r ||jkrtd|i|_||_dS)NzUnknown system %s)rrrr)rPrrIrIrJrs   cCs.||jkr|j|S|s$td|||S)aKReturn a Group. Parameters ---------- name : str Name of the group to be create_if_needed : bool If True, create a group if not found. If False, raise an Exception. (Default value = True) Returns ------- type System zUnknown system %s)rrr2)rPrrrIrIrJ get_systems    zSystemRegistry.get_systemcs8t|\}}}t|tr.|d|j|||fS)Nr)rMrrr+rrr)rPrrr)rTrIrJrs zSystemRegistry._definezUnion[UnitLike, Quantity]zUnion[str, System, None]zTuple[Number, Unit])r rr#r\cCs(t|}||||\}}|||fS)aConvert unit or dict of units to the base units. If any unit is non multiplicative and check_converter is True, then None is returned as the multiplicative factor. Unlike BaseRegistry, in this registry root_units might be different from base_units Parameters ---------- input_units : UnitsContainer or str units check_nonmult : bool if True, None will be returned as the multiplicative factor if a non-multiplicative units is found in the final Units. (Default value = True) system : (Default value = None) Returns ------- type multiplicative factor, base units )r>_get_base_unitsrA)rPr rr#rrrIrIrJr$*s zSystemRegistry.get_base_unitsr)r rr#c Cs|dkr|j}|r0||jkr0||jkr0|j|S|||\}}|sL||fSt||}|}||dj}xN|D]B\}} ||kr||} t| |} || | 9}qv|||| i9}qvW||||} |r| |f|j|<| |fS)NF) rrrr>r5rZ base_unitsrr3) rPr rr#r"rZdestination_unitsrrrZnew_unitZ base_factorrIrIrJrPs,     zSystemRegistry._get_base_unitszFrozenSet[Unit]csl|dkr|j}t||}|rh||jkr8|j|j}n$||jkrP|j|j}n td|t||@S|S)Nz%Unknown Group o System with name '%s')rrMr&rrrrr')rPr r(rFr)rTrIrJr&~s    z$SystemRegistry._get_compatible_units)N)T)T)TN)TN)rUrVrWrXrarurOrtrrrrYrrrZrrr$rr&rYrIrI)rTrJrs$    %*rc speZdZdZddddddddddedf ddddddd fd d Zd d ZddddddZej Z ej Z Z S) UnitRegistryaMThe unit registry stores the definitions and relationships between units. Parameters ---------- filename : path of the units definition file to load or line-iterable object. Empty to load the default definition file. None to leave the UnitRegistry empty. force_ndarray : bool convert any input, scalar or not to a numpy.ndarray. force_ndarray_like : bool convert all inputs other than duck arrays to a numpy.ndarray. default_as_delta : In the context of a multiplication of units, interpret non-multiplicative units as their *delta* counterparts. autoconvert_offset_to_baseunit : If True converts offset units in quantities are converted to their base units in multiplicative context. If False no conversion happens. on_redefinition : str action to take in case a unit is redefined. 'warn', 'raise', 'ignore' auto_reduce_dimensions : If True, reduce dimensionality on appropriate operations. preprocessors : list of callables which are iteratively ran on any input expression or unit string fmt_locale : locale identifier string, used in `format_babel`. Default to None case_sensitive : bool, optional Control default case sensitivity of unit parsing. (Default: True) rgFTrhNrirj)rlrmr^r_rnrrc s(tj||||||||| | | | d dS)N) rrlrmrnr^r_r#rorprfrqrr)rMra) rPrrlrmr^r_rnr#rorprfrqrr)rTrIrJraszUnitRegistry.__init__cCs t||S)u.Builds dimensionless quantities using the Buckingham π theorem Parameters ---------- quantities : dict mapping between variable name and units Returns ------- list a list of dimensionless quantities expressed as dicts )r;)rPZ quantitiesrIrIrJr;szUnitRegistry.pi_theoremr[)enabler\cCsddlm}|||dS)zSet up handlers for matplotlib's unit support. Parameters ---------- enable : bool whether support should be enabled or disabled (Default value = True) r)setup_matplotlib_handlersN)Z matplotlibr)rPrrrIrIrJsetup_matplotlibs zUnitRegistry.setup_matplotlib)T) rUrVrWrXrPrar;rrrZcheckrYrIrI)rTrJrs"  rcsFeZdZdddZddZddZfdd Zd d Zd d ZZ S) LazyRegistryNcCs|pd|p if|jd<dS)NrIparams)r)rPrQrRrIrIrJraszLazyRegistry.__init__cCs4|jd\}}d|d<t|_|j|||dS)Nrrrn)rrrTrarO)rPrQrRrIrIrJZ__inits  zLazyRegistry.__initcCs|dkr dS|t||S)Nrwr)_LazyRegistry__initr)rPrrIrIrJr szLazyRegistry.__getattr__cs0|dkrt||n|t|||dS)NrT)rM __setattr__rsetattr)rPrr)rTrIrJr szLazyRegistry.__setattr__cCs|||S)N)r)rPrrIrIrJr szLazyRegistry.__getitem__cOs||||S)N)r)rPrQrRrIrIrJrN szLazyRegistry.__call__)NN) rUrVrWrarrrrrNrYrIrI)rTrJrs   rc@sXeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ dS)ApplicationRegistryzGA wrapper class used to distribute changes to the application registry.cCs ||_dS)N) _registry)rPregistryrIrIrJra szApplicationRegistry.__init__cCs|jS)zGet the wrapped registry)r)rPrIrIrJr szApplicationRegistry.getcCsNt|t|r|}t|ttfs4tdt|td|j|||_dS)zSet the new registry Parameters ---------- new_registry : ApplicationRegistry or LazyRegistry or UnitRegistry The new registry. See Also -------- set_application_registry zExpected UnitRegistry; got %sz$Changing app registry from %r to %r.N) rrrrrrr:debugr)rPZ new_registryrIrIrJr|" s  zApplicationRegistry.setcCs t|j|S)N)rr)rPrrIrIrJr8 szApplicationRegistry.__getattr__cCs t|jS)N)dirr)rPrIrIrJr; szApplicationRegistry.__dir__cCs |j|S)N)r)rPrrIrIrJr> szApplicationRegistry.__getitem__cOs |j||S)N)r)rPrQrRrIrIrJrNA szApplicationRegistry.__call__cCs |j|S)N)rr)rPrrIrIrJrD sz ApplicationRegistry.__contains__cCs t|jS)N)rr)rPrIrIrJrG szApplicationRegistry.__iter__N) rUrVrWrXrarr|rrrrNrrrIrIrIrJr sr)srXZ __future__rrrZimportlib.resourcesrr8rrrF collectionsrr contextlibrdecimalrZ fractionsriorZnumbersr tokenizer r typingr r rrrrrrrrrrrrrrgrrZ_typingrrcompatr r!r"rpr#r$Z convertersr%r&Z definitionsr'r(r)r*r+errorsr,r-r.r/Z pint_evalr0r1r2utilr3r4r5r6r7r8r9r:r;r<r=r>r?rr@rrArZbabelZLocalerBrHr lru_cacherKrrLrZrbrPrkrjZPreprocessorTyperdr]rhrrrrrIrIrIrJ"s      D 8        Od!