Skip to main content

Web based error utils

Project description

Web Errors v0.4.2

image image image style tests codecov

web_error is a set of exceptions and handlers for use in web apis to support easy error management and responses

Each exception easily marshals to JSON for use in api errors. Handlers for different web frameworks are provided.


The base web_error.error.HttpException accepts a message, debug_message, code and status (default 500)

And will render a response with status as the status code:

    "code": "code",
    "message": "message",
    "debug_message": "debug_message",

Some convenience Exceptions are provided, to create custom error subclass these and define message and code attributes.

  • web_error.error.ServerException provides status 500 errors
  • web_error.error.BadRequestException provides status 400 errors
  • web_error.error.UnauthorisedException provides status 401 errors
  • web_error.error.NotFoundException provides status 404 errors

Custom Errors

Subclassing the convenience classes provide a simple way to consistently raise the same error and message.

Code is an optional attribute to provide a unique value to parse in a frontend/client instead of matching against messages.

from web_error.error import NotFoundException

class UserNotFoundError(NotFoundException):
    message = "User not found."
    code = "E001"


Include the pyramid exception handlers in your config.

def main(global_config, **config_blob):
    config = Configurator(settings=config_blob)



    return config.make_wsgi_app()

This will handle all unexpected errors, and any app specific errors.

@view_config(route_name="test", renderer="json")
def test(request):
    raise UserNotFoundError("debug message")


Register the error handler with your application

app.register_error_handler(Exception, web_error.handler.flask.exception_handler)


Decorate your views with the error handler.

async def user(self):
    raise UserNotFoundError("debug message")

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

web_error-0.4.2.tar.gz (9.3 kB view hashes)

Uploaded source

Built Distribution

web_error-0.4.2-py3-none-any.whl (11.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page