Основные концепции Flask

В предыдущей главе мы узнали, как создать наше первое приложение Flask. В этой главе мы подробно рассмотрим некоторые основные концепции Flask.

Понимание основных концепций Flask очень важно для разработки эффективных веб-приложений.

Ниже представлен подробный анализ основных базовых концепций Flask:

  • МаршрутизацияМаршрутизация — это сопоставление URL-адресов функциям Python. Flask позволяет определять маршруты, чтобы при обращении к определенному URL вызывалась соответствующая функция.

  • Функция представленияФункции представления — это функции Python, которые обрабатывают запросы и возвращают ответы. Обычно они принимают объект запроса в качестве параметра и возвращают объект ответа.

  • Объект запросаОбъект запроса содержит информацию, отправленную клиентом, такую как метод запроса, URL, заголовки запроса, данные формы и многое другое.

  • Объект ответаОбъект ответа содержит информацию, отправляемую клиенту, такую как код состояния, заголовки ответа, тело ответа и многое другое.

  • ШаблоныFlask использует шаблонизатор Jinja2 для рендеринга HTML-шаблонов. Шаблоны позволяют встраивать код Python в HTML, тем самым динамически генерируя веб-страницы.

  • Фабрика приложений: Фабрика приложений — это функция Python, которая создает и возвращает экземпляр приложения Flask. Это позволяет настраивать и инициализировать приложение, а также создавать несколько экземпляров приложения.

  • Объект конфигурацииПриложение Flask имеет объект конфигурации, который можно использовать для установки различных параметров конфигурации, таких как строки подключения к базе данных, режим отладки и многое другое.

  • Чертеж: Чертежи — это способ организации кода во Flask, позволяющий группировать связанные функции представления, шаблоны и статические файлы вместе, и они могут повторно использоваться в нескольких приложениях.

  • Статические файлыСтатические файлы — это файлы, которые не выполняются на стороне сервера, такие как CSS, JavaScript и файлы изображений. Flask предоставляет простой способ обслуживания этих файлов.

  • РасширенияFlask имеет множество расширений, которые могут добавлять дополнительную функциональность, такую как интеграция с базой данных, проверка форм, аутентификация пользователей и многое другое.

  • СессияFlask использует клиентские сессии для хранения информации о пользователе, что позволяет запоминать состояние пользователя, пока он просматривает ваше приложение.

  • Обработка ошибокFlask позволяет определять функции обработки ошибок, которые вызываются при возникновении определённых ошибок.

1. Маршрутизация

Маршрутизация — это сопоставление URL-адресов функциям Python. Flask позволяет определять маршруты, чтобы, когда пользователь обращается к определённому URL-адресу, Flask вызывал соответствующую функцию представления для обработки запроса.

Пример

from flask import Flask

app = Flask(__name__)

@app.route('/')
def home():
    return 'Welcome to the Home Page!'

@app.route('/about')
def about():
    return 'This is the About Page.'
  • @app.route('/'): Сопоставить корневой URL/вhomeфункцию.
  • @app.route('/about'): соответствует/aboutURL сопоставляется сaboutфункцию.

2. Функции представления

Функции представления — это Python-функции, которые обрабатывают запросы и возвращают ответы. Обычно они принимают объект запроса в качестве параметра и возвращают объект ответа либо напрямую возвращают строку, HTML или другой контент.

Пример

from flask import request

@app.route('/greet/<name>')
def greet(name):
    return f'Hello, {name}!'

Функция greet получает параметр name из URL и возвращает строковый ответ.

3. Объект запроса

Объект request содержит информацию, отправленную клиентом, включая метод запроса, URL, заголовки запроса, данные формы и другое. Flask предоставляет объект request для доступа к этой информации.

Пример

from flask import request

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username')
    return f'Hello, {username}!'

request.form.get('username')Получить поле username из данных формы в POST-запросе.

4. Объект ответа

Объект ответа содержит информацию, отправляемую клиенту, включая код состояния, заголовки ответа и тело ответа. По умолчанию Flask рассматривает строки и HTML непосредственно как тело ответа.

Пример

from flask import make_response

@app.route('/custom_response')
def custom_response():
    response = make_response('This is a custom response!')
    response.headers['X-Custom-Header'] = 'Value'
    return response

make_responseСоздать пользовательский объект ответа и установить заголовок ответа X-Custom-Header.

5. Шаблоны

Flask использует шаблонизатор Jinja2 для рендеринга HTML-шаблонов. Шаблоны позволяют встраивать код Python в HTML, тем самым динамически генерируя содержимое веб-страницы.

Пример

from flask import render_template

@app.route('/hello/<name>')
def hello(name):
    return render_template('hello.html', name=name)

Файл шаблона (templates/hello.html):

Пример

<!DOCTYPE html>
<html>
<head>
    <title>Привет</title>
</head>
<body>
    <h1>Привет, {{ name }}!</h1>
</body>
</html>

6. Фабрика приложений

Фабрика приложений — это функция Python, используемая для создания и настройки экземпляров приложения Flask. Этот подход позволяет создавать несколько экземпляров приложения или инициализировать приложения с различными конфигурациями.

Пример

from flask import Flask

def create_app(config_name):
    app = Flask(__name__)
    app.config.from_object(config_name)

    from . import routes
    app.register_blueprint(routes.bp)

    return app

Функция create_app создаёт экземпляр приложения Flask и загружает конфигурацию из объекта конфигурации.

7. Объекты конфигурации

Объект конфигурации используется для установки различных параметров конфигурации приложения, таких как строки подключения к базе данных, режим отладки и другое. Вы можете настроить приложение Flask, задавая значения напрямую или загружая файл конфигурации.

Пример

class Config:
    DEBUG = True
    SECRET_KEY = 'mysecretkey'
    SQLALCHEMY_DATABASE_URI = 'sqlite:///mydatabase.db'

app.config.from_object(Config)Загрузите элементы конфигурации из класса Config в конфигурацию приложения.

8. Чертежи

Чертежи — это способ организации кода в Flask. Они позволяют объединять связанные функции представлений, шаблоны и статические файлы, и их можно повторно использовать в нескольких приложениях.

Пример

from flask import Blueprint

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return 'Home Page'

Зарегистрируйте чертеж (app/__init__.py):

Пример

from flask import Flask
from .routes import bp as main_bp

def create_app():
    app = Flask(__name__)
    app.register_blueprint(main_bp)
    return app

9. Статические файлы

Статические файлы — это файлы, которые не выполняются на стороне сервера, такие как CSS, JavaScript и файлы изображений. Flask предоставляет простой способ обслуживать эти файлы.

Пример доступа к статическим файлам:

<link rel="stylesheet" type="text/css" href="{{ url_for(.html'static', filename='style.css') }}">

Каталог статических файлов:Поместите статические файлы в папку static, и Flask будет автоматически их обслуживать.

10. Расширения

У Flask есть много расширений, которые могут добавлять дополнительную функциональность, например интеграцию с базами данных, проверку форм, аутентификацию пользователей и многое другое. Эти расширения предоставляют более продвинутые возможности и сторонние интеграции.

Пример

from flask_sqlalchemy import SQLAlchemy

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///mydatabase.db'
db = SQLAlchemy(app)

SQLAlchemy: Расширения для интеграции с базами данных.

11. Сессии

Flask использует клиентские сессии для хранения информации о пользователе, чтобы запоминать состояние пользователя во время просмотра приложения. Данные сессии хранятся в cookie клиента и подписываются и шифруются на стороне сервера.

Пример

from flask import session

# Автоматически сгенерированный секретный ключ
app.secret_key = 'your_secret_key_here'

@app.route('/set_session/<username>')
def set_session(username):
    session['username'] = username
    return f'Session set for {username}'

@app.route('/get_session')
def get_session():
    username = session.get('username')
    return f'Hello, {username}!' if username else 'No session data'

Объект session используется для хранения и извлечения данных сессии.

Вы можете использовать встроенный модуль secrets в Python для генерации надёжного случайного секретного ключа.

python3 -c 'import secrets; print(secrets.token_hex())'

12. Обработка ошибок

Flask позволяет определять функции обработки ошибок, которые вызываются при возникновении определённых ошибок. Вы можете настраивать страницы ошибок или логику обработки.

Пример

@app.errorhandler(404)
def page_not_found(e):
    return 'Page not found', 404

@app.errorhandler(500)
def internal_server_error(e):
    return 'Internal server error', 500

@app.errorhandler(404)Определите функцию-обработчик для ошибки 404 и возвращайте пользовательскую страницу ошибки.

Другие расширения