{"id": "plugin_hooks:plugin-register-routes", "page": "plugin_hooks", "ref": "plugin-register-routes", "title": "register_routes(datasette)", "content": "datasette  -  Datasette class \n                     \n                         You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) \n                     \n                 \n             \n             Register additional view functions to execute for specified URL routes. \n             Return a list of  (regex, view_function)  pairs, something like this: \n             from datasette import hookimpl, Response\nimport html\n\n\nasync def hello_from(request):\n    name = request.url_vars[\"name\"]\n    return Response.html(\n        \"Hello from {}\".format(html.escape(name))\n    )\n\n\n@hookimpl\ndef register_routes():\n    return [(r\"^/hello-from/(?P<name>.*)$\", hello_from)] \n             The view functions can take a number of different optional arguments. The corresponding argument will be passed to your function depending on its named parameters - a form of dependency injection. \n             The optional view function arguments are as follows: \n             \n                 \n                     datasette  -  Datasette class \n                     \n                         You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) , or to execute SQL queries. \n                     \n                 \n                 \n                     request  -  Request object \n                     \n                         The current HTTP request. \n                     \n                 \n                 \n                     scope  - dictionary \n                     \n                         The incoming ASGI scope dictionary. \n                     \n                 \n                 \n                     send  - function \n                     \n                         The ASGI send function. \n                     \n                 \n                 \n                     receive  - function \n                     \n                         The ASGI receive function. \n                     \n                 \n             \n             The view function can be a regular function or an  async def  function, depending on if it needs to use any  await  APIs. \n             The function can either return a  Response class  or it can return nothing and instead respond directly to the request using the ASGI  send  function (for advanced uses only). \n             It can also raise the  datasette.NotFound  exception to return a 404 not found error, or the  datasette.Forbidden  exception for a 403 forbidden. \n             See  Designing URLs for your plugin  for tips on designing the URL routes used by your plugin. \n             Examples:  datasette-auth-github ,  datasette-psutil", "breadcrumbs": "[\"Plugin hooks\"]", "references": "[{\"href\": \"https://datasette.io/plugins/datasette-auth-github\", \"label\": \"datasette-auth-github\"}, {\"href\": \"https://datasette.io/plugins/datasette-psutil\", \"label\": \"datasette-psutil\"}]"}