Improve the error message when trying to use a build-scripts package as a regular requirement
#15366
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e as a regular requirement It currently fails on an assert with no further context provided in the stack trace. There might be a better place to do this check, though. Also, might want to add a check for `PackageType.PYTHON` as well.
memsharded
reviewed
Dec 31, 2023
There was a problem hiding this comment.
Looks good, just a couple of quick things:
- Is there any scenario that this could break to users already leveraging this, even if it could be considered a bug? (I'd also like to check this with the team, labeling as look-into to discuss, it seems it makes sense, but just in case there could be some angle that I'd be missing)
- It would be good to cover this with a test, if you need help or guidance, please ask, we can even contribute the test ourselves
memsharded
reviewed
Jan 2, 2024
| @@ -289,6 +289,8 @@ def transform_downstream(self, pkg_type, require, dep_pkg_type): | |||
| downstream_require = Requirement(require.ref, headers=False, libs=False, run=require.run) | |||
| elif pkg_type is PackageType.HEADER: | |||
| downstream_require = Requirement(require.ref, headers=require.headers, libs=require.libs, run=require.run) | |||
| elif pkg_type is PackageType.BUILD_SCRIPTS: | |||
| raise ConanError("build-scripts package must be used as a tool_requires(), not a regular requirement") | |||
There was a problem hiding this comment.
This check is about a build-script depending on a library, not really about it being used as regular requires. This might be an extra check to do, but it seems we want to do a general check over build-scripts being used only as tool-requires
|
I just want to mention one case where we are currently using a |
memsharded
requested changes
Apr 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It currently fails on an assert with no further context provided in the stack trace. There might be a better place to do this check, though.
Also, might want to add a check for
PackageType.PYTHONas well.Changelog: Fix: Improve the error message when trying to use a
build-scriptspackage as a regular requirementDocs: Omit
developbranch, documenting this one.