12.4 API

12.4.1 The Tree: Resources

Private API

• _get_names()

  Returns a list of the sub-resources names.

• _get_resource(name)

  Makes it possible to return dynamically created resources. The default implementation raises LookupError so the Web server will return “404 Not Found”.

Public API

• get_root()

  Returns the root resource.

• get_resource(path)

  Returns the resource at the given path.

• has_resource(path)

  Returns True if there is a resource at the given path, False otherwise.

• get_names(path=’.’)

  Returns the names of the resources at the given path.

• get_abspath()

  Returns the absolute path.

• get_pathto(resource)

  Returns the relative path to the given resource.

• get_view(name, query=None))

  Returns the view to call based on its name. In the calendar application above, the name was view_calendar.

• GET(resource, context), HEAD(resource, context), POST(resource, context), PUT(resource, context), LOCK(resource, context), and UNLOCK(resource, context)

  Those methods are mapped to the HTTP methods if no method name (like view_calendar) is given. Note that LOCK and UNLOCK are part of the WebDAV protocol.

  They must return a byte string for the response body, or a Reference for redirection, or None for not returning a body. Raising an exception will make the Web server returning an error page instead.

• get_access_control()

  Returns the object responsible for the security of the application. The default implementation looks up for the closest instance of the AccessControl class in the parent path.