Objetos fila en mssql-python

El controlador mssql-python devuelve los datos de fila como Row objetos de operaciones de obtención. Estos objetos proporcionan patrones de acceso flexibles:

  • El acceso a atributos (row.ColumnName) es la opción más legible para columnas con nombre. Úsalo cuando tu consulta tenga una lista de columnas estable y conocida.
  • El acceso a claves de cadena (row['ColumnName']) proporciona acceso tipo diccionario a columnas por nombre, útil cuando necesitas búsqueda programática de columnas o cuando los nombres de columnas contienen espacios o caracteres especiales.
  • El acceso al índice (row[0]) es útil para consultas dinámicas donde los nombres de las columnas no se conocen en el momento del desarrollo o al procesar SELECT * resultados.
  • El desempacado de tuplas (a, b, c = row) es la opción más concisa para cuerpos de bucles con un número pequeño y fijo de columnas.

Acceso a atributos

Acceder directamente a los valores de las columnas por nombre:

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

Distinción entre mayúsculas y minúsculas

El acceso a nombres de columnas es sensible a mayúsculas minúsculas y coincide con los nombres de columna devueltos por SQL Server. Si tu base de datos utiliza mayúsculas inconsistentes, utiliza alias SQL AS para normalizar nombres o activa la configuración del lowercase módulo (ver Configuración del 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

Alias de columna

Utiliza alias SQL para crear nombres de atributos amigables:

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

Acceso al índice

Valores de acceso por índice de columna basado en cero:

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

Indexación negativa

El controlador soporta indexación negativa al 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)

Acceso a la clave de cadenas

Acceder a los valores de las columnas por nombre usando una sintaxis tipo diccionario:

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

Esto es útil cuando los nombres de columnas contienen espacios o caracteres especiales, o cuando necesitas acceder a las columnas de forma programática:

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

Segmentación

Extrae múltiples valores usando slices:

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

Desempacando tuplas

Desglosa los valores de las filas directamente en variables:

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

Desempaquetado parcial

Úsalo * para capturar los 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}")

Longitud de fila e iteración

Trabaja con dimensiones de fila e itera entre los valores de columna:

Obtén el recuento de columnas

Úsalo len() para obtener el número de columnas seguidas:

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

print(len(row))  # Number of columns

Iterar sobre valores

Haz un bucle entre los valores de las columnas en orden:

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

for value in row:
    print(value)

Comprueba si existe una columna

Úsase hasattr() para comprobar la presencia de un nombre de columna:

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

Convertir a tipos integrados

Los objetos fila pueden convertirse a tipos estándar de Python para su integración con otras bibliotecas y APIs:

Convertir a tupla

Convierte una fila en tupla usando el tuple() constructor:

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

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

Convertir a lista

Convierte una fila en una lista usando el list() constructor:

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

Convertir en diccionario

Convierte una fila en diccionario cuando necesites serializarla a JSON, pásalo a un motor de plantillas o fusionarlo con otros datos. Construye el diccionario a partir de cursor.description valores de fila:

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

Función auxiliar para la conversión de dicts

Crea una función auxiliar reutilizable para convertir todas las filas obtenidas en diccionarios:

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

Trabajo con valores anulables

El controlador devuelve 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}"

Trabajo con cursor.description

Metadatos de columna de acceso junto con los datos de fila:

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

Patrones comunes

Aquí tienes patrones prácticos para trabajar con objetos Row en aplicaciones reales:

Filas de procesos con acceso nombrado

Filas de proceso usando acceso a atributos para código legible y mantenible:

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 filas

Para aplicaciones con un modelo de dominio, asigna las filas a clases de datos u objetos tipados. Este mapeo te proporciona autocompletación del IDE, comprobación de tipos y un límite claro entre las filas de la base de datos y la lógica de la aplicación.

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
    ]

Exportación a JSON

Serializar objetos de fila a JSON con manejo personalizado de tipos para valores de fecha y decimales:

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

Agregarse en grupos

Agrupa las filas por valor de columna y recóllalas en un diccionario para su análisis o visualización:

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