Flask: различия между версиями

= Вводное слово =

Одним из проектных решений во Flask является то, что простые задачи должны быть простыми; они не должны занимать много кода, и это не должно ограничивать вас. Поэтому мы сделали несколько вариантов дизайна, некоторые люди могут посчитать это удивительным и не общепринятым. Например, Flask использует локальные треды внутри объектов, так что вы не должны передавать объекты в пределах одного запроса от функции к функции, оставаясь в безопасном треде. Хотя это очень простой подход и позволяет сэкономить много времени, это также может вызвать некоторые проблемы для очень больших приложений, поскольку изменения в этих локальных тредах-объектов может произойти где угодно в том же треде. Для того, чтобы решить эти проблемы, мы не скрываем от вас локальные треды-объекты, вместо этого охватываем их и предоставляем вам много инструментов, чтобы сделать работу с ними настолько приятным насколько это возможно.

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

 

== Безопасность ==

 

== Статус насчет Python 3 ==

 

= Установка =

== Под Windows ==

<code>C:\Python27\python.exe C:\Python27\Scripts\easy_install-2.7-script.py Virtualenv</code>

== Установка под Mac OSx ==

 

= Краткая документация =

== Простейший Hello world ==

Создадим файл hello.py следующего содержания:

</source>

 

Наберите в браузере в адресной строке http://localhost:5000/ и увидите надпись Hello World!

 

 

== Разбор программы Hello world! ==

# Сначала мы импортируем Flask класс. Экземпляр этого класса будет нашим WSGI приложением. Первым аргументом является имя модуля приложения. Если вы используете один модуль (как в данном примере), вы должны использовать __name__, потому что в зависимости от того, было ли это начато как приложение или как импорт модуля, название будет другим ('__main__' по сравнению с реальным именем импорта).

# Далее мы создаем экземпляр этого класса. Мы передаем ему имя модуля или пакета. Это необходимо, так как Flask не знает, где искать шаблоны, статические файлы, и так далее.

# Затем мы используем route(). Декоратор говорит Flask, что URL должен вызывать нашу функцию.

# Функция задает имя, которое также используется для создания URL-адресов для этой функции, и возвращает сообщение, что мы хотим отобразить в браузере пользователя.

 

== Общедоступный сервер ==

 

Это говорит вашей операционной системе слушать все ip.

== Режим отладки ==

<code>app.debug = True<br>

Оба метода дадут одинаковый эффект

 

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

 

== Маршрутизация ==

Как вы видели выше, декоратор route() используется для связывания функций с URL. Вот несколько основных примеров:

<source lang="python">

 

=== Уникальные линки и редирект ===

Используйте два правила:

<source lang="python">

return 'The project page'

</source>

<source lang="python">

@app.route('/about')

return 'The about page'

</source>

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

 

Здесь также используется метод test_request_context(), который объяснен ниже. Он говорит Flask, как нужно обрабатывать запрос, даже если мы взаимодействуем через шел Python. Почему мы используем построение URL вместо их жесткого задания в шаблонах? На то есть три хорошие причины:

* Реверсирование, зачастую является более описательным методом и позволяет изменять URL на одном дыхании.

* Если ваше приложение находится вне корневой URL (например, /myapplication вместо /), функция url_for () будет это правильно обрабатывать для вас.

 

show_the_login_form()

</source>

Если вы ничего не знаете про HTTP методы, приводим небольшую справку:

Браузер сообщает серверу, что желает получить информацию со страницы и просит отправить ее. Возможно, это самый распространенный метод.

Браузер сообщает серверу, что желает получить информацию, но интересуется только заголовком, а не содержанием страницы. Приложение допускает запрос, в случае если GET был получен.

Браузер сообщает серверу, что хочет запостить новую информацию по данному URL и сервер должен быть уверен, что сохранит ее и сделает один раз. Так обычно передается информация из HTML форм на сервер.

Быстрый способ для клиента выяснить какой из методов поддерживается по данному URL. Начиная с Flask 0.6 эта возможность имплементирована автоматически.

 

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

Для генерации адресов для статических файлов, используйте специальное имя 'static':

<source lang="python">

 

== Рендеринг шаблонов ==

<source lang="python">

from flask import render_template

return render_template('hello.html', name=name)

</source>

Случай с модулем:

<source lang="python">

</source>

 

<source lang="python">

/application

{% endif %}

</source>

Включено автоматическое экранирование, что позволит избежать проблем, если имя содержит HTML-теги. Если доверяете переменной, а вы знаете, что это будет безопасно в HTML (например, потому что оно пришло от модуля, который преобразует вики-разметки в HTML), вы можете пометить его как безопасный с помощью Markup класса или с помощью |safe фильтра в шаблоне. В документации Jinja 2 представлено несколько примеров.

Вот пример, как работает класс разметки:

<source lang="python">

 

== Доступ к данным запроса ==

=== Локальные контексты (Context Locals) ===

'''Инсайдерская информация'''

прочитайте этот раздел, в противном случае, пропустите его.

 

Итак, что же это значит для вас? В принципе, пока вы тестируете, вы можете полностью это игнорировать. Но вы можете заметить, что код, который зависит от объекта запроса может внезапно сломаться, потому что нет объекта запроса. Решением является создание объекта запроса для себя и привязка его к контексту. Самое простое решение для тестирования, это использование контекст менеджера test_request_context() В сочетании с постановкой, он свяжет тестовый запрос, так что вы можете взаимодействовать с ним. Вот пример:

<source lang="python">

 

=== Загрузка файла ===

Загруженные файлы сохраняются в память сервера или во временное хранилище в файловой системе. Вы можете получить доступ к этим файлам через атрибут <code>files</code> в объекте запроса. Каждый загруженный файл хранится в этом словаре. Он ведет себя так же, как стандартный объект <code>file</code> в Python, но имеет метод save(), который позволяет сохранить этот файл в файловую систему сервера. Вот простой пример, показывающий, как это работает:

<source lang="python">

 

=== Cookies ===

Чтение кукис:

<source lang="python">

this_is_never_executed()

</source>

По умолчанию черно-белые страницы ошибок показываются в каждом коде ошибок. Если вы хотите настроить страницу ошибки, вы можете использовать декоратор <code>errorhandler()</code>

<source lang="python">

 

== Об ответах ==

# Если объект-ответ возвращает правильный тип, то это есть прямое возвращение непосредственно от обозревающей функции.

# Если это строка, объект-ответ создается с этими данными и параметрами по умолчанию.

return resp

</source>

== Сессии ==

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

app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'

</source>

Самый простой и наиболее доступный способ, сделать это на основе генератора псевдослучайных чисел.

<source lang="python">

</source>

Небольшое замечание о кукисах основанных на базе сессий: Flask примет значение, положит в объект-сессию и сериализует их в кукисы. Если вы обнаружили, что некоторые значения не сохранились между запросами, то учтите, что кукисы на самом деле активны, и вы не получите четкое сообщение об ошибке, поэтому проверяйте размер куки в ваших ответах на странице по сравнению с размером, который поддерживается веб-браузерами.

== Фидбэк, система флэшинга ==

Примеры использования можете посмотреть [http://flask.pocoo.org/docs/patterns/flashing/#message-flashing-pattern здесь]

 

== Логирование ==

Если вы хотите видеть, что произошло что-то подозрительное, используйте логирование.

<source lang="python">

</source>

[http://docs.python.org/library/logging.html Здесь можете ознакомится с документацией по логированию.]

== Подключение WSGI Middlewares ==

Если вы хотите добавить WSGI middleware в ваше приложение, вы можете обернуть его внутри WSGI приложения. Например, если вы хотите добавить middleware от Werkzeug в работе, чтобы обойти ошибки в lighttpd, вы можете сделать это следующим образом:

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

# Страница отображает все записи в обратном порядке (новые сверху), и пользователь может добавлять новые записи из формы вверху, если он залогинился.

[[Файл:Flaskr.png]]

== Шаг 0: Создание каталогов ==

Вначале создадим каталоги, необходимые Вашему приложению:

</source> с именем <code>schema.sql</code> в только что созданный каталог <code>flaskr</code>.

 

 

== Шаг 2: Установочный код приложения ==

</source>

 

 

Секретный ключ (<code>SECRET_KEY</code>) необходим для безопасности клиентских сессий. Вдумчиво выбирайте ключевые слова: они должны быть настолько сложными, насколько это возможно.

Флаг отладки (<code>DEBUG</code>) включает или выключает интерактивный отладчик. Никогда не оставляйте режим отладки активным на производственном сервере, это позволит пользователям выполнять код на нём!

 

<source lang="python">

def connect_db():

app.run()

</source>

 

== Шаг 3: Создание базы данных ==

 

 

Такая схема может быть создана передачей файла <code>schema.sql</code> в <code>sqlite3</code>:

<source lang="bash">sqlite3 /tmp/flaskr.db < schema.sql</source>

 

 

Желая поступить так, сначала Вы должны импортировать функцию <code>contextlib.closing()</code> из пакета <code>contextlib</code>. При использовании Python 2.5 необходимо импортировать <code>with_statement</code> из пакета <code>__future__</code> (импорт из <code>__future__</code> всегда должен быть первым в списке):

</source>

 

<source lang="python">

def init_db():

</source>

 

 

Соединяясь с базой данных, получаем объект связи (называемый <code>db</code>), предоставляющий нам курсор <code>cursor</code> с методом для выполнения всего сценария. В конце нужно подтвердить (<code>commit</code>) изменения. SQLite3 и другие транзакционные базы данных не подтверждают операций без Вашего особого распоряжения.

 

=== Поиск и устранение неисправностей ===

 

== Шаг 4: Запрос подключения к базе данных ==

;Где поместить этот код?

 

 

== Шаг 5: Функции представления ==

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

=== Вывод записей ===

Эта обзорная функция пропускает записи через словари в шаблоне show_entries.html и возвращает обработанное значение:

<source lang="python">

</source>

 

 

'''Замечание о безопасности:'''

убедитесь, что вы используете знаки вопроса (?) при составлении SQL-запроса, аналогично примеру выше. Если при составлении запроса вы используете форматированные строки, ваше приложение может быть уязвимо к атакам типа sql-injection. См. [http://flask.pocoo.org/docs/patterns/sqlite3/#sqlite3 Using SQLite 3 with Flask ]

 

<source lang="python">

@app.route('/login', methods=['GET', 'POST'])

</source>

 

<source lang="python">

@app.route('/logout')

 

= Ссылки =

http://groups.google.com/group/flask-russian - русскоязычная группа обсуждения Flask