feat: Improve conversion error handling & add migration guide. #304
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
Refactor the conversion errors and make them available as Python objects. This allows handling the conversion error cases much more user friendly. Add an initial migration guide and example listing the demonstrates how to use the conversion function and handle the resulting errors. Some other minor error updates and improvements included.
jetuk
force-pushed
the
migration-guide
branch
from
6af55bc to
73d07af
Compare
Batch21
reviewed
Dec 14, 2024
pywr-book/src/migration_guide.md
Outdated
| The conversion function that takes a JSON string and returns a tuple of the converted JSON string and a list of errors. | ||
| The function then handles these errors using the `handle_conversion_error` function. | ||
| After the errors are handled other arbitrary changes are applied using the `patch_model` function. | ||
| Finally, the converted JSON can be saved to a new file and run using Pywr v2.x. |
There was a problem hiding this comment.
The block above might be clearer as a numbered list?
|
|
||
| Pywr v2.x includes a more strict schema for defining models. This schema, along with the | ||
| [pywr-v1-schema](https://crates.io/crates/pywr-v1-schema) crate, provide a way to convert models from v1.x to v2.x. | ||
| However, this process is not perfect and will more than likely require manual intervention to complete the migration. |
There was a problem hiding this comment.
Maybe emphasize that its an iterative process and may take some time to complete for complex models
pywr-book/src/migration_guide.md
Outdated
| ignoring them. | ||
| It is suggested to implement a function that can handle these errors in a way that is appropriate for your use case. | ||
| Begin by matching a few types of errors and then expand the matching as needed. By raising exceptions | ||
| for unhandled errors, you can ensure that all errors are eventually accounted, and that new errors are not missed. |
There was a problem hiding this comment.
should be '...accounted for, ' ?
Batch21
approved these changes
Dec 16, 2024
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.
Refactor the conversion errors and make them available as Python objects. This allows handling the conversion error cases much more user friendly.
Add an initial migration guide and example listing the demonstrates how to use the conversion function and handle the resulting errors.
Some other minor error updates and improvements included.