From 395d5b91b16f09d38f2541576a421182eeffa1b1 Mon Sep 17 00:00:00 2001 From: Juan Sanchez Date: Tue, 14 May 2024 11:37:03 +0200 Subject: [PATCH 1/3] add deprecate warning to path functions in conanfile --- conans/model/conan_file.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/conans/model/conan_file.py b/conans/model/conan_file.py index 03118d2365a..2280ff2bc18 100644 --- a/conans/model/conan_file.py +++ b/conans/model/conan_file.py @@ -1,3 +1,4 @@ +import inspect import os from pathlib import Path @@ -236,8 +237,15 @@ def source_folder(self): """ return self.folders.source_folder + def _deprecate_path_warning(self): + function_name = inspect.stack()[1].function + new_function_name = function_name.replace("_path", "_folder") + ConanOutput().warning(f"{self.display_name}: Use of '{function_name}' is deprecated, " + f"please use '{new_function_name}' instead", warn_tag="deprecated") + @property def source_path(self) -> Path: + self._deprecate_path_warning() assert self.source_folder is not None, "`source_folder` is `None`" return Path(self.source_folder) @@ -258,6 +266,7 @@ def export_sources_folder(self): @property def export_sources_path(self) -> Path: + self._deprecate_path_warning() assert self.export_sources_folder is not None, "`export_sources_folder` is `None`" return Path(self.export_sources_folder) @@ -267,6 +276,7 @@ def export_folder(self): @property def export_path(self) -> Path: + self._deprecate_path_warning() assert self.export_folder is not None, "`export_folder` is `None`" return Path(self.export_folder) @@ -291,6 +301,7 @@ def package_metadata_folder(self): @property def build_path(self) -> Path: + self._deprecate_path_warning() assert self.build_folder is not None, "`build_folder` is `None`" return Path(self.build_folder) @@ -310,11 +321,13 @@ def generators_folder(self): @property def package_path(self) -> Path: + self._deprecate_path_warning() assert self.package_folder is not None, "`package_folder` is `None`" return Path(self.package_folder) @property def generators_path(self) -> Path: + self._deprecate_path_warning() assert self.generators_folder is not None, "`generators_folder` is `None`" return Path(self.generators_folder) From b24062ba28e8837757ae6943941487b5f6fe1490 Mon Sep 17 00:00:00 2001 From: Juan Sanchez Date: Tue, 14 May 2024 12:17:31 +0200 Subject: [PATCH 2/3] remove function --- conans/model/conan_file.py | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/conans/model/conan_file.py b/conans/model/conan_file.py index 2280ff2bc18..31356625d91 100644 --- a/conans/model/conan_file.py +++ b/conans/model/conan_file.py @@ -237,15 +237,10 @@ def source_folder(self): """ return self.folders.source_folder - def _deprecate_path_warning(self): - function_name = inspect.stack()[1].function - new_function_name = function_name.replace("_path", "_folder") - ConanOutput().warning(f"{self.display_name}: Use of '{function_name}' is deprecated, " - f"please use '{new_function_name}' instead", warn_tag="deprecated") - @property def source_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'source_path' is deprecated, please use 'source_folder' instead", + warn_tag="deprecated") assert self.source_folder is not None, "`source_folder` is `None`" return Path(self.source_folder) @@ -266,7 +261,8 @@ def export_sources_folder(self): @property def export_sources_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'export_sources_path' is deprecated, please use " + f"'export_sources_folder' instead", warn_tag="deprecated") assert self.export_sources_folder is not None, "`export_sources_folder` is `None`" return Path(self.export_sources_folder) @@ -276,7 +272,9 @@ def export_folder(self): @property def export_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'export_path' is deprecated, please use 'export_folder' instead", + warn_tag="deprecated") + assert self.export_folder is not None, "`export_folder` is `None`" return Path(self.export_folder) @@ -301,7 +299,8 @@ def package_metadata_folder(self): @property def build_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'build_path' is deprecated, please use 'build_folder' instead", + warn_tag="deprecated") assert self.build_folder is not None, "`build_folder` is `None`" return Path(self.build_folder) @@ -321,13 +320,16 @@ def generators_folder(self): @property def package_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'package_path' is deprecated, please use 'package_folder' instead", + warn_tag="deprecated") + assert self.package_folder is not None, "`package_folder` is `None`" return Path(self.package_folder) @property def generators_path(self) -> Path: - self._deprecate_path_warning() + self.output.warning(f"Use of 'generators_path' is deprecated, please use " + f"'generators_folder' instead", warn_tag="deprecated") assert self.generators_folder is not None, "`generators_folder` is `None`" return Path(self.generators_folder) From 61f977bb614f72b46e1058c55eeb974f12606844 Mon Sep 17 00:00:00 2001 From: Juan Sanchez Date: Tue, 14 May 2024 12:19:20 +0200 Subject: [PATCH 3/3] remove import --- conans/model/conan_file.py | 1 - 1 file changed, 1 deletion(-) diff --git a/conans/model/conan_file.py b/conans/model/conan_file.py index 31356625d91..96e819ff128 100644 --- a/conans/model/conan_file.py +++ b/conans/model/conan_file.py @@ -1,4 +1,3 @@ -import inspect import os from pathlib import Path