Use functools.cached_property instead of the local copy

Author: arichardson

pycheribuild/config/chericonfig.py

@@ -36,6 +36,7 @@
 import shutil
 import typing
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
 from typing import Optional
 
@@ -45,7 +46,6 @@
 from ..utils import (
     ConfigBase,
     DoNotUseInIfStmt,
-    cached_property,
     fatal_error,
     have_working_internet_connection,
     status_update,

pycheribuild/config/compilation_targets.py

@@ -36,6 +36,7 @@
 import sys
 import typing
 from abc import ABC, abstractmethod
+from functools import cached_property
 from pathlib import Path
 from typing import Optional
 
@@ -56,7 +57,7 @@
 )
 from ..processutils import extract_version, get_compiler_info, get_version_output
 from ..projects.simple_project import SimpleProject
-from ..utils import cached_property, is_jenkins_build, warning_message
+from ..utils import is_jenkins_build, warning_message
 
 
 class BuildLLVMInterface(SimpleProject if typing.TYPE_CHECKING else object):

pycheribuild/config/target_info.py

@@ -33,13 +33,14 @@
 import typing
 from abc import ABC, abstractmethod
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
 from typing import ClassVar, Optional
 
 from .chericonfig import AArch64FloatSimdOptions, CheriConfig, MipsFloatAbi
 from ..filesystemutils import FileSystemUtils
 from ..processutils import CompilerInfo, get_compiler_info
-from ..utils import OSInfo, cached_property, fatal_error, final, status_update, warning_message
+from ..utils import OSInfo, fatal_error, final, status_update, warning_message
 
 __all__ = [
     "AArch64FloatSimdOptions",

pycheribuild/projects/cross/cheribsd.py

@@ -37,6 +37,7 @@
 import typing
 from collections import OrderedDict
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
 from typing import ClassVar, Optional, Union
 
@@ -59,7 +60,7 @@
 from ...config.loader import ConfigOptionHandle
 from ...config.target_info import AutoVarInit, CompilerType, CrossCompileTarget
 from ...processutils import latest_system_clang_tool, print_command
-from ...utils import OSInfo, ThreadJoiner, cached_property, classproperty, is_jenkins_build
+from ...utils import OSInfo, ThreadJoiner, classproperty, is_jenkins_build
 
 
 def _arch_suffixed_custom_install_dir(prefix: str) -> "ComputedDefaultValue[Path]":

pycheribuild/projects/cross/llvm_test_suite.py

@@ -28,6 +28,7 @@
 # SUCH DAMAGE.
 #
 import shutil
+from functools import cached_property
 from pathlib import Path
 
 from .benchmark_mixin import BenchmarkMixin
@@ -42,7 +43,7 @@
 from ..project import ReuseOtherProjectRepository
 from ..simple_project import BoolConfigOption
 from ...config.compilation_targets import FreeBSDTargetInfo
-from ...utils import cached_property, classproperty, is_jenkins_build
+from ...utils import classproperty, is_jenkins_build
 
 
 class BuildLLVMTestSuiteBase(BenchmarkMixin, CrossCompileCMakeProject):

pycheribuild/projects/disk_image.py

@@ -34,6 +34,7 @@
 import sys
 import tempfile
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
 from typing import Optional
 
@@ -53,7 +54,7 @@
 from .simple_project import SimpleProject
 from ..config.compilation_targets import CompilationTargets
 from ..mtree import MtreeFile
-from ..utils import AnsiColour, cached_property, classproperty, coloured, include_local_file
+from ..utils import AnsiColour, classproperty, coloured, include_local_file
 
 # Notes:
 # Mount the filesystem of a BSD VM: guestmount -a /foo/bar.qcow2 -m /dev/sda1:/:ufstype=ufs2:ufs --ro /mnt/foo

pycheribuild/projects/project.py

@@ -40,6 +40,7 @@
 import typing
 from collections import OrderedDict
 from enum import Enum
+from functools import cached_property
 from pathlib import Path
 from typing import Callable, Optional, Sequence, Union
 
@@ -77,7 +78,6 @@
     InstallInstructions,
     OSInfo,
     ThreadJoiner,
-    cached_property,
     classproperty,
     coloured,
     remove_duplicates,

pycheribuild/projects/run_fvp.py

@@ -32,6 +32,7 @@
 import subprocess
 import tempfile
 import typing
+from functools import cached_property
 from pathlib import Path
 from subprocess import CompletedProcess
 from typing import Optional
@@ -47,7 +48,6 @@
     AnsiColour,
     OSInfo,
     SocketAndPort,
-    cached_property,
     classproperty,
     coloured,
     find_free_port,

pycheribuild/projects/testrig.py

@@ -27,6 +27,7 @@
 import time
 import typing
 from abc import ABC, abstractmethod
+from functools import cached_property
 from pathlib import Path
 from typing import Optional
 
@@ -36,7 +37,7 @@
 from .sail import BuildSailCheriRISCV
 from .simple_project import BoolConfigOption, IntConfigOption, OptionalIntConfigOption, SimpleProject
 from ..processutils import FakePopen, commandline_to_str, popen
-from ..utils import cached_property, find_free_port
+from ..utils import find_free_port
 
 
 # This repository contains various implementations and QuickCheckVEngine

pycheribuild/utils.py

@@ -39,7 +39,6 @@
 import traceback
 import typing
 from pathlib import Path
-from threading import RLock
 from typing import Callable, Optional, Union
 
 from .colour import AnsiColour, coloured
@@ -56,7 +55,6 @@
     "ThreadJoiner",
     "Type_T",
     "add_error_context",
-    "cached_property",
     "classproperty",
     "coloured",
     "default_make_jobs_count",
@@ -144,60 +142,6 @@ def get_global_config() -> ConfigBase:
     return GlobalConfig
 
 
-if False and sys.version_info >= (3, 8, 0):
-    # TODO: once we depend on 3.8 use functools version instead
-    # from functools import cached_property
-    pass
-else:
-    # Note: this is a copy of the python 3.8.6 implementation with f-strings removed for python 3.5.2 compat.
-    _NOT_FOUND: object = object()
-
-    # noinspection PyPep8Naming
-    class cached_property(typing.Generic[Type_T]):  # noqa: N801
-        def __init__(self, func: "Callable[[typing.Any], Type_T]") -> None:
-            self.func = func
-            self.attrname = func.__name__ if sys.version_info < (3, 6) else None
-            self.__doc__ = func.__doc__
-            self.lock = RLock()
-
-        def __set_name__(self, _, name) -> None:  # XXX: requires python 3.6
-            if self.attrname is None:
-                self.attrname = name
-            elif name != self.attrname:
-                raise TypeError(
-                    f"Cannot assign the same cached_property to two different names ({self.attrname} and {name})."
-                )
-
-        def __get__(self, instance, owner=None) -> Type_T:
-            if instance is None:
-                return self
-            if self.attrname is None:
-                raise TypeError("Cannot use cached_property instance without calling __set_name__ on it.")
-            try:
-                cache = instance.__dict__
-            except AttributeError:  # not all objects have __dict__ (e.g. class defines slots)
-                msg = (
-                    f"No '__dict__' attribute on {type(instance).__name__} instance to cache {self.attrname} property."
-                )
-                raise TypeError(msg) from None
-            val = cache.get(self.attrname, _NOT_FOUND)
-            if val is _NOT_FOUND:
-                with self.lock:
-                    # check if another thread filled cache while we awaited lock
-                    val = cache.get(self.attrname, _NOT_FOUND)
-                    if val is _NOT_FOUND:
-                        val = self.func(instance)
-                        try:
-                            cache[self.attrname] = val
-                        except TypeError:
-                            msg = (
-                                f"The '__dict__' attribute on {type(instance).__name__} instance does not support "
-                                f"item assignment for caching {self.attrname} property."
-                            )
-                            raise TypeError(msg) from None
-            return val
-
-
 def is_jenkins_build() -> bool:
     return os.getenv("_CHERIBUILD_JENKINS_BUILD") is not None
 
@@ -600,12 +544,12 @@ def replace_one(s: str, old, new) -> str:
 
 
 def remove_duplicates(items: "typing.Iterable[Type_T]") -> "list[Type_T]":
-    # Convert to a dict to remove duplicates (retains order since python 3.6, which is our minimum)
+    # Convert to a dict to remove duplicates (retains order since python 3.6, which is older than our minimum)
     return list(dict.fromkeys(items))
 
 
 def remove_tuple_duplicates(items: "typing.Iterable[Type_T]") -> "tuple[Type_T, ...]":
-    # Convert to a dict to remove duplicates (retains order since python 3.6, which is our minimum)
+    # Convert to a dict to remove duplicates (retains order since python 3.6, which is older than our minimum)
     return tuple(dict.fromkeys(items))