Utilize mssql-python com Flask

O Flask é um framework web Python leve que lhe dá controlo total sobre a estrutura da aplicação. Combinado com mssql-python, pode construir aplicações web e APIs REST apoiadas por Microsoft SQL e Base de Dados SQL do Azure com sobrecarga mínima.

Pré-requisitos

• Python 3.10 ou posterior.
• Os pacotes mssql-python e flask. Instale ambos com pip install flask mssql-python.
• Instale pré-requisitos que devem ser instalados uma única vez específicos do sistema operacional. Os utilizadores do Windows podem saltar este passo. Para detalhes completos da plataforma, consulte Instalar mssql-python.
  • Alpino
  • Debian/Ubuntu
  • RHEL
  • SUSE
  • openSUSE
  • macOS

  apk add libtool krb5-libs krb5-dev
  

Criar um banco de dados SQL

Criar ou ligar-se a uma base de dados SQL numa das seguintes plataformas:

Os exemplos neste artigo utilizam a base de dados de exemplos AdventureWorksLT , especificamente a SalesLT.Product tabela. Se não tiver o AdventureWorksLT instalado, consulte as bases de dados de exemplo do AdventureWorks.

Configuração do projeto

Instalar dependências

Instale os pacotes necessários com pip:

pip install flask mssql-python

Estrutura do projeto

Organize o seu projeto com módulos separados para configuração, gestão de ligações, rotas e testes:

my_app/
├── app.py            # Flask app and routes
├── config.py         # database settings
├── database.py       # connection lifecycle
├── test_app.py       # pytest tests
└── blueprints/       # optional: routes grouped into modules
    ├── __init__.py
    └── products.py

Gestão de ligações à base de dados

O Flask não inclui uma camada de base de dados incorporada, por isso geres as ligações diretamente. O padrão nesta secção armazena uma ligação por pedido no objeto do g Flask e fecha-o automaticamente quando o pedido termina.

Cria config.py

Centraliza as definições da base de dados numa classe de configuração. As variáveis de ambiente permitem-te sobrepor os padrões sem alterar o código.

# config.py
import os

class Config:
    """Application configuration."""
    DATABASE_SERVER = os.getenv("DB_SERVER", "<server>.database.windows.net")
    DATABASE_NAME = os.getenv("DB_NAME", "<database>")
    POOL_SIZE = int(os.getenv("DB_POOL_SIZE", "10"))

Cria database.py

O database.py módulo gere o ciclo de vida da ligação. O objeto do g Flask é um namespace por requerimento, por isso armazenar a ligação ali garante que cada pedido recebe a sua própria ligação que é limpa quando o pedido termina.

A get_connection_string() função constrói a cadeia de ligação a partir da configuração da aplicação. A get_db() função cria uma ligação na primeira chamada e reutiliza-a para o resto do pedido. A função close_db() executa-se automaticamente no final de cada pedido, revertendo a transação caso ocorra uma exceção e confirmando-a caso contrário. A init_app() função regista este comportamento de desmontagem com a aplicação Flask.

# database.py
import mssql_python
from flask import g, current_app

def get_connection_string() -> str:
    """Build connection string from Flask app config."""
    cfg = current_app.config
    return (
        f"Server={cfg['DATABASE_SERVER']};"
        f"Database={cfg['DATABASE_NAME']};"
        "Authentication=ActiveDirectoryDefault;"
        "Encrypt=yes"
    )

def get_db():
    """Get a database cursor for the current request.

    The connection is stored on Flask's g object so it persists
    for the duration of the request and is reused across calls.
    """
    if "db_conn" not in g:
        g.db_conn = mssql_python.connect(get_connection_string())
        g.db_cursor = g.db_conn.cursor()
    return g.db_cursor

def close_db(exception=None):
    """Close the database connection at the end of the request."""
    cursor = g.pop("db_cursor", None)
    conn = g.pop("db_conn", None)

    if cursor is not None:
        cursor.close()
    if conn is not None:
        if exception:
            conn.rollback()
        else:
            conn.commit()
        conn.close()

def init_app(app):
    """Register database teardown with the Flask app."""
    app.teardown_appcontext(close_db)

Aplicação Flask

O exemplo seguinte mostra uma aplicação Flask completa com rotas para listar, recuperar, criar, atualizar e eliminar produtos.

Crie app.py

O módulo de aplicação cria a aplicação Flask, carrega a configuração e regista a desmontagem da base de dados. Cada função de rota chama get_db() para obter um cursor, executa consultas com SQL parametrizado (utilizando os marcadores de posição %(name)s e um dicionário de valores) e devolve respostas em JSON.

# app.py
from flask import Flask, jsonify, request, abort
from config import Config
from database import init_app, get_db

app = Flask(__name__)
app.config.from_object(Config)
init_app(app)

@app.route("/")
def index():
    return jsonify({"message": "Product API", "docs": "/products"})

@app.route("/products")
def list_products():
    """List products with pagination."""
    page = request.args.get("page", 1, type=int)
    page_size = request.args.get("page_size", 10, type=int)
    skip = (page - 1) * page_size

    cursor = get_db()

    cursor.execute("SELECT COUNT(*) FROM SalesLT.Product")
    total = cursor.fetchval()

    cursor.execute("""
        SELECT ProductID, Name, ProductNumber, ListPrice, Color, ProductCategoryID
        FROM SalesLT.Product
        ORDER BY ProductID
        OFFSET %(skip)s ROWS
        FETCH NEXT %(limit)s ROWS ONLY
    """, {"skip": skip, "limit": page_size})

    items = [{
        "id": row.ProductID,
        "name": row.Name,
        "product_number": row.ProductNumber,
        "price": float(row.ListPrice),
        "color": row.Color,
        "category_id": row.ProductCategoryID
    } for row in cursor.fetchall()]

    return jsonify({
        "items": items,
        "total": total,
        "page": page,
        "page_size": page_size,
        "pages": (total + page_size - 1) // page_size
    })

@app.route("/products/<int:product_id>")
def get_product(product_id):
    """Get a single product by ID."""
    cursor = get_db()
    cursor.execute("""
        SELECT ProductID, Name, ProductNumber, ListPrice, Color, ProductCategoryID
        FROM SalesLT.Product
        WHERE ProductID = %(id)s
    """, {"id": product_id})

    row = cursor.fetchone()
    if not row:
        abort(404)

    return jsonify({
        "id": row.ProductID,
        "name": row.Name,
        "product_number": row.ProductNumber,
        "price": float(row.ListPrice),
        "color": row.Color,
        "category_id": row.ProductCategoryID
    })

@app.route("/products", methods=["POST"])
def create_product():
    """Create a new product."""
    data = request.get_json()
    if not data:
        abort(400)

    cursor = get_db()

    # OUTPUT INSERTED returns the new row's columns in the same statement,
    # so you don't need a separate SELECT to get the generated ID and defaults.
    # ProductNumber is required and unique. StandardCost and SellStartDate are
    # also NOT NULL in SalesLT.Product, so supply values for them.
    cursor.execute("""
        INSERT INTO SalesLT.Product
            (Name, ProductNumber, ListPrice, Color, Size, ProductCategoryID, StandardCost, SellStartDate)
        OUTPUT INSERTED.ProductID, INSERTED.Name, INSERTED.ProductNumber, INSERTED.ListPrice,
               INSERTED.Color, INSERTED.ProductCategoryID
        VALUES (%(name)s, %(product_number)s, %(price)s, %(color)s, %(size)s, %(category_id)s, 0, GETDATE())
    """, {
        "name": data["name"],
        "product_number": data["product_number"],
        "price": data["price"],
        "color": data.get("color"),
        "size": data.get("size"),
        "category_id": data["category_id"]
    })

    row = cursor.fetchone()
    return jsonify({
        "id": row.ProductID,
        "name": row.Name,
        "product_number": row.ProductNumber,
        "price": float(row.ListPrice),
        "color": row.Color,
        "category_id": row.ProductCategoryID
    }), 201

@app.route("/products/<int:product_id>", methods=["PUT"])
def update_product(product_id):
    """Update an existing product."""
    data = request.get_json()
    if not data:
        abort(400)

    cursor = get_db()

    updates = []
    params = {"id": product_id}

    for field in ("name", "product_number", "price", "color", "category_id"):
        if field in data:
            col = {"name": "Name", "product_number": "ProductNumber",
                   "price": "ListPrice", "color": "Color",
                   "category_id": "ProductCategoryID"}[field]
            updates.append(f"{col} = %({field})s")
            params[field] = data[field]

    if not updates:
        abort(400)

    cursor.execute(f"""
        UPDATE SalesLT.Product SET {', '.join(updates)}
        OUTPUT INSERTED.ProductID, INSERTED.Name, INSERTED.ProductNumber, INSERTED.ListPrice,
               INSERTED.Color, INSERTED.ProductCategoryID
        WHERE ProductID = %(id)s
    """, params)

    row = cursor.fetchone()
    if not row:
        abort(404)

    return jsonify({
        "id": row.ProductID,
        "name": row.Name,
        "product_number": row.ProductNumber,
        "price": float(row.ListPrice),
        "color": row.Color,
        "category_id": row.ProductCategoryID
    })

@app.route("/products/<int:product_id>", methods=["DELETE"])
def delete_product(product_id):
    """Delete a product."""
    cursor = get_db()
    cursor.execute("DELETE FROM SalesLT.Product WHERE ProductID = %(id)s", {"id": product_id})
    if cursor.rowcount == 0:
        abort(404)
    return "", 204

@app.route("/health")
def health_check():
    """Check database connectivity."""
    try:
        cursor = get_db()
        cursor.execute("SELECT 1")
        return jsonify({"status": "healthy", "database": "connected"})
    except Exception as e:
        return jsonify({"status": "unhealthy", "error": str(e)}), 503

Execute o aplicativo

Inicie o servidor de desenvolvimento:

flask --app app run --debug --port 5000

O servidor ouve em http://localhost:5000. Abra um segundo terminal e chame os endpoints utilizando curl para confirmar que a aplicação está a comunicar com a base de dados:

# Check database connectivity
curl http://localhost:5000/health

# List the first page of products
curl "http://localhost:5000/products?page_size=5"

# Get a single product by ID
curl http://localhost:5000/products/680

Cada endpoint devolve JSON. Também pode abrir http://localhost:5000/products num navegador para ver a lista paginada.

Agrupamento de conexões

Sem agrupamento de ligações, cada solicitação abre e fecha uma ligação TCP ao Microsoft SQL, o que acrescenta latência. O agrupamento de conexões mantém um conjunto de conexões inativas pronto para reutilização. Para ativar o agrupamento de ligações, chame mssql_python.pooling() uma vez ao nível do módulo. Com o pooling ativado, conn.close() na close_db desmontagem devolve a conexão ao pool em vez de a fechar.

Permitir o agrupamento de ligações

Permitir o pooling chamando mssql_python.pooling() ao nível do módulo antes de qualquer ligação ser aberta:

# database.py with connection pooling
import mssql_python
from flask import g, current_app

# Configure pool at module level
mssql_python.pooling(max_size=20, idle_timeout=300)

def get_db():
    """Get a database cursor with connection pooling."""
    if "db_conn" not in g:
        g.db_conn = mssql_python.connect(get_connection_string())
        g.db_cursor = g.db_conn.cursor()
    return g.db_cursor

Tratamento de erros

O Flask permite-te registar handlers para tipos específicos de exceções. Capturar mssql_python.DatabaseError e mssql_python.IntegrityError permite devolver respostas de erro JSON estruturadas em vez de páginas de erro HTML por defeito.

Registar manipuladores de erros

Adicione estes manipuladores ao existente app.py, após a app = Flask(__name__) linha. Como os manipuladores fazem referência ao objeto app, têm de ser definidos após a criação da aplicação. app.py precisa de import mssql_python no topo. Os handlers retornam respostas JSON estruturadas em vez de páginas de erro HTML por defeito:

# app.py
import mssql_python

@app.errorhandler(mssql_python.DatabaseError)
def handle_database_error(error):
    """Handle database errors."""
    return jsonify({"error": "Database error occurred"}), 500

@app.errorhandler(mssql_python.IntegrityError)
def handle_integrity_error(error):
    """Handle integrity constraint violations."""
    error_msg = str(error)
    if "UNIQUE" in error_msg:
        return jsonify({"error": "Resource already exists"}), 409
    if "FOREIGN KEY" in error_msg:
        return jsonify({"error": "Referenced resource not found"}), 400
    return jsonify({"error": "Data integrity error"}), 400

@app.errorhandler(404)
def not_found(error):
    return jsonify({"error": "Resource not found"}), 404

@app.errorhandler(400)
def bad_request(error):
    return jsonify({"error": "Bad request"}), 400

Blueprints

À medida que a sua aplicação cresce, colocar todas as rotas num único ficheiro torna-se difícil de manter. O Flask Blueprints permite agrupar rotas relacionadas em módulos separados que estão registados na aplicação.

Organizar percursos com plantas

Crie um módulo Blueprint para rotas de produtos que importe get_db e defina endpoints com um prefixo de URL comum:

# blueprints/products.py
from flask import Blueprint, jsonify, request, abort
from database import get_db

products_bp = Blueprint("products", __name__, url_prefix="/api/products")

@products_bp.route("/")
def list_products():
    """List all products."""
    cursor = get_db()
    cursor.execute("""
        SELECT ProductID, Name, ListPrice, Color, ProductCategoryID
        FROM SalesLT.Product ORDER BY ProductID
    """)
    return jsonify([{
        "id": row.ProductID,
        "name": row.Name,
        "price": float(row.ListPrice),
        "color": row.Color,
        "category_id": row.ProductCategoryID
    } for row in cursor.fetchall()])

@products_bp.route("/<int:product_id>")
def get_product(product_id):
    """Get a product by ID."""
    cursor = get_db()
    cursor.execute(
        "SELECT ProductID, Name, ListPrice, Color FROM SalesLT.Product WHERE ProductID = %(id)s",
        {"id": product_id}
    )
    row = cursor.fetchone()
    if not row:
        abort(404)
    return jsonify({"id": row.ProductID, "name": row.Name, "price": float(row.ListPrice), "color": row.Color})

Registe o plano

Guarde o blueprint como blueprints/products.py, e adicione um ficheiro vazio blueprints/__init__.py para que o Python trate a pasta como um pacote. Depois, em app.py, importa o blueprint juntamente com as outras importações e regista-o a seguir à linha app = Flask(__name__):

# app.py
from blueprints.products import products_bp

app.register_blueprint(products_bp)

Como o blueprint define url_prefix="/api/products", as suas rotas são servidas sob esse prefixo. Por exemplo, a rota de lista está disponível em http://localhost:5000/api/products/, separada das rotas /products definidas diretamente em app.py.

Testing

O Flask fornece um cliente de teste que envia pedidos para a sua aplicação sem iniciar um servidor HTTP real. Use pytest fixtures para criar o cliente e reutilize-o ao longo dos testes.

Configuração de testes com pytest

Crie um fixture pytest que forneça um cliente de teste e escreva testes para verificar o comportamento da rota:

# test_app.py
import uuid

import pytest
from app import app

@pytest.fixture
def client():
    app.config["TESTING"] = True
    with app.test_client() as client:
        yield client

def test_health_check(client):
    response = client.get("/health")
    assert response.status_code == 200
    data = response.get_json()
    assert data["status"] == "healthy"

def test_list_products(client):
    response = client.get("/products")
    assert response.status_code == 200
    data = response.get_json()
    assert "items" in data
    assert "total" in data

def test_create_product(client):
    suffix = uuid.uuid4().hex[:8]
    name = f"Test Product {suffix}"
    response = client.post("/products", json={
        "name": name,
        "product_number": f"TEST-{suffix}",
        "price": 19.99,
        "category_id": 18
    })
    assert response.status_code == 201
    data = response.get_json()
    assert data["name"] == name

def test_get_product_not_found(client):
    response = client.get("/products/99999")
    assert response.status_code == 404

Estes testes correm contra a sua base de dados em tempo real em vez de mocks, por isso test_create_product insere uma linha real em SalesLT.Product. No AdventureWorksLT, tanto Name como ProductNumber têm restrições únicas, pelo que o teste gera um valor único para cada uma em cada execução. Se codificares esses valores de forma fixa, o teste falha com um conflito na segunda execução, a menos que apagues a linha primeiro.

Executar os testes

Guarda os testes na test_app.py pasta do teu projeto. Com o teu ambiente virtual ativado, instala pytest e executa a partir dessa pasta. Instalar e correr pytest dentro do mesmo ambiente virtual de flask e mssql-python garante que os testes importam os pacotes que a sua aplicação utiliza. pytest descobre test_app.py e reporta automaticamente os resultados:

pip install pytest
pytest

pytest descobre test_app.py automaticamente e reporta os resultados:

==================== test session starts ====================
collected 4 items

test_app.py ....                                       [100%]

===================== 4 passed in 3.21s =====================

Conteúdo relacionado

• Gestão de ligações
• Pool de conexões
• Tratamento de erros
• Integração com FastAPI
• Autenticação do Microsoft Entra