Oggetti riga in mssql-python

Il driver mssql-python restituisce i dati delle righe come Row oggetti provenienti da operazioni di recupero. Questi oggetti offrono schemi di accesso flessibili:

  • L'accesso agli attributi (row.ColumnName) è la scelta più leggibile per colonne nominate. Usalo quando la tua query ha una lista di colonne nota e stabile.
  • L'accesso a chiave stringa (row['ColumnName']) fornisce accesso in stile dizionario alle colonne per nome, utile quando si necessita di una ricerca programmatica delle colonne o quando i nomi delle colonne contengono spazi o caratteri speciali.
  • L'accesso all'indice (row[0]) è utile per query dinamiche in cui i nomi delle colonne non sono noti al momento dello sviluppo, o durante l'elaborazione SELECT * dei risultati.
  • Il discombussellamento delle tuple (a, b, c = row) è la scelta più concisa per corpi ad anello con un numero piccolo e fisso di colonne.

Accesso agli attributi

Accedi i valori delle colonne direttamente per 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

Distinzione tra maiuscole e minuscole

L'accesso ai nomi delle colonne è distinto dalla madicia e corrisponde ai nomi delle colonne restituiti da SQL Server. Se il tuo database utilizza maiuscole incoerenti, usa alias SQL AS per normalizzare i nomi o abilita l'impostazione lowercase del modulo (vedi Configurazione del modulo):

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

Alias di colonna

Usa alias SQL per creare nomi di attributi amichevoli (friendly):

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})")

Accesso all'indice

Valori di accesso tramite indice di colonne basato su 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

Indicizzazione negativa

Il driver supporta indicizzazione negativa in stile 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)

Accesso a chiave stringa

Accedi ai valori delle colonne per nome usando una sintassi in stile dizionario:

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')

Questo è utile quando i nomi delle colonne contengono spazi o caratteri speciali, o quando è necessario accedere alle colonne in modo programmativo:

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

Sezionamento

Estrai più valori usando le fette:

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

Disimballaggio della tupla

Scompatta direttamente i valori delle righe in variabili:

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}")

Disfattaggio parziale

Utilizzare * per catturare i valori rimanenti:

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}")

Lunghezza della riga e iterazione

Lavora con le dimensioni delle righe e itera attraverso i valori delle colonne:

Ottieni il conteggio delle colonne

Usa len() per ottenere il numero di colonne in fila:

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

print(len(row))  # Number of columns

Itera sui valori

Ripassare i valori delle colonne in ordine:

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

for value in row:
    print(value)

Controlla se esiste una colonna

Da usare hasattr() per verificare la presenza di un nome di colonna:

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

Convertizione ai tipi integrati

Gli oggetti riga possono essere convertiti in tipi standard Python per l'integrazione con altre librerie e API:

Convertire in tupla

Converti una riga in una tupla usando il tuple() costruttore:

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

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

Converti in lista

Converti una riga in una lista usando il list() costruttore:

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

Converti in dizionario

Converti una riga in dizionario quando devi serializzarla in JSON, passala a un motore template o uniscila ad altri dati. Costruisci il dizionario da cursor.description e valori di riga:

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')}

Funzione helper per la conversione del dict

Crea una funzione helper riutilizzabile per convertire tutte le righe recuperate in dizionari:

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'])

Lavoro con valori nullabili

Il driver restituisce valori NULL come 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}"

Lavorare con cursor.description

Accedi ai metadati delle colonne insieme ai dati della riga:

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]}")

Modelli comuni

Ecco i modelli pratici per lavorare con oggetti Row in applicazioni reali:

Righe di processo con accesso nominato

Processare le righe usando l'accesso agli attributi per un codice leggibile e mantenibile:

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}")

Build oggetti da righe

Per le applicazioni con un modello di dominio, mappa le righe a classi dati o oggetti tipizzati. Questa mappatura ti offre l'autocompletamento IDE, il controllo dei tipi e un confine chiaro tra le righe del database e la logica applicativa.

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
    ]

Esportazione in JSON

Serializzare gli oggetti Row in JSON con la gestione personalizzata dei tipi per valori data-orario e decimale:

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")

Aggregare in gruppi

Raggruppare le righe per valore di colonna e raccoglierle in un dizionario per analisi o visualizzazione:

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']}")