mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-10 08:38:30 +00:00
6c336d04da
- Modified ConsoleFormatter.print() to pause Live sessions when printing non-Tree content - Added _paused_tree attribute to store tree state during pauses - Updated pause_live_updates() and resume_live_updates() methods to properly restore Live sessions - Added comprehensive tests covering the logging conflict scenario - Fixes issue #3197 where custom Python loggers were suppressed when verbose=True The fix ensures custom loggers work properly while preserving CrewAI's live formatting functionality. Co-Authored-By: Jo\u00E3o <joao@crewai.com>
140 lines
3.9 KiB
Python
140 lines
3.9 KiB
Python
"""
|
|
Tests for issue #3197: Custom logger conflicts with Crew AI logging
|
|
"""
|
|
import logging
|
|
import io
|
|
import sys
|
|
from unittest.mock import patch
|
|
import pytest
|
|
from crewai import Agent, Task, Crew
|
|
from crewai.tools import BaseTool
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class TestInput(BaseModel):
|
|
message: str = Field(description="Message to log")
|
|
|
|
|
|
class CustomLoggingTool(BaseTool):
|
|
name: str = "custom_logging_tool"
|
|
description: str = "A tool that uses Python's logging module"
|
|
args_schema: type[BaseModel] = TestInput
|
|
|
|
def _run(self, message: str) -> str:
|
|
logger = logging.getLogger("test_custom_logger")
|
|
logger.setLevel(logging.INFO)
|
|
|
|
if not logger.handlers:
|
|
handler = logging.StreamHandler()
|
|
formatter = logging.Formatter('CUSTOM_LOG: %(message)s')
|
|
handler.setFormatter(formatter)
|
|
logger.addHandler(handler)
|
|
|
|
logger.info(f"Custom logger message: {message}")
|
|
print(f"Print message: {message}")
|
|
|
|
return f"Logged: {message}"
|
|
|
|
|
|
def test_custom_logger_with_verbose_false():
|
|
"""Test that custom loggers work when verbose=False"""
|
|
agent = Agent(
|
|
role="Test Agent",
|
|
goal="Test logging",
|
|
backstory="Testing agent",
|
|
tools=[CustomLoggingTool()],
|
|
verbose=False
|
|
)
|
|
|
|
task = Task(
|
|
description="Log a test message",
|
|
expected_output="Confirmation of logging",
|
|
agent=agent
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[agent],
|
|
tasks=[task],
|
|
verbose=False
|
|
)
|
|
|
|
with patch('sys.stdout', new_callable=io.StringIO) as mock_stdout:
|
|
result = crew.kickoff()
|
|
output = mock_stdout.getvalue()
|
|
|
|
assert "Custom logger message" in output or "Print message" in output
|
|
assert result is not None
|
|
|
|
|
|
def test_custom_logger_with_verbose_true():
|
|
"""Test that custom loggers work when verbose=True after the fix"""
|
|
agent = Agent(
|
|
role="Test Agent",
|
|
goal="Test logging",
|
|
backstory="Testing agent",
|
|
tools=[CustomLoggingTool()],
|
|
verbose=True
|
|
)
|
|
|
|
task = Task(
|
|
description="Log a test message",
|
|
expected_output="Confirmation of logging",
|
|
agent=agent
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[agent],
|
|
tasks=[task],
|
|
verbose=True
|
|
)
|
|
|
|
with patch('sys.stdout', new_callable=io.StringIO) as mock_stdout:
|
|
result = crew.kickoff()
|
|
output = mock_stdout.getvalue()
|
|
|
|
assert "Custom logger message" in output or "Print message" in output
|
|
assert result is not None
|
|
|
|
|
|
def test_console_formatter_pause_resume():
|
|
"""Test that ConsoleFormatter properly pauses and resumes Live sessions"""
|
|
from crewai.utilities.events.utils.console_formatter import ConsoleFormatter
|
|
from rich.tree import Tree
|
|
|
|
formatter = ConsoleFormatter(verbose=True)
|
|
|
|
tree = Tree("Test Tree")
|
|
formatter.print(tree)
|
|
|
|
assert formatter._live is not None
|
|
assert not formatter._live_paused
|
|
|
|
formatter.pause_live_updates()
|
|
assert formatter._live_paused
|
|
assert formatter._live is None
|
|
assert formatter._paused_tree is not None
|
|
|
|
formatter.resume_live_updates()
|
|
assert not formatter._live_paused
|
|
assert formatter._live is not None
|
|
|
|
|
|
def test_console_formatter_non_tree_printing():
|
|
"""Test that non-Tree content properly pauses/resumes Live sessions"""
|
|
from crewai.utilities.events.utils.console_formatter import ConsoleFormatter
|
|
from rich.tree import Tree
|
|
|
|
formatter = ConsoleFormatter(verbose=True)
|
|
|
|
tree = Tree("Test Tree")
|
|
formatter.print(tree)
|
|
|
|
assert formatter._live is not None
|
|
|
|
with patch('sys.stdout', new_callable=io.StringIO) as mock_stdout:
|
|
formatter.print("Non-tree content")
|
|
output = mock_stdout.getvalue()
|
|
|
|
assert "Non-tree content" in output
|
|
assert formatter._live is not None
|