13.4 API

13.4.1 The Tree: Nodes

Private API

• _get_names()

  Returns a list of the sub-nodes names.

• _get_object(name)

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

Public API

• get_root()

  Returns the root node.

• get_object(path)

  Returns the node at the given path.

• has_object(path)

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

• get_names(path=’.’)

  Returns the names of the nodes at the given path.

• get_abspath()

  Returns the absolute path.

• get_pathto(node)

  Returns the relative path to the given node.

• get_method(name)

  Returns the method to call based on its name. In the calendar application above, the names were GETand view_calendar.

• GET(context), HEAD(context), POST(context), PUT(context), LOCK(context), and UNLOCK(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.