namespace

Author: andrewgsavage

src/metrology_apis/__init__.py

@@ -8,8 +8,45 @@
 __all__ = ["__version__", "Dimension", "Quantity", "Unit"]
 
 
+@runtime_checkable
+class MetrologyNamespace[Q: Quantity, U: Unit, D: Dimension](Protocol):
+
+    @staticmethod
+    def asdimension(obj: str | D) -> D: ...
+
+    @staticmethod
+    def asunit(obj) -> U[D]: ...
+
+    @staticmethod
+    def asquantity(obj: V, unit: obj) -> Q[V, U[D]]: ...
+
+    @property
+    def Dimension(self) -> D: ...
+
+    @property
+    def Unit(self) -> U: ...
+
+    @property
+    def Quantity(self) -> Q: ...
+
+
 @runtime_checkable
 class Dimension(Protocol):
+    def __metrology_namespace__(
+        self, /, *, api_version: str | None = None
+    ) -> MetrologyNamespace:
+        """
+        Returns an object that has all the metrology API functions on it.
+        Parameters
+        ----------
+        api_version: str or None
+            string representing the version of the metrology API specification to be returned. If it is ``None``, it should return the namespace corresponding to latest version of the metrology API specification.  If the given version is invalid or not implemented for the given module, an error should be raised. Default: ``None``.
+        Returns
+        -------
+        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: ...
@@ -23,6 +60,21 @@ def __ne__(self, other: Self, /) -> bool: ...
 
 @runtime_checkable
 class Unit(Protocol):
+    def __metrology_namespace__(
+        self, /, *, api_version: str | None = None
+    ) -> MetrologyNamespace:
+        """
+        Returns an object that has all the metrology API functions on it.
+        Parameters
+        ----------
+        api_version: str or None
+            string representing the version of the metrology API specification to be returned. If it is ``None``, it should return the namespace corresponding to latest version of the metrology API specification.  If the given version is invalid or not implemented for the given module, an error should be raised. Default: ``None``.
+        Returns
+        -------
+        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.
+        """
+
     @property
     def dimension(self) -> Dimension: ...
 
@@ -34,8 +86,24 @@ def __rmul__(self, other: Self, /) -> Self: ...
     def __rtruediv__(self, other: Self, /) -> Self: ...
     def __rpow__(self, other: int | float, /) -> Self: ...
 
+
 @runtime_checkable
 class Quantity[V, U: Unit](Protocol):
+    def __metrology_namespace__(
+        self, /, *, api_version: str | None = None
+    ) -> MetrologyNamespace:
+        """
+        Returns an object that has all the metrology API functions on it.
+        Parameters
+        ----------
+        api_version: str or None
+            string representing the version of the metrology API specification to be returned. If it is ``None``, it should return the namespace corresponding to latest version of the metrology API specification.  If the given version is invalid or not implemented for the given module, an error should be raised. Default: ``None``.
+        Returns
+        -------
+        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.
+        """
+
     @property
     def value(self) -> V: ...
     @property