MetrologyNamespace (initial PR) #9
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lucascolley
reviewed
Mar 17, 2025
| out: Any | ||
| an object representing the metrology API namespace. It should have every top-level function defined in the specification as an attribute. It may contain other public names as well, but it is recommended to only include those names that are part of the specification. | ||
| """ | ||
|
|
||
| def __mul__(self, other: Self, /) -> Self: ... | ||
| def __truediv__(self, other: Self, /) -> Self: ... | ||
| def __pow__(self, other: int, /) -> Self: ... | ||
|
|
||
|
|
||
| @runtime_checkable | ||
| class Unit(Protocol): |
There was a problem hiding this comment.
Looks like we are suggesting here to parametrize Unit with a D: Dimension
There was a problem hiding this comment.
Most libraries will have Dimension as only one class, but parametrizing like this allows for users/libraries to have different classes if they choose. Potential use cases include:
- Differentiating between base and composed dimensions (if they use different classes)
- Supporting different dimension classes, e.g greedy vs lazy resolution of the dimension
- Typing functions that can take a quantity from one library and convert it to a quantity of another library.
Comment on lines
+23
to
+30
| @property | ||
| def Dimension(self) -> D: ... | ||
|
|
||
| @property | ||
| def Unit(self) -> U: ... | ||
|
|
||
| @property | ||
| def Quantity(self) -> Q: ... |
There was a problem hiding this comment.
do we even need to make the classes accessible?
There was a problem hiding this comment.
I don't think so. Like array api, which doesn't
andrewgsavage
commented
Mar 17, 2025
| def asdimension(obj: str | D) -> D: ... | ||
|
|
||
| @staticmethod | ||
| def asunit(obj) -> U[D]: ... |
There was a problem hiding this comment.
Suggested change
| def asunit(obj) -> U[D]: ... | |
| def asunit(obj: str | U) -> U[D]: ... |
should this be type hinted?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
transferred from quantity-dev/quantity-api#5