Files
fn_registry/python/functions/datascience/diff_relations.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

65 lines
2.8 KiB
Markdown

---
name: diff_relations
kind: function
lang: py
domain: datascience
version: "1.0.0"
purity: pure
signature: "def diff_relations(before: list[dict], after: list[dict], key: tuple[str, str, str] = ('source_id', 'target_id', 'relation_type'), ignore_fields: list[str] | None = None, compare_fields: list[str] | None = None) -> dict"
description: "Compara relaciones entre dos snapshots usando key compuesta (source_id, target_id, relation_type). Detecta relaciones añadidas, eliminadas y modificadas con detalle campo a campo."
tags: [diff, relations, graph, snapshot, operations, comparison, datascience]
uses_functions: []
uses_types: []
returns: []
returns_optional: false
error_type: ""
imports: []
params:
- name: before
desc: "lista de dicts con relaciones antes (ej: [{'source_id': 'A', 'target_id': 'B', 'relation_type': 'knows', 'weight': 1.0}, ...])"
- name: after
desc: "lista de dicts con relaciones despues, misma estructura que before"
- name: key
desc: "tupla de 3 nombres de campo que forman la identidad de una relacion (defecto: ('source_id', 'target_id', 'relation_type'))"
- name: ignore_fields
desc: "lista opcional de campos a ignorar en comparacion (ej: ['timestamp'])"
- name: compare_fields
desc: "lista opcional de campos SOLO a comparar (si se da, prioridad sobre ignore_fields)"
output: "dict con {added, removed, modified, unchanged} describiendo cambios en relaciones"
tested: true
tests:
- "relacion añadida"
- "relacion eliminada"
- "relacion con metadata modificada (mismo source/target/type, distinto weight)"
- "key compuesta funciona correctamente"
test_file_path: "python/functions/datascience/diff_relations_test.py"
file_path: "python/functions/datascience/diff_relations.py"
---
## Ejemplo
```python
before = [
{"source_id": "A", "target_id": "B", "relation_type": "knows", "weight": 1.0},
{"source_id": "B", "target_id": "C", "relation_type": "owns", "weight": 0.5},
]
after = [
{"source_id": "A", "target_id": "B", "relation_type": "knows", "weight": 2.0},
{"source_id": "C", "target_id": "D", "relation_type": "knows", "weight": 1.0},
]
result = diff_relations(before, after)
# result["added"] -> [{"source_id": "C", "target_id": "D", ...}]
# result["removed"] -> [{"source_id": "B", "target_id": "C", ...}]
# result["modified"] -> [{"key": "A|B|knows", "changes": {"weight": {"old": 1.0, "new": 2.0}}}]
# result["unchanged"] -> 0
```
## Notas
La key compuesta se serializa como `source_id|target_id|relation_type`. Si alguno de los campos clave no existe en la relacion, se usa string vacio.
Misma semantica que `diff_entities_py_datascience` pero adaptada para relaciones donde no hay un ID unico — la identidad se define por los tres campos de la key.
Complemento natural de `diff_entities_py_datascience` para comparar grafos completos entre ejecuciones de pipelines.