hwebserver.errorResponse function

Generates a Response object representing an HTTP error.

errorResponse(request, error_message, status, use_heading): → hwebserver.Response

request

The Request object passed to the URL handler or API function.

(The function checks the request to see if the client wants a JSON response. If the client provided an Accept: application/json, */* header, this returns the JSON response {"error": error_message}, and error_message may be any JSON-encodable value.)

error_message

Error message to display to the user.

(This can be any JSON-encodable value if you know the response will be JSON rather than HTML.)

use_heading

If the response is an HTML page (instead of JSON), automatically wrap the error_message in an <h1> element.

import hou
import hwebserver


@hwebserver.urlHandler("/node/info/", is_prefix=True)
def node_info(request):
    path = request.path()
    assert path.startswith("/node/info")
    node_path = path[10:]
    node = hou.node(node_path)
    if node is None:
        return hwebserver.errorResponse(request, "Resource not found", 404)
    # ...

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.