ci#dZddlmZddlmZGddeZGddeZGdd eZGd d eZ Gd d eZ GddeZ GddeZ GddeZ GddeZGddeZGddeZGddeZGddeZGddeZGd d!eZGd"d#eZGd$d%eZy&)'zExceptions for ExceptionToStatusInterceptor. See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for the source of truth on status code meanings. )Optional) StatusCodec~eZdZUdZej Zeed<dZe ed< d de e de efdZ de fdZ e d Zy) GrpcExceptionaQBase class for gRPC exceptions. Generally you would not use this class directly, but rather use a subclass representing one of the standard gRPC status codes (see: https://grpc.github.io/grpc/core/md_doc_statuscodes.html for the official list). Attributes: status_code: A grpc.StatusCode other than OK. The only use case for this is if gRPC adds a new status code that isn't represented by one of the subclasses of GrpcException. Must not be OK, because gRPC will not raise an RpcError to the client if the status code is OK. details: A string with additional informantion about the error. Args: details: If not None, specifies a custom error message. status_code: If not None, sets the status code. Raises: ValueError: If status_code is OK. status_codezUnknown exception occurreddetailsNcf|%|tjk(r td||_|||_yy)Nz-The status code for an exception cannot be OK)rOK ValueErrorrr)selfrrs B/tmp/pip-target-z3e9_cxr/lib/python/grpc_interceptor/exceptions.py__init__zGrpcException.__init__$s<  "jmm+ !PQQ*D   "DL returnc|jj}|jj}|d|d|jdS)zShow the status code and details. Returns: A string displaying the class name, status code, and details. z (status_code=z , details=)) __class____name__rnamer)r clsnamescs r __repr__zGrpcException.__repr__.sB ..))    " "-t:dll5EQGGrc.|jjS)zReturn status_code as a string. Returns: The status code as a string. Example: >>> GrpcException(status_code=StatusCode.NOT_FOUND).status_string 'NOT_FOUND' )rr)r s r status_stringzGrpcException.status_string8s$$$r)NN)r __module__ __qualname____doc__rUNKNOWNr__annotations__rstrrrrpropertyrrr rr sj()00K0/GS/RV#}#:B::N#H#H % %rrc,eZdZdZej ZdZy)AbortedzThe operation was aborted. Typically this is due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines on other exceptions for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. zThe operation was abortedN)rrrrrABORTEDrrr"rr r$r$Fs$$K)Grr$c,eZdZdZej ZdZy) AlreadyExistszThe entity that a client attempted to create already exists. E.g., a file or directory that a client is trying to create already exists. z1The entity attempted to be created already existsN)rrrrrALREADY_EXISTSrrr"rr r'r'Rs ++KAGrr'c,eZdZdZej ZdZy) Cancelledz5The operation was cancelled, typically by the caller.zThe operation was cancelledN)rrrrr CANCELLEDrrr"rr r*r*\s?&&K+Grr*c,eZdZdZej ZdZy)DataLossz&Unrecoverable data loss or corruption.z/There was unrecoverable data loss or corruptionN)rrrrr DATA_LOSSrrr"rr r-r-cs0&&K?Grr-c,eZdZdZej ZdZy)DeadlineExceededaThe deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long. z0Deadline expired before operation could completeN)rrrrrDEADLINE_EXCEEDEDrrr"rr r0r0js..K@Grr0c,eZdZdZej ZdZy)FailedPreconditiona|The operation failed because the system is in an invalid state for execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless the files are deleted from the directory. zVThe operation was rejected because the system is not in a state required for executionN)rrrrrFAILED_PRECONDITIONrrr"rr r3r3vs 00K - rr3c,eZdZdZej ZdZy)InvalidArgumentzThe client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). z(The client specified an invalid argumentN)rrrrrINVALID_ARGUMENTrrr"rr r6r6s--K8Grr6c,eZdZdZej ZdZy)InternalzInternal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. zInternal errorN)rrrrrINTERNALrrr"rr r9r9s %%KGrr9c,eZdZdZej ZdZy) OutOfRangeaThe operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size. There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done. z0The operation was attempted past the valid rangeN)rrrrr OUT_OF_RANGErrr"rr r<r<s ))K@Grr<c,eZdZdZej ZdZy)NotFoundaxSome requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented whitelist, NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control, PERMISSION_DENIED must be used. z"The requested entity was not foundN)rrrrr NOT_FOUNDrrr"rr r?r?s&&K2Grr?c,eZdZdZej ZdZy)PermissionDeniedaThe caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. zFThe caller does not have permission to execute the specified operationN)rrrrrPERMISSION_DENIEDrrr"rr rBrBs..KVGrrBc,eZdZdZej ZdZy)ResourceExhaustedzxSome resource has been exhausted. Perhaps a per-user quota, or perhaps the entire file system is out of space. zA resource has been exhaustedN)rrrrrRESOURCE_EXHAUSTEDrrr"rr rErEs //K-GrrEc,eZdZdZej ZdZy)UnauthenticatedzMThe request does not have valid authentication credentials for the operation.zLThe request does not have valid authentication credentials for the operationN)rrrrrUNAUTHENTICATEDrrr"rr rHrHsW,,KV rrHc,eZdZdZej ZdZy) UnavailablezThe service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. z$The service is currently unavailableN)rrrrr UNAVAILABLErrr"rr rKrKs ((K4GrrKc,eZdZdZej ZdZy) UnimplementedzMThe operation is not implemented or is not supported/enabled in this service.zIThe operation is not implemented or not supported/enabled in this serviceN)rrrrr UNIMPLEMENTEDrrr"rr rNrNsW**KS rrNceZdZdZy)Unknowna.Unknown error. For example, this error may be returned when a Status value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. N)rrrrr"rr rQrQs  rrQN)rtypingrgrpcr Exceptionrr$r'r*r-r0r3r6r9r<r?rBrErHrKrNrQr"rr rUs 7%I7%t *m *BMB, ,@}@ A} A, 9m 9}AA" 3} 3 W} W. .m5-5M  m  r