GitLocker: The Coding Marketplace

Description:

httpexceptions 0.2.10

HTTP Exceptions

Raisable HTTP Exceptions
Install
Simply install the package from PyPI.
$ pip install -U http-exceptions

And that is it, you are ready to raise HTTP Exceptions.
What is it good for?

Saves writing boilerplate code:
Converts this:
# e.g. app/internal.py
def some_function() -> None:
raise SomeError()

# e.g. app/api.py
def api(request: Request) -> Response:
try:
response = some_function()
except SomeError:
response = Response(status_code=403)
return response

into this:
# e.g. app/internal.py
from http_exceptions import ForbiddenException

def some_function() -> None:
raise ForbiddenException()

# e.g. app/api.py
def api(request: Request) -> None:
return some_function()

Dynamic exception raising:
from http_exceptions import HTTPException

def raise_from_status(response: Response) -> None:
if 400 <= response.status < 600:
raise HTTPException.from_status_code(status_code=response.status_code)(message=response.text)

>>> response = Response(status_code=403)
>>> raise_from_status(response=response) # ForbiddenException raised

What else?
HTTPException
Base class that provides all the exceptions to be raised.
HTTPExceptions.from_status_code(status_code=status_code)
Returns the relevant Exception corresponding to status_code
e.g. HTTPExceptions.from_status_code(status_code=431) -> RequestHeaderFieldsTooLargeException
ClientException
Subclass of HTTPException serving as a base class for exceptions with statuses in the [400, 499] range.
from http_exceptions import ClientException, RequestHeaderFieldsTooLargeException

try:
raise RequestHeaderFieldsTooLargeException # 431 - Client exception
except ClientException:
# exception is caught here
pass

ServerException
Subclass of HTTPException serving as a base class for exceptions with statuses in the [500, 599] range.
from http_exceptions import HTTPVersionNotSupportedException, ServerException

try:
raise HTTPVersionNotSupportedException # 505 - Server exception
except ServerException:
# exception is caught here
pass

Available Exceptions
Client Exceptions: 400 <= status <= 499
400: BadRequestException
401: UnauthorizedException
402: PaymentRequiredException
403: ForbiddenException
404: NotFoundException
405: MethodNotAllowedException
406: NotAcceptableException
407: ProxyAuthenticationRequiredException
408: RequestTimeoutException
409: ConflictException
410: GoneException
411: LengthRequiredException
412: PreconditionFailedException
413: PayloadTooLargeException
414: URITooLongException
415: UnsupportedMediaTypeException
416: RangeNotSatisfiableException
417: ExpectationFailedException
418: ImATeapotException
421: MisdirectedRequestException
422: UnprocessableEntityException
423: LockedException
424: FailedDependencyException
425: TooEarlyException
426: UpgradeRequiredException
428: PreconditionRequiredException
429: TooManyRequestsException
431: RequestHeaderFieldsTooLargeException
444: NoResponseException
451: UnavailableForLegalReasonsException

Server Exceptions: 500 <= status <= 599
500: InternalServerErrorException
501: NotImplementedException
502: BadGatewayException
503: ServiceUnavailableException
504: GatewayTimeoutException
505: HTTPVersionNotSupportedException
506: VariantAlsoNegotiatesException
507: InsufficientStorageException
508: LoopDetectedException
510: NotExtendedException
511: NetworkAuthenticationRequiredException

Contributing
Contributions are welcome via pull requests.
First time setup
$ git clone git@github.com:DeveloperRSquared/http-exceptions.git
$ cd http-exceptions
$ poetry install
$ poetry shell

Tools including black, mypy etc. will run automatically if you install pre-commit using the instructions below
$ pre-commit install
$ pre-commit run --all-files

Running tests
$ poetry run pytest

Links

Source Code: https://github.com/DeveloperRSquared/http-exceptions/
PyPI Releases: https://pypi.org/project/http-exceptions/
Issue Tracker: https://github.com/DeveloperRSquared/http-exceptions/issues/