Fix crash when building inside a submodule #854
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
ausbin
commented
Aug 6, 2024
| @@ -13,7 +13,7 @@ | |||
| __all__ = ["each_unignored_file"] | |||
|
|
|||
| EXCLUDE_LINES = [ | |||
| ".git/", | |||
| ".git", | |||
There was a problem hiding this comment.
This is so the .git file itself does not show up in the list
|
I think the error here actually depends on the operating system. python/cpython#119993 PermissionsError is another one. |
If .git is a file instead of a directory (such as when you are building in a submodule), scikit-build-core will currently crash. This commit accounts for the resulting exception (NotADirectoryError) instead of crashing.
henryiii
force-pushed
the
bugfix/submodule-build
branch
from
faf8df4
to
858e5aa
Compare
henryiii
approved these changes
Aug 6, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #854 +/- ##
=======================================
Coverage 83.87% 83.88%
=======================================
Files 74 74
Lines 4361 4362 +1
=======================================
+ Hits 3658 3659 +1
Misses 703 703 ☔ View full report in Codecov by Sentry. |
|
Thanks for a great and fast PR that included a test! I’ll release once I get #853 working on PyPy. |
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.
If .git is a file instead of a directory (such as when you are building in a submodule), scikit-build-core will currently crash because a NotADirectoryError is thrown instead of a FileNotFoundError. This PR accounts for the resulting exception (NotADirectoryError) instead of crashing.
Another option instead of hardcoding this list would be to catch the more general
OSError. However, I did not do that, because I am worried about silently swallowing too broad of a class of exceptions.I wrote a unit test and also tested the fix against the project where I encountered this.
(By the way, this project is very helpful, thank you. The fact that I encountered this issue only a couple of hours after the release of 0.10.0 tells you how often I use it!)