Coding Standards: URL Handlers

URL handlers in this system are often called indirectly. For each individual application, the URL hierarchy and level-specific handlers are defined in an all-encompassing WSGI handler named wsgifunc, which can be found in the uw.local.application.webui.wsgifunc module. This handler is then passed to other functions which interact with the web server.

Handler parameters are supplied by the context created by the surrounding WSGI constructors. More specifically, this context is explicitly built up by delegator functions from the uw.local.application.webui.delegate module.

Thus, to create a new page in the URL hierarchy:

  • Add the new URL path to the appropriate place in the overarching WSGI handler for the application.
  • Specify a delegator function to obtain any additional context parameters required by the new page handler.
  • Specify the handler function to be passed into the delegator function.

See the page on docstrings for information on how to document URL handlers.