id,page,ref,title,content,breadcrumbs,references
internals:internals-request,internals,internals-request,Request object,"The request object is passed to various plugin hooks. It represents an incoming HTTP request. It has the following properties: 
             
                 
                     .scope  - dictionary 
                     
                         The ASGI scope that was used to construct this request, described in the  ASGI HTTP connection scope  specification. 
                     
                 
                 
                     .method  - string 
                     
                         The HTTP method for this request, usually  GET  or  POST . 
                     
                 
                 
                     .url  - string 
                     
                         The full URL for this request, e.g.  https://latest.datasette.io/fixtures . 
                     
                 
                 
                     .scheme  - string 
                     
                         The request scheme - usually  https  or  http . 
                     
                 
                 
                     .headers  - dictionary (str -> str) 
                     
                         A dictionary of incoming HTTP request headers. Header names have been converted to lowercase. 
                     
                 
                 
                     .cookies  - dictionary (str -> str) 
                     
                         A dictionary of incoming cookies 
                     
                 
                 
                     .host  - string 
                     
                         The host header from the incoming request, e.g.  latest.datasette.io  or  localhost . 
                     
                 
                 
                     .path  - string 
                     
                         The path of the request excluding the query string, e.g.  /fixtures . 
                     
                 
                 
                     .full_path  - string 
                     
                         The path of the request including the query string if one is present, e.g.  /fixtures?sql=select+sqlite_version() . 
                     
                 
                 
                     .query_string  - string 
                     
                         The query string component of the request, without the  ?  - e.g.  name__contains=sam&age__gt=10 . 
                     
                 
                 
                     .args  - MultiParams 
                     
                         An object representing the parsed query string parameters, see below. 
                     
                 
                 
                     .url_vars  - dictionary (str -> str) 
                     
                         Variables extracted from the URL path, if that path was defined using a regular expression. See  register_routes(datasette) . 
                     
                 
                 
                     .actor  - dictionary (str -> Any) or None 
                     
                         The currently authenticated actor (see  actors ), or  None  if the request is unauthenticated. 
                     
                 
             
             The object also has two awaitable methods: 
             
                 
                     await request.post_vars()  - dictionary 
                     
                         Returns a dictionary of form variables that were submitted in the request body via  POST . Don't forget to read about  CSRF protection ! 
                     
                 
                 
                     await request.post_body()  - bytes 
                     
                         Returns the un-parsed body of a request submitted by  POST  - useful for things like incoming JSON data. 
                     
                 
             
             And a class method that can be used to create fake request objects for use in tests: 
             
                 
                     fake(path_with_query_string, method=""GET"", scheme=""http"", url_vars=None) 
                     
                         Returns a  Request  instance for the specified path and method. For example: 
                         from datasette import Request
from pprint import pprint

request = Request.fake(
    ""/fixtures/facetable/"",
    url_vars={""database"": ""fixtures"", ""table"": ""facetable""},
)
pprint(request.scope) 
                         This outputs: 
                         {'http_version': '1.1',
 'method': 'GET',
 'path': '/fixtures/facetable/',
 'query_string': b'',
 'raw_path': b'/fixtures/facetable/',
 'scheme': 'http',
 'type': 'http',
 'url_route': {'kwargs': {'database': 'fixtures', 'table': 'facetable'}}}","[""Internals for plugins""]","[{""href"": ""https://asgi.readthedocs.io/en/latest/specs/www.html#connection-scope"", ""label"": ""ASGI HTTP connection scope""}]"