Objetos linha em mssql-python

O driver mssql-python devolve dados de linha como Row objetos provenientes de operações de busca. Estes objetos fornecem padrões de acesso flexíveis:

  • O acesso a atributos (row.ColumnName) é a escolha mais legível para colunas nomeadas. Usa-o quando a tua consulta tiver uma lista de colunas conhecida e estável.
  • O acesso à chave string (row['ColumnName']) fornece acesso ao estilo de dicionário às colunas por nome, útil quando precisa de pesquisa programática de colunas ou quando os nomes das colunas contêm espaços ou caracteres especiais.
  • O acesso ao índice (row[0]) é útil para consultas dinâmicas onde os nomes das colunas não são conhecidos no momento do desenvolvimento, ou ao processar SELECT * resultados.
  • A desempacotamento de tuplas (a, b, c = row) é a escolha mais concisa para corpos de laços com um número pequeno e fixo de colunas.

Acesso a atributos

Aceder diretamente aos valores das colunas pelo nome:

import mssql_python

conn = mssql_python.connect(connection_string)
cursor = conn.cursor()

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = 1")
row = cursor.fetchone()

print(row.ProductID)     # 1
print(row.Name)          # 'Adjustable Race'
print(row.ListPrice)     # 0.00

Sensível às maiúsculas e minúsculas

O acesso aos nomes das colunas é sensível a maiúsculas minúsculas e corresponde aos nomes das colunas devolvidos pelo SQL Server. Se a sua base de dados usar maiúsculas e minúsculas inconsistentes, use pseudónimos SQL AS para normalizar nomes ou ative a definição do lowercase módulo (ver Configuração do módulo):

cursor.execute("SELECT FirstName, LastName, EmailPromotion FROM Person.Person WHERE BusinessEntityID < 10")
row = cursor.fetchone()

print(row.FirstName)      # Works
print(row.LastName)       # Works
print(row.EmailPromotion) # Works
print(row.firstname)      # AttributeError - wrong case

Nomes de coluna

Use pseudónimos SQL para criar nomes de atributos amigáveis:

cursor.execute("""
    SELECT 
        p.ProductID,
        p.Name,
        c.Name AS Category
    FROM Production.Product p
    JOIN Production.ProductSubcategory c ON p.ProductSubcategoryID = c.ProductSubcategoryID
    WHERE p.ProductSubcategoryID IS NOT NULL
""")

for row in cursor:
    print(f"{row.Name} ({row.Category})")

Acesso ao índice

Valores de acesso por índice de colunas baseados em zero:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 5")
row = cursor.fetchone()

print(row[0])  # ProductID
print(row[1])  # Name
print(row[2])  # ListPrice

Indexação negativa

O driver suporta indexação negativa ao estilo Python:

cursor.execute("""
    SELECT Demo.A, Demo.B, Demo.C, Demo.D
    FROM (VALUES (1, 2, 3, 4)) AS Demo(A, B, C, D)
""")
row = cursor.fetchone()

print(row[-1])  # Last column (D)
print(row[-2])  # Second to last (C)

Acesso à chave de cordas

Aceder aos valores das colunas por nome usando sintaxe ao estilo de dicionário:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = 1")
row = cursor.fetchone()

print(row['ProductID'])   # 1
print(row['Name'])        # 'Adjustable Race'
print(row['ListPrice'])   # Decimal('0.00')

Isto é útil quando os nomes das colunas contêm espaços ou caracteres especiais, ou quando precisa de aceder às colunas programaticamente:

column_name = 'ListPrice'
value = row[column_name]  # Programmatic column access

Fatiamento

Extrair múltiplos valores usando fatias:

cursor.execute("""
    SELECT Demo.A, Demo.B, Demo.C, Demo.D, Demo.E
    FROM (VALUES (1, 2, 3, 4, 5)) AS Demo(A, B, C, D, E)
""")
row = cursor.fetchone()

print(row[1:4])    # Columns B, C, D (indices 1, 2, 3)
print(row[:2])     # First two columns (A, B)
print(row[2:])     # From C to end

Desempacotamento de tuplas

Descompacte os valores das linhas diretamente em variáveis:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 10")

for product_id, name, price in cursor:
    print(f"#{product_id}: {name} - ${price}")

Desempacotamento parcial

Usar * para capturar os valores restantes:

cursor.execute("""
    SELECT TOP 2 ProductID, Name, ProductNumber, Color, Size, Weight
    FROM Production.Product
    WHERE ProductNumber IS NOT NULL
    ORDER BY ProductID
""")

for product_id, name, *rest in cursor:
    print(f"{product_id}: {name}, extra columns: {rest}")

Comprimento da linha e iteração

Trabalhe com dimensões de linha e itere pelos valores das colunas:

Obtém a contagem de colunas

len() Use para obter o número de colunas seguidas:

cursor.execute("SELECT * FROM Production.Product WHERE ProductID < 5")
row = cursor.fetchone()

print(len(row))  # Number of columns

Iterar sobre valores

Percorra os valores das colunas por ordem:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 5")
row = cursor.fetchone()

for value in row:
    print(value)

Verifique se existe uma coluna

Use hasattr() para testar a presença de um nome de coluna:

# Use hasattr to check for column name
if hasattr(row, 'DiscountPrice'):
    print(f"Discount: {row.DiscountPrice}")
else:
    print("No discount available")

Converter para tipos incorporados

Os objetos linha podem ser convertidos para tipos padrão de Python para integração com outras bibliotecas e APIs:

Converter para tupla

Converta uma linha numa tupla usando o tuple() construtor:

cursor.execute("SELECT ProductID, Name FROM Production.Product WHERE ProductID = 1")
row = cursor.fetchone()

row_tuple = tuple(row)
print(row_tuple)  # (1, 'Adjustable Race')

Converter para lista

Converta uma linha numa lista usando o list() construtor:

row_list = list(row)
print(row_list)  # [1, 'Adjustable Race']

Converter para dicionário

Converte uma linha num dicionário quando precisares de a serializar para JSON, passa-a para um motor de templates ou junta-a com outros dados. Constrói o dicionário a partir de cursor.description valores de linha:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = 1")
row = cursor.fetchone()

# Create dict from description and values
columns = [col[0] for col in cursor.description]
row_dict = dict(zip(columns, row))
print(row_dict)  # {'ProductID': 1, 'Name': 'Adjustable Race', 'ListPrice': Decimal('0.00')}

Função auxiliar para conversão de dict

Crie uma função auxiliar reutilizável para converter todas as linhas buscadas em dicionários:

def rows_to_dicts(cursor):
    """Convert fetched rows to list of dictionaries."""
    columns = [col[0] for col in cursor.description]
    return [dict(zip(columns, row)) for row in cursor.fetchall()]

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 10")
products = rows_to_dicts(cursor)
for p in products:
    print(p['Name'])

Trabalho com valores nulos

O driver devolve valores NULL como PythonNone:

cursor.execute("SELECT FirstName, MiddleName, LastName FROM Person.Person WHERE BusinessEntityID = 1")
row = cursor.fetchone()

if row.MiddleName is None:
    full_name = f"{row.FirstName} {row.LastName}"
else:
    full_name = f"{row.FirstName} {row.MiddleName} {row.LastName}"

Trabalho com cursor.description

Metadados das colunas de acesso juntamente com os dados da linha:

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 5")

# Column information
for col in cursor.description:
    print(f"Name: {col[0]}, Type: {col[1]}")

# Fetch with metadata
row = cursor.fetchone()
for i, col in enumerate(cursor.description):
    print(f"{col[0]}: {row[i]}")

Padrões comuns

Aqui estão padrões práticos para trabalhar com objetos Row em aplicações do mundo real:

Linhas de processos com acesso nomeado

Linhas de processo usando acesso a atributos para código legível e mantido:

def process_orders(conn):
    cursor = conn.cursor()
    cursor.execute("""
        SELECT SalesOrderID, CustomerID, OrderDate, TotalDue 
        FROM Sales.SalesOrderHeader 
        WHERE Status = 5
    """)
    
    for order in cursor:
        print(f"Order #{order.SalesOrderID}")
        print(f"  Customer: {order.CustomerID}")
        print(f"  Date: {order.OrderDate}")
        print(f"  Total: ${order.TotalDue:.2f}")

Construir objetos a partir de linhas

Para aplicações com um modelo de domínio, mapeie as linhas para classes de dados ou objetos tipados. Este mapeamento dá-te autocompletamento do IDE, verificação de tipos e um limite claro entre as linhas da base de dados e a lógica da aplicação.

from dataclasses import dataclass
from datetime import date
from decimal import Decimal

@dataclass
class Product:
    id: int
    name: str
    price: Decimal
    created: date

def get_products(conn) -> list[Product]:
    cursor = conn.cursor()
    cursor.execute("SELECT ProductID, Name, ListPrice, SellStartDate FROM Production.Product WHERE ProductID < 10")
    
    return [
        Product(
            id=row.ProductID,
            name=row.Name,
            price=row.ListPrice,
            created=row.SellStartDate
        )
        for row in cursor
    ]

Exportação para JSON

Serialize objetos de linha para JSON com tratamento personalizado de tipos para valores de data-hora e decimais:

import json
from datetime import date, datetime
from decimal import Decimal

def json_serializer(obj):
    """Custom serializer for non-JSON types."""
    if isinstance(obj, (date, datetime)):
        return obj.isoformat()
    if isinstance(obj, Decimal):
        return float(obj)
    raise TypeError(f"Type {type(obj)} not serializable")

def export_to_json(cursor, filename):
    columns = [col[0] for col in cursor.description]
    rows = [dict(zip(columns, row)) for row in cursor.fetchall()]
    
    with open(filename, 'w') as f:
        json.dump(rows, f, default=json_serializer, indent=2)

cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 10")
export_to_json(cursor, "products.json")

Agregar-se em grupos

Agrupe as linhas por valor de coluna e recolha-as num dicionário para análise ou visualização:

from collections import defaultdict

cursor.execute("""
    SELECT c.Name AS CategoryName, p.Name AS ProductName, p.ListPrice 
    FROM Production.Product p
    JOIN Production.ProductSubcategory c ON p.ProductSubcategoryID = c.ProductSubcategoryID
    WHERE p.ProductSubcategoryID IS NOT NULL
    ORDER BY c.Name
""")

products_by_category = defaultdict(list)
for row in cursor:
    products_by_category[row.CategoryName].append({
        'name': row.ProductName,
        'price': row.ListPrice
    })

for category, products in products_by_category.items():
    print(f"\n{category}:")
    for p in products:
        print(f"  - {p['name']}: ${p['price']}")

Conteúdo relacionado

  • Last updated on