API объекта Request во Flask
Класс Request инкапсулирует всю информацию об HTTP-запросе, отправленном клиентом.
С помощьюfrom flask import requestимпортируйте прокси-объект и используйте его напрямую в функциях представления.
Краткая справка по общим атрибутам
| Свойство | Type | Описание | Пример значения |
|---|---|---|---|
| method | str | Метод HTTP-запроса | "GET"、"POST" |
| path | str | Часть пути URL (без домена и строки запроса) | "/search" |
| full_path | str | Путь + строка запроса | "/search?q=example" |
| url | str | Полный URL запроса (без строки запроса) | "http://localhost:5000/search" |
| base_url | str | То же, что url, но без завершающей строки запроса. | "http://localhost:5000/search" |
| url_root | str | Домен + корневой путь приложения | "http://localhost:5000/" |
| host | str | Заголовок Host, включая порт | "localhost:5000" |
| host_url | str | scheme + host + корень приложения | "http://localhost:5000/" |
| scheme | str | Протокол | "http"、"https" |
| remote_addr | str | IP-адрес клиента | "127.0.0.1" |
| endpoint | str | Конечная точка совпавшего маршрута | "index"、"blog.show" |
| url_rule | Правило | Объект правила сопоставленного маршрута | Экземпляр Rule из Werkzeug |
| view_args | dict | Динамические переменные в URL | {"post_id": 42} |
| blueprint | str | Имя текущего Blueprint | "auth"、"blog" |
| blueprints | list | Текущий список уровней совпавшего blueprint | ["auth"] |
| is_json | bool | Является ли Content-Type запроса JSON | True / False |
Получение данных запроса
| Атрибуты/Методы | Type | Описание |
|---|---|---|
| args | MultiDict | Параметры строки запроса URL. Доступ /search?q=flask → request.args.get("q") |
| форма | MultiDict | Данные формы POST (application/x-www-form-urlencoded или multipart/form-data) |
| json | dict / None | Тело JSON-запроса (разобранное в объект Python). Возвращает None, если запрос не является JSON. |
| data | bytes | Необработанные данные тела запроса |
| files | FileMultiDict | Загруженный файл. request.files["file"] возвращает объект FileStorage |
| cookies | dict | Cookie, отправленный клиентом |
| headers | Headers | Заголовок запроса. Поддерживает несколько способов доступа |
| get_json(force=False, silent=False, cache=True) | — | Разбирает тело JSON-запроса. force принудительно разбирает типы, отличные от JSON, silent возвращает None при ошибке |
Параargs、formи т. д. Типы MultiDict, всегда используйте..get(key, default)Метод для получения значения. Используйте напрямуюrequest.args["key"]Обращение к несуществующему ключу вызывает KeyError (возвращает ошибку 400).
Атрибуты согласования содержимого
| Атрибуты/Методы | Описание |
|---|---|
| accept_mimetypes | Список MIME-типов, принимаемых клиентом (объект MIMEAccept). |
| accept_charsets | Набор символов, принимаемый клиентом |
| accept_encodings | Кодировка, принимаемая клиентом |
| accept_languages | Язык, принимаемый клиентом |
| content_type | Content-Type запроса |
| content_length | Длина тела запроса (bytes) |
| content_md5 | Контрольная сумма MD5 тела запроса |
Примеры кода
Пример
from flask import Flask, request
app = Flask(__name__)
@app.route("/demo", methods=["GET", "POST"])
def demo():
# Получить параметры запроса
keyword = request.args.get("q", "")
# Получить данные формы
username = request.form.get("username", "")
# Получить JSON-данные
if request.is_json:
data = request.json
name = data.get("name", "unknown")
# Получение заголовков запроса
user_agent = request.headers.get("User-Agent", "")
accept_lang = request.accept_languages.best
# Получение информации об URL
url_info = {
"method": request.method, # "GET" или "POST"
"path": request.path, # "/demo"
"url": request.url, # Полный URL
"remote_addr": request.remote_addr, # IP-адрес клиента
}
return url_info
app = Flask(__name__)
@app.route("/demo", methods=["GET", "POST"])
def demo():
# Получить параметры запроса
keyword = request.args.get("q", "")
# Получить данные формы
username = request.form.get("username", "")
# Получить JSON-данные
if request.is_json:
data = request.json
name = data.get("name", "unknown")
# Получение заголовков запроса
user_agent = request.headers.get("User-Agent", "")
accept_lang = request.accept_languages.best
# Получение информации об URL
url_info = {
"method": request.method, # "GET" или "POST"
"path": request.path, # "/demo"
"url": request.url, # Полный URL
"remote_addr": request.remote_addr, # IP-адрес клиента
}
return url_info