DM-38414: Switch to Safir 4.0.0 #735
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
validate_exactly_one_of is now a root validator rather than a regular validator. Update Gafaelfawr's models accordingly.
Now that SlackWebException has been imported into Safir, use it from there rather than rolling our own. This results in some minor improvements in how errors are reported to Slack.
Gafaelfawr was using ValidationError as a base class that knew how to format itself into a FastAPI-compatible error message. Safir now offers ClientRequestError based on this code that does the same thing, so rename ValidationError to InputValidationError (to avoid the conflict with Pydantic's exception) and inherit from that exception. Use inheritance rather than simply replacing it since Gafaelfawr also wants to tag this exception as kopf.PermanentError. Adjust for the different calling convention for ClientRequestError (a list of field path).
Several classes had symbols that weren't mentioned in __all__, and gafaelfawr.class had an internal variable that didn't have an underscore prefix. Caught when testing an alternate documentation generation method with autosummary.
Generate API documentation with autodoc_pydantic, which generates much better documentation for Pydantic models. Enable inherited members for all module documentation, since module hierarchies generally should merge all of their fields for documentation purposes.
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.
Update to Safir 4.0.0, adjust for its backward-incompatible changes, and use the exception infrastructure from Safir now that it has been imported there (with some modifications).
Enable autodoc_pydantic to generate better documentation of Pydantic models. This also seems to be required for proper cross-referencing to Safir documentation now that Safir is also using autodoc_pydantic.