format_detection: add a dedicated function to report unsupported detection #665
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
…ction
Currently, instances where detection for a format is unsupported are
reported via `context.fail`. However, `context.fail` is intended primarily
for situations where the dataset fails some requirement, and using it for
this leads to unnatural-looking messages:
The following requirement was not met:
this format cannot be autodetected
Fix this by adding a dedicated rejection reason for this case and a new
method, `context.raise_unsupported` to abort detection for this reason.
Comment on lines
+208
to
+209
| def detect(context): | ||
| context.raise_unsupported() |
There was a problem hiding this comment.
It looks like it should be the default implementation (in Importer or Environment), shouldn't it?
There was a problem hiding this comment.
I considered this, but I think the current default implementation (falling back to find_sources) is more useful.
There was a problem hiding this comment.
When it's supposed to be called then?
There was a problem hiding this comment.
I have added calls to it in this PR.
There was a problem hiding this comment.
Ok, I expect it to be redesigned quite soon though.
zhiltsov-max
approved these changes
Feb 15, 2022
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
Currently, instances where detection for a format is unsupported are reported via
context.fail. However,context.failis intended primarily for situations where the dataset fails some requirement, and using it for this leads to unnatural-looking messages:Fix this by adding a dedicated rejection reason for this case and a new method,
context.raise_unsupportedto abort detection for this reason.How to test
Checklist
developbranchLicense
Feel free to contact the maintainers if that's a concern.