Apply ruff/flake8-type-checking rule TCH003

TCH003 Move standard library import into a type-checking block

Author: DimitriPapadopoulos

ci/min_deps_check.py

@@ -8,13 +8,16 @@
 
 import itertools
 import sys
-from collections.abc import Iterator
 from datetime import datetime
+from typing import TYPE_CHECKING
 
 import libmambapy  # type: ignore[import]
 import yaml
 from dateutil.relativedelta import relativedelta
 
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
 CHANNELS = ["conda-forge", "defaults"]
 IGNORE_DEPS = {
     "coveralls",

xarray/backends/common.py

@@ -4,7 +4,6 @@
 import os
 import time
 import traceback
-from collections.abc import Iterable, Mapping, Sequence
 from glob import glob
 from typing import TYPE_CHECKING, Any, ClassVar, TypeVar, cast, overload
 
@@ -18,6 +17,7 @@
 from xarray.namedarray.pycompat import is_chunked_array
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Mapping, Sequence
     from io import BufferedIOBase
 
     from xarray.core.dataset import Dataset

xarray/backends/file_manager.py

@@ -2,18 +2,20 @@
 
 import atexit
 import contextlib
-import io
 import threading
 import uuid
 import warnings
-from collections.abc import Hashable
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from xarray.backends.locks import acquire
 from xarray.backends.lru_cache import LRUCache
 from xarray.core import utils
 from xarray.core.options import OPTIONS
 
+if TYPE_CHECKING:
+    import io
+    from collections.abc import Hashable
+
 # Global cache for storing open files.
 FILE_CACHE: LRUCache[Any, io.IOBase] = LRUCache(
     maxsize=OPTIONS["file_cache_maxsize"], on_evict=lambda k, v: v.close()

xarray/backends/h5netcdf_.py

@@ -3,7 +3,6 @@
 import functools
 import io
 import os
-from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any
 
 import numpy as np
@@ -39,6 +38,7 @@
 from xarray.core.variable import Variable
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
     from io import BufferedIOBase
 
     from xarray.backends.common import AbstractDataStore

xarray/backends/locks.py

@@ -4,10 +4,12 @@
 import threading
 import uuid
 import weakref
-from collections.abc import Hashable, MutableMapping
-from typing import Any, ClassVar
+from typing import TYPE_CHECKING, Any, ClassVar
 from weakref import WeakValueDictionary
 
+if TYPE_CHECKING:
+    from collections.abc import Hashable, MutableMapping
+
 
 # SerializableLock is adapted from Dask:
 # https://github.com/dask/dask/blob/74e898f0ec712e8317ba86cc3b9d18b6b9922be0/dask/utils.py#L1160-L1224

xarray/backends/netCDF4_.py

@@ -3,7 +3,6 @@
 import functools
 import operator
 import os
-from collections.abc import Iterable
 from contextlib import suppress
 from typing import TYPE_CHECKING, Any
 
@@ -41,6 +40,7 @@
 from xarray.core.variable import Variable
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
     from io import BufferedIOBase
 
     from h5netcdf.core import EnumType as h5EnumType

xarray/backends/plugins.py

@@ -4,7 +4,6 @@
 import inspect
 import itertools
 import warnings
-from collections.abc import Callable
 from importlib.metadata import entry_points
 from typing import TYPE_CHECKING, Any
 
@@ -13,6 +12,7 @@
 
 if TYPE_CHECKING:
     import os
+    from collections.abc import Callable
     from importlib.metadata import EntryPoint, EntryPoints
     from io import BufferedIOBase
 

xarray/backends/pydap_.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any
 
 import numpy as np
@@ -26,6 +25,7 @@
 
 if TYPE_CHECKING:
     import os
+    from collections.abc import Iterable
     from io import BufferedIOBase
 
     from xarray.core.dataset import Dataset

xarray/backends/scipy_.py

@@ -3,7 +3,6 @@
 import gzip
 import io
 import os
-from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any
 
 import numpy as np
@@ -34,6 +33,7 @@
 from xarray.core.variable import Variable
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable
     from io import BufferedIOBase
 
     from xarray.backends.common import AbstractDataStore

xarray/backends/store.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any
 
 from xarray import conventions
@@ -13,6 +12,7 @@
 
 if TYPE_CHECKING:
     import os
+    from collections.abc import Iterable
     from io import BufferedIOBase
 
 

xarray/backends/zarr.py

@@ -4,7 +4,6 @@
 import json
 import os
 import struct
-from collections.abc import Hashable, Iterable, Mapping
 from typing import TYPE_CHECKING, Any, Literal
 
 import numpy as np
@@ -35,6 +34,7 @@
 from xarray.namedarray.utils import module_available
 
 if TYPE_CHECKING:
+    from collections.abc import Hashable, Iterable, Mapping
     from io import BufferedIOBase
 
     from zarr import Group as ZarrGroup

xarray/coding/cftime_offsets.py

@@ -44,7 +44,6 @@
 
 import re
 import warnings
-from collections.abc import Mapping
 from datetime import datetime, timedelta
 from functools import partial
 from typing import TYPE_CHECKING, ClassVar, Literal, TypeVar
@@ -76,6 +75,8 @@
 
 
 if TYPE_CHECKING:
+    from collections.abc import Mapping
+
     from xarray.core.types import InclusiveOptions, Self, SideOptions, TypeAlias
 
 

xarray/coding/variables.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import warnings
-from collections.abc import Callable, Hashable, MutableMapping
 from functools import partial
 from typing import TYPE_CHECKING, Any, Union
 
@@ -16,6 +15,8 @@
 from xarray.namedarray.pycompat import is_chunked_array
 
 if TYPE_CHECKING:
+    from collections.abc import Callable, Hashable, MutableMapping
+
     T_VarTuple = tuple[tuple[Hashable, ...], Any, dict, dict]
     T_Name = Union[Hashable, None]
 

xarray/core/_aggregations.py

@@ -4,14 +4,15 @@
 
 from __future__ import annotations
 
-from collections.abc import Callable, Sequence
 from typing import TYPE_CHECKING, Any
 
 from xarray.core import duck_array_ops
 from xarray.core.options import OPTIONS
 from xarray.core.utils import contains_only_chunked_or_numpy, module_available
 
 if TYPE_CHECKING:
+    from collections.abc import Callable, Sequence
+
     from xarray.core.dataarray import DataArray
     from xarray.core.dataset import Dataset
     from xarray.core.types import Dims, Self

xarray/core/_typed_ops.py

@@ -5,12 +5,13 @@
 from __future__ import annotations
 
 import operator
-from collections.abc import Callable
 from typing import TYPE_CHECKING, Any, overload
 
 from xarray.core import nputils, ops
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
+
     from xarray.core.dataarray import DataArray
     from xarray.core.dataset import Dataset
     from xarray.core.datatree import DataTree

xarray/core/accessor_str.py

@@ -42,7 +42,6 @@
 import codecs
 import re
 import textwrap
-from collections.abc import Callable, Hashable, Mapping
 from functools import reduce
 from operator import or_ as set_union
 from re import Pattern
@@ -56,6 +55,8 @@
 from xarray.core.types import T_DataArray
 
 if TYPE_CHECKING:
+    from collections.abc import Callable, Hashable, Mapping
+
     from numpy.typing import DTypeLike
 
     from xarray.core.dataarray import DataArray

xarray/core/common.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import datetime
 import warnings
 from collections.abc import Callable, Hashable, Iterable, Iterator, Mapping
 from contextlib import suppress
@@ -34,6 +33,8 @@
 
 
 if TYPE_CHECKING:
+    import datetime
+
     from numpy.typing import DTypeLike
 
     from xarray.core.dataarray import DataArray

xarray/core/computation.py

@@ -9,15 +9,6 @@
 import operator
 import warnings
 from collections import Counter
-from collections.abc import (
-    Callable,
-    Hashable,
-    Iterable,
-    Iterator,
-    Mapping,
-    Sequence,
-    Set,
-)
 from typing import TYPE_CHECKING, Any, Literal, TypeVar, Union, cast, overload
 
 import numpy as np
@@ -38,6 +29,16 @@
 from xarray.util.deprecation_helpers import deprecate_dims
 
 if TYPE_CHECKING:
+    from collections.abc import (
+        Callable,
+        Hashable,
+        Iterable,
+        Iterator,
+        Mapping,
+        Sequence,
+        Set,
+    )
+
     from xarray.core.coordinates import Coordinates
     from xarray.core.dataarray import DataArray
     from xarray.core.dataset import Dataset

xarray/core/concat.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from collections.abc import Hashable, Iterable
 from typing import TYPE_CHECKING, Any, Union, overload
 
 import numpy as np
@@ -21,6 +20,8 @@
 from xarray.core.variable import concat as concat_vars
 
 if TYPE_CHECKING:
+    from collections.abc import Hashable, Iterable
+
     from xarray.core.types import (
         CombineAttrsOptions,
         CompatOptions,

xarray/core/dataarray.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import datetime
 import warnings
 from collections.abc import (
     Callable,
@@ -11,8 +10,6 @@
     Sequence,
 )
 from functools import partial
-from os import PathLike
-from types import EllipsisType
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -87,6 +84,10 @@
 from xarray.util.deprecation_helpers import _deprecate_positional_args, deprecate_dims
 
 if TYPE_CHECKING:
+    import datetime
+    from os import PathLike
+    from types import EllipsisType
+
     from dask.dataframe import DataFrame as DaskDataFrame
     from dask.delayed import Delayed
     from iris.cube import Cube as iris_Cube

xarray/core/dataset.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import copy
-import datetime
 import inspect
 import itertools
 import math
@@ -22,8 +21,6 @@
 from html import escape
 from numbers import Number
 from operator import methodcaller
-from os import PathLike
-from types import EllipsisType
 from typing import IO, TYPE_CHECKING, Any, Generic, Literal, cast, overload
 
 import numpy as np
@@ -132,6 +129,10 @@
 from xarray.util.deprecation_helpers import _deprecate_positional_args, deprecate_dims
 
 if TYPE_CHECKING:
+    import datetime
+    from os import PathLike
+    from types import EllipsisType
+
     from dask.dataframe import DataFrame as DaskDataFrame
     from dask.delayed import Delayed
     from numpy.typing import ArrayLike

xarray/core/datatree_io.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
-from collections.abc import Mapping, MutableMapping
-from os import PathLike
 from typing import TYPE_CHECKING, Any, Literal, get_args
 
 if TYPE_CHECKING:
+    from collections.abc import Mapping, MutableMapping
+    from os import PathLike
+
     from xarray.core.datatree import DataTree
     from xarray.core.types import NetcdfWriteModes, ZarrWriteModes