gidgethub — Exceptions

Exceptions

exception gidgethub.GitHubException

Base exception for this library.

exception gidgethub.ValidationFailure

An exception representing failed validation of a webhook event.

Inherits from GitHubException.

exception gidgethub.HTTPException(status_code, *args)

A general exception to represent HTTP responses. Inherits from GitHubException. The status_code is expected to be an http.HTTPStatus enum value.

status_code

The http.HTTPStatus status code that the exception represents.

exception gidgethub.RedirectionException

Exception for 3XX HTTP responses.

Inherits from HTTPException.

exception gidgethub.BadRequest

Exception for 4XX HTTP responses.

Inherits from HTTPException.

exception gidgethub.BadRequestUnknownError

Exception for 422 status code responses which do not include a JSON response.

New in version XXX.

response

The response as returned by GitHub.

exception gidgethub.RateLimitExceeded(rate_limit)

Raised when one’s rate limit has been reached. A subclass of BadRequest.

New in version 2.0.

rate_limit

The RateLimit object with the rate limit details which triggered the raising of the exception.

exception gidgethub.InvalidField(errors, *args)

Raised when a field in a request is invalid.

Inherits from BadRequest and explicitly specifies a 422 status code. Details of what fields were invalid are stored in the errors attribute.

errors

A list of error details for each field which was invalid.

exception gidgethub.ValidationError(errors, *args)

A request was unable to be completed.

Inherits from BadRequest a 422 HTTP response.

errors

Error details.

exception gidgethub.GitHubBroken

An exception representing 5XX HTTP responses.

Inherits from HTTPException.

GraphQL-specific

exception gidgethub.GraphQLException(message, response)

Base exception for all GraphQL-related exceptions.

Inherits from GitHubException.

response

The decoded JSON response from GitHub.

exception gidgethub.BadGraphQLRequest(status_code, response)

A 4XX HTTP response to a GraphQL request.

Inherits from GraphQLException.

response

The decoded JSON response from GitHub.

exception gidgethub.GraphQLAuthorizationFailure(response)

A 401 HTTP response due to an authorization failure.

Inherits from BadGraphQLRequest.

exception gidgethub.QueryError(response)

An exception representing an error relating to the GraphQL query itself.

Inherits from GraphQLException.

exception gidgethub.GraphQLResponseTypeError(content_type, response)

An exception raised when a GraphQL query response is not JSON.

Inherits from GraphQLException.

content_type

The value of the content-type header in the response from GitHub.

response

The decoded response value from GitHub.