Use PEP 585 generic types

Part of #109

Author: mx-moth

docs/developing/grass.py

@@ -1,7 +1,8 @@
 # > imports
 import enum
+from collections.abc import Hashable, Sequence
 from functools import cached_property
-from typing import Dict, Hashable, Optional, Sequence, Tuple
+from typing import Optional
 
 import numpy
 import xarray
@@ -19,7 +20,7 @@ class GrassGridKind(enum.Enum):
     fence = 'fence'
 
 
-GrassIndex = Tuple[GrassGridKind, Sequence[int]]
+GrassIndex = tuple[GrassGridKind, Sequence[int]]
 
 
 class Grass(DimensionConvention[GrassGridKind, GrassIndex]):
@@ -37,14 +38,14 @@ def check_dataset(cls, dataset: xarray.Dataset) -> Optional[int]:
             return Specificity.HIGH
         return None
 
-    def unpack_index(self, index: GrassIndex) -> Tuple[GrassGridKind, Sequence[int]]:
+    def unpack_index(self, index: GrassIndex) -> tuple[GrassGridKind, Sequence[int]]:
         return index[0], list(index[1])
 
     def pack_index(self, grid_kind: GrassGridKind, indices: Sequence[int]) -> GrassIndex:
         return (grid_kind, list(indices))
 
     @cached_property
-    def grid_dimensions(self) -> Dict[GrassGridKind, Sequence[Hashable]]:
+    def grid_dimensions(self) -> dict[GrassGridKind, Sequence[Hashable]]:
         return {
             GrassGridKind.field: ['warp', 'weft'],
             GrassGridKind.fence: ['post'],

docs/roles.py

@@ -1,5 +1,6 @@
 import re
-from typing import Callable, Iterable, List, Tuple, cast
+from collections.abc import Iterable
+from typing import Callable, cast
 
 import yaml
 from docutils import nodes, utils
@@ -30,7 +31,7 @@ def role_fn(
         inliner: Inliner,
         options: dict = {},
         content: list = [],
-    ) -> Tuple[list, list]:
+    ) -> tuple[list, list]:
         match = GITHUB_FULL_REF.match(utils.unescape(text))
         if match is not None:
             repo = match.group('repo')
@@ -83,15 +84,15 @@ def load_citation_file(self) -> dict:
         with open(citation_file, 'r') as f:
             return cast(dict, yaml.load(f, yaml.Loader))
 
-    def run(self) -> List[nodes.Node]:
+    def run(self) -> list[nodes.Node]:
         if self.options['format'] == 'apa':
             return self.run_apa()
         elif self.options['format'] == 'biblatex':
             return self.run_biblatex()
         else:
             raise ValueError("Unknown format")
 
-    def run_apa(self) -> List[nodes.Node]:
+    def run_apa(self) -> list[nodes.Node]:
         citation = self.load_citation_file()
         names = self.comma_ampersand_join(map(self.apa_name, citation['authors']))
         year = citation['date-released'].year
@@ -118,7 +119,7 @@ def comma_ampersand_join(self, items: Iterable[str]) -> str:
             return items[0]
         return '{}, & {}'.format(', '.join(items[:-1]), items[-1])
 
-    def run_biblatex(self) -> List[nodes.Node]:
+    def run_biblatex(self) -> list[nodes.Node]:
         citation = self.load_citation_file()
 
         year = citation['date-released'].year

scripts/release.py

@@ -6,7 +6,7 @@
 import shlex
 import subprocess
 import sys
-from typing import List, Optional
+from typing import Optional
 
 PROJECT = pathlib.Path(__file__).parent.parent
 
@@ -29,7 +29,7 @@
 
 
 def main(
-    args: Optional[List[str]] = None,
+    args: Optional[list[str]] = None,
 ) -> None:
     parser = argparse.ArgumentParser()
     add_options(parser)

src/emsarray/cli/__init__.py

@@ -6,7 +6,7 @@
 import argparse
 import importlib
 import pkgutil
-from typing import Iterable, Type
+from collections.abc import Iterable
 
 import emsarray
 
@@ -40,7 +40,7 @@ def main(options: argparse.Namespace) -> None:
     options.func(options)
 
 
-def _find_all_commands() -> Iterable[Type[BaseCommand]]:
+def _find_all_commands() -> Iterable[type[BaseCommand]]:
     for moduleinfo in pkgutil.iter_modules(commands.__path__):
         if moduleinfo.name.startswith('_'):
             continue

src/emsarray/cli/commands/clip.py

@@ -3,7 +3,6 @@
 import logging
 import tempfile
 from pathlib import Path
-from typing import ContextManager
 
 import emsarray
 from emsarray.cli import BaseCommand
@@ -39,7 +38,7 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
             ))
 
     def handle(self, options: argparse.Namespace) -> None:
-        work_context: ContextManager[Pathish]
+        work_context: contextlib.AbstractContextManager[Pathish]
         if options.work_dir:
             work_context = contextlib.nullcontext(options.work_dir)
         else:

src/emsarray/cli/commands/export_geometry.py

@@ -1,7 +1,7 @@
 import argparse
 import logging
 from pathlib import Path
-from typing import Callable, Dict
+from typing import Callable
 
 import xarray
 
@@ -13,7 +13,7 @@
 logger = logging.getLogger(__name__)
 
 Writer = Callable[[xarray.Dataset, Pathish], None]
-format_writers: Dict[str, Writer] = {
+format_writers: dict[str, Writer] = {
     'geojson': geometry.write_geojson,
     'shapefile': geometry.write_shapefile,
     'wkt': geometry.write_wkt,

src/emsarray/cli/commands/plot.py

@@ -2,7 +2,7 @@
 import functools
 import logging
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Text, TypeVar
+from typing import Any, Callable, Optional, TypeVar
 
 import emsarray
 from emsarray.cli import BaseCommand, CommandException
@@ -12,7 +12,7 @@
 logger = logging.getLogger(__name__)
 
 
-def key_value(arg: str, value_type: Callable = str) -> Dict[str, T]:
+def key_value(arg: str, value_type: Callable = str) -> dict[str, T]:
     try:
         name, value = arg.split("=", 2)
     except ValueError:
@@ -24,11 +24,11 @@ def key_value(arg: str, value_type: Callable = str) -> Dict[str, T]:
 class UpdateDict(argparse.Action):
     def __init__(
         self,
-        option_strings: List[str],
+        option_strings: list[str],
         dest: str,
         *,
         value_type: Callable = str,
-        default: Optional[Dict[str, Any]] = None,
+        default: Optional[dict[str, Any]] = None,
         **kwargs: Any,
     ):
         if default is None:
@@ -42,7 +42,7 @@ def __call__(
         parser: argparse.ArgumentParser,
         namespace: argparse.Namespace,
         values: Any,
-        option_string: Optional[Text] = None,
+        option_string: Optional[str] = None,
     ) -> None:
         super().__call__
         holder = getattr(namespace, self.dest, {})

src/emsarray/cli/utils.py

@@ -9,9 +9,10 @@
 import re
 import sys
 import textwrap
+from collections.abc import Iterator
 from functools import wraps
 from pathlib import Path
-from typing import Callable, Iterator, List, Optional, Protocol
+from typing import Callable, Optional, Protocol
 
 from shapely.geometry import box, shape
 from shapely.geometry.base import BaseGeometry
@@ -29,7 +30,7 @@
 class MainCallable(Protocol):
     def __call__(
         self,
-        argv: Optional[List[str]] = None,
+        argv: Optional[list[str]] = None,
         handle_errors: bool = True,
     ) -> None:
         ...
@@ -90,7 +91,7 @@ def main(options: argparse.Namespace) -> None:
     .. code-block:: python
 
         @nice_console_errors()
-        def main(argv: Optional[List[str]]) -> None:
+        def main(argv: Optional[list[str]]) -> None:
             parser = argparse.ArgumentParser()
             add_verbosity_group(parser)
             command_line_flags(parser)
@@ -111,7 +112,7 @@ def decorator(
     ) -> MainCallable:
         @wraps(fn)
         def wrapper(
-            argv: Optional[List[str]] = None,
+            argv: Optional[list[str]] = None,
             handle_errors: bool = True,
         ) -> None:
             parser = argparse.ArgumentParser(

src/emsarray/compat/shapely.py

@@ -1,5 +1,6 @@
 import warnings
-from typing import Generic, Iterable, Tuple, TypeVar, Union, cast
+from collections.abc import Iterable
+from typing import Generic, TypeVar, Union, cast
 
 import numpy
 import shapely
@@ -30,7 +31,7 @@ class SpatialIndex(Generic[T]):
 
     def __init__(
         self,
-        items: Union[numpy.ndarray, Iterable[Tuple[BaseGeometry, T]]],
+        items: Union[numpy.ndarray, Iterable[tuple[BaseGeometry, T]]],
     ):
         self.items = numpy.array(items, dtype=self.dtype)
 

src/emsarray/conventions/_base.py

@@ -5,10 +5,10 @@
 import enum
 import logging
 import warnings
+from collections.abc import Hashable, Iterable, Sequence
 from functools import cached_property
 from typing import (
-    TYPE_CHECKING, Any, Callable, Dict, FrozenSet, Generic, Hashable, Iterable,
-    List, Optional, Sequence, Tuple, TypeVar, Union, cast
+    TYPE_CHECKING, Any, Callable, Generic, Optional, TypeVar, Union, cast
 )
 
 import numpy
@@ -399,7 +399,7 @@ def get_depth_name(self) -> Hashable:
         except IndexError:
             raise NoSuchCoordinateError("Could not find depth coordinate in dataset")
 
-    def get_all_depth_names(self) -> List[Hashable]:
+    def get_all_depth_names(self) -> list[Hashable]:
         """Get the names of all depth layers.
         Some datasets include both a depth layer centre,
         and the depth layer 'edges'.
@@ -595,7 +595,7 @@ def unravel_index(
 
     @property
     @abc.abstractmethod
-    def grid_kinds(self) -> FrozenSet[GridKind]:
+    def grid_kinds(self) -> frozenset[GridKind]:
         """
         All of the :data:`grid kinds <.GridKind>` this dataset includes.
         """
@@ -612,7 +612,7 @@ def default_grid_kind(self) -> GridKind:
 
     @property
     @abc.abstractmethod
-    def grid_size(self) -> Dict[GridKind, int]:
+    def grid_size(self) -> dict[GridKind, int]:
         """The linear size of each grid kind."""
         pass
 
@@ -662,7 +662,7 @@ def get_grid_kind(self, data_array: xarray.DataArray) -> GridKind:
 
     def get_grid_kind_and_size(
         self, data_array: xarray.DataArray,
-    ) -> Tuple[GridKind, int]:
+    ) -> tuple[GridKind, int]:
         """
         Determines the relevant index kind and the extent of the linear index space
         for this data array.
@@ -885,7 +885,7 @@ def plot_on_figure(
         self,
         figure: Figure,
         scalar: Optional[DataArrayOrName] = None,
-        vector: Optional[Tuple[DataArrayOrName, DataArrayOrName]] = None,
+        vector: Optional[tuple[DataArrayOrName, DataArrayOrName]] = None,
         title: Optional[str] = None,
         **kwargs: Any,
     ) -> None:
@@ -965,7 +965,7 @@ def animate_on_figure(
         self,
         figure: Figure,
         scalar: Optional[DataArrayOrName] = None,
-        vector: Optional[Tuple[DataArrayOrName, DataArrayOrName]] = None,
+        vector: Optional[tuple[DataArrayOrName, DataArrayOrName]] = None,
         coordinate: Optional[DataArrayOrName] = None,
         title: Optional[Union[str, Callable[[Any], str]]] = None,
         **kwargs: Any,
@@ -1187,7 +1187,7 @@ def make_quiver(
         # sometimes preferring to fill them in later,
         # so `u` and `v` are optional.
         # If they are not provided, we set default quiver values of `numpy.nan`.
-        values: Union[Tuple[numpy.ndarray, numpy.ndarray], Tuple[float, float]]
+        values: Union[tuple[numpy.ndarray, numpy.ndarray], tuple[float, float]]
         values = numpy.nan, numpy.nan
 
         if u is not None and v is not None:
@@ -1422,7 +1422,7 @@ def get_index_for_point(
         return None
 
     @abc.abstractmethod
-    def selector_for_index(self, index: Index) -> Dict[Hashable, int]:
+    def selector_for_index(self, index: Index) -> dict[Hashable, int]:
         """
         Convert a convention native index into a selector
         that can be passed to :meth:`Dataset.isel <xarray.Dataset.isel>`.
@@ -1516,7 +1516,7 @@ def select_point(self, point: Point) -> xarray.Dataset:
         return self.select_index(index.index)
 
     @abc.abstractmethod
-    def get_all_geometry_names(self) -> List[Hashable]:
+    def get_all_geometry_names(self) -> list[Hashable]:
         """
         Return a list of the names of all geometry variables used by this convention.
 
@@ -1742,7 +1742,7 @@ class DimensionConvention(Convention[GridKind, Index]):
 
     @property
     @abc.abstractmethod
-    def grid_dimensions(self) -> Dict[GridKind, Sequence[Hashable]]:
+    def grid_dimensions(self) -> dict[GridKind, Sequence[Hashable]]:
         """
         The dimensions associated with a particular grid kind.
 
@@ -1760,7 +1760,7 @@ def grid_dimensions(self) -> Dict[GridKind, Sequence[Hashable]]:
         pass
 
     @property
-    def grid_shape(self) -> Dict[GridKind, Sequence[int]]:
+    def grid_shape(self) -> dict[GridKind, Sequence[int]]:
         """
         The :attr:`shape <numpy.ndarray.shape>` of each grid kind.
 
@@ -1775,7 +1775,7 @@ def grid_shape(self) -> Dict[GridKind, Sequence[int]]:
         }
 
     @property
-    def grid_size(self) -> Dict[GridKind, int]:
+    def grid_size(self) -> dict[GridKind, int]:
         return {
             grid_kind: int(numpy.prod(shape))
             for grid_kind, shape in self.grid_shape.items()
@@ -1806,7 +1806,7 @@ def _get_data_array(self, data_array: DataArrayOrName) -> xarray.DataArray:
             return self.dataset[data_array]
 
     @abc.abstractmethod
-    def unpack_index(self, index: Index) -> Tuple[GridKind, Sequence[int]]:
+    def unpack_index(self, index: Index) -> tuple[GridKind, Sequence[int]]:
         """Convert a native index in to a grid kind and dimension indices.
 
         Parameters
@@ -1902,7 +1902,7 @@ def wind(
             dimensions=dimensions, sizes=sizes,
             linear_dimension=linear_dimension)
 
-    def selector_for_index(self, index: Index) -> Dict[Hashable, int]:
+    def selector_for_index(self, index: Index) -> dict[Hashable, int]:
         grid_kind, indices = self.unpack_index(index)
         dimensions = self.grid_dimensions[grid_kind]
         return dict(zip(dimensions, indices))