feat: add docstring (#1819)

Co-authored-by: João Moura <joaomdmoura@gmail.com>

src/crewai/flow/flow.py

@@ -95,7 +95,6 @@ def decorator(func):
 
     return decorator
 
-
 def listen(condition: Union[str, dict, Callable]) -> Callable:
     """
     Creates a listener that executes when specified conditions are met.
@@ -198,7 +197,6 @@ def router(condition: Union[str, dict, Callable]) -> Callable:
     """
     def decorator(func):
         func.__is_router__ = True
-        # Handle conditions like listen/start
         if isinstance(condition, str):
             func.__trigger_methods__ = [condition]
             func.__condition_type__ = "OR"
@@ -220,7 +218,6 @@ def decorator(func):
 
     return decorator
 
-
 def or_(*conditions: Union[str, dict, Callable]) -> dict:
     """
     Combines multiple conditions with OR logic for flow control.

src/crewai/flow/flow_visualizer.py

@@ -18,6 +18,8 @@
 
 
 class FlowPlot:
+    """Handles the creation and rendering of flow visualization diagrams."""
+
     def __init__(self, flow):
         """
         Initialize FlowPlot with a flow object.

src/crewai/flow/html_template_handler.py

@@ -6,6 +6,8 @@
 
 
 class HTMLTemplateHandler:
+    """Handles HTML template processing and generation for flow visualization diagrams."""
+
     def __init__(self, template_path, logo_path):
         """
         Initialize HTMLTemplateHandler with validated template and logo paths.
@@ -29,19 +31,23 @@ def __init__(self, template_path, logo_path):
             raise ValueError(f"Invalid template or logo path: {e}")
 
     def read_template(self):
+        """Read and return the HTML template file contents."""
         with open(self.template_path, "r", encoding="utf-8") as f:
             return f.read()
 
     def encode_logo(self):
+        """Convert the logo SVG file to base64 encoded string."""
         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):
+        """Extract and return content between body tags from HTML string."""
         match = re.search("<body.*?>(.*?)</body>", html, re.DOTALL)
         return match.group(1) if match else ""
 
     def generate_legend_items_html(self, legend_items):
+        """Generate HTML markup for the legend items."""
         legend_items_html = ""
         for item in legend_items:
             if "border" in item:
@@ -69,6 +75,7 @@ def generate_legend_items_html(self, legend_items):
         return legend_items_html
 
     def generate_final_html(self, network_body, legend_items_html, title="Flow Plot"):
+        """Combine all components into final HTML document with network visualization."""
         html_template = self.read_template()
         logo_svg_base64 = self.encode_logo()
 

src/crewai/flow/legend_generator.py

@@ -1,3 +1,4 @@
+
 def get_legend_items(colors):
     return [
         {"label": "Start Method", "color": colors["start"]},

src/crewai/flow/visualization_utils.py

@@ -55,6 +55,7 @@ def method_calls_crew(method: Any) -> bool:
         return False
 
     class CrewCallVisitor(ast.NodeVisitor):
+        """AST visitor to detect .crew() method calls."""
         def __init__(self):
             self.found = False