docs: Document raised exceptions in client methods#3383
Open
andreahlert wants to merge 1 commit intoflyteorg:masterfrom
Open
docs: Document raised exceptions in client methods#3383andreahlert wants to merge 1 commit intoflyteorg:masterfrom
andreahlert wants to merge 1 commit intoflyteorg:masterfrom
Conversation
Replace `:raises: TODO` placeholders with actual exception documentation in RawSynchronousFlyteClient and SynchronousFlyteClient methods. The documented exceptions are based on the RetryExceptionWrapperInterceptor which converts gRPC status codes to Flyte exceptions: - FlyteAuthenticationException (UNAUTHENTICATED) - FlyteEntityNotExistException (NOT_FOUND) - FlyteEntityAlreadyExistsException (ALREADY_EXISTS) - FlyteInvalidInputException (INVALID_ARGUMENT) - FlyteSystemException (other errors) This improves API documentation and helps users understand what exceptions to expect when using the client methods.
andreahlert
requested review from
cosmicBboy,
davidmirror-ops,
kumare3,
machichima,
pingsutw,
samhita-alla and
wild-endeavor
as code owners
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
1 participant
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
:raises: TODOplaceholders with actual exception documentation inRawSynchronousFlyteClientandSynchronousFlyteClientmethodsraw.pyandfriendly.pyChanges
The documented exceptions are based on the
RetryExceptionWrapperInterceptorwhich converts gRPC status codes to Flyte exceptions:UNAUTHENTICATEDFlyteAuthenticationExceptionNOT_FOUNDFlyteEntityNotExistExceptionALREADY_EXISTSFlyteEntityAlreadyExistsExceptionINVALID_ARGUMENTFlyteInvalidInputExceptionUNAVAILABLEFlyteSystemUnavailableExceptionFlyteSystemExceptionWhy
This improves API documentation and helps users understand what exceptions to expect when using the client methods, enabling better error handling in their code.
Test plan
wrap_exception_interceptor.pylogic