Graphify / entity_relationship_generator.py
ZahirJS's picture
Update entity_relationship_generator.py
8828f63 verified
raw
history blame
21.3 kB
# import graphviz
# import json
# from tempfile import NamedTemporaryFile
# import os
# def generate_entity_relationship_diagram(json_input: str, output_format: str) -> str:
# """
# Generates an entity relationship diagram from JSON input.
# Args:
# json_input (str): A JSON string describing the entity relationship diagram structure.
# It must follow the Expected JSON Format Example below.
# Expected JSON Format Example:
# {
# "entities": [
# {
# "name": "Customer",
# "type": "strong",
# "attributes": [
# {"name": "customer_id", "type": "primary_key"},
# {"name": "first_name", "type": "regular"},
# {"name": "last_name", "type": "regular"},
# {"name": "email", "type": "regular"},
# {"name": "phone", "type": "multivalued", "multivalued": true},
# {"name": "age", "type": "derived", "derived": true},
# {"name": "address", "type": "composite", "composite": true}
# ]
# },
# {
# "name": "Order",
# "type": "strong",
# "attributes": [
# {"name": "order_id", "type": "primary_key"},
# {"name": "customer_id", "type": "foreign_key"},
# {"name": "order_date", "type": "regular"},
# {"name": "total_amount", "type": "regular"},
# {"name": "status", "type": "regular"},
# {"name": "shipping_address", "type": "composite", "composite": true}
# ]
# },
# {
# "name": "Product",
# "type": "strong",
# "attributes": [
# {"name": "product_id", "type": "primary_key"},
# {"name": "name", "type": "regular"},
# {"name": "description", "type": "regular"},
# {"name": "price", "type": "regular"},
# {"name": "category_id", "type": "foreign_key"},
# {"name": "stock_quantity", "type": "regular"}
# ]
# },
# {
# "name": "Category",
# "type": "strong",
# "attributes": [
# {"name": "category_id", "type": "primary_key"},
# {"name": "name", "type": "regular"},
# {"name": "description", "type": "regular"},
# {"name": "parent_category_id", "type": "foreign_key"}
# ]
# },
# {
# "name": "OrderItem",
# "type": "weak",
# "attributes": [
# {"name": "order_id", "type": "primary_key"},
# {"name": "product_id", "type": "primary_key"},
# {"name": "quantity", "type": "regular"},
# {"name": "unit_price", "type": "regular"},
# {"name": "discount", "type": "regular"}
# ]
# },
# {
# "name": "Payment",
# "type": "strong",
# "attributes": [
# {"name": "payment_id", "type": "primary_key"},
# {"name": "order_id", "type": "foreign_key"},
# {"name": "payment_method", "type": "regular"},
# {"name": "amount", "type": "regular"},
# {"name": "payment_date", "type": "regular"},
# {"name": "transaction_id", "type": "regular"}
# ]
# },
# {
# "name": "Supplier",
# "type": "strong",
# "attributes": [
# {"name": "supplier_id", "type": "primary_key"},
# {"name": "company_name", "type": "regular"},
# {"name": "contact_person", "type": "regular"},
# {"name": "email", "type": "regular"},
# {"name": "phone", "type": "multivalued", "multivalued": true},
# {"name": "address", "type": "composite", "composite": true}
# ]
# },
# {
# "name": "Review",
# "type": "weak",
# "attributes": [
# {"name": "customer_id", "type": "primary_key"},
# {"name": "product_id", "type": "primary_key"},
# {"name": "rating", "type": "regular"},
# {"name": "comment", "type": "regular"},
# {"name": "review_date", "type": "regular"}
# ]
# }
# ],
# "relationships": [
# {
# "name": "Places",
# "type": "regular",
# "entities": ["Customer", "Order"],
# "cardinalities": {
# "Customer": "1",
# "Order": "N"
# }
# },
# {
# "name": "Contains",
# "type": "identifying",
# "entities": ["Order", "OrderItem"],
# "cardinalities": {
# "Order": "1",
# "OrderItem": "N"
# }
# },
# {
# "name": "Includes",
# "type": "regular",
# "entities": ["OrderItem", "Product"],
# "cardinalities": {
# "OrderItem": "N",
# "Product": "1"
# }
# },
# {
# "name": "BelongsTo",
# "type": "regular",
# "entities": ["Product", "Category"],
# "cardinalities": {
# "Product": "N",
# "Category": "1"
# }
# },
# {
# "name": "ProcessedBy",
# "type": "regular",
# "entities": ["Order", "Payment"],
# "cardinalities": {
# "Order": "1",
# "Payment": "1"
# }
# },
# {
# "name": "Supplies",
# "type": "regular",
# "entities": ["Supplier", "Product"],
# "cardinalities": {
# "Supplier": "N",
# "Product": "M"
# }
# },
# {
# "name": "Writes",
# "type": "weak",
# "entities": ["Customer", "Review"],
# "cardinalities": {
# "Customer": "1",
# "Review": "N"
# }
# },
# {
# "name": "ReviewsProduct",
# "type": "weak",
# "entities": ["Review", "Product"],
# "cardinalities": {
# "Review": "N",
# "Product": "1"
# }
# },
# {
# "name": "Subcategory",
# "type": "regular",
# "entities": ["Category", "Category"],
# "cardinalities": {
# "Category": "1",
# "Category": "N"
# }
# }
# ]
# }
# Returns:
# str: The filepath to the generated PNG image file.
# """
# try:
# if not json_input.strip():
# return "Error: Empty input"
# data = json.loads(json_input)
# if 'entities' not in data:
# raise ValueError("Missing required field: entities")
# dot = graphviz.Graph(comment='ER Diagram', engine='dot')
# dot.attr(rankdir='TB', bgcolor='white', pad='0.5')
# dot.attr('node', fontname='Arial', fontsize='10', color='black')
# dot.attr('edge', fontname='Arial', fontsize='9', color='black')
# entities = data.get('entities', [])
# relationships = data.get('relationships', [])
# for entity in entities:
# entity_name = entity.get('name')
# entity_type = entity.get('type', 'strong')
# attributes = entity.get('attributes', [])
# if not entity_name:
# continue
# label_parts = [entity_name]
# if attributes:
# attr_lines = []
# for attr in attributes:
# attr_name = attr.get('name', '')
# attr_type = attr.get('type', 'regular')
# is_multivalued = attr.get('multivalued', False)
# is_derived = attr.get('derived', False)
# is_composite = attr.get('composite', False)
# if attr_type == 'primary_key':
# if is_multivalued:
# attr_display = f"PK: {{ {attr_name} }}"
# else:
# attr_display = f"PK: {attr_name}"
# elif attr_type == 'foreign_key':
# attr_display = f"FK: {attr_name}"
# else:
# attr_display = attr_name
# if is_derived:
# attr_display = f"/ {attr_display} /"
# if is_multivalued:
# attr_display = f"{{ {attr_display} }}"
# if is_composite:
# attr_display = f"( {attr_display} )"
# attr_lines.append(attr_display)
# if attr_lines:
# label_parts.extend(attr_lines)
# label = "\\n".join(label_parts)
# if entity_type == 'weak':
# style = 'filled'
# fillcolor = '#e8e8e8'
# penwidth = '2'
# else:
# style = 'filled'
# fillcolor = '#d0d0d0'
# penwidth = '1'
# dot.node(entity_name, label, shape='box', style=style, fillcolor=fillcolor, penwidth=penwidth)
# for relationship in relationships:
# rel_name = relationship.get('name')
# rel_type = relationship.get('type', 'regular')
# entities_involved = relationship.get('entities', [])
# cardinalities = relationship.get('cardinalities', {})
# if not rel_name or len(entities_involved) < 2:
# continue
# if rel_type == 'identifying':
# style = 'filled'
# fillcolor = '#c0c0c0'
# penwidth = '2'
# else:
# style = 'filled'
# fillcolor = '#c0c0c0'
# penwidth = '1'
# dot.node(rel_name, rel_name, shape='diamond', style=style, fillcolor=fillcolor, penwidth=penwidth)
# for entity in entities_involved:
# cardinality = cardinalities.get(entity, '1')
# dot.edge(entity, rel_name, label=cardinality)
# with NamedTemporaryFile(delete=False, suffix=f'.{output_format}') as tmp:
# dot.render(tmp.name, format=output_format, cleanup=True)
# return f"{tmp.name}.{output_format}"
# except json.JSONDecodeError:
# return "Error: Invalid JSON format"
# except Exception as e:
# return f"Error: {str(e)}"
import graphviz
import json
from tempfile import NamedTemporaryFile
import os
def generate_entity_relationship_diagram(json_input: str, output_format: str) -> str:
"""
Generates an entity relationship diagram from JSON input.
Args:
json_input (str): A JSON string describing the entity relationship diagram structure.
It must follow the Expected JSON Format Example below.
Expected JSON Format Example:
{
"entities": [
{
"name": "EMPLEADO",
"type": "strong",
"attributes": [
{"name": "RUT", "type": "primary_key"},
{"name": "Nombre", "type": "regular"},
{"name": "Apellido1", "type": "regular"},
{"name": "Apellido2", "type": "regular"},
{"name": "Dirección", "type": "regular"},
{"name": "Sexo", "type": "regular"},
{"name": "Salario", "type": "regular"},
{"name": "FechaN", "type": "regular"}
]
},
{
"name": "DEPARTAMENTO",
"type": "strong",
"attributes": [
{"name": "Número", "type": "primary_key"},
{"name": "Nombre", "type": "regular"},
{"name": "Localizaciones", "type": "multivalued"}
]
},
{
"name": "PROYECTO",
"type": "strong",
"attributes": [
{"name": "Número", "type": "primary_key"},
{"name": "Nombre", "type": "regular"},
{"name": "Localización", "type": "regular"}
]
},
{
"name": "DEPENDIENTE",
"type": "weak",
"attributes": [
{"name": "Nombre", "type": "partial_key"},
{"name": "Sexo", "type": "regular"},
{"name": "FechaN", "type": "regular"},
{"name": "Relación", "type": "regular"}
]
}
],
"relationships": [
{
"name": "TRABAJA_PARA",
"type": "regular",
"entities": ["EMPLEADO", "DEPARTAMENTO"],
"cardinalities": {
"EMPLEADO": "N",
"DEPARTAMENTO": "1"
}
},
{
"name": "ADMINISTRA",
"type": "regular",
"entities": ["EMPLEADO", "DEPARTAMENTO"],
"cardinalities": {
"EMPLEADO": "1",
"DEPARTAMENTO": "1"
},
"attributes": [
{"name": "FechaInicio", "type": "regular"}
]
},
{
"name": "CONTROLA",
"type": "regular",
"entities": ["DEPARTAMENTO", "PROYECTO"],
"cardinalities": {
"DEPARTAMENTO": "1",
"PROYECTO": "N"
}
},
{
"name": "SUPERVISIÓN",
"type": "regular",
"entities": ["EMPLEADO", "EMPLEADO"],
"cardinalities": {
"EMPLEADO": "1",
"EMPLEADO": "N"
},
"roles": {
"EMPLEADO": ["supervisor", "supervisado"]
}
},
{
"name": "TRABAJA_PARA_PROYECTO",
"type": "ternary",
"entities": ["EMPLEADO", "PROYECTO"],
"cardinalities": {
"EMPLEADO": "M",
"PROYECTO": "N"
},
"attributes": [
{"name": "Horas", "type": "regular"}
]
},
{
"name": "DEPENDIENTES",
"type": "identifying",
"entities": ["EMPLEADO", "DEPENDIENTE"],
"cardinalities": {
"EMPLEADO": "1",
"DEPENDIENTE": "N"
}
}
]
}
Returns:
str: The filepath to the generated PNG image file.
"""
try:
if not json_input.strip():
return "Error: Empty input"
data = json.loads(json_input)
if 'entities' not in data:
raise ValueError("Missing required field: entities")
dot = graphviz.Graph(comment='ER Diagram', engine='dot')
dot.attr(rankdir='TB', bgcolor='white', pad='0.5', nodesep='1.0', ranksep='1.5')
dot.attr('node', fontname='Arial', fontsize='10', color='black')
dot.attr('edge', fontname='Arial', fontsize='9', color='black')
entities = data.get('entities', [])
relationships = data.get('relationships', [])
# Crear entidades
for entity in entities:
entity_name = entity.get('name')
entity_type = entity.get('type', 'strong')
if not entity_name:
continue
# Entidades fuertes: rectángulo simple
# Entidades débiles: rectángulo doble (simulado con penwidth)
if entity_type == 'weak':
dot.node(entity_name, entity_name, shape='box', style='filled',
fillcolor='white', color='black', penwidth='3')
else:
dot.node(entity_name, entity_name, shape='box', style='filled',
fillcolor='white', color='black', penwidth='1')
# Crear atributos para cada entidad
for entity in entities:
entity_name = entity.get('name')
attributes = entity.get('attributes', [])
for attr in attributes:
attr_name = attr.get('name', '')
attr_type = attr.get('type', 'regular')
attr_id = f"{entity_name}_{attr_name}"
if attr_type == 'primary_key':
# Atributo clave: elipse con texto subrayado
dot.node(attr_id, f"<U>{attr_name}</U>", shape='ellipse',
style='filled', fillcolor='white', color='black')
elif attr_type == 'partial_key':
# Clave parcial: elipse con línea punteada
dot.node(attr_id, f"<U>{attr_name}</U>", shape='ellipse',
style='filled,dashed', fillcolor='white', color='black')
elif attr_type == 'multivalued':
# Atributo multivaluado: doble elipse (simulado con penwidth)
dot.node(attr_id, attr_name, shape='ellipse',
style='filled', fillcolor='white', color='black', penwidth='3')
elif attr_type == 'derived':
# Atributo derivado: elipse con línea punteada
dot.node(attr_id, attr_name, shape='ellipse',
style='filled,dashed', fillcolor='white', color='black')
elif attr_type == 'composite':
# Atributo compuesto: elipse normal (los componentes se conectarían por separado)
dot.node(attr_id, attr_name, shape='ellipse',
style='filled', fillcolor='white', color='black')
else:
# Atributo regular: elipse simple
dot.node(attr_id, attr_name, shape='ellipse',
style='filled', fillcolor='white', color='black')
# Conectar atributo con entidad
dot.edge(entity_name, attr_id, color='black')
# Crear relaciones
for relationship in relationships:
rel_name = relationship.get('name')
rel_type = relationship.get('type', 'regular')
entities_involved = relationship.get('entities', [])
cardinalities = relationship.get('cardinalities', {})
rel_attributes = relationship.get('attributes', [])
roles = relationship.get('roles', {})
if not rel_name or len(entities_involved) < 2:
continue
# Relaciones identificadoras: rombo doble
# Relaciones regulares: rombo simple
if rel_type == 'identifying':
dot.node(rel_name, rel_name, shape='diamond', style='filled',
fillcolor='white', color='black', penwidth='3')
else:
dot.node(rel_name, rel_name, shape='diamond', style='filled',
fillcolor='white', color='black', penwidth='1')
# Crear atributos de la relación
for attr in rel_attributes:
attr_name = attr.get('name', '')
attr_type = attr.get('type', 'regular')
attr_id = f"{rel_name}_{attr_name}"
dot.node(attr_id, attr_name, shape='ellipse',
style='filled', fillcolor='white', color='black')
dot.edge(rel_name, attr_id, color='black')
# Conectar entidades con la relación
if len(entities_involved) == 2 and entities_involved[0] == entities_involved[1]:
# Relación reflexiva (como supervisión)
entity = entities_involved[0]
cardinality1 = cardinalities.get(entity, '1')
# Para relaciones reflexivas, necesitamos crear dos conexiones
dot.edge(entity, rel_name, label=cardinality1, color='black')
dot.edge(entity, rel_name, label='N', color='black')
# Agregar roles si están definidos
if roles and entity in roles:
role_list = roles[entity]
if len(role_list) >= 2:
# Crear nodos de texto para los roles
role1_id = f"{rel_name}_role1"
role2_id = f"{rel_name}_role2"
dot.node(role1_id, role_list[0], shape='plaintext', fontsize='8')
dot.node(role2_id, role_list[1], shape='plaintext', fontsize='8')
else:
# Relación normal entre diferentes entidades
for entity in entities_involved:
cardinality = cardinalities.get(entity, '1')
dot.edge(entity, rel_name, label=cardinality, color='black')
with NamedTemporaryFile(delete=False, suffix=f'.{output_format}') as tmp:
dot.render(tmp.name, format=output_format, cleanup=True)
return f"{tmp.name}.{output_format}"
except json.JSONDecodeError:
return "Error: Invalid JSON format"
except Exception as e:
return f"Error: {str(e)}"