typing: use | None instead of Optional

Author: amorison

src/stagpy/_helpers.py

@@ -8,8 +8,6 @@
 import matplotlib.pyplot as plt
 
 if typing.TYPE_CHECKING:
-    from typing import Optional
-
     from matplotlib.figure import Figure
     from numpy.typing import NDArray
 
@@ -24,7 +22,7 @@ def walk(sdat: StagyyData, conf: Config) -> StepsView:
     return sdat.snaps[conf.core.snapshots]
 
 
-def out_name(conf: Config, stem: str, timestep: Optional[int] = None) -> str:
+def out_name(conf: Config, stem: str, timestep: int | None = None) -> str:
     """Return StagPy out file name.
 
     Args:
@@ -62,7 +60,7 @@ def saveplot(
     conf: Config,
     fig: Figure,
     stem: str,
-    timestep: Optional[int] = None,
+    timestep: int | None = None,
     close: bool = True,
 ) -> None:
     """Save matplotlib figure.

src/stagpy/args.py

@@ -26,7 +26,7 @@
 from .config import Config
 
 if typing.TYPE_CHECKING:
-    from typing import Any, Callable, Optional
+    from typing import Any, Callable
 
 
 def _sub(cmd: Any, *sections: str) -> Subcmd:
@@ -72,7 +72,7 @@ def _load_mplstyle(conf: Config) -> None:
 
 
 def parse_args(
-    conf: Config, arglist: Optional[list[str]] = None
+    conf: Config, arglist: list[str] | None = None
 ) -> Callable[[Config], None]:
     """Parse cmd line arguments.
 

src/stagpy/commands.py

@@ -15,7 +15,7 @@
 from .stagyydata import _sdat_from_conf
 
 if typing.TYPE_CHECKING:
-    from typing import Callable, Iterable, Mapping, Optional, Sequence, Union
+    from typing import Callable, Iterable, Mapping, Sequence, Union
 
     from loam.base import Section
 
@@ -56,7 +56,7 @@ def _pretty_print(
     key_val: Sequence[tuple[str, str]],
     sep: str = ": ",
     min_col_width: int = 39,
-    text_width: Optional[int] = None,
+    text_width: int | None = None,
 ) -> None:
     """Print a iterable of key/values.
 

src/stagpy/config.py

@@ -8,7 +8,7 @@
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, Optional, Sequence, Union
+from typing import Dict, Sequence, Union
 
 import loam.parsers as lprs
 from loam.base import ConfigBase, Section, entry
@@ -53,15 +53,15 @@ class Core(Section):
 class Plot(Section):
     """Plotting."""
 
-    ratio: Optional[float] = MaybeEntry(float).entry(
+    ratio: float | None = MaybeEntry(float).entry(
         doc="force aspect ratio of field plot", in_file=False
     )
     raster: bool = switch_opt(True, None, "rasterize field plots")
     format: str = entry(val="pdf", doc="figure format (pdf, eps, svg, png)")
-    vmin: Optional[float] = MaybeEntry(float).entry(
+    vmin: float | None = MaybeEntry(float).entry(
         doc="minimal value on plot", in_file=False
     )
-    vmax: Optional[float] = MaybeEntry(float).entry(
+    vmax: float | None = MaybeEntry(float).entry(
         doc="maximal value on plot", in_file=False
     )
     cminmax: bool = switch_opt(False, "C", "constant min max across plots")
@@ -97,18 +97,18 @@ class FieldSec(Section):
         default="T,stream", cli_short="o", doc="variables to plot (see stagpy var)"
     )
     perturbation: bool = switch_opt(False, None, "plot departure from average profile")
-    shift: Optional[int] = MaybeEntry(int).entry(
+    shift: int | None = MaybeEntry(int).entry(
         doc="shift plot horizontally", in_file=False
     )
     timelabel: bool = switch_opt(False, None, "add label with time")
     colorbar: bool = switch_opt(True, None, "add color bar to plot")
-    ix: Optional[int] = MaybeEntry(int).entry(
+    ix: int | None = MaybeEntry(int).entry(
         doc="x-index of slice for 3D fields", in_file=False
     )
-    iy: Optional[int] = MaybeEntry(int).entry(
+    iy: int | None = MaybeEntry(int).entry(
         doc="y-index of slice for 3D fields", in_file=False
     )
-    iz: Optional[int] = MaybeEntry(int).entry(
+    iz: int | None = MaybeEntry(int).entry(
         doc="z-index of slice for 3D fields", in_file=False
     )
     isocolors: Sequence[str] = TupleEntry(str).entry(doc="list of colors for isolines")
@@ -151,11 +151,9 @@ class Time(Section):
     compstat: Sequence[str] = TupleEntry(str).entry(
         doc="compute mean and rms of listed variables", in_file=False
     )
-    tstart: Optional[float] = MaybeEntry(float).entry(
-        doc="beginning time", in_file=False
-    )
-    tend: Optional[float] = MaybeEntry(float).entry(doc="end time", in_file=False)
-    fraction: Optional[float] = MaybeEntry(float).entry(
+    tstart: float | None = MaybeEntry(float).entry(doc="beginning time", in_file=False)
+    tend: float | None = MaybeEntry(float).entry(doc="end time", in_file=False)
+    fraction: float | None = MaybeEntry(float).entry(
         doc="ending fraction of series to process", in_file=False
     )
     marktimes: Sequence[float] = TupleEntry(float).entry(
@@ -200,7 +198,7 @@ class Plates(Section):
         False, None, "plot number of plates as function of time"
     )
     distribution: bool = switch_opt(False, None, "plot plate size distribution")
-    zoom: Optional[float] = MaybeEntry(float).entry(
+    zoom: float | None = MaybeEntry(float).entry(
         doc="zoom around surface", in_file=False
     )
 

src/stagpy/field.py

@@ -17,7 +17,7 @@
 from .stagyydata import _sdat_from_conf
 
 if typing.TYPE_CHECKING:
-    from typing import Any, Iterable, Optional, Union
+    from typing import Any, Iterable
 
     from matplotlib.axes import Axes
     from matplotlib.collections import QuadMesh
@@ -40,9 +40,9 @@ def _threed_extract(
     """Return suitable slices and coords for 3D fields."""
     is_vector = not valid_field_var(var)
     hwalls = is_vector or walls
-    i_x: Optional[Union[int, slice]] = conf.field.ix
-    i_y: Optional[Union[int, slice]] = conf.field.iy
-    i_z: Optional[Union[int, slice]] = conf.field.iz
+    i_x: int | slice | None = conf.field.ix
+    i_y: int | slice | None = conf.field.iy
+    i_z: int | slice | None = conf.field.iz
     if i_x is not None or i_y is not None:
         i_z = None
     if i_x is not None or i_z is not None:
@@ -177,11 +177,11 @@ def get_meshes_vec(
 def plot_scalar(
     step: Step,
     var: str,
-    field: Optional[NDArray] = None,
-    axis: Optional[Axes] = None,
-    conf: Optional[Config] = None,
+    field: NDArray | None = None,
+    axis: Axes | None = None,
+    conf: Config | None = None,
     **extra: Any,
-) -> tuple[Figure, Axes, QuadMesh, Optional[Colorbar]]:
+) -> tuple[Figure, Axes, QuadMesh, Colorbar | None]:
     """Plot scalar field.
 
     Args:
@@ -271,8 +271,8 @@ def plot_iso(
     axis: Axes,
     step: Step,
     var: str,
-    field: Optional[NDArray] = None,
-    conf: Optional[Config] = None,
+    field: NDArray | None = None,
+    conf: Config | None = None,
     **extra: Any,
 ) -> None:
     """Plot isocontours of scalar field.
@@ -311,7 +311,7 @@ def plot_vec(
     axis: Axes,
     step: Step,
     var: str,
-    conf: Optional[Config] = None,
+    conf: Config | None = None,
 ) -> None:
     """Plot vector field.
 

src/stagpy/plates.py

@@ -18,7 +18,7 @@
 from .stagyydata import _sdat_from_conf
 
 if typing.TYPE_CHECKING:
-    from typing import Optional, Sequence, TextIO, Union
+    from typing import Sequence, TextIO, Union
 
     from matplotlib.axes import Axes
     from numpy.typing import NDArray
@@ -211,7 +211,7 @@ def _continents_location(snap: Step, at_surface: bool = True) -> NDArray:
 def plot_at_surface(
     snap: Step,
     names: Sequence[Sequence[Sequence[str]]],
-    conf: Optional[Config],
+    conf: Config | None,
 ) -> None:
     """Plot surface diagnostics.
 
@@ -333,7 +333,7 @@ def _write_trench_diagnostics(
 def plot_scalar_field(
     snap: Step,
     fieldname: str,
-    conf: Optional[Config] = None,
+    conf: Config | None = None,
 ) -> None:
     """Plot scalar field with plate information.
 

src/stagpy/processing.py

@@ -16,8 +16,6 @@
 from .error import NotAvailableError
 
 if typing.TYPE_CHECKING:
-    from typing import Optional
-
     from numpy.typing import NDArray
 
     from .stagyydata import StagyyData
@@ -121,7 +119,7 @@ def delta_r(step: Step) -> Rprof:
     return Rprof((edges[1:] - edges[:-1]), step.rprofs.centers, meta)
 
 
-def _scale_prof(step: Step, rprof: NDArray, rad: Optional[NDArray] = None) -> NDArray:
+def _scale_prof(step: Step, rprof: NDArray, rad: NDArray | None = None) -> NDArray:
     """Scale profile to take sphericity into account."""
     rbot, rtop = step.rprofs.bounds
     if rbot == 0:  # not spherical

src/stagpy/refstate.py

@@ -2,8 +2,6 @@
 
 from __future__ import annotations
 
-from typing import Optional
-
 import matplotlib.pyplot as plt
 
 from . import _helpers
@@ -12,7 +10,7 @@
 from .stagyydata import StagyyData, _sdat_from_conf
 
 
-def plot_ref(sdat: StagyyData, var: str, conf: Optional[Config] = None) -> None:
+def plot_ref(sdat: StagyyData, var: str, conf: Config | None = None) -> None:
     """Plot one reference state.
 
     Args:

src/stagpy/rprof.py

@@ -11,15 +11,15 @@
 from .stagyydata import _sdat_from_conf
 
 if typing.TYPE_CHECKING:
-    from typing import Optional, Sequence
+    from typing import Sequence
 
     from .step import Rprofs, Step
 
 
 def plot_rprofs(
     rprofs: Rprofs,
     names: Sequence[Sequence[Sequence[str]]],
-    conf: Optional[Config] = None,
+    conf: Config | None = None,
 ) -> None:
     """Plot requested radial profiles.
 
@@ -70,7 +70,7 @@ def plot_rprofs(
         _helpers.saveplot(conf, fig, fname + stepstr)
 
 
-def plot_grid(step: Step, conf: Optional[Config] = None) -> None:
+def plot_grid(step: Step, conf: Config | None = None) -> None:
     """Plot cell position and thickness.
 
     The figure is call grid_N.pdf where N is replace by the step index.