Type keep_attrs as bool = True

Author: dcherian

xarray/core/variable.py

@@ -1743,14 +1743,15 @@ def reduce(
             Array with summarized data and the indicated dimension(s)
             removed.
         """
-        if keep_attrs is None:
-            keep_attrs = _get_keep_attrs(default=False)
+        keep_attrs_ = (
+            _get_keep_attrs(default=False) if keep_attrs is None else keep_attrs
+        )
 
         result = super().reduce(
             func=func,
             dim=dim,
             axis=axis,
-            keep_attrs=keep_attrs,
+            keep_attrs=keep_attrs_,
             keepdims=keepdims,
             **kwargs,
         )

xarray/namedarray/_aggregations.py

@@ -19,7 +19,7 @@ def reduce(
         dim: Dims = None,
         *,
         axis: int | Sequence[int] | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         keepdims: bool = False,
         **kwargs: Any,
     ) -> Self:
@@ -29,7 +29,7 @@ def count(
         self,
         dim: Dims = None,
         *,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -40,7 +40,7 @@ def count(
         dim : str, Iterable of Hashable, "..." or None, default: None
             Name of dimension[s] along which to apply ``count``. For e.g. ``dim="x"``
             or ``dim=["x", "y"]``. If "..." or None, will reduce over all dimensions.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -90,7 +90,7 @@ def all(
         self,
         dim: Dims = None,
         *,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -101,7 +101,7 @@ def all(
         dim : str, Iterable of Hashable, "..." or None, default: None
             Name of dimension[s] along which to apply ``all``. For e.g. ``dim="x"``
             or ``dim=["x", "y"]``. If "..." or None, will reduce over all dimensions.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -151,7 +151,7 @@ def any(
         self,
         dim: Dims = None,
         *,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -162,7 +162,7 @@ def any(
         dim : str, Iterable of Hashable, "..." or None, default: None
             Name of dimension[s] along which to apply ``any``. For e.g. ``dim="x"``
             or ``dim=["x", "y"]``. If "..." or None, will reduce over all dimensions.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -213,7 +213,7 @@ def max(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -229,7 +229,7 @@ def max(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -287,7 +287,7 @@ def min(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -303,7 +303,7 @@ def min(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -361,7 +361,7 @@ def mean(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -377,7 +377,7 @@ def mean(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -440,7 +440,7 @@ def prod(
         *,
         skipna: bool | None = None,
         min_count: int | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -462,7 +462,7 @@ def prod(
             NA. Only used if skipna is set to True or defaults to True for the
             array's dtype. Changed in version 0.17.0: if specified on an integer
             array and skipna=True, the result will be a float array.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -532,7 +532,7 @@ def sum(
         *,
         skipna: bool | None = None,
         min_count: int | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -554,7 +554,7 @@ def sum(
             NA. Only used if skipna is set to True or defaults to True for the
             array's dtype. Changed in version 0.17.0: if specified on an integer
             array and skipna=True, the result will be a float array.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -624,7 +624,7 @@ def std(
         *,
         skipna: bool | None = None,
         ddof: int = 0,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -643,7 +643,7 @@ def std(
         ddof : int, default: 0
             “Delta Degrees of Freedom”: the divisor used in the calculation is ``N - ddof``,
             where ``N`` represents the number of elements.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -713,7 +713,7 @@ def var(
         *,
         skipna: bool | None = None,
         ddof: int = 0,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -732,7 +732,7 @@ def var(
         ddof : int, default: 0
             “Delta Degrees of Freedom”: the divisor used in the calculation is ``N - ddof``,
             where ``N`` represents the number of elements.
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -801,7 +801,7 @@ def median(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -817,7 +817,7 @@ def median(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -879,7 +879,7 @@ def cumsum(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -895,7 +895,7 @@ def cumsum(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.
@@ -957,7 +957,7 @@ def cumprod(
         dim: Dims = None,
         *,
         skipna: bool | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs: bool = True,
         **kwargs: Any,
     ) -> Self:
         """
@@ -973,7 +973,7 @@ def cumprod(
             skips missing values for float dtypes; other dtypes either do not
             have a sentinel missing value (int) or ``skipna=True`` has not been
             implemented (object, datetime64 or timedelta64).
-        keep_attrs : bool or None, optional
+        keep_attrs : bool, optional
             If True, ``attrs`` will be copied from the original
             object to the new one.  If False, the new object will be
             returned without attributes.

xarray/util/generate_aggregations.py

@@ -61,12 +61,13 @@ def reduce(
         dim: Dims = None,
         *,
         axis: int | Sequence[int] | None = None,
-        keep_attrs: bool | None = None,
+        keep_attrs{keep_attrs_type},
         keepdims: bool = False,
         **kwargs: Any,
     ) -> Self:
         raise NotImplementedError()"""
 
+
 GROUPBY_PREAMBLE = """
 
 class {obj}{cls}Aggregations:
@@ -120,7 +121,7 @@ def {method}(
         self,
         dim: Dims = None,
         *,{extra_kwargs}
-        keep_attrs: bool | None = None,
+        keep_attrs{keep_attrs_type},
         **kwargs: Any,
     ) -> Self:
         """
@@ -188,7 +189,7 @@ def {method}(
     “Delta Degrees of Freedom”: the divisor used in the calculation is ``N - ddof``,
     where ``N`` represents the number of elements."""
 
-_KEEP_ATTRS_DOCSTRING = """keep_attrs : bool or None, optional
+_KEEP_ATTRS_DOCSTRING = """keep_attrs : {keep_attrs_type}, optional
     If True, ``attrs`` will be copied from the original
     object to the new one.  If False, the new object will be
     returned without attributes."""
@@ -240,13 +241,16 @@ def {method}(
         >>> {calculation}(skipna=True, ddof=1)""",
 )
 
+from dataclasses import field
+
 
 @dataclass
 class DataStructure:
     name: str
     create_example: str
     example_var_name: str
     numeric_only: bool = False
+    keep_attrs_type: str = field(default=": bool | None = None")
     see_also_modules: tuple[str] = tuple
 
 
@@ -295,7 +299,11 @@ def __init__(
         self.docref = docref
         self.docref_description = docref_description
         self.example_call_preamble = example_call_preamble
-        self.preamble = definition_preamble.format(obj=datastructure.name, cls=cls)
+        self.preamble = definition_preamble.format(
+            obj=datastructure.name,
+            cls=cls,
+            keep_attrs_type=datastructure.keep_attrs_type,
+        )
         self.notes = "" if notes is None else notes
 
     def generate_methods(self):
@@ -304,7 +312,11 @@ def generate_methods(self):
             yield self.generate_method(method)
 
     def generate_method(self, method):
-        template_kwargs = dict(obj=self.datastructure.name, method=method.name)
+        template_kwargs = dict(
+            obj=self.datastructure.name,
+            method=method.name,
+            keep_attrs_type=self.datastructure.keep_attrs_type,
+        )
 
         if method.extra_kwargs:
             extra_kwargs = "\n        " + "\n        ".join(
@@ -321,7 +333,11 @@ def generate_method(self, method):
         for text in [
             self._dim_docstring.format(method=method.name, cls=self.cls),
             *(kwarg.docs for kwarg in method.extra_kwargs if kwarg.docs),
-            _KEEP_ATTRS_DOCSTRING,
+            _KEEP_ATTRS_DOCSTRING.format(
+                keep_attrs_type="bool or None"
+                if "None" in self.datastructure.keep_attrs_type
+                else "bool"
+            ),
             _KWARGS_DOCSTRING.format(method=method.name),
         ]:
             if text:
@@ -574,6 +590,7 @@ def generate_code(self, method):
         ... )""",
     example_var_name="na",
     numeric_only=False,  # TODO
+    keep_attrs_type=": bool = True",
     see_also_modules=("Dataset", "DataArray"),
 )