addurls: Provide better placeholder error for special keys #5664
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
_get_placeholder_exception() callers pass in the row to provide a collection of known keys, but an upcoming commit will care about having access to the entire row. Rename the parameter for clarity.
_get_placeholder_exception() builds up the exception message from
several parts, including a message prefix passed in by the caller. As
a reader, it's a bit confusing to keep those parts in your head and
construct the final message. Plus there's a confusing condition on
"sugmsg" even though it's never false.
Instead construct the entire message for each condition, with the
caller passing in what's being formatted ("URL" or "file name").
For each row, addurls() derives special keys from the URL. If a row is missing a special key (e.g., "_url_basename" because the URL has not path), addurls() emits a confusing error: Unknown placeholder '_url_basename' in file name: Did you mean any of these? _url_hostname For _that_ row, '_url_basename' couldn't be derived and is unknown, but that's unhelpful to say to the caller given that '_url_basename' is a documented placeholder. Instead check whether the key error is for a special key. If it is, say that the field couldn't be constructed, including the problematic row in the message. Closes datalad#4658.
Codecov Report
@@ Coverage Diff @@
## maint #5664 +/- ##
==========================================
- Coverage 90.31% 90.29% -0.02%
==========================================
Files 299 299
Lines 42312 42328 +16
==========================================
+ Hits 38214 38222 +8
- Misses 4098 4106 +8
Continue to review full report at Codecov.
|
yarikoptic
approved these changes
May 14, 2021
8 tasks
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.
As described in gh-4658,
addurlsgives a confusing error message if it can't derive fields like_url_basenamefrom the provided URL field. Check if a placeholder is a special key and give a more helpful message.