mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
* docs: add comprehensive docstrings to Flow class and methods - Added NumPy-style docstrings to all decorator functions - Added detailed documentation to Flow class methods - Included parameter types, return types, and examples - Enhanced documentation clarity and completeness Co-Authored-By: Joe Moura <joao@crewai.com> * feat: add secure path handling utilities - Add path_utils.py with safe path handling functions - Implement path validation and security checks - Integrate secure path handling in flow_visualizer.py - Add path validation in html_template_handler.py - Add comprehensive error handling for path operations Co-Authored-By: Joe Moura <joao@crewai.com> * docs: add comprehensive docstrings and type hints to flow utils (#1819) Co-Authored-By: Joe Moura <joao@crewai.com> * fix: add type annotations and fix import sorting Co-Authored-By: Joe Moura <joao@crewai.com> * fix: add type annotations to flow utils and visualization utils Co-Authored-By: Joe Moura <joao@crewai.com> * fix: resolve import sorting and type annotation issues Co-Authored-By: Joe Moura <joao@crewai.com> * fix: properly initialize and update edge_smooth variable Co-Authored-By: Joe Moura <joao@crewai.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Joe Moura <joao@crewai.com>
87 lines
3.1 KiB
Python
87 lines
3.1 KiB
Python
import base64
|
|
import re
|
|
from pathlib import Path
|
|
|
|
from crewai.flow.path_utils import safe_path_join, validate_path_exists
|
|
|
|
|
|
class HTMLTemplateHandler:
|
|
def __init__(self, template_path, logo_path):
|
|
"""
|
|
Initialize HTMLTemplateHandler with validated template and logo paths.
|
|
|
|
Parameters
|
|
----------
|
|
template_path : str
|
|
Path to the HTML template file.
|
|
logo_path : str
|
|
Path to the logo image file.
|
|
|
|
Raises
|
|
------
|
|
ValueError
|
|
If template or logo paths are invalid or files don't exist.
|
|
"""
|
|
try:
|
|
self.template_path = validate_path_exists(template_path, "file")
|
|
self.logo_path = validate_path_exists(logo_path, "file")
|
|
except ValueError as e:
|
|
raise ValueError(f"Invalid template or logo path: {e}")
|
|
|
|
def read_template(self):
|
|
with open(self.template_path, "r", encoding="utf-8") as f:
|
|
return f.read()
|
|
|
|
def encode_logo(self):
|
|
with open(self.logo_path, "rb") as logo_file:
|
|
logo_svg_data = logo_file.read()
|
|
return base64.b64encode(logo_svg_data).decode("utf-8")
|
|
|
|
def extract_body_content(self, html):
|
|
match = re.search("<body.*?>(.*?)</body>", html, re.DOTALL)
|
|
return match.group(1) if match else ""
|
|
|
|
def generate_legend_items_html(self, legend_items):
|
|
legend_items_html = ""
|
|
for item in legend_items:
|
|
if "border" in item:
|
|
legend_items_html += f"""
|
|
<div class="legend-item">
|
|
<div class="legend-color-box" style="background-color: {item['color']}; border: 2px dashed {item['border']};"></div>
|
|
<div>{item['label']}</div>
|
|
</div>
|
|
"""
|
|
elif item.get("dashed") is not None:
|
|
style = "dashed" if item["dashed"] else "solid"
|
|
legend_items_html += f"""
|
|
<div class="legend-item">
|
|
<div class="legend-{style}" style="border-bottom: 2px {style} {item['color']};"></div>
|
|
<div>{item['label']}</div>
|
|
</div>
|
|
"""
|
|
else:
|
|
legend_items_html += f"""
|
|
<div class="legend-item">
|
|
<div class="legend-color-box" style="background-color: {item['color']};"></div>
|
|
<div>{item['label']}</div>
|
|
</div>
|
|
"""
|
|
return legend_items_html
|
|
|
|
def generate_final_html(self, network_body, legend_items_html, title="Flow Plot"):
|
|
html_template = self.read_template()
|
|
logo_svg_base64 = self.encode_logo()
|
|
|
|
final_html_content = html_template.replace("{{ title }}", title)
|
|
final_html_content = final_html_content.replace(
|
|
"{{ network_content }}", network_body
|
|
)
|
|
final_html_content = final_html_content.replace(
|
|
"{{ logo_svg_base64 }}", logo_svg_base64
|
|
)
|
|
final_html_content = final_html_content.replace(
|
|
"<!-- LEGEND_ITEMS_PLACEHOLDER -->", legend_items_html
|
|
)
|
|
|
|
return final_html_content
|