Use type hinting generics from standard collections (#271)

This eliminates all uses of these members of 'typing':
Tuple, List, Dict, Set, FrozenSet, Type

Author: JonathonReinhart

scuba/config.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 import re
 import shlex
-from typing import Any, List, Dict, Optional, TextIO, Tuple, Type, TypeVar, Union
+from typing import Any, Optional, TextIO, TypeVar, Union
 from typing import overload
 
 import yaml
@@ -15,8 +15,8 @@
 from .dockerutil import make_vol_opt
 
 CfgNode = Any
-CfgData = Dict[str, CfgNode]
-Environment = Dict[str, str]
+CfgData = dict[str, CfgNode]
+Environment = dict[str, str]
 _T = TypeVar("_T")
 
 VOLUME_NAME_PATTERN = re.compile(r"^[a-zA-Z0-9][a-zA-Z0-9_.-]+$")
@@ -59,7 +59,7 @@ class OverrideStr(str, OverrideMixin):
 # http://stackoverflow.com/a/9577670
 class Loader(yaml.SafeLoader):
     _root: Path  # directory containing the loaded document
-    _cache: Dict[Path, Any]  # document path => document
+    _cache: dict[Path, Any]  # document path => document
 
     def __init__(self, stream: TextIO):
         if not hasattr(self, "_root"):
@@ -68,7 +68,7 @@ def __init__(self, stream: TextIO):
         super().__init__(stream)
 
     @staticmethod
-    def _rooted_loader(root: Path) -> Type[Loader]:
+    def _rooted_loader(root: Path) -> type[Loader]:
         """Get a Loader class with _root set to root"""
 
         class RootedLoader(Loader):
@@ -160,7 +160,7 @@ def override(self, node: yaml.nodes.Node) -> OverrideMixin:
 Loader.add_constructor("!override", Loader.override)
 
 
-def find_config() -> Tuple[Path, Path, ScubaConfig]:
+def find_config() -> tuple[Path, Path, ScubaConfig]:
     """Search up the directory hierarchy for .scuba.yml
 
     Returns: path, rel, config on success, or None if not found
@@ -218,7 +218,7 @@ def _expand_env_vars(in_str: str) -> str:
         ) from ve
 
 
-def _process_script_node(node: CfgNode, name: str) -> List[str]:
+def _process_script_node(node: CfgNode, name: str) -> list[str]:
     """Process a script-type node
 
     Args:
@@ -274,7 +274,7 @@ def _process_environment(node: CfgNode, name: str) -> Environment:
     return result
 
 
-def _get_nullable_str(data: Dict[str, Any], key: str) -> Optional[str]:
+def _get_nullable_str(data: dict[str, Any], key: str) -> Optional[str]:
     # N.B. We can't use data.get() here, because that might return
     # None, leading to ambiguity between the key being absent or set
     # to a null value.
@@ -303,7 +303,7 @@ def _get_entrypoint(data: CfgData) -> Optional[str]:
     return _get_nullable_str(data, "entrypoint")
 
 
-def _get_docker_args(data: CfgData) -> Optional[List[str]]:
+def _get_docker_args(data: CfgData) -> Optional[list[str]]:
     args_str = _get_nullable_str(data, "docker_args")
     if args_str is None:
         return None
@@ -319,7 +319,7 @@ def _get_docker_args(data: CfgData) -> Optional[List[str]]:
 def _get_typed_val(
     data: CfgData,
     key: str,
-    type_: Type[_T],
+    type_: type[_T],
     default: Optional[_T] = None,
 ) -> Optional[_T]:
     v = data.get(key, default)
@@ -346,14 +346,14 @@ def _get_dict(data: CfgData, key: str) -> Optional[dict[str, Any]]:
     return _get_typed_val(data, key, dict)
 
 
-def _get_delimited_str_list(data: CfgData, key: str, sep: str) -> List[str]:
+def _get_delimited_str_list(data: CfgData, key: str, sep: str) -> list[str]:
     s = _get_typed_val(data, key, str)
     return s.split(sep) if s else []
 
 
 def _get_volumes(
     data: CfgData, scuba_root: Optional[Path]
-) -> Optional[Dict[Path, ScubaVolume]]:
+) -> Optional[dict[Path, ScubaVolume]]:
     voldata = _get_dict(data, "volumes")
     if voldata is None:
         return None
@@ -414,7 +414,7 @@ class ScubaVolume:
     container_path: Path
     host_path: Optional[Path] = None
     volume_name: Optional[str] = None
-    options: List[str] = dataclasses.field(default_factory=list)
+    options: list[str] = dataclasses.field(default_factory=list)
 
     def __post_init__(self) -> None:
         if sum(bool(x) for x in (self.host_path, self.volume_name)) != 1:
@@ -498,14 +498,14 @@ def get_vol_opt(self) -> str:
 @dataclasses.dataclass(frozen=True)
 class ScubaAlias:
     name: str
-    script: List[str]
+    script: list[str]
     image: Optional[str] = None
     entrypoint: Optional[str] = None
-    environment: Optional[Dict[str, str]] = None
+    environment: Optional[dict[str, str]] = None
     shell: Optional[str] = None
     as_root: bool = False
-    docker_args: Optional[List[str]] = None
-    volumes: Optional[Dict[Path, ScubaVolume]] = None
+    docker_args: Optional[list[str]] = None
+    volumes: Optional[dict[Path, ScubaVolume]] = None
 
     @classmethod
     def from_dict(
@@ -534,10 +534,10 @@ def from_dict(
 class ScubaConfig:
     shell: str
     entrypoint: Optional[str]
-    docker_args: Optional[List[str]]  # TODO: drop Optional?
-    volumes: Optional[Dict[Path, ScubaVolume]]  # TODO: drop Optional? Dict?
-    aliases: Dict[str, ScubaAlias]
-    hooks: Dict[str, List[str]]
+    docker_args: Optional[list[str]]  # TODO: drop Optional?
+    volumes: Optional[dict[Path, ScubaVolume]]  # TODO: drop Optional? dict?
+    aliases: dict[str, ScubaAlias]
+    hooks: dict[str, list[str]]
     environment: Environment
 
     def __init__(
@@ -578,15 +578,15 @@ def __init__(
 
     def _load_aliases(
         self, data: CfgData, scuba_root: Optional[Path]
-    ) -> Dict[str, ScubaAlias]:
+    ) -> dict[str, ScubaAlias]:
         aliases = {}
         for name, node in data.get("aliases", {}).items():
             if " " in name:
                 raise ConfigError("Alias names cannot contain spaces")
             aliases[name] = ScubaAlias.from_dict(name, node, scuba_root)
         return aliases
 
-    def _load_hooks(self, data: CfgData) -> Dict[str, List[str]]:
+    def _load_hooks(self, data: CfgData) -> dict[str, list[str]]:
         hooks = {}
         for name in (
             "user",

scuba/dockerutil.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 import subprocess
 import json
-from typing import Any, Dict, IO, Optional, Sequence, Union
+from typing import Any, IO, Optional, Sequence, Union
 from pathlib import Path
 
 # https://github.com/python/typeshed/blob/main/stdlib/subprocess.pyi
@@ -41,7 +41,7 @@ def call(
 def _run_docker(*args: str, capture: bool = False) -> subprocess.CompletedProcess[str]:
     """Run docker and raise DockerExecuteError on ENOENT"""
     docker_args = ["docker"] + list(args)
-    kw: Dict[str, Any] = dict(text=True)
+    kw: dict[str, Any] = dict(text=True)
     if capture:
         kw.update(capture_output=True)
 
@@ -89,7 +89,7 @@ def docker_inspect_or_pull(image: str) -> dict:
 def get_images() -> Sequence[str]:
     """Get the current list of docker images
 
-    Returns: List of image names
+    Returns: A list of image names
     """
     cp = _run_docker(
         "images",

scuba/scuba.py

@@ -9,7 +9,7 @@
 from grp import getgrgid
 from pathlib import Path
 from pwd import getpwuid
-from typing import cast, Any, Dict, Iterable, List, Optional, Sequence, Tuple, Union
+from typing import cast, Any, Iterable, Optional, Sequence, Union
 from typing import TextIO
 
 from .config import ScubaConfig, OverrideMixin
@@ -19,7 +19,7 @@
 from .dockerutil import make_vol_opt
 from .utils import shell_quote_cmd, flatten_list, get_umask, writeln
 
-VolumeTuple = Tuple[Path, Path, List[str]]
+VolumeTuple = tuple[Path, Path, list[str]]
 
 
 class ScubaError(Exception):
@@ -28,21 +28,21 @@ class ScubaError(Exception):
 
 class ScubaDive:
     context: ScubaContext
-    env_vars: Dict[str, str]
-    volumes: List[VolumeTuple]
-    options: List[str]
-    docker_args: List[str]
+    env_vars: dict[str, str]
+    volumes: list[VolumeTuple]
+    options: list[str]
+    docker_args: list[str]
 
-    docker_cmd: List[str]
+    docker_cmd: list[str]
 
     def __init__(
         self,
-        user_command: List[str],
+        user_command: list[str],
         config: ScubaConfig,
         top_path: Path,
         top_rel: Path,
-        docker_args: Optional[List[str]] = None,
-        env: Optional[Dict[str, str]] = None,
+        docker_args: Optional[list[str]] = None,
+        env: Optional[dict[str, str]] = None,
         as_root: bool = False,
         verbose: bool = False,
         image_override: Optional[str] = None,
@@ -143,7 +143,7 @@ def add_volume(
         self,
         hostpath: Union[Path, str],
         contpath: Union[Path, str],
-        options: Optional[List[str]] = None,
+        options: Optional[list[str]] = None,
     ) -> None:
         """Add a volume (bind-mount) to the docker run invocation"""
         hostpath = Path(hostpath)
@@ -375,11 +375,11 @@ def get_docker_cmdline(self) -> Sequence[str]:
 @dataclasses.dataclass
 class ScubaContext:
     image: str
-    environment: Dict[str, str]  # key: value
-    volumes: Dict[Path, ScubaVolume]
+    environment: dict[str, str]  # key: value
+    volumes: dict[Path, ScubaVolume]
     shell: str
-    docker_args: List[str]
-    script: Optional[List[str]] = None  # TODO: drop Optional?
+    docker_args: list[str]
+    script: Optional[list[str]] = None  # TODO: drop Optional?
     entrypoint: Optional[str] = None
     as_root: bool = False
 
@@ -408,7 +408,7 @@ def process_command(
         entrypoint = cfg.entrypoint
         environment = copy.copy(cfg.environment)
         docker_args = copy.copy(cfg.docker_args) or []
-        volumes: Dict[Path, ScubaVolume] = copy.copy(cfg.volumes or {})
+        volumes: dict[Path, ScubaVolume] = copy.copy(cfg.volumes or {})
         as_root = False
 
         if command:
@@ -429,7 +429,7 @@ def process_command(
                     as_root = True
 
                 if isinstance(alias.docker_args, OverrideMixin) or docker_args is None:
-                    docker_args = cast(List[str], alias.docker_args)
+                    docker_args = cast(list[str], alias.docker_args)
                 elif alias.docker_args is not None:
                     docker_args.extend(alias.docker_args)
 

tests/test_main.py

@@ -10,7 +10,7 @@
 import sys
 from tempfile import TemporaryFile, NamedTemporaryFile
 from textwrap import dedent
-from typing import cast, IO, List, Optional, Sequence, TextIO, Tuple
+from typing import cast, IO, Optional, Sequence, TextIO
 from unittest import mock
 import warnings
 
@@ -27,7 +27,7 @@
     PseudoTTY,
 )
 
-ScubaResult = Tuple[str, str]
+ScubaResult = tuple[str, str]
 
 
 SCUBA_YML = Path(".scuba.yml")
@@ -40,7 +40,7 @@ def write_script(path: Path, text: str) -> None:
 
 
 def run_scuba(
-    args: List[str],
+    args: list[str],
     *,
     expect_return: int = 0,
     mock_isatty: bool = False,
@@ -296,7 +296,7 @@ def _test_user(
         expected_username: str,
         expected_gid: int,
         expected_groupname: str,
-        scuba_args: List[str] = [],
+        scuba_args: list[str] = [],
     ) -> None:
         SCUBA_YML.write_text(f"image: {DOCKER_IMAGE}")
 
@@ -316,7 +316,7 @@ def _test_user(
         assert gid == expected_gid
         assert groupname == expected_groupname
 
-    def _test_user_expect_root(self, scuba_args: List[str] = []) -> None:
+    def _test_user_expect_root(self, scuba_args: list[str] = []) -> None:
         return self._test_user(
             expected_uid=0,
             expected_username="root",
@@ -392,7 +392,7 @@ def test_user_root_alias(self) -> None:
 
 
 class TestMainHomedir(MainTest):
-    def _test_home_writable(self, scuba_args: List[str] = []) -> None:
+    def _test_home_writable(self, scuba_args: list[str] = []) -> None:
         SCUBA_YML.write_text(f"image: {DOCKER_IMAGE}")
 
         args = scuba_args + [

tests/test_utils.py

@@ -3,14 +3,14 @@
 import os
 import pytest
 import shlex
-from typing import List, Sequence
+from typing import Sequence
 
 from .utils import assert_seq_equal
 
 import scuba.utils
 
 
-def _parse_cmdline(cmdline: str) -> List[str]:
+def _parse_cmdline(cmdline: str) -> list[str]:
     # Strip the formatting and whitespace
     lines = [l.rstrip("\\").strip() for l in cmdline.splitlines()]
 

tests/utils.py

@@ -7,7 +7,7 @@
 import unittest
 import logging
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Sequence, TypeVar, Optional, Union
+from typing import Any, Callable, Sequence, TypeVar, Optional, Union
 from unittest import mock
 
 from scuba.config import ScubaVolume
@@ -41,10 +41,10 @@ def assert_str_equalish(exp: Any, act: Any) -> None:
 
 
 def assert_vol(
-    vols: Dict[Path, ScubaVolume],
+    vols: dict[Path, ScubaVolume],
     cpath_str: PathStr,
     hpath_str: PathStr,
-    options: List[str] = [],
+    options: list[str] = [],
 ) -> None:
     cpath = Path(cpath_str)
     hpath = Path(hpath_str)