Webové aplikace: Flask

Python je víceúčelový jazyk. Na minulém cvičení jsme tvořili aplikace pro příkazovou řádku, nyní se podíváme na aplikace webové.

Webových frameworků pro Python je více, mezi nejznámější patří Django, Flask nebo Pyramid.

Pro naše účely použijeme Flask, protože je nejrychlejší na pochopení a nevyžaduje striktně použití MVC paradigmatu.

Flask

Flask opět můžete nainstalovat do virtualenvu, nejlépe použít projekt z minulého cvičení:

$ cd project
$ . __venv__/bin/activate 
(__venv__) $ python -m pip install Flask

Základní použití Flasku je poměrně primitivní. Do souboru hello.py napište:

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello():
    return 'MI-PYT je nejlepší předmět na FITu!'

Pak aplikaci spusťte pomocí následujících příkazů. (Na Windows použijte místo export příkaz set.)

(__venv__) $ export FLASK_APP=hello.py
(__venv__) $ export FLASK_DEBUG=1
(__venv__) $ flask run
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger pin code: 189-972-345

Na zmíněné adrese byste měli v prohlížeči vidět použitý text.

Proměnná prostředí FLASK_APP říká Flasku, kde aplikaci najít. V daném souboru Flask hledá automaticky proměnnou jménem app. (Jde nastavit i jiná.)

Proměnná FLASK_DEBUG říká, že se aplikace má spustit v ladícím režimu: je zapnutý příjemnější výpis chyb a aplikace se automaticky restartuje po změnách. Tento mód je užitečný, ale nebezpečný – návštěvníkům stránky může umožnit spustit jakýkoli Pythonní kód. Navíc aplikaci zpomaluje. Používejte ho proto pouze na svém počítači.

V příkladu jsme vytvořili flaskovou aplikaci (app). Argument __name__ je jméno modulu – Flask podle něj hledá soubory, které k aplikaci patří (viz static a templates níže).

Pomocí dekorátoru @app.route jsme vytvořili takzvanou routu (cestu). Říkáme tím, že na adrese / bude k dispozici obsah, který vrátí definovaná funkce. Více různých cest lze vytvořit jednoduše přidáním další funkce.

@app.route('/')
def index():
    return 'Index Page'

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

Na adrese http://127.0.0.1:5000/hello pak uvidíte druhou stránku.

Dynamické routy

Když vytváříte dynamický web, ne vždy můžete všechna URL znát dopředu. Pokud například chcete zobrazit informace o uživatelích na adrese /user/hroncok apod., musíte použít dynamické routy:

@app.route('/user/<username>')
def profile(username):
    return 'User {}'.format(username)

Proměnnou část cesty ohraničíte lomenými závorkami a použijte jako parametr funkce. Pokud chcete, můžete specifikovat, na jaký obsah se pravidlo vztahuje:

@app.route('/post/<int:post_id>')

Můžete použít různá pravidla, např.:

Získání URL

Opačným způsobem jak k routám přistupovat je, když potřebujete získat URL nějaké stránky, například protože potřebujete zobrazit odkaz. K tomu se používá funkce url_for(), která jako první parametr bere jméno routy (neboli jméno funkce, která routu obsluhuje):

from flask import url_for
...
url_for('profile', username='hroncok')

Tuto funkci jde použít jen uvnitř funkce obsluhující cestu, pokud ji chcete vyzkoušet například v interaktivní konzoli, můžete použít speciální kontext manager:

>>> with app.test_request_context():
...     print(url_for('profile', username='hroncok'))
... 
/user/hroncok

Možná si říkáte, proč tu URL prostě nevytvořit ručně, ale mohli byste narazit na problém, pokud cestu později změníte – což se může stát např. i když web nasadíte na jiný server.

Šablony

Zatím jsou naše webové stránky poměrně nudné, protože nepoužívají HTML. Klidně byste mohli udělat něco jako:

@app.route('/')
def hello():
    return '<html><head><title>...'

...ale asi by to nebylo příliš příjemné. Lepší je použít šablony:

from flask import render_template

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

Pak je třeba vedle souboru vytvořit složku templates a v ní hello.html:

<!doctype html>
<html>
    <head>
        <title>Hello from Flask</title>
    </head>
    <body>
        {% if name %}
        <h1>Hello {{ name }}!</h1>
        <a href=" {{ url_for('hello') }} ">Go back home</a>
        {% else %}
        <h1>Hello, World!</h1>
        {% endif %}
    </body>
</html>

Šablony používají v Pythonu velmi oblíbený šablonovací jazyk Jinja2. Kompletní popis jazyka najdete v dokumentaci, ale pro většinu stránek se obejdete s {% if %} a {{ promenna }} jako výše, případně s {% for %}/{% endfor %}.

Veškerý kontext (proměnné) do šablony musí přijít z volání render_template(), navíc můžete automaticky použít např. funkci url_for().

Filtry

Není úplně elegantní vzít nějaká data (např. tweety z Twitter API) a ještě před předáním šabloně do nich cpát svoje úpravy (např. HTML). Od toho jsou tu filtry. Filtr transformuje hodnotu na řetězec, který pak ukážeme uživateli.

Zde je například filtr time, který načte čas v určitém formátu a převede ho do jiného:

from datetime import datetime

@app.template_filter('time')
def convert_time(text):
    """Convert the time format to a different one"""
    dt = datetime.strptime(text, '%a %b %d %H:%M:%S %z %Y')
    return dt.strftime('%c')

@app.route('/date_example')
def date_example():
    return render_template(
        'date_example.html',
        created_at='Tue Mar 21 15:50:59 +0000 2017',
    )

V šabloně date_example.html:

{{ created_at|time }}

Escaping

V textu, který se vkládá do šablon, jsou automaticky nahrazeny znaky, které mají v HTML speciální význam. Zabraňuje se tak bezpečnostním rizikům, kdy se vstup od uživatele interpretuje jako HTML.

Například když v aplikaci výše navštívíme URL /hello/<script>alert("Foo"), bude výsledné HTML vypadat takto:

<!doctype html>
<title>Hello from Flask</title>

  <h1>Hello &lt;script&gt;alert(&#34;Foo&#34;)!</h1>

Někdy je ovšem potřeba do stránky opravdu vložit HTML. To se dá zajistit dvěma způsoby. Nejjednodušší je vestavěný filtr safe:

{{ "<em>Text</em>" | safe }}

Z Pythonu pak lze použít jinja2.Markup, čímž se daný text označí jako „bezpečný”.

import jinja2

@app.template_filter('time')
def convert_time(text):
    """Convert the time format to a different one"""
    dt = datetime.strptime(text, '%a %b %d %H:%M:%S %z %Y')
    result = dt.strftime('<strong>%c</strong>')
    return jinja2.Markup(result)

Statické soubory

Pokud budete potřebovat nějaké statické soubory (např. css soubory nebo obrázky), dejte je do složky static a přistupujte k nim pomocí:

url_for('static', filename='style.css')

V šabloně pak například:

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

Vlastní podtřída Flask

Třída Flask je uzpůsobena k tomu, aby bylo možné snadno rozšiřovat a přepisovat výchozí chování. Mimo přidávání vlastních metod lze například měnit třídy, které budou použity pro HTTP požadavky a odpovědi, měnit výchozí konfiguraci flask a spoustu dalšího. Nezapomeňte volat konstruktor nadtřídy.

from flask import current_app, Flask, Response

class MIPYTResponse(Response):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.set_cookie('MI-PYT', 'best')


class GreeterApp(Flask):
    response_class = MIPYTResponse

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.greetings = 0

    def greet(self):
        self.greetings += 1
        return 'Hello!'


app = GreeterApp(__name__)


@app.route('/')
def greet():
    return current_app.greet()


@app.route('/number')
def greetings_number():
    return str(current_app.greetings)

A další

Flask umí i další věci – například zpracování formulářů, chybové stránky nebo přesměrování.

Všechno to najdete v dokumentaci.