Flask JSON
Модуль JSON во Flask обеспечивает функциональность сериализации/десериализации, по умолчанию используя стандартную библиотеку Python json, которую можно заменить через JSONProvider.
Способ импорта:
from flask import jsonify
или
from flask.json import dumps, loads
Функция jsonify
Наиболее часто используемая функция построения JSON-ответа. Сериализует объекты Python в JSON Response.
| Использование | Описание |
|---|---|
| jsonify(*args, **kwargs) | Сериализует параметры в JSON, возвращает Response (Content-Type: application/json) |
| jsonify(dict) | Сериализовать словарь в JSON-ответ |
| jsonify(key=value, ...) | Сериализует именованные аргументы в JSON-ответ |
dumps / loads / dump / load
| Функция | Сигнатура | Описание |
|---|---|---|
| dumps | (obj, *, skipkeys=False, ensure_ascii=True, ...) | Сериализует объекты Python в строку JSON |
| loads | (s, *, ...) | Десериализует строку JSON в объект Python |
| dump | (obj, fp, *, ...) | Сериализует объект Python и записывает его в файл |
| load | (fp, *, ...) | Читает из файла и десериализует JSON |
Класс JSONProvider
Настраиваемый базовый класс обработчика JSON. Чтобы заменить реализацию JSON по умолчанию, наследуйте этот класс и переопределите соответствующие методы.
| Методы | Описание |
|---|---|
| dumps(obj, **kwargs) | Сериализует объект в строку JSON |
| loads(s, **kwargs) | Десериализует строку JSON в объект Python |
| response(obj) | Преобразует объект в JSON Response. Используется для jsonify и при возврате dict/list. |
DefaultJSONProvider
Реализация JSONProvider по умолчанию, основанная на стандартной библиотеке Python json.
| Атрибуты/Методы | Описание |
|---|---|
| ensure_ascii | Следует ли экранировать символы, не входящие в ASCII. Можно установить False, чтобы поддерживать вывод на китайском |
| sort_keys | Сортировать ли вывод по ключу. По умолчанию True |
| compact | Выводить ли компактно (без пробелов). По умолчанию False |
Сериализация тегов JSON
flask.json.tagМодуль поддерживает сериализацию дополнительных типов Python, таких как datetime, tuple, set и т. д.
| Теги | Соответствующие типы Python |
|---|---|
| JSONTaggedJSONSerializer | Улучшенный сериализатор, используемый Session по умолчанию. Поддерживает формат JSON с тегами |
Примеры кода
Пример
from flask import Flask, jsonify
app = Flask(__name__)
@app.get("/api/me")
def me():
# Вернуть dict, Flask автоматически вызывает jsonify
return {
"username": "example",
"email": "test@example.com",
"roles": ["admin", "editor"]
}
@app.get("/api/users")
def users():
# Вернуть list, Flask автоматически вызывает jsonify
return [
{"id": 1, "name": "example"},
{"id": 2, "name": "admin"}
]
@app.get("/api/status")
def status():
# Явно использовать jsonify
return jsonify(status="ok", version="1.0")
# Настроить вывод JSON на китайском
app.json.ensure_ascii = False
# {"username": "example", "description": "Содержимое описания на китайском"}
app = Flask(__name__)
@app.get("/api/me")
def me():
# Вернуть dict, Flask автоматически вызывает jsonify
return {
"username": "example",
"email": "test@example.com",
"roles": ["admin", "editor"]
}
@app.get("/api/users")
def users():
# Вернуть list, Flask автоматически вызывает jsonify
return [
{"id": 1, "name": "example"},
{"id": 2, "name": "admin"}
]
@app.get("/api/status")
def status():
# Явно использовать jsonify
return jsonify(status="ok", version="1.0")
# Настроить вывод JSON на китайском
app.json.ensure_ascii = False
# {"username": "example", "description": "Содержимое описания на китайском"}