App route flask что это

Значение __name__ и @app.route во Flask, Python

Здесь (в книге) указано, что «классу Flask нужно знать текущее значение name, когда создаётся новый объект Flask, поэтому оно должно быть передано в аргументе, что мы и сделали» — вообще не понял, зачем это нужно. Ну и соответственно, как работает route я тоже не понял. Объясните, пожалуйста, максимально доходчиво.

Отслеживать
задан 16 мар 2018 в 16:34
Виталий Суворов Виталий Суворов
3 3 3 бронзовых знака

1 ответ 1

Сортировка: Сброс на вариант по умолчанию

name это специальная переменная(атрибут модуля) в которую сохраняется имя модуля. Просто о модулях — https://wombat.org.ua/AByteOfPython/modules.html @function — это декоратор. Грубо говоря декоратор это функция которая изменяет поведение другой функции, в гугле очень много инфы по поводу декораторов, поэтому примеры писать не буду. В текущем примере @app.route обрабатывает функцию hello() перед ее исполнением @app.route def hello(): pass
является тем же что и hello_new = app.route(hello) # hello_new — это измененная функция hello() . Касаясь самого фласка, app.route обрабатывает функцию hello как адрес(ссылку) на функцию представления нашего приложения. То есть чтобы при запуске нашего приложения увидеть ‘Hello world from Flask’, нам нужно обратится к функции hello, которая вернет нам эту строку, а функция вызывается с помощью указания ее имени как пути к странице приложения. http:\app_host:app_port\hello.

Отслеживать
ответ дан 17 мар 2018 в 3:54
Vladimir Yaremenko Vladimir Yaremenko
161 1 1 золотой знак 2 2 серебряных знака 9 9 бронзовых знаков

• python
• flask
• route

Важное на Мете

Похожие

Подписаться на ленту

Лента вопроса

Для подписки на ленту скопируйте и вставьте эту ссылку в вашу программу для чтения RSS.

Дизайн сайта / логотип © 2024 Stack Exchange Inc; пользовательские материалы лицензированы в соответствии с CC BY-SA . rev 2024.1.3.2953

Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.

#3 Основы Flask

Начать знакомство с Flask можно с создания простого приложения, которое выводит “Hello World”. Создаем новый файл main.py и вводим следующий код.

from flask import Flask app = Flask(__name__) @app.route('/') def index(): return 'Hello World' if __name__ == "__main__": app.run() 

Это приложение “Hello World”, созданное с помощью фреймворка Flask. Если код в main.py не понятен, это нормально. В следующих разделах все будет разбираться подробно. Чтобы запустить main.py , нужно ввести следующую команду в виртуальную среду Python.

(env) gvido@vm:~/flask_app$ python main.py * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) 

Запуск файла main.py запускает локальный сервер для разработки на порте 5000. Осталось открыть любимый браузер и зайти на https://127.0.0.1:5000/ , чтобы увидеть приложение Hello World в действии.

Остановить сервер можно с помощью комбинации CTRL+C.

Создание приложения Flask

У каждого Flask-приложения должен быть экземпляр класса. Экземпляр — это WSGI-приложение (WSGI – это интерфейс для взаимодействия сервера с фреймворком), которое показывает, что сервер передает все полученные запросы экземпляру для дальнейшей обработки. Объект класса Flask создается следующим образом:

from flask import Flask app = Flask(__name__) 

В первой строке класс Flask импортируется из пакета flask .

Во второй строке создается объект Flask . Для этого конструктору Flask назначается аргумент __name__ . Конструктор Flask должен иметь один обязательный аргумент. Им служит название пакета. В большинстве случаев значение __name__ подходит. Название пакета приложения используется фреймворком Flask, чтобы находить статические файлы, шаблоны и т. д.

Создание route (путей)

Маршрут (или путь) используется во фреймворке Flask для привязки URL к функции представления. Эта функция отвечает на запрос. Во Flask декоратор route используется, чтобы связать URL адрес с функций. Вот как маршрут создается.

@app.route('/') def index(): return 'Hello World' 

Этот код назначает функцию index() обработчиком корневого URL в приложении. Другими словами, каждый раз, когда приложение будет получать запрос, где путь — / , вызывается функция index() , и на этом запрос завершается.

Как вариант можно использовать метод add_url_rule() вместо декоратора route для маршрутизации. add_url_rule() — это простой метод, а не декоратор. Помимо URL он принимает конечную точку и название функции представления. Конечная точка относится к уникальному имени маршрута. Обычно, название функции представления — это и есть конечная точка. Flask может генерировать URL из конечной точки, но об этом позже. Предыдущий код аналогичен следующему:

def index(): return 'Hello World' app.add_url_rule('/', 'index', index) 

Декоратор route используется в большинстве случаев, но у add_url_rule() есть свои преимущества.

Функция представления должна вернуть строку. Если пытаться вернуть что-то другое, сервер ответит ошибкой 500 Internal Sever Error.

Можно создать столько столько, сколько нужно приложению. Например, в следующем списке 3 пути.

@app.route('/') def index(): return 'Home Page' @app.route('/career/') def career(): return 'Career Page' @app.route('/feedback/') def feedback(): return 'Feedback Page' 

Когда URL в маршруте заканчивается завершающим слешем ( / ), Flask перенаправляет запрос без слеша на URL со слешем. Так, запрос к /career будет перенаправлен на /career/ .

Для одной функции представления может быть использовано несколько URL. Например:

@app.route('/contact/') @app.route('/feedback/') def feedback(): return 'Feedback Page' 

В этом случае в ответ на запросы /contact/ или /feedback/ , будет вызвана функция feedback() .

Если перейти по адресу, для которого нет соответствующей функции представления, появится ошибка 404 Not Found.

Эти маршруты статичны. Большая часть современных приложений имеют динамичные URL. Динамичный URL – это адрес, который состоит из одной или нескольких изменяемых частей, влияющих на вывод страницы. Например, при создании веб-приложения со страницами профилей, у каждого пользователя будет уникальный id. Профиль первого пользователя будет на странице /user/1 , второго — на /user/2 и так далее. Очень неудобный способ добиться такого результата — создавать маршруты для каждого пользователя отдельно.

Вместе этого можно отметить динамические части URL как (переменные). Эти части потом будут передавать ключевые слова функции отображения. Следующий код демонстрирует путь с динамическим элементом.

@app.route('/user//') def user_profile(id): return "Profile page of user #<>".format(id) 

В этом примере на месте будет указываться часть URI, которая идет после /user/ . Например, если зайти на /user/100/ , ответ будет следующим.

Profile page of user #100 

Этот элемент не ограничен числовыми id. Адрес может быть /user/cowboy/ , /user/foobar10/ , /user/@@##/ и так далее. Но он не будет работать со следующими URI: /user/ , /user/12/post/ . Можно ограничить маршрут, чтобы он работал только с числовыми id после /user/ . Это делается с помощью конвертера.

По умолчанию динамические части URL передаются в функцию в виде строк. Это можно изменить с помощью конвертера, который указывается перед динамическими элементами URL с помощью . Например, /user// будет работать с адресами /user/1/ , /user/200/ и другими. Но /user/cowboy/ , /user/foobar10/ и /user/@@##/ не подойдут.

В этом списке все конвертеры, доступные во Flask:

Конвертер	Описание
string	принимает любые строки (значение по умолчанию).
int	принимает целые числа.
float	принимает числа с плавающей точкой.
path	принимает полный путь включая слеши и завершающий слеш.
uuid	принимает строки uuid (символьные id).

Запуск сервера

Для запуска сервера разработки нужно использовать метод run() объекта Flask .

if __name__ == "__main__": app.run() 

Условие __name__ == «__main__» гарантирует, что метод run() будет вызван только в том случае, если main.py будет запущен, как основная программа. Если попытаться использовать метод run() при импорте main.py в другой модуль Python, он не вызовется.

Важно: сервер разработки Flask используется исключительно для тестирования, поэтому его производительность невысокая.

Теперь должно быть понятнее, как работает main.py .

Режим отладки (Debug)

Баги неизбежны в программировании. Поэтому так важно знать, как находить ошибки в программе и исправлять их. Во Flask есть мощный интерактивный отладчик, который по умолчанию отключен. Когда он выключен, а в программе обнаруживается ошибка, функция показывает 500 Internal Sever Error. Чтобы увидеть это поведение наглядно, можно специально добавить баг в файл main.py .

from flask import Flask app = Flask(__name__) @app.route('/') def index(): print(i) return 'Hello World' if __name__ == "__main__": app.run() 

В этом случае программа пытается вывести значение неопределенной переменной i, что приводит к ошибке. Если открыть https://127.0.0.1:5000/ , то появится ошибка 500 Internal Sever Error:

Тем не менее сам браузер не сообщает о типе ошибки. Если посмотреть в консоль, то можно увидеть отчет об ошибке. В данном случае он выглядит вот так:

File "/home/gvido/flask_app/env/lib/python3.5/site-packages/flask/app.py", line 1612, in full_dispatch_request rv = self.dispatch_request() File "/home/gvido/flask_app/env/lib/python3.5/site-packages/flask/app.py", line 1598, in dispatch_request return self.view_functions[rule.endpoint](**req.view_args) File "main.py", line 13, in index print(i) NameError: name 'i' is not defined 

Когда режим отладки выключен, после изменения кода нужно каждый раз вручную запускать сервер, чтобы увидеть изменения. Но режим отладки будет перезапускать его после любых изменений в коде.

Чтобы включить режим, нужно передать аргумент debug=True методу run() :

if __name__ == "__main__": app.run(debug=True) 

Еще один способ — указать значение True для атрибута debug .

from flask import Flask app = Flask(__name__) app.debug = True 

После обновления файл main.py следующим образом его можно запускать.

from flask import Flask app = Flask(__name__) @app.route('/') def index(): print(i) return 'Hello World' if __name__ == "__main__": app.run(debug=True) # add debug mode 

Теперь при открытии https://127.0.0.1:5000/ на странице будет отладчик.

Теперь, когда отладчик включен, вместо ошибки 500 Internal Server на странице будет отображаться отчет об ошибке. Он в полной мере описывает, какая ошибка случилась. Внизу страницы видно, что оператор print пытался вывести значение неопределенной переменной i . Там же указан тип ошибки, NameError , что подтверждает то, что ошибка заключается в том, что имя i не определено.

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

При наведении на строчку кода отображается иконка терминала. Нажав на нее, откроется консоль, где можно ввести любой код Python.

В ней можно проверить локальные переменные.

Если консоль открывается первый раз, то нужно ввести PIN-код.

Это мера безопасности, призванная ограничить доступ к консоли неавторизованным пользователям. Посмотреть код можно в консоли при запуске сервера. Он будет указан в начале вывода.

Завершить урок стоит созданием еще одного приложения Flask с применением всех имеющихся знаний.

Создаем еще один файл main2.py со следующим кодом:

from flask import Flask app = Flask(__name__) @app.route('/') def index(): return 'Hello Flask' @app.route('/user//') def user_profile(user_id): return "Profile page of user #<>".format(user_id) @app.route('/books//') def books(genre): return "All Books in <> category".format(genre) if __name__ == "__main__": app.run(debug=True) 

Если запустить файл и зайти на https://127.0.0.1:5000/ , браузер поприветствует выражением «Hello Flask»:

В этой новой версии приложения есть два динамических пути. Если в браузере ввести https://127.0.0.1:5000/user/123/ , откроется страница со следующим содержанием:

Стоит заметить, что путь /user// будет работать только с теми URL, где динамическая часть ( user_id ) представлена числом.

Чтобы проверить второй динамический путь, нужно открыть https://127.0.0.1:5000/books/sci-fi/ . В этот раз получится следующее:

Если сейчас попробовать открыть URL, который не определен в путях, выйдет ошибка 404 Not Found. Например, такой ответ получите при попытке перейти на https://127.0.0.1:5000/products .

Как Flask обрабатывает запрос?

Откуда Flask знает, какую функцию выводить, когда он получает запрос от клиента?

Flask сопоставляет URL и функции отображения, которые будут выводиться. Определение соответствий (маршрутизация) создается с помощью декоратора route или метода add_url_rule() в экземпляре Flask. Получить доступ к этим соответствиям можно с помощью атрибута url_map у экземпляра Flask .

>>> >>> from main2 import app >>> app.url_map Map([Rule '/' (OPTIONS, GET, HEAD) -> index>, Rule '/static/' (OPTIONS, GET, HEAD) -> static>, Rule '/books/' (OPTIONS, GET, HEAD) -> books>, Rule '/user/' (OPTIONS, GET, HEAD) -> user_profile>]) >>> 

Как видно, есть 4 правила. Flask определяет соответствия URL в следующем формате:

url pattern, (comma separated list of HTTP methods handled by the route) -> view function to execute 

Путь /static/ автоматически добавляется для статических файлов Flask. О работе со статическими файлами речь пойдет в отдельном уроке «Обслуживание статических файлов во Flask».

• ТЕГИ
• Flask
• Уроки по Flask на русском

Декоратор @route() и метод add_url_rule() приложения Flask Python

Декоратор @app.route() и метод app.add_url_rule() регистрируют URL-адрес, по которому будет доступно соответствующее представление и вызываются экземпляром приложения app фреймворка Flask.

Содержание:

• Декоратор экземпляра приложения @app.route() .
• Метод экземпляра приложения app.add_url_rule() .
• Список аргументов @app.route() и app.add_url_rule() .

@app.route(rule, **options) :

Декоратор @app.route() регистрирует URL-адрес, по которому будет доступно соответствующее представление (расположенное под декоратором), а так же правила маршрутизации входящих запросов. Этот декоратор вызывает метод app.add_url_rule() , реализация которого рассматривается более подробно.

@app.route("/") def index(): return "Hello, World!" 

Правила маршрутизации входящих запросов (переменные части маршрута) указанные в угловых скобках передаются в соответствующую функцию-представление в качестве аргументов.

@app.route("`//`") def user(user, username): return f"Hello, username>! ID-user: user>" 

Если аргумент endpoint не определен, то по умолчанию в качестве имени конечной точки для маршрута используется имя функции-представления.

Подробное описание аргументов, которые принимает декоратор @app.route() смотрите ниже.

Декоратор @app.route() вызывается экземпляром приложения фреймворка Flask.

app.add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options) :

Метод app.add_url_rule() регистрирует URL-адрес, по которому будет доступно соответствующее представление, а так же правила маршрутизации входящих запросов. Декоратор @app.route() — это ссылка для вызова этого метода с аргументом view_func (функция-представление). Они эквивалентны:

@app.route("/") def index(): . # эквивалентно def index(): . app.add_url_rule("/", view_func=index) 

Правила маршрутизации входящих запросов (переменные части маршрута), указанные в угловых скобках, передаются в соответствующую функцию-представление в качестве аргументов.

def index(id): . app.add_url_rule("/user/", view_func=index) 

Если аргумент endpoint не передан, то по умолчанию, в качестве имени конечной точки маршрута используется имя функции-представления. Если функция-представление уже была зарегистрирована для конечной точки, то будет вызвана ошибка.

По умолчанию для аргумента methods установлено значение [‘GET’] . HTTP-метод HEAD всегда добавляется автоматически, а HTTP-метод OPTIONS добавлен в настройках по умолчанию.

Аргумент view_func не всегда нужно передавать, но если правило участвует в маршрутизации, то имя конечной точки endpoint должно быть связано с функцией-представлением декоратором @app.endpoint() .

app.add_url_rule("/", endpoint="index") @app.endpoint("index") def index(): . 

Если функция-представления имеет атрибут required_methods , то HTTP-методы, указанные в этом атрибуте, добавляются к переданным в app.add_url_rule() HTTP-методам. Если у функции-представления есть атрибут provide_automatic_options , то он используется по умолчанию, если одноименный аргумент не определен.

def index(): if request.method == 'OPTIONS': # обработка запроса . return 'Hello World!' # присваиваем атрибуты функции-представлению index.provide_automatic_options = False index.methods = ['GET', 'OPTIONS'] # атрибуты функции `index()` передаются # в качестве аргументов app.add_url_rule('/', index) 

Подробнее об атрибутах, которые может иметь функция-представление, смотрите в материале «Представления в веб-приложении на Flask».

Список аргументов декоратора @app.route() и метода app.add_url_rule() .

Ниже приведены аргументы, которые принимают декоратор @app.route() и метод app.add_url_rule() . Единственное отличие состоит в том, что аргумент view_func в декораторе @app.route() отсутствует, так как за декоратором следует функция-представление, которая и заменяет этот аргумент.

• rule : правило URL-адреса в виде строки;
• endpoint : конечная точка для зарегистрированного правила URL-адреса. Сам Flask предполагает, что имя функции-представления является именем конечной точки, если явно она не задана;
• view_func : функция, вызываемая при обслуживании запроса к предоставленной конечной точке. Если это не предусмотрено, то можно указать функцию позже, сохранив ее в словаре view_functions с конечной точкой в качестве ключа.
• defaults : словарь с настройками по умолчанию для этого правила.

@app.route('/users/', defaults='page': 1>) @app.route('/users/page/') def show_users(page): pass 

from flask import Flask app = Flask(__name__, subdomain_matching=True) app.config['SERVER_NAME'] = "example.com" @app.route("/") def index(): return "example.com" @app.route("/", subdomain="") def sub_index(subdomain): return f'subdomain>.example.com' 

• methods=[‘GET’] : это список методов, которым должен быть ограничен маршрут ( GET , POST и т. д.). По умолчанию правило просто прослушивает GET (и неявно HEAD ). Начиная с Flask 0.6, OPTIONS неявно добавляются и обрабатываются стандартными запросами.
• redirect_to : если задано, то это должно быть либо строка URL, либо вызываемая функция-представление. В случае вызываемого объекта, он вызывается с адаптером URL, который инициировал сопоставление, и значениями URL в качестве ключевых аргументов и должны возвращать цель для перенаправления, в противном случае это должна быть строка маршрута:

# Функция, которая генерирует новые URL-адреса def foo_with_slug(adapter, id): # запросить в базе данных `id` для старого идентификатора. return f'foo/Foo.get_slug_for_id(id)>' @blueprint.route('/foo/') def all(page): . # правила перенаправлений на новые URL-адреса app.add_url_rule('/some/old/url/', redirect_to='foo/') app.add_url_rule('/other/old/url/', redirect_to=foo_with_slug) 

• КРАТКИЙ ОБЗОР МАТЕРИАЛА.
• Пример структуры приложения Flask как пакета Python
• Модульные приложения на схемах blueprint во Flask Python
• Фабрика веб-приложений модуля Flask
• Представления в веб-приложении на Flask Python
• Правила составления URL-маршрутов во Flask Python
• Использование шаблонизатора Jinja2 в приложении Flask Python
• Пользовательские страницы HTTP-ошибок на Flask Python
• Выполнение кода до или после запроса во Flask Python
• Загрузка файлов на сервер во Flask Python
• Всплывающие сообщения в приложении на Flask Python
• Извлечение данных из запроса во Flask Python
• Хранение и загрузка конфигураций Flask
• Параметры/ключи конфигурации, используемые во Flask
• Папки экземпляров приложений на Flask
• Контекст веб-приложения на Flask
• Контекст запроса приложения на Flask
• Ведение журнала логов в приложении Flask Python
• Собственные декораторы в приложении Flask Python
• Класс Config() модуля flask
• Функция redirect модуля flask
• Функция url_for() модуля flask
• Прокси-объект current_app() модуля flask
• Функция abort() модуля flask
• Отладочные сигналы приложения Flask
• Работа с cookie в приложении на Flask Python
• Безопасность веб-приложения на Flask
• Асинхронность в веб-приложении на Flask
• Использование URL-процессора в приложениях на Flask Python
• Диспетчеризация приложений на Flask
• Функция make_response модуля flask
• Доступность контекстов запроса/приложения во Flask Python
• Декоратор @route() и метод add_url_rule() приложения Flask Python
• Функция send_file() модуля flask
• Функция send_from_directory() модуля flask
• Как обслуживать статические файлы в Flask Python
• Функция render_template() модуля flask
• Класс Markup() модуля flask
• Отложенная загрузка представлений в приложении Flask Python
• Сессии/сеансы sessions модуля flask
• Глобальный объект flask.g в приложении Flask Python
• Класс Request() модуля flask
• Класс Response() модуля flask
• Класс Flask() модуля flask
• Тестирование приложений на Flask
• Использование SQLite 3 в приложении Flask Python
• Генерация своей капчи на сайте Flask
• Использование модуля WTForms в приложении Flask Python
• Расширение Flask-Caching для приложения Flask
• Расширение Flask-Assets, управление статикой приложения
• Расширение Flask-WTF для приложения Flask
• Расширение Flask-SQLAlchemy для приложения Flask
• Расширение Flask-Paginate для приложения Flask
• Расширение Flask-Mail для приложения Flask
• Расширение Flask-APScheduler
• Связка Nginx + Gunicorn + Gevent + Flask Python
• Как передать переменную NGINX во Flask environ
• Защита приложения/сайта от DDoS атак

Что такое Flask и как на нем быстро написать простой сайт

Рассказываем про один из самых популярных и лаконичных микрофреймворков для Python — Flask. Как написать простое приложение, подключить к нему Bootstrap и базу данных, и есть ли вообще у Flask минусы.

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

Первая публичная версия Flask вышла 16 апреля 2010 года. Автор проекта — Армин Ронахер , который возглавлял команду энтузиастов в Python-разработке Poocco. Flask основан на быстром и расширяемом механизме шаблонов Jinja и наборе инструментов Werkzeug. Кроме того, Flask использует одну из самых передовых служебных библиотек WSGI (Web Server Gateway Interface — стандарт взаимодействия между Python-программой, выполняющейся на стороне сервера, и самим веб-сервером).

При этом WSGI тоже разработал Армин Ронахер. По его словам, идея Flask изначально была первоапрельской шуткой, которая стала популярной и превратилась в серьезное приложение.

Изучите Python на Хекслете Пройдите нашу профессию «Python-разработчик», чтобы поменять свою жизнь и стать бэкенд-программистом.

Плюсы и минусы Flask

Практически все плюсы и минусы Flask появились именно из-за того, что он является микрофреймворком.

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

При этом у Flask есть и свои недостатки:

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

То есть Flask можно удобно использовать в небольших проектах — он идеален для макетирования идей и быстрого прототипирования. При этом его редко используют в крупных проектах, и он плохо подходит для асинхронного программирования.

Как создать проект на Flask

Для начала работы с микрофреймворком нужно скачать последнюю версию Flask:

pip install Flask

Для примера мы напишем на Flask тестовое веб-приложение с минимальным функционалом. Как работают приложения такого типа:

• Пользователь вводит в браузере url, например — hexlet.io. В нашем тестовом приложении пользователь не будет вводить url, потому что мы будем работать с локальным сервером по адресу http://127.0.0.1:5000 .
• Браузер получает у DNS IP-адрес нужного нам сервера. DNS — это Domain Name System, распределенная системе серверов. Она работает как общая «контактная книга» в интернете.
• Браузер отправляет запрос по этому адресу и получает ответ. Как правило — в виде HTML-страницы.
• Браузер отображает содержимое страницы.

Итак, создадим файл hello.py и запишем в него следующий код:

from flask import Flask app = Flask(__name__) @app.route('/') def index() -> str: return '
Hello Flask!
' if __name__ == '__main__': app.run(debug=True) 

Давайте подробно разберем, что делает код, который мы написали.

Первой строкой мы импортируем класс Flask . После этого мы создаем объект этого класса, передав первым аргументом имя модуля, — это и будет наше приложение для общения с веб-cервером. __name__ — это удобный способ передать именно то приложение, из которого запущен Flask.

Декоратор route() сообщает Flask, при обращении к какому URL-адресу запустится декорируемая разработчиком функция — в нашем примере это index . Последней строчкой мы открываем локальный веб-сервер с параметром debug=True — это позволит следить за всеми ошибками в логе программы.

Читайте также: Программирование на Python: особенности обучения, перспективы, ситуация на рынке труда

Запускаем веб-приложение через терминал:

Если мы все сделали правильно, то в терминале появятся эти сообщения:

В основном тут отображается служебная информация. Единственное, что нас интересует — сообщение, что наш локальный сервер запущен по адресу http://127.0.0.1:5000/ . В нем красными буквами указывается, что локальный сервер не подходит для продакшена. Но, так как мы реализовали тестовое приложение, то не будем деплоить его на реальный сервер.

Вернемся к коду. С помощью переменной части маршрута Flask может передавать в функцию аргументы.

from flask import Flask app = Flask(__name__) @app.route('/') def index(): greet_with_link = """
Привет, Мир!
 
Нажми на меня
""" return greet_with_link @app.route('/user//') def get_user(name, surname): personal_instruc = f"""
Привет, surname> name>!
 
Измени имя пользователя в адресной строке и перезагрузи страницу
""" return personal_instruc if __name__ == '__main__': app.run(debug=True) 

В нашем примере значения просто появятся в браузере как часть строки. На стартовой странице нашего сайта будет запускаться функция index() . В ней пользователю, помимо приветствия, будет предлагаться нажать на ссылку, при клике на которую он перейдет на user/Аникин/Георгий . Этот URL-маршрут будет обрабатываться уже функцией get_user .

Функция get_user декорируется @app.route(‘//’) , а в адресной строке у нас /user/Аникин/Георгий . То есть наша функция получает аргументы из URL-адреса, эти значения лежат между косых скобок. По умолчанию тип таких значений string принимает любой текст без косой черты. Но переменные маршрутов могут быть и иных типов: int , float , path и других. Типы указываются в формате .

Структура приложения на Flask

Создадим подкаталог flask_app с такой структурой файлов и папок:

Чтобы написать приложение сложнее одной строки, в директории проекта должны находиться папки static и templates . Директория static содержит ресурсы, которые используются шаблонами. В том числе включая файлы CSS, JavaScript и картинки. Папка templates содержит только шаблоны с расширением *.html .

Заполним наши файлы кодом. Сначала — наш основной файл проекта app.py :

from flask import Flask, render_template app = Flask(__name__) @app.route("/") def index(): return render_template("index.html") @app.route("/about") def get_page_about(): return render_template("about.html") if __name__ == "__main__": app.run(debug=True) 

После этого — index.html :

    Main page   Главная страница   

И файл about.html :

    About   О приложении   

Для отображения HTML-шаблонов мы используем функцию render_template() . В нашем коде она принимает только имя шаблона и возвращает строку с результатом рендеринга шаблона.

Однако render_template() может принимать неограниченное количество именованных аргументов, которые можно использовать в этом шаблоне. Это позволит решить проблему нашего тестового проекта — сейчас у нас две функции, две страницы, и очень много дублированного кода.

Напишем базовый шаблон base.html и пару его наследников. При этом блоки … — это части базового шаблона, которые можно заменить в наследнике. Переменные передаются по именам в конструкции > .

    Приложение Flask  >   

После появления файла с базовым HTML-шаблоном можем поправить наши остальные HTML-файлы:

 About index.html: Main page

Кроме того, нужно поправить и основной файл Flask-проекта app.py :

from flask import Flask, render_template app = Flask(__name__) @app.route("/") def index(): return render_template("index.html", h1 = "Главная страница") @app.route("/about") def get_page_about(): return render_template("about.html", h1 = "О приложении") if __name__ == "__main__": app.run(debug=True) 

Подключаем Bootstrap

Bootstrap — это открытый и бесплатный набор инструментов для создания сайтов и веб-приложений.

В нашем проекте в папке templates у нас есть подкаталог bootstrap , а в нем файл base.html — это немного модифицированная заготовка сайта-документации Bootstrap-Flask:

  lang="en">    charset="utf-8">  name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">  >  Приложение Flask    class="jumbotron text-center"> >    > 

В файлах index.html и about.html заменим строку наследования на:

Второй путь подключения Bootstrap к проекту на Flask — через CDN. Подробнее об этом можно почитать в документации фреймворка .

Читайте также: Как создатель Python Гвидо ван Россум устроился в Microsoft и теперь работает над развитием CPython

После подключения Bootstrap нужно будет немного поправить основной файл нашего проекта app.py :

from flask_bootstrap import Bootstrap4 from flask import Flask, render_template app = Flask(__name__) bootstrap = Bootstrap4(app) @app.route("/") def index(): return render_template("index.html", h1 = "Главная страница") @app.route("/about") def get_page_about(): return render_template("about.html", h1 = "О приложении") if __name__ == "__main__": app.run(debug=True) 

Последним элементом нашего веб-приложения будет форма отправки. Для этого нужно немного модифицировать index.html :

 Main page  >  class="container text-center">  class="d-inline-block" style="max-width: 33%;">  class="form-group">  for="eventDate">Дата  type="date" name="eventDate" class="form-control" placeholder="Дата события">   class="form-group">  for="eventName">Событие  type="text" name="eventName" class="form-control" placeholder="Название события">   class="form-group">  for="eventDuration">Продолжительность  type="number" name="eventDuration" class="form-control" placeholder="Продолжительность" min="1" max="24">   type="submit" class="btn btn-primary">Записать   

Вообще, Bootstrap может добавить огромное количество элементов в приложение буквально в несколько кликов. Мы ограничились четырьмя — три поля и одна кнопка. Ключевой элемент здесь — это > .

Подключаем базу данных

Итак, у нас есть форма отправки, но она пока ничего не делает с данными. Для нас было бы неплохо хранить, обрабатывать и в будущем легко извлекать данные этих форм. Обычно такие задачи решают с помощью реляционных баз данных (далее БД).

Есть большое количество способов работы с SQL-запросами во Flask. Мы можем использовать, например, sqlite3 и чистый SQL, а можем — библиотеку sqlite3 для Python. Кроме того, можно обернуть чистые SQL-запросы в код, либо использовать Psycopg2 для работы с PostgresSQL в Python (мы рекомендуем делать именно так и вот почему). Для примера в этом тексте мы используем библиотеку Flask SQLAlchemy (расширение для Flask), которая предлагает технологию ORM для взаимодействия с БД.

Подключаем базу данных к нашему проекту через файл app.py :

from datetime import datetime from flask import Flask, redirect, render_template, request from flask_bootstrap import Bootstrap4 from flask_sqlalchemy import SQLAlchemy app = Flask(__name__) bootstrap = Bootstrap4(app) app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///events.db' app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False db = SQLAlchemy(app) class Event(db.Model): id = db.Column(db.Integer, primary_key=True) date = db.Column(db.Date, nullable=False) name = db.Column(db.String(255), nullable=False) duration = db.Column(db.Integer, nullable=False) def __str__(self): return ( f"Название: self.name>\n" f"Дата: self.date>\n" f"Продолжительность self.duration>ч" ) @app.route('/', methods=['POST']) def add_event(): date = datetime.strptime(request.form['eventDate'], '%Y-%m-%d').date() name = request.form['eventName'] duration = int(request.form['eventDuration']) print(date, name, duration, sep='\n') event = Event(date=date, name=name, duration=duration) db.session.add(event) db.session.commit() return redirect('/') @app.route("/") def index(): return render_template("index.html", h1 = "Главная страница") @app.route("/about") def get_page_about(): return render_template("about.html", h1 = "О приложении") if __name__ == "__main__": with app.app_context(): db.create_all() app.run(debug=True) 

В нашей БД появился класс Event c атрибутами, который наследуется от db.Model . Это позволяет с помощью SQLAlchemy создать таблицу event , а поля нашего класса сделать колонками этой таблицы. Кроме того, мы определили магический метод __str__ для строкового отображения экземпляров класса — это пригодится для отображения в HTML.

Для создания таблицы в блок if __name__ == ‘__main__’ мы добавили команду db.create_all() , а для обработки отправленной формы — метод add_event . Он работает с методом POST , который указывает Flask, что данные будут отправлены на сервер.

В методе POST мы считываем данные отправленной формы и создаем для каждой строки временную переменную. После этого мы создаем объект event класса Event , передаем наши временные переменные как именованные аргументы, добавляем event в БД и фиксируем изменения.

Нам осталось лишь немного поправить форму: в файле index.html в открывающем теге добавим атрибуты action=»>» method=»POST» . Теперь форма отправки по нажатию на кнопку «Записать» будет отправлять данные в базу данных.

Добавим страницу отображения наших записей в новый файл Events.html :

 Events  >  class="container text-center">  href=">"> Добавить событие    class="mt-4">  class="list-group">  class="list-group-item"> >   

В файл app.py добавим view :

@app.route("/events") def view_events(): events = Event.query.order_by(Event.date).all() return render_template("events.html", h1 = "События", events=events) 

А в основном контейнере index.html добавим ссылку на эту страницу:

Наш тестовый проект на Flask готов! Его можно запустить на локальном сервере через команду python app.py (в некоторых случаях надо будет написать название директории перед названием файла app.py ).

Что еще почитать про Flask

• Большой курс по Flask на Хекслете
• Документация Flask
• Цикл статей на Real Python
• Проектирование RESTful API с помощью Python и Flask

Изучите Python на Хекслете Пройдите нашу профессию «Python-разработчик», чтобы поменять свою жизнь и стать бэкенд-программистом.