Files
fn_registry/python/functions/datascience/diff_entities.md
T
egutierrez 5f4f1f7508 docs: params/output semántico en 506 funciones para composabilidad
Añade campos params y output al frontmatter YAML de las 506 funciones del registry.
Cada parámetro tiene descripción semántica (qué representa, unidades, rango típico)
y cada función describe qué produce su output. Permite a agentes razonar sobre
cadenas de composición (ej: prices → log_return → sharpe_ratio) sin leer código.
2026-04-05 18:45:16 +02:00

2.9 KiB

name, kind, lang, domain, version, purity, signature, description, tags, uses_functions, uses_types, returns, returns_optional, error_type, imports, params, output, tested, tests, test_file_path, file_path
name kind lang domain version purity signature description tags uses_functions uses_types returns returns_optional error_type imports params output tested tests test_file_path file_path
diff_entities function py datascience 1.0.0 pure def diff_entities(before: list[dict], after: list[dict], key: str = 'id', ignore_fields: list[str] | None = None, compare_fields: list[str] | None = None) -> dict Compara dos snapshots de entities y devuelve diferencias campo a campo. Detecta añadidas, eliminadas, modificadas e inalteradas. Ignora created_at y updated_at por defecto.
diff
entities
snapshot
operations
comparison
datascience
false
name desc
before lista de dicts con entities antes de cambios (ej: [{'id': '1', 'name': 'Alice', 'status': 'active'}, ...])
name desc
after lista de dicts con entities despues de cambios, misma estructura que before
name desc
key nombre del campo que identifica cada entity (tipico: 'id'). Debe existir en todas las entities.
name desc
ignore_fields lista opcional de campos a ignorar en la comparacion (ej: ['created_at', 'updated_at'])
name desc
compare_fields lista opcional de campos SOLO a comparar (si se da, tiene prioridad sobre ignore_fields)
dict con {added, removed, modified, unchanged, summary} describiendo los cambios campo a campo true
entity añadida
entity eliminada
entity modificada con detalle de campos
entities identicas → unchanged
ignore_fields funciona
compare_fields filtra correctamente
lista vacia vs lista con datos
python/functions/datascience/diff_entities_test.py python/functions/datascience/diff_entities.py

Ejemplo

before = [
    {"id": "1", "name": "Alice", "status": "active", "updated_at": "2024-01-01"},
    {"id": "2", "name": "Bob", "status": "active", "updated_at": "2024-01-01"},
]
after = [
    {"id": "1", "name": "Alice", "status": "inactive", "updated_at": "2024-01-02"},
    {"id": "3", "name": "Carol", "status": "active", "updated_at": "2024-01-02"},
]

result = diff_entities(before, after)
# result["added"]    -> [{"id": "3", "name": "Carol", ...}]
# result["removed"]  -> [{"id": "2", "name": "Bob", ...}]
# result["modified"] -> [{"key": "1", "changes": {"status": {"old": "active", "new": "inactive"}}}]
# result["unchanged"] -> 0
# result["summary"]  -> "1 added, 1 removed, 1 modified, 0 unchanged"

Notas

Funcion pura. No hace I/O — toma listas de dicts ya cargadas en memoria.

El campo key debe existir en todas las entities; las que no lo tengan se ignoran silenciosamente.

Si compare_fields se da, tiene prioridad sobre ignore_fields. Esto permite comparar solo un subconjunto especifico de campos sin preocuparse por los campos temporales.

El orden de added y removed no esta garantizado (depende del orden de iteracion de sets).