Make error handling part of the public interface #25
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
eivindjahren
force-pushed
the
document_error_handling
branch
from
92e1377
to
8b8bc2d
Compare
hnformentin
reviewed
Jul 26, 2022
| @@ -38,6 +38,17 @@ def lazy_read(filelike, fileformat=None): | |||
| :param fileformat: Either ecl_data_io.Format.FORMATTED for ascii | |||
| format, ecl_data_io.Format.UNFORMATTED for binary formatted files | |||
| or None for guess. | |||
|
|
|||
| :raises ecl_data_io.EclParsingError: If the file is not a valid | |||
| ecl file. | |||
There was a problem hiding this comment.
Is ecl always referring to Eclipse? If so, why don't we write the full name?
There was a problem hiding this comment.
ecl is the name of the group that made eclipse. Its a convention now, perhaps something to change, but that is perhaps a bigger issue than this PR as ecl is in the name of the package.
| built-in `open()` function may be raised. | ||
|
|
||
| When given a stream, the exceptions associated with the stream will | ||
| pass through. |
There was a problem hiding this comment.
Would it be possible to have a test for error handling? It would be easier to visualise what you mean by the condition file opposed to stream.
There was a problem hiding this comment.
I have added some doctests for this
| built-in `open()` function may be raised. | ||
|
|
||
| When given a stream, the exceptions associated with the stream will | ||
| pass through. |
There was a problem hiding this comment.
Also added doctest for this.
Introduces doctest to the rst files (which found some errors). Makes error handling more consistent for write operations. There is a breaking change where the custom error are now a subtype of value-error which could break some existing error handling.
eivindjahren
force-pushed
the
document_error_handling
branch
from
756a34d
to
ee6950a
Compare
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.
No description provided.