{"id": "internals:datasette-sign", "page": "internals", "ref": "datasette-sign", "title": ".sign(value, namespace=\"default\")", "content": "value  - any serializable type \n                         \n                             The value to be signed. \n                         \n                     \n                     \n                         namespace  - string, optional \n                         \n                             An alternative namespace, see the  itsdangerous salt documentation . \n                         \n                     \n                 \n                 Utility method for signing values, such that you can safely pass data to and from an untrusted environment. This is a wrapper around the  itsdangerous  library. \n                 This method returns a signed string, which can be decoded and verified using  .unsign(value, namespace=\"default\") .", "breadcrumbs": "[\"Internals for plugins\", \"Datasette class\"]", "references": "[{\"href\": \"https://itsdangerous.palletsprojects.com/en/1.1.x/serializer/#the-salt\", \"label\": \"itsdangerous salt documentation\"}, {\"href\": \"https://itsdangerous.palletsprojects.com/\", \"label\": \"itsdangerous\"}]"}
{"id": "internals:datasette-render-template", "page": "internals", "ref": "datasette-render-template", "title": "await .render_template(template, context=None, request=None)", "content": "template  - string, list of strings or jinja2.Template \n                         \n                             The template file to be rendered, e.g.  my_plugin.html . Datasette will search for this file first in the  --template-dir=  location, if it was specified - then in the plugin's bundled templates and finally in Datasette's set of default templates. \n                             If this is a list of template file names then the first one that exists will be loaded and rendered. \n                             If this is a Jinja  Template object  it will be used directly. \n                         \n                     \n                     \n                         context  - None or a Python dictionary \n                         \n                             The context variables to pass to the template. \n                         \n                     \n                     \n                         request  - request object or None \n                         \n                             If you pass a Datasette request object here it will be made available to the template. \n                         \n                     \n                 \n                 Renders a  Jinja template  using Datasette's preconfigured instance of Jinja and returns the resulting string. The template will have access to Datasette's default template functions and any functions that have been made available by other plugins.", "breadcrumbs": "[\"Internals for plugins\", \"Datasette class\"]", "references": "[{\"href\": \"https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.Template\", \"label\": \"Template object\"}, {\"href\": \"https://jinja.palletsprojects.com/en/2.11.x/\", \"label\": \"Jinja template\"}]"}
{"id": "internals:internals-datasette-client", "page": "internals", "ref": "internals-datasette-client", "title": "datasette.client", "content": "Plugins can make internal simulated HTTP requests to the Datasette instance within which they are running. This ensures that all of Datasette's external JSON APIs are also available to plugins, while avoiding the overhead of making an external HTTP call to access those APIs. \n                 The  datasette.client  object is a wrapper around the  HTTPX Python library , providing an async-friendly API that is similar to the widely used  Requests library . \n                 It offers the following methods: \n                 \n                     \n                         await datasette.client.get(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal GET request against that path. \n                         \n                     \n                     \n                         await datasette.client.post(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal POST request. Use  data={\"name\": \"value\"}  to pass form parameters. \n                         \n                     \n                     \n                         await datasette.client.options(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal OPTIONS request. \n                         \n                     \n                     \n                         await datasette.client.head(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal HEAD request. \n                         \n                     \n                     \n                         await datasette.client.put(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal PUT request. \n                         \n                     \n                     \n                         await datasette.client.patch(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal PATCH request. \n                         \n                     \n                     \n                         await datasette.client.delete(path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal DELETE request. \n                         \n                     \n                     \n                         await datasette.client.request(method, path, **kwargs)  - returns HTTPX Response \n                         \n                             Execute an internal request with the given HTTP method against that path. \n                         \n                     \n                 \n                 These methods can be used with  datasette.urls  - for example: \n                 table_json = (\n    await datasette.client.get(\n        datasette.urls.table(\n            \"fixtures\", \"facetable\", format=\"json\"\n        )\n    )\n).json() \n                 datasette.client  methods automatically take the current  base_url  setting into account, whether or not you use the  datasette.urls  family of methods to construct the path. \n                 For documentation on available  **kwargs  options and the shape of the HTTPX Response object refer to the  HTTPX Async documentation .", "breadcrumbs": "[\"Internals for plugins\", \"Datasette class\"]", "references": "[{\"href\": \"https://www.python-httpx.org/\", \"label\": \"HTTPX Python library\"}, {\"href\": \"https://requests.readthedocs.io/\", \"label\": \"Requests library\"}, {\"href\": \"https://www.python-httpx.org/async/\", \"label\": \"HTTPX Async documentation\"}]"}