Replace custom cached_property with stdlib

Since Python 3.8 there's functools.cached_property, which works
the same way, but also passes type information through.

Author: omad

datacube/drivers/postgis/_fields.py

@@ -10,6 +10,7 @@
 from collections.abc import Callable
 from datetime import date, datetime, timezone
 from decimal import Decimal
+from functools import cached_property
 from typing import Any, TypeAlias
 
 from sqlalchemy import and_, cast, func
@@ -25,7 +26,7 @@
 from datacube.drivers.postgis._schema import Dataset, search_field_index_map
 from datacube.model import Range
 from datacube.model.fields import Expression, Field
-from datacube.utils import cached_property, get_doc_offset
+from datacube.utils import get_doc_offset
 from datacube.utils.dates import tz_as_utc
 
 DatasetJoinArgs = tuple[FromClause] | tuple[FromClause, ColumnExpressionArgument]

datacube/index/abstract/_index.py

@@ -5,6 +5,7 @@
 import logging
 from abc import ABC, abstractmethod
 from collections.abc import Iterable, Mapping, Sequence
+from functools import cached_property
 from urllib.parse import ParseResult, urlparse
 
 from deprecat import deprecat
@@ -13,7 +14,7 @@
 from datacube.cfg import ODCEnvironment, ODCOptionHandler
 from datacube.migration import ODC2DeprecationWarning
 from datacube.model import Field, MetadataType
-from datacube.utils import cached_property, report_to_user
+from datacube.utils import report_to_user
 from datacube.utils.generic import thread_local_cache
 
 from ._datasets import AbstractDatasetResource

datacube/index/abstract/_types.py

@@ -3,14 +3,14 @@
 # Copyright (c) 2015-2025 ODC Contributors
 # SPDX-License-Identifier: Apache-2.0
 from collections.abc import Iterable, Sequence
+from functools import cached_property
 from typing import NamedTuple
 from uuid import UUID
 
 from deprecat import deprecat
 
 from datacube.migration import ODC2DeprecationWarning
 from datacube.model import Dataset, Product
-from datacube.utils import cached_property
 from datacube.utils.documents import JsonDict
 
 

datacube/model/__init__.py

@@ -12,6 +12,7 @@
 from collections import OrderedDict
 from collections.abc import Iterable, Iterator, Mapping, Sequence
 from datetime import datetime
+from functools import cached_property
 from pathlib import Path
 from typing import Any
 from urllib.parse import urlparse
@@ -22,7 +23,6 @@
 
 from datacube.utils import (
     DocReader,
-    cached_property,
     parse_time,
     schema_validated,
     uri_to_local_path,

datacube/utils/__init__.py

@@ -30,7 +30,7 @@
     unsqueeze_data_array,
     unsqueeze_dataset,
 )
-from .py import cached_property, ignore_exceptions_if, import_function
+from .py import ignore_exceptions_if, import_function
 from .serialise import jsonify_document
 from .uris import get_part_from_uri, is_url, is_vsipath, mk_part_uri, uri_to_local_path
 
@@ -41,7 +41,6 @@
     "NoDatesSafeLoader",
     "SimpleDocNav",
     "_readable_offset",
-    "cached_property",
     "check_write_path",
     "gen_password",
     "get_doc_offset",

datacube/utils/documents.py

@@ -282,10 +282,8 @@ class UnknownMetadataType(InvalidDocException):
     pass
 
 
-def get_doc_offset(offset: list[str | int], document: dict, default=None):
+def get_doc_offset(offset: list[str | int], document: dict[str, Any], default=None):
     """
-    :type offset: list[str]
-    :type document: dict
 
     """
     return toolz.get_in(offset, document, default=default)

datacube/utils/py.py

@@ -43,26 +43,6 @@ def ignore_exceptions_if(ignore_errors, errors: tuple[type[Exception]] | None =
         yield
 
 
-class cached_property:  # pylint: disable=invalid-name  # noqa: N801
-    """
-    A property that is only computed once per instance and then replaces
-    itself with an ordinary attribute. Deleting the attribute resets the
-    property.
-
-    Source: https://github.com/bottlepy/bottle/commit/fa7733e075da0d790d809aa3d2f53071897e6f76
-    """
-
-    def __init__(self, func) -> None:
-        self.__doc__ = func.__doc__
-        self.func = func
-
-    def __get__(self, obj, cls):
-        if obj is None:
-            return self
-        value = obj.__dict__[self.func.__name__] = self.func(obj)
-        return value
-
-
 def sorted_items(d, key=None, reverse: bool = False):
     """Given a dictionary `d` return items: (k1, v1), (k2, v2)... sorted in
     ascending order according to key.

docs/about/whats_new.rst

@@ -37,6 +37,7 @@ Next Version
 - Remove executable permission :pull:`1846`
 - Sort imports with Ruff :pull:`1858`
 - Fix documentation parameter names :pull:`1857`
+- Replace internal `@cached_property` with one from `functools` :pull:`1866`
 
 v1.9.3 (15th April 2025)
 ========================