Add error codes mapping with doc pages generation and static check#65423
Open
omkar-foss wants to merge 3 commits intoapache:mainfrom
Open
Add error codes mapping with doc pages generation and static check#65423omkar-foss wants to merge 3 commits intoapache:mainfrom
omkar-foss wants to merge 3 commits intoapache:mainfrom
Conversation
This adds AirflowEnumeratedException providing a way for devs to specify error code (AERR) while raising exceptions. These AERRs are mapped in yaml providing info about the error to users via docs, as a new doc page is generated for each error code in the yaml. This also adds a static check that validates raises for AirflowEnumeratedException and all its subclasses. Supporting tests also added for this static check. Entire story can be thought of as follows: - airflow dev identifies an error case and raises a new enumerated exception in code with new error code (say AERRNEW01) - dev then adds AERRNEW01 to error mapping yml with required info - dev runs breeze build-docs that generates a new page for AERRNEW01 - in case dev misses adding AERRNEW01 to error mapping yml or doesnt specify error_code in raise then static check will catch it Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
Signed-off-by: Omkar P <45419097+omkar-foss@users.noreply.github.com>
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
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.
Related: #43171
This adds AirflowEnumeratedException providing a way for devs to specify error code (AERR) while raising exceptions. These AERRs are mapped in yaml providing info about the error to users via docs, as a new doc page is generated for each error code in the yaml.
This also adds a static check that validates raises for AirflowEnumeratedException and all its subclasses. Supporting tests also added for this static check.
Entire story can be thought of as follows:
Was generative AI tooling used to co-author this PR?
No
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.