hwebserver.APIError class

Raise this exception in apiFunction handlers to indicate an error.

If an apiFunction handler raises this exception, the server will use hwebserver.errorResponse to generate a 422 Unprocessable Entity response with a JSON Object body containing an error key with the given error message.

Any other kind of exception in a handler function will generate a generic 500 Internal Server Error. If the server is running in debug mode, the response body will contain a stack trace.

Note

webapiclient.py also has an APIError exception class. If an API function raises an APIError exception from the server, webapiclient will also raise an APIError from the client. If an API function on the server raises another exception and returns 500, webapiclient will also raise APIerror with the contents of the 500 response. You can access api_error.status_code from the client to differentiate between 422 and 500 errors.

Methods ¶

__init__(msg)

You can supply an error message string or any JSON-encodable object as the “message”. Assuming the client indicated it accepts JSON, the response will be JSON where the body is a JSON Object with an error key containing the error message.

You can supply an error message string or any JSON-encodable object as the message.

hwebserver

Classes ¶

hwebserver.Request

A request made to Houdini’s web server.
hwebserver.Response

A response made back from Houdini’s web server.
hwebserver.UploadedFile

A file uploaded in a request made to Houdini’s web server.
URLHandler

The general purpose HTTP handler.
AsyncURLHandler

The general purpose Async HTTP handler.
WebSocket

Base class for WebSocket support with the embedded server.

Starting and Stopping ¶

hwebserver.run

Starts Houdini’s web server.
hwebserver.requestShutdown

Tells Houdini’s web server to shut down after serving all open requests.
hwebserver.isInDebugMode

Returns True if Houdini’s web server was started in debug mode debug=True in )

Handling Web Requests and Returning Responses ¶

hwebserver.urlHandler

Decorator for functions that handle requests to Houdini’s web server.
hwebserver.errorResponse

Generates a Response object representing an HTTP error.
hwebserver.notFoundResponse

Generates a Response object representing a 404 Not Found HTTP error.
hwebserver.fileResponse

Generates a Response object that sends the contents of a file.
hwebserver.redirect

Generates a Response object representing a 301 Moved or 302 Found HTTP response.
hwebserver.registerStaticFilesDirectory

Tells Houdini’s web server to check the given directory for files to automatically serve for URLs that match the given path prefix.
/hwebserver/registerOpdefPath.html
hwebserver.registerWSGIApp

Function used to register a wsgi capable application such as django to be used on a path prefix.
hwebserver.registerASGIApp

Function used to register a asgi capable application such as django to be used on a path prefix.
hwebserver.setSettingsForPort

Set the settings for a specific port.

WebSocket ¶

WebSocket

Base class for WebSocket support with the embedded server.
hwebserver.webSocket

Decorator for registering WebSocket classes with Houdini’s web server.

API Calls ¶

hwebserver.apiFunction

Decorator for functions that can be called through an API endpoint on Houdini’s web server, returning JSON or binary responses.
hwebserver.APIError

Raise this exception in apiFunction handlers to indicate an error.