Blueprints Flask | Tutorial de Desenvolvimento Web

Introdução

Neste laboratório, vamos percorrer como criar e usar blueprints (plantas) do Flask para estruturar sua aplicação usando views (visualizações). Blueprints do Flask permitem que você agrupe views (visualizações) relacionadas, código e recursos, tornando sua aplicação modular e escalável. Criaremos uma aplicação simples que incluirá autenticação de usuário e funcionalidade de posts de blog.

Nota: Você precisa criar o arquivo de código você mesmo e executá-lo no ambiente. Você pode visualizar o status do serviço Flask na Web 5000.

Criar um Blueprint (Planta)

Vamos começar criando um blueprint (planta) para nossa aplicação. Este blueprint (planta) será nomeado 'auth' e lidará com as views (visualizações) relacionadas à autenticação do usuário. Definiremos nosso blueprint (planta) em um módulo separado chamado flaskr/auth.py.

## flaskr/auth.py

import functools
from flask import Blueprint, flash, g, redirect, render_template, request, session, url_for
from werkzeug.security import check_password_hash, generate_password_hash
from flaskr.db import get_db

## Create a Blueprint named 'auth'
bp = Blueprint('auth', __name__, url_prefix='/auth')

Registrar o Blueprint (Planta)

Após criar o blueprint (planta), precisamos registrá-lo com nossa aplicação. Isso é feito na função da fábrica da aplicação em flaskr/__init__.py.

## flaskr/__init__.py

def create_app():
    app = ...
    ## existing code omitted

    ## Import and register the blueprint
    from . import auth
    app.register_blueprint(auth.bp)

    return app

Implementar a View (Visualização) de Registro

Agora, vamos implementar a view (visualização) de registro em flaskr/auth.py. Esta view (visualização) renderizará um formulário de registro e lidará com a submissão do formulário.

## flaskr/auth.py

@bp.route('/register', methods=('GET', 'POST'))
def register():
    if request.method == 'POST':
        username = request.form['username']
        password = request.form['password']
        db = get_db()
        error = None

        if not username:
            error = 'Username is required.'
        elif not password:
            error = 'Password is required.'

        if error is None:
            try:
                db.execute(
                    "INSERT INTO user (username, password) VALUES (?, ?)",
                    (username, generate_password_hash(password)),
                )
                db.commit()
            except db.IntegrityError:
                error = f"User {username} is already registered."
            else:
                return redirect(url_for("auth.login"))

        flash(error)

    return render_template('auth/register.html')

Em seguida, implementaremos a view (visualização) de login em flaskr/auth.py. Esta view (visualização) lidará com a funcionalidade de login do usuário.

## flaskr/auth.py

@bp.route('/login', methods=('GET', 'POST'))
def login():
    if request.method == 'POST':
        username = request.form['username']
        password = request.form['password']
        db = get_db()
        error = None
        user = db.execute(
            'SELECT * FROM user WHERE username = ?', (username,)
        ).fetchone()

        if user is None:
            error = 'Incorrect username.'
        elif not check_password_hash(user['password'], password):
            error = 'Incorrect password.'

        if error is None:
            session.clear()
            session['user_id'] = user['id']
            return redirect(url_for('index'))

        flash(error)

    return render_template('auth/login.html')

Implementar a View (Visualização) de Logout

Agora, vamos adicionar uma view (visualização) de logout em flaskr/auth.py. Esta view (visualização) lidará com a funcionalidade de logout do usuário.

## flaskr/auth.py

@bp.route('/logout')
def logout():
    session.clear()
    return redirect(url_for('index'))

Também precisaremos de um decorator (decorador) para proteger nossas views (visualizações) que exigem que um usuário esteja logado. Este decorator (decorador) será implementado em flaskr/auth.py.

## flaskr/auth.py

def login_required(view):
    @functools.wraps(view)
    def wrapped_view(**kwargs):
        if g.user is None:
            return redirect(url_for('auth.login'))

        return view(**kwargs)

    return wrapped_view

Resumo

Neste laboratório, aprendemos como usar blueprints (plantas) do Flask para estruturar nossa aplicação. Criamos um blueprint (planta) para autenticação de usuário e implementamos as views (visualizações) de registro, login e logout. Também implementamos um decorator (decorador) para proteger as views (visualizações) que exigem que um usuário esteja logado. Com este conhecimento, você agora pode estruturar suas aplicações Flask de maneira modular e escalável.

Aplicação Flask Modular com Autenticação