phyvars.Var* are NamedTuples

This is cleaner and allows for type annotations.

Author: amorison

docs/sources/apiref/phyvars.rst

@@ -3,15 +3,7 @@ phyvars
 
 .. automodule:: stagpy.phyvars
 
-   .. class:: Varf
-
-      :class:`collections.namedtuple` whose instances hold metadata of
-      scalar fields. It defines the following fields:
-
-      - **description** (*str* or *func*): short description of the variable if
-        it is output by StagYY, function to compute it otherwise.
-      - **dim** (*str*): dimension used to
-        :func:`~stagpy.stagyydata.StagyyData.scale` to dimensional values.
+   .. autoclass:: Varf
 
    .. data:: FIELD
       :annotation: = {fieldvar: Varf()}
@@ -31,17 +23,7 @@ phyvars
       Dictionary of surface scalar fields output by StagYY. Keys are the
       variable names, values are :class:`Varf` instances.
 
-   .. class:: Varr
-
-      :class:`collections.namedtuple` whose instances hold metadata of
-      radial profiles. It defines the following fields:
-
-      - **description** (*str* or *func*): short description of the variable if
-        it is output by StagYY, function to compute it otherwise.
-      - **kind** (*str*): shorter description to group similar variables under
-        the same label.
-      - **dim** (*str*): dimension used to
-        :func:`~stagpy.stagyydata.StagyyData.scale` to dimensional values.
+   .. autoclass:: Varr
 
    .. data:: RPROF
       :annotation: = {rprofvar: Varr()}
@@ -61,17 +43,7 @@ phyvars
       Dictionary of radial profiles of the reference state. Keys are the
       variable names, values are :class:`Varr` instances.
 
-   .. class:: Vart
-
-      :class:`collections.namedtuple` whose instances hold metadata of
-      time series. It defines the following fields:
-
-      - **description** (*str* or *func*): short description of the variable if
-        it is output by StagYY, function to compute it otherwise.
-      - **kind** (*str*): shorter description to group similar variables under
-        the same label.
-      - **dim** (*str*): dimension used to
-        :func:`~stagpy.stagyydata.StagyyData.scale` to dimensional values.
+   .. autoclass:: Vart
 
    .. data:: TIME
       :annotation: = {timevar: Vart()}

stagpy/phyvars.py

@@ -5,13 +5,34 @@
 be computed from other variables.
 """
 
-from collections import namedtuple
+from __future__ import annotations
 from operator import attrgetter
 from types import MappingProxyType
+from typing import NamedTuple, TYPE_CHECKING
 
 from . import processing
 
-Varf = namedtuple('Varf', ['description', 'dim'])
+if TYPE_CHECKING:
+    from typing import Union, Callable, Tuple
+    from numpy import ndarray
+    from ._step import Step
+    from .stagyydata import StagyyData
+
+
+class Varf(NamedTuple):
+    """Metadata of scalar fields.
+
+    Attributes:
+        description: short description of the variable if it is output by
+            StagYY, function to compute it otherwise.
+        dim: dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
+            dimensional values.
+    """
+
+    description: Union[str, Callable[[Step], ndarray]]
+    dim: str
+
+
 FIELD = MappingProxyType({
     'T': Varf('Temperature', 'K'),
     'v1': Varf('x Velocity', 'm/s'),
@@ -129,7 +150,24 @@
     'CrustThickness': ['crust'],
 })
 
-Varr = namedtuple('Varr', ['description', 'kind', 'dim'])
+
+class Varr(NamedTuple):
+    """Metadata of radial profiles.
+
+    Attributes:
+        description: short description of the variable if it is output by
+            StagYY, function to compute it otherwise.
+        kind: shorter description to group similar variables under the same
+            label.
+        dim: dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
+            dimensional values.
+    """
+
+    description: Union[str, Callable[[Step], Tuple[ndarray, ndarray]]]
+    kind: str
+    dim: str
+
+
 RPROF = MappingProxyType({
     'r': Varr('Radial coordinate', 'Radius', 'm'),
     'Tmean': Varr('Temperature', 'Temperature', 'K'),
@@ -212,7 +250,24 @@
     'advth': Varr(processing.advth, 'Heat Flux', 'W/m2'),
 })
 
-Vart = namedtuple('Vart', ['description', 'kind', 'dim'])
+
+class Vart(NamedTuple):
+    """Metadata of time series.
+
+    Attributes:
+        description: short description of the variable if it is output by
+            StagYY, function to compute it otherwise.
+        kind: shorter description to group similar variables under the same
+            label.
+        dim: dimension used to :func:`~stagpy.stagyydata.StagyyData.scale` to
+            dimensional values.
+    """
+
+    description: Union[str, Callable[[StagyyData], Tuple[ndarray, ndarray]]]
+    kind: str
+    dim: str
+
+
 TIME = MappingProxyType({
     't': Vart('Time', 'Time', 's'),
     'ftop': Vart('Heat flux at top', 'Heat flux', 'W/m2'),