Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add warning to deprecate path functions in conanfile #16247

Merged
merged 3 commits into from
May 14, 2024
Merged

Add warning to deprecate path functions in conanfile #16247

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
395d5b9
add deprecate warning to path functions in conanfile
juansblanco May 14, 2024
b24062b
remove function
juansblanco May 14, 2024
61f977b
remove import
juansblanco May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions conans/model/conan_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,8 @@ def source_folder(self):

@property
def source_path(self) -> Path:
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)

Expand All @@ -258,6 +260,8 @@ def export_sources_folder(self):

@property
def export_sources_path(self) -> Path:
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)

Expand All @@ -267,6 +271,9 @@ def export_folder(self):

@property
def export_path(self) -> Path:
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)

Expand All @@ -291,6 +298,8 @@ def package_metadata_folder(self):

@property
def build_path(self) -> Path:
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)

Expand All @@ -310,11 +319,16 @@ def generators_folder(self):

@property
def package_path(self) -> Path:
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.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)

Expand Down