Warn about possible exceptions during file decoding - #1022
Merged
Conversation
Collaborator
|
Thanks! |
phadej
reviewed
Jul 7, 2026
| -- This function parses immediately, but defers conversion. See | ||
| -- 'json' for details. | ||
| -- | ||
| -- Throws an 'Exception' when the file is missing. |
Collaborator
There was a problem hiding this comment.
This is misleading. decodeFileStrict (and others) throw all the errors B.readFile may throw, not only missing file. More correctly it should say "Doesn't modify exceptions thrown by Data.ByteString.readFile used to read the file". FWIW, readFile doesn't document any exception behavior either.
*Data.Aeson> decodeFileStrict "foo" :: IO (Maybe Int)
*** Exception: foo: withBinaryFile: permission denied (Permission denied)
Collaborator
There was a problem hiding this comment.
It's a bit strong to call this "misleading", but feel free to make it more precise.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
In my project, I spent a couple of hours trying to determine the reason for an exception
withBinaryFile: does not exist (No such file or directory).After reading the current
aesondocs, I expected that the case when the file is missing is also reported as a String error.I see that currently, this is not true. I'm not sure these functions should handle missing files so I suggest to just warn about possible exceptions.