Merge branch 'main' into namedarray_no_imag

doc/api-hidden.rst

@@ -265,7 +265,7 @@
    Variable.dims
    Variable.dtype
    Variable.encoding
-   Variable.reset_encoding
+   Variable.drop_encoding
    Variable.imag
    Variable.nbytes
    Variable.ndim

doc/api.rst

@@ -110,9 +110,9 @@ Dataset contents
    Dataset.drop_indexes
    Dataset.drop_duplicates
    Dataset.drop_dims
+   Dataset.drop_encoding
    Dataset.set_coords
    Dataset.reset_coords
-   Dataset.reset_encoding
    Dataset.convert_calendar
    Dataset.interp_calendar
    Dataset.get_index
@@ -303,8 +303,8 @@ DataArray contents
    DataArray.drop_vars
    DataArray.drop_indexes
    DataArray.drop_duplicates
+   DataArray.drop_encoding
    DataArray.reset_coords
-   DataArray.reset_encoding
    DataArray.copy
    DataArray.convert_calendar
    DataArray.interp_calendar

doc/user-guide/io.rst

@@ -260,12 +260,12 @@ Note that all operations that manipulate variables other than indexing
 will remove encoding information.
 
 In some cases it is useful to intentionally reset a dataset's original encoding values.
-This can be done with either the :py:meth:`Dataset.reset_encoding` or
-:py:meth:`DataArray.reset_encoding` methods.
+This can be done with either the :py:meth:`Dataset.drop_encoding` or
+:py:meth:`DataArray.drop_encoding` methods.
 
 .. ipython:: python
 
-    ds_no_encoding = ds_disk.reset_encoding()
+    ds_no_encoding = ds_disk.drop_encoding()
     ds_no_encoding.encoding
 
 .. _combining multiple files:

doc/whats-new.rst

@@ -45,7 +45,12 @@ Breaking changes
 
 Deprecations
 ~~~~~~~~~~~~
-
+- Rename :py:meth:`Dataset.reset_encoding` & :py:meth:`DataArray.reset_encoding`
+  to :py:meth:`Dataset.drop_encoding` & :py:meth:`DataArray.drop_encoding` for
+  consistency with other ``drop`` & ``reset`` methods — ``drop`` generally
+  removes something, while ``reset`` generally resets to some default or
+  standard value. (:pull:`8287`, :issue:`8259`)
+  By `Maximilian Roos <https://github.com/max-sixty>`_.
 
 Bug fixes
 ~~~~~~~~~

pyproject.toml

@@ -78,6 +78,7 @@ files = "xarray"
 show_error_codes = true
 show_error_context = true
 warn_redundant_casts = true
+warn_unused_configs = true
 warn_unused_ignores = true
 
 # Much of the numerical computing stack doesn't have type annotations yet.
@@ -168,26 +169,24 @@ module = [
 # ref: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
 [[tool.mypy.overrides]]
 # Start off with these
-warn_unused_configs = true
-warn_redundant_casts = true
 warn_unused_ignores = true
 
 # Getting these passing should be easy
-strict_equality = true
 strict_concatenate = true
+strict_equality = true
 
 # Strongly recommend enabling this one as soon as you can
 check_untyped_defs = true
 
 # These shouldn't be too much additional work, but may be tricky to
 # get passing if you use a lot of untyped libraries
+disallow_any_generics = true
 disallow_subclassing_any = true
 disallow_untyped_decorators = true
-disallow_any_generics = true
 
 # These next few are various gradations of forcing use of type annotations
-disallow_untyped_calls = true
 disallow_incomplete_defs = true
+disallow_untyped_calls = true
 disallow_untyped_defs = true
 
 # This one isn't too hard to get passing, but return on investment is lower
@@ -201,12 +200,12 @@ module = ["xarray.namedarray.*", "xarray.tests.test_namedarray"]
 [tool.pyright]
 # include = ["src"]
 # exclude = ["**/node_modules",
-    # "**/__pycache__",
-    # "src/experimental",
-    # "src/typestubs"
+# "**/__pycache__",
+# "src/experimental",
+# "src/typestubs"
 # ]
 # ignore = ["src/oldstuff"]
-defineConstant = { DEBUG = true }
+defineConstant = {DEBUG = true}
 # stubPath = "src/stubs"
 # venv = "env367"
 
@@ -217,10 +216,10 @@ reportMissingTypeStubs = false
 # pythonPlatform = "Linux"
 
 # executionEnvironments = [
-  # { root = "src/web", pythonVersion = "3.5", pythonPlatform = "Windows", extraPaths = [ "src/service_libs" ] },
-  # { root = "src/sdk", pythonVersion = "3.0", extraPaths = [ "src/backend" ] },
-  # { root = "src/tests", extraPaths = ["src/tests/e2e", "src/sdk" ]},
-  # { root = "src" }
+# { root = "src/web", pythonVersion = "3.5", pythonPlatform = "Windows", extraPaths = [ "src/service_libs" ] },
+# { root = "src/sdk", pythonVersion = "3.0", extraPaths = [ "src/backend" ] },
+# { root = "src/tests", extraPaths = ["src/tests/e2e", "src/sdk" ]},
+# { root = "src" }
 # ]
 
 [tool.ruff]
@@ -252,16 +251,16 @@ known-first-party = ["xarray"]
 
 [tool.pytest.ini_options]
 addopts = ["--strict-config", "--strict-markers"]
-log_cli_level = "INFO"
-minversion = "7"
 filterwarnings = [
   "ignore:Using a non-tuple sequence for multidimensional indexing is deprecated:FutureWarning",
 ]
+log_cli_level = "INFO"
 markers = [
   "flaky: flaky tests",
   "network: tests requiring a network connection",
   "slow: slow tests",
 ]
+minversion = "7"
 python_files = "test_*.py"
 testpaths = ["xarray/tests", "properties"]
 

xarray/core/_typed_ops.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 import operator
-from typing import TYPE_CHECKING, Any, Callable, NoReturn, overload
+from typing import TYPE_CHECKING, Any, Callable, overload
 
 from xarray.core import nputils, ops
 from xarray.core.types import (
@@ -446,201 +446,201 @@ def _binary_op(
         raise NotImplementedError
 
     @overload
-    def __add__(self, other: T_DataArray) -> NoReturn:
+    def __add__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __add__(self, other: VarCompatible) -> Self:
         ...
 
-    def __add__(self, other: VarCompatible) -> Self:
+    def __add__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.add)
 
     @overload
-    def __sub__(self, other: T_DataArray) -> NoReturn:
+    def __sub__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __sub__(self, other: VarCompatible) -> Self:
         ...
 
-    def __sub__(self, other: VarCompatible) -> Self:
+    def __sub__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.sub)
 
     @overload
-    def __mul__(self, other: T_DataArray) -> NoReturn:
+    def __mul__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __mul__(self, other: VarCompatible) -> Self:
         ...
 
-    def __mul__(self, other: VarCompatible) -> Self:
+    def __mul__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.mul)
 
     @overload
-    def __pow__(self, other: T_DataArray) -> NoReturn:
+    def __pow__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __pow__(self, other: VarCompatible) -> Self:
         ...
 
-    def __pow__(self, other: VarCompatible) -> Self:
+    def __pow__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.pow)
 
     @overload
-    def __truediv__(self, other: T_DataArray) -> NoReturn:
+    def __truediv__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __truediv__(self, other: VarCompatible) -> Self:
         ...
 
-    def __truediv__(self, other: VarCompatible) -> Self:
+    def __truediv__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.truediv)
 
     @overload
-    def __floordiv__(self, other: T_DataArray) -> NoReturn:
+    def __floordiv__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __floordiv__(self, other: VarCompatible) -> Self:
         ...
 
-    def __floordiv__(self, other: VarCompatible) -> Self:
+    def __floordiv__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.floordiv)
 
     @overload
-    def __mod__(self, other: T_DataArray) -> NoReturn:
+    def __mod__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __mod__(self, other: VarCompatible) -> Self:
         ...
 
-    def __mod__(self, other: VarCompatible) -> Self:
+    def __mod__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.mod)
 
     @overload
-    def __and__(self, other: T_DataArray) -> NoReturn:
+    def __and__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __and__(self, other: VarCompatible) -> Self:
         ...
 
-    def __and__(self, other: VarCompatible) -> Self:
+    def __and__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.and_)
 
     @overload
-    def __xor__(self, other: T_DataArray) -> NoReturn:
+    def __xor__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __xor__(self, other: VarCompatible) -> Self:
         ...
 
-    def __xor__(self, other: VarCompatible) -> Self:
+    def __xor__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.xor)
 
     @overload
-    def __or__(self, other: T_DataArray) -> NoReturn:
+    def __or__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __or__(self, other: VarCompatible) -> Self:
         ...
 
-    def __or__(self, other: VarCompatible) -> Self:
+    def __or__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.or_)
 
     @overload
-    def __lshift__(self, other: T_DataArray) -> NoReturn:
+    def __lshift__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __lshift__(self, other: VarCompatible) -> Self:
         ...
 
-    def __lshift__(self, other: VarCompatible) -> Self:
+    def __lshift__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.lshift)
 
     @overload
-    def __rshift__(self, other: T_DataArray) -> NoReturn:
+    def __rshift__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __rshift__(self, other: VarCompatible) -> Self:
         ...
 
-    def __rshift__(self, other: VarCompatible) -> Self:
+    def __rshift__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.rshift)
 
     @overload
-    def __lt__(self, other: T_DataArray) -> NoReturn:
+    def __lt__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __lt__(self, other: VarCompatible) -> Self:
         ...
 
-    def __lt__(self, other: VarCompatible) -> Self:
+    def __lt__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.lt)
 
     @overload
-    def __le__(self, other: T_DataArray) -> NoReturn:
+    def __le__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __le__(self, other: VarCompatible) -> Self:
         ...
 
-    def __le__(self, other: VarCompatible) -> Self:
+    def __le__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.le)
 
     @overload
-    def __gt__(self, other: T_DataArray) -> NoReturn:
+    def __gt__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __gt__(self, other: VarCompatible) -> Self:
         ...
 
-    def __gt__(self, other: VarCompatible) -> Self:
+    def __gt__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.gt)
 
     @overload
-    def __ge__(self, other: T_DataArray) -> NoReturn:
+    def __ge__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __ge__(self, other: VarCompatible) -> Self:
         ...
 
-    def __ge__(self, other: VarCompatible) -> Self:
+    def __ge__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, operator.ge)
 
     @overload  # type:ignore[override]
-    def __eq__(self, other: T_DataArray) -> NoReturn:
+    def __eq__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __eq__(self, other: VarCompatible) -> Self:
         ...
 
-    def __eq__(self, other: VarCompatible) -> Self:
+    def __eq__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, nputils.array_eq)
 
     @overload  # type:ignore[override]
-    def __ne__(self, other: T_DataArray) -> NoReturn:
+    def __ne__(self, other: T_DataArray) -> T_DataArray:
         ...
 
     @overload
     def __ne__(self, other: VarCompatible) -> Self:
         ...
 
-    def __ne__(self, other: VarCompatible) -> Self:
+    def __ne__(self, other: VarCompatible) -> Self | T_DataArray:
         return self._binary_op(other, nputils.array_ne)
 
     def __radd__(self, other: VarCompatible) -> Self: