FIX: Use traits to provide type hints when modifying paths #2949
Conversation
This file contains hidden or 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
satra
reviewed
Jun 27, 2019
| @@ -455,7 +466,7 @@ def format_node(node, format='python', include_config=False): | |||
| return lines | |||
|
|
|||
|
|
|||
| def modify_paths(object, relative=True, basedir=None): | |||
| def modify_paths(object, relative=True, basedir=None, type_hints=None): | |||
There was a problem hiding this comment.
@effigies - you may want to take a peek at the recursive inputs hash function in core specs. since the hints tell whether to hash a path (nested or not) or not, i think that function may be relevant in this scenario.
|
Using traits is a much better solution than my proposed fix. My knowledge of the traits system isn't so great, so I don't have any comments on the implementation itself. |
1 task
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.
Summary
This may not be the best way to do things, but in all cases where we're calling
modify_paths, we have a traited spec that we can use to provide type hints, if we're careful about inspecting a fairly inconsistent API. Hopefully this falls back to the old behavior.Additionally, I created a function
resolve_pathwhich should provide a consistent convention for returning absolute or relative paths, given an absolute or relative path, with respect to a base directory. This allowed some of the logic ofmodify_pathsto be simplified, although that hardly makes up for the total muddle that is the type hints.Let me know what you think, @oesteban, @satra, @stilley2. If this seems like the way to go, I can finish it up.
TODO:
modify_pathsFixes #2944.
Acknowledgment