JSONResponse
class¶
esmerald.JSONResponse
¶
JSONResponse(content, status_code=status.HTTP_200_OK, headers=None, media_type=None, background=None, encoders=None)
Bases: Response
PARAMETER | DESCRIPTION |
---|---|
content |
TYPE:
|
status_code |
TYPE:
|
headers |
TYPE:
|
media_type |
TYPE:
|
background |
TYPE:
|
encoders |
TYPE:
|
Source code in lilya/responses.py
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
|
make_headers
¶
make_headers(content_headers=None)
Initializes the headers based on RFC specifications by setting appropriate conditions and restrictions.
PARAMETER | DESCRIPTION |
---|---|
content_headers |
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
content_headers |
Additional headers to include (default is None).
TYPE:
|
Source code in lilya/responses.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
set_cookie
¶
set_cookie(key, value='', *, path='/', domain=None, secure=False, max_age=None, expires=None, httponly=False, samesite='lax')
Sets a cookie in the response headers.
PARAMETER | DESCRIPTION |
---|---|
key |
TYPE:
|
value |
TYPE:
|
path |
TYPE:
|
domain |
TYPE:
|
secure |
TYPE:
|
max_age |
TYPE:
|
expires |
TYPE:
|
httponly |
TYPE:
|
samesite |
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
key |
The name of the cookie.
TYPE:
|
value |
The value of the cookie.
TYPE:
|
path |
The path for which the cookie is valid (default is '/').
TYPE:
|
domain |
The domain to which the cookie belongs.
TYPE:
|
secure |
If True, the cookie should only be sent over HTTPS.
TYPE:
|
max_age |
The maximum age of the cookie in seconds.
TYPE:
|
expires |
The expiration date of the cookie.
TYPE:
|
httponly |
If True, the cookie should only be accessible through HTTP.
TYPE:
|
samesite |
SameSite attribute of the cookie.
TYPE:
|
RAISES | DESCRIPTION |
---|---|
AssertionError
|
If samesite is not one of 'strict', 'lax', or 'none'. |
Source code in lilya/responses.py
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
|
delete_cookie
¶
delete_cookie(key, path='/', domain=None, secure=False, httponly=False, samesite='lax')
Deletes a cookie in the response headers by setting its max age and expiration to 0.
PARAMETER | DESCRIPTION |
---|---|
key |
TYPE:
|
path |
TYPE:
|
domain |
TYPE:
|
secure |
TYPE:
|
httponly |
TYPE:
|
samesite |
TYPE:
|
PARAMETER | DESCRIPTION |
---|---|
key |
The name of the cookie to delete.
TYPE:
|
path |
The path for which the cookie is valid (default is '/').
TYPE:
|
domain |
The domain to which the cookie belongs.
TYPE:
|
secure |
If True, the cookie should only be sent over HTTPS.
TYPE:
|
httponly |
If True, the cookie should only be accessible through HTTP.
TYPE:
|
samesite |
SameSite attribute of the cookie.
TYPE:
|
Source code in lilya/responses.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
message
¶
message(prefix)
PARAMETER | DESCRIPTION |
---|---|
prefix |
TYPE:
|
Source code in lilya/responses.py
220 221 222 223 224 225 |
|
make_response
¶
make_response(content)
PARAMETER | DESCRIPTION |
---|---|
content |
TYPE:
|
Source code in lilya/responses.py
272 273 274 275 276 277 278 279 |
|