[Build] CMake install Python dist-info #66
Merged
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
feltech
requested changes
Nov 17, 2023
foundrytom
suggested changes
Nov 17, 2023
Part of OpenAssetIO#58. Install a minimal dist-info alongside the Python sources. This means attempting to overwrite a CMake installation using `pip install` will error like: > ERROR: Cannot uninstall openassetio-mediacreation 1.0.0a7, > RECORD file not found. > Hint: The package was installed by cmake. * `INSTALLER` is used by `pip` to provide the competing packager name ("cmake" in the example hint above). * `METADATA` is mandatory according to the docs. It has the minimal contents required to be valid. * `REQUESTED` is an empty flag file to signal that the package was installed individually and not as a dependency of another. Just seemed cheap to provide, not really necessary. * `top_level.txt` contains the top-level namespace names provided by the package. Another one that seemed cheap to provide and is not really necessary. Optionally skip installing `.dist-info` metadata directory as part of installing Python files using a new `OPENASSETIO_MEDIACREATION_ENABLE_PYTHON_INSTALL_DIST_INFO` CMake option. Signed-off-by: Elliot Morris <elliot.morris@foundry.com>
foundrytom
approved these changes
Nov 21, 2023
elliotcmorris
force-pushed
the
work/1088-dist-info
branch
from
afe0d9a to
1a13d84
Compare
feltech
approved these changes
Nov 21, 2023
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.
Closes #58.
Install a minimal dist-info alongside the Python sources. This means attempting to overwrite a CMake installation using
pip installwill error like:This is as far as possible a direct duplication of OpenAssetIO/OpenAssetIO#1111
The cmake testing is more direct than in OpenAssetIO proper, due to the lack of the utility ecosystem, as well as the test file itself needing a minor change to account for
openassetio-mediacreationbeing two words and thus having a hyphon.Added some additional incidental comments around the cmake stuff, simply because I found the concepts confusing personally.