module documentation

Undocumented

Class PassthroughRetryPrepare Returns the Request's keyword arguments unchanged, when no change needs to be made before a retry.
Class PrepareRequestForRetry This class allows for the manipulation of the Request keyword arguments before a retry.
Class ResilientSession This class is supposed to retry requests that do return temporary errors.
Function parse_error_msg Parse a Jira Error messages from the Response and join them by comma.
Function parse_errors Parse a Jira Error messages from the Response.
Function raise_on_error Handle errors from a Jira Request.
Constant LOG Undocumented
def parse_error_msg(resp: Response) -> str: (source)

Parse a Jira Error messages from the Response and join them by comma. https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#status-codes Args: resp (Response): The Jira API request's response. Returns: str: The error message parsed from the Response. An empty str if no error.

def parse_errors(resp: Response) -> List[str]: (source)

Parse a Jira Error messages from the Response. https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#status-codes Args: resp (Response): The Jira API request's response. Returns: List[str]: The error messages list parsed from the Response. An empty list if no error.

def raise_on_error(resp: Optional[Response], **kwargs) -> TypeGuard[Response]: (source)

Handle errors from a Jira Request. Args: resp (Optional[Response]): Response from Jira request Raises: JIRAError: If Response is None JIRAError: for unhandled 400 status codes. Returns: TypeGuard[Response]: True if the passed in Response is all good.