Add custom UnitRegistry to handle scaling factors more cleanly #212
Conversation
|
|
||
|
|
||
| _REGISTRY: UnitRegistry = None # global requires it be defined in this scope | ||
| def _unmangle_scaling(input_string: str) -> str: |
| assert "11e2" in parse_units("F* 11*10^2") | ||
|
|
||
|
|
||
| def test_deprecation(): |
There was a problem hiding this comment.
Best practice assume 3p libs are working
gemd/units/impl.py
Outdated
|
|
||
| @functools.lru_cache(maxsize=1024) | ||
| def parse_units(units: Union[str, Unit, None], | ||
| def parse_units(units: Union[str, _ScaleFactorUnit, None], |
There was a problem hiding this comment.
does this mean I can't pass in a base Unit instance?
There was a problem hiding this comment.
It'd work, but typehints would complain. Functionally there's no reason to not support both, so I'll update that.
|
|
||
|
|
||
| @register_unit_format("clean") | ||
| @deprecated(deprecated_in="2.1.0", removed_in="3.0.0", details="Scaling factor clean-up ") |
There was a problem hiding this comment.
if this is deprecated, what is it replaced with?
There was a problem hiding this comment.
is it that _unmangle_scaling encompasses the customization that clean was performing before?
There was a problem hiding this comment.
Yes, the clean formatter is now obsolete, because of the __format__ method does its fundamental work without getting in the way of invoking other formatters (H, P, etc.). That's potentially very valuable because we'll because to do server-side HTML formatting, rather than forcing a browser side fix.
An issue happened where stringified versions of parsed units weren't directly parsable on later invocations of the library when there was a scaling factor. For example,
grams / 10 minuteswas being internally represented asgram / _10_minute, but then the units service was storing that instead of what would have come out of acleanformatted string. The specific bug encountered is here:https://citrine.atlassian.net/browse/SPT-1311
This PR prevents this issue in the future by:
__format__method always cleans up the munged scaling factorcleansince the subclass makes it obsolete