Use strict marshmallow schemas, add custom exception #1695
Merged
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
Add `strict=True` (as a `Meta` attribute) to the validation schemas, avoiding the marshmallow deprecation warning.
Add custom Exception class to `qiskit.validation.exceptions`, for conforming to qiskit convention that only subclasses of `QiskitError` should be raised by the library.
diego-plan9
requested review from
1ucian0,
ajavadia,
atilag,
delapuente,
ewinston,
jaygambetta,
mtreinish,
nonhermitian and
taalexander
as code owners
jaygambetta
approved these changes
Jan 18, 2019
lia-approves
pushed a commit
to edasgupta/qiskit-terra
that referenced
this pull request
Jul 30, 2019
* Use strict schemas for validation Add `strict=True` (as a `Meta` attribute) to the validation schemas, avoiding the marshmallow deprecation warning. * Add custom Exception to qiskit.validation Add custom Exception class to `qiskit.validation.exceptions`, for conforming to qiskit convention that only subclasses of `QiskitError` should be raised by the library. * Rename exception to ModelValidationError * Update CHANGELOG
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
As a spiritual successor of sorts to #1642, this PR:
qiskit.validation.base.BaseSchema"strict" (in practice, it raises an Exception directly when dumping/loading/validating), silencing that particularChangedInMarshmallow3Warning.qiskit.validationmodule,ModelValidationError. This brings the module in line with the project's philosophy, raising exceptions that inherit fromQiskitError.ModelValidationError.Details and comments
In practice, it helps removing the
ChangedInMarshmallow3Warningthat could still appear under some conditions even after #1642 (such as importing the models without passing throughqiskit._util), and the new exception helps third-party not having to add a dependency on marshmallow just for catching that exception