Resolve path arguments when specified on command line #575
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
This change enhances the behavior of command line arguments which specify a path which might be relative to the current directory. The new functionality captures the current working directory when the parser is constructed, and captures a given relative path on the command line by resolving it from that captured working directory. If an argument is left to the default value, it is not resolved by this new functionality and is left for resolution in the consuming code later. The main use case for this capture-then-resolve behavior is to support changing the working directory of the colcon process. If that happens, the context of where a user intended a relative path to be based is lost, so this change captures the directory early in the colcon startup sequence.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #575 +/- ##
==========================================
- Coverage 81.88% 81.79% -0.09%
==========================================
Files 62 63 +1
Lines 3648 3663 +15
Branches 705 706 +1
==========================================
+ Hits 2987 2996 +9
- Misses 609 615 +6
Partials 52 52
☔ View full report in Codecov by Sentry. |
nuclearsandwich
approved these changes
Aug 17, 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.
This change enhances the behavior of command line arguments which specify a path which might be relative to the current directory.
The new functionality captures the current working directory when the parser is constructed, and captures a given relative path on the command line by resolving it from that captured working directory. If an argument is left to the default value, it is not resolved by this new functionality and is left for resolution in the consuming code later.
The main use case for this capture-then-resolve behavior is to support changing the working directory of the colcon process. If that happens, the context of where a user intended a relative path to be based is lost, so this change captures the directory early in the colcon startup sequence.
An alternative approach to changing resolving the path only when specified on the command line could involve creating a custom argparse action implementation. A disadvantage would be a tighter coupling to the argparse API.