Skip to content

A programming framework for agentic AI

Replace the use of `assert` in non-test code (#80)

Mohamed Attiaa3547f82c4eb
diff --git a/autogen/agentchat/conversable_agent.py b/autogen/agentchat/conversable_agent.py
index ce3169e17..7ab7cd349 100644
--- a/autogen/agentchat/conversable_agent.py
+++ b/autogen/agentchat/conversable_agent.py
@@ -2,6 +2,7 @@ import asyncio
from collections import defaultdict
import copy
import json
+import logging
from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
from autogen import oai
from .agent import Agent
@@ -21,6 +22,9 @@ except ImportError:
return x
+logger = logging.getLogger(__name__)
+
+
class ConversableAgent(Agent):
"""(In preview) A class for generic conversable agents which can be configured as assistant or user proxy.
@@ -757,7 +761,11 @@ class ConversableAgent(Agent):
Returns:
str or dict or None: reply. None if no reply is generated.
"""
- assert messages is not None or sender is not None, "Either messages or sender must be provided."
+ if all((messages is None, sender is None)):
+ error_msg = f"Either {messages=} or {sender=} must be provided."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
+
if messages is None:
messages = self._oai_messages[sender]
@@ -804,7 +812,11 @@ class ConversableAgent(Agent):
Returns:
str or dict or None: reply. None if no reply is generated.
"""
- assert messages is not None or sender is not None, "Either messages or sender must be provided."
+ if all((messages is None, sender is None)):
+ error_msg = f"Either {messages=} or {sender=} must be provided."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
+
if messages is None:
messages = self._oai_messages[sender]
diff --git a/autogen/code_utils.py b/autogen/code_utils.py
index e7d4faa8a..4e76b7073 100644
--- a/autogen/code_utils.py
+++ b/autogen/code_utils.py
@@ -26,6 +26,8 @@ DEFAULT_TIMEOUT = 600
WIN32 = sys.platform == "win32"
PATH_SEPARATOR = WIN32 and "\\" or "/"
+logger = logging.getLogger(__name__)
+
def infer_lang(code):
"""infer the language for the code.
@@ -250,7 +252,11 @@ def execute_code(
str: The error message if the code fails to execute; the stdout otherwise.
image: The docker image name after container run when docker is used.
"""
- assert code is not None or filename is not None, "Either code or filename must be provided."
+ if all((code is None, filename is None)):
+ error_msg = f"Either {code=} or {filename=} must be provided."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
+
timeout = timeout or DEFAULT_TIMEOUT
original_filename = filename
if WIN32 and lang in ["sh", "shell"]:
@@ -276,7 +282,7 @@ def execute_code(
f".\\{filename}" if WIN32 else filename,
]
if WIN32:
- logging.warning("SIGALRM is not supported on Windows. No timeout will be enforced.")
+ logger.warning("SIGALRM is not supported on Windows. No timeout will be enforced.")
result = subprocess.run(
cmd,
cwd=work_dir,
diff --git a/autogen/math_utils.py b/autogen/math_utils.py
index f664e765e..7f35470fa 100644
--- a/autogen/math_utils.py
+++ b/autogen/math_utils.py
@@ -35,8 +35,9 @@ def remove_boxed(string: str) -> Optional[str]:
"""
left = "\\boxed{"
try:
- assert string[: len(left)] == left
- assert string[-1] == "}"
+ if not all((string[: len(left)] == left, string[-1] == "}")):
+ raise AssertionError
+
return string[len(left) : -1]
except Exception:
return None
@@ -94,7 +95,8 @@ def _fix_fracs(string: str) -> str:
new_str += substr
else:
try:
- assert len(substr) >= 2
+ if not len(substr) >= 2:
+ raise AssertionError
except Exception:
return string
a = substr[0]
@@ -129,7 +131,8 @@ def _fix_a_slash_b(string: str) -> str:
try:
a = int(a_str)
b = int(b_str)
- assert string == "{}/{}".format(a, b)
+ if not string == "{}/{}".format(a, b):
+ raise AssertionError
new_string = "\\frac{" + str(a) + "}{" + str(b) + "}"
return new_string
except Exception:
@@ -143,7 +146,8 @@ def _remove_right_units(string: str) -> str:
"""
if "\\text{ " in string:
splits = string.split("\\text{ ")
- assert len(splits) == 2
+ if not len(splits) == 2:
+ raise AssertionError
return splits[0]
else:
return string
diff --git a/autogen/oai/completion.py b/autogen/oai/completion.py
index af2088ad9..55ca278f8 100644
--- a/autogen/oai/completion.py
+++ b/autogen/oai/completion.py
@@ -582,23 +582,31 @@ class Completion(openai_Completion):
cls._prompts = space.get("prompt")
if cls._prompts is None:
cls._messages = space.get("messages")
- assert isinstance(cls._messages, list) and isinstance(
- cls._messages[0], (dict, list)
- ), "messages must be a list of dicts or a list of lists."
+ if not all((isinstance(cls._messages, list), isinstance(cls._messages[0], (dict, list)))):
+ error_msg = "messages must be a list of dicts or a list of lists."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
if isinstance(cls._messages[0], dict):
cls._messages = [cls._messages]
space["messages"] = tune.choice(list(range(len(cls._messages))))
else:
- assert space.get("messages") is None, "messages and prompt cannot be provided at the same time."
- assert isinstance(cls._prompts, (str, list)), "prompt must be a string or a list of strings."
+ if space.get("messages") is not None:
+ error_msg = "messages and prompt cannot be provided at the same time."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
+ if not isinstance(cls._prompts, (str, list)):
+ error_msg = "prompt must be a string or a list of strings."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
if isinstance(cls._prompts, str):
cls._prompts = [cls._prompts]
space["prompt"] = tune.choice(list(range(len(cls._prompts))))
cls._stops = space.get("stop")
if cls._stops:
- assert isinstance(
- cls._stops, (str, list)
- ), "stop must be a string, a list of strings, or a list of lists of strings."
+ if not isinstance(cls._stops, (str, list)):
+ error_msg = "stop must be a string, a list of strings, or a list of lists of strings."
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
if not (isinstance(cls._stops, list) and isinstance(cls._stops[0], list)):
cls._stops = [cls._stops]
space["stop"] = tune.choice(list(range(len(cls._stops))))
@@ -969,7 +977,10 @@ class Completion(openai_Completion):
elif isinstance(agg_method, dict):
for key in metric_keys:
metric_agg_method = agg_method[key]
- assert callable(metric_agg_method), "please provide a callable for each metric"
+ if not callable(metric_agg_method):
+ error_msg = "please provide a callable for each metric"
+ logger.error(error_msg)
+ raise AssertionError(error_msg)
result_agg[key] = metric_agg_method([r[key] for r in result_list])
else:
raise ValueError(
diff --git a/autogen/retrieve_utils.py b/autogen/retrieve_utils.py
index cd8ccbde2..ecca2f2b0 100644
--- a/autogen/retrieve_utils.py
+++ b/autogen/retrieve_utils.py
@@ -29,6 +29,7 @@ TEXT_FORMATS = [
"yml",
"pdf",
]
+VALID_CHUNK_MODES = frozenset({"one_line", "multi_lines"})
def num_tokens_from_text(
@@ -96,7 +97,8 @@ def split_text_to_chunks(
overlap: int = 10,
):
"""Split a long text into chunks of max_tokens."""
- assert chunk_mode in {"one_line", "multi_lines"}
+ if chunk_mode not in VALID_CHUNK_MODES:
+ raise AssertionError
if chunk_mode == "one_line":
must_break_at_empty_line = False
chunks = []
diff --git a/setup.py b/setup.py
index bb642af4d..b9ec7af33 100644
--- a/setup.py
+++ b/setup.py
@@ -38,15 +38,18 @@ setuptools.setup(
install_requires=install_requires,
extras_require={
"test": [
- "pytest>=6.1.1",
+ "chromadb",
"coverage>=5.3",
- "pre-commit",
"datasets",
+ "ipykernel",
"nbconvert",
"nbformat",
- "ipykernel",
+ "pre-commit",
"pydantic==1.10.9",
+ "pytest-asyncio",
+ "pytest>=6.1.1",
"sympy",
+ "tiktoken",
"wolframalpha",
],
"blendsearch": ["flaml[blendsearch]"],
diff --git a/test/agentchat/test_conversable_agent.py b/test/agentchat/test_conversable_agent.py
index 9debb6a36..905e34bdd 100644
--- a/test/agentchat/test_conversable_agent.py
+++ b/test/agentchat/test_conversable_agent.py
@@ -2,6 +2,17 @@ import pytest
from autogen.agentchat import ConversableAgent
+def conversable_agent():
+ return ConversableAgent(
+ "conversable_agent_0",
+ max_consecutive_auto_reply=10,
+ code_execution_config=False,
+ llm_config=False,
+ human_input_mode="NEVER",
+ )
+
+
def test_trigger():
agent = ConversableAgent("a0", max_consecutive_auto_reply=0, llm_config=False, human_input_mode="NEVER")
agent1 = ConversableAgent("a1", max_consecutive_auto_reply=0, human_input_mode="NEVER")
@@ -217,6 +228,17 @@ def test_generate_reply():
), "generate_reply not working when messages is None"
+def test_generate_reply_raises_on_messages_and_sender_none(conversable_agent):
+ with pytest.raises(AssertionError):
+ conversable_agent.generate_reply(messages=None, sender=None)
+
+
+async def test_a_generate_reply_raises_on_messages_and_sender_none(conversable_agent):
+ with pytest.raises(AssertionError):
+ await conversable_agent.a_generate_reply(messages=None, sender=None)
+
+
if __name__ == "__main__":
test_trigger()
# test_context()
diff --git a/test/test_code.py b/test/test_code.py
index 06c6f9fa1..65c407cc3 100644
--- a/test/test_code.py
+++ b/test/test_code.py
@@ -264,6 +264,11 @@ def test_execute_code(use_docker=None):
assert isinstance(image, str) or docker is None or os.path.exists("/.dockerenv") or use_docker is False
+def test_execute_code_raises_when_code_and_filename_are_both_none():
+ with pytest.raises(AssertionError):
+ execute_code(code=None, filename=None)
+
+
@pytest.mark.skipif(
sys.platform in ["darwin"],
reason="do not run on MacOS",
diff --git a/test/test_retrieve_utils.py b/test/test_retrieve_utils.py
index 2232ed8db..b0743455f 100644
--- a/test/test_retrieve_utils.py
+++ b/test/test_retrieve_utils.py
@@ -48,6 +48,10 @@ class TestRetrieveUtils:
chunks = split_text_to_chunks(long_text, max_tokens=1000)
assert all(num_tokens_from_text(chunk) <= 1000 for chunk in chunks)
+ def test_split_text_to_chunks_raises_on_invalid_chunk_mode(self):
+ with pytest.raises(AssertionError):
+ split_text_to_chunks("A" * 10000, chunk_mode="bogus_chunk_mode")
+
def test_extract_text_from_pdf(self):
pdf_file_path = os.path.join(test_dir, "example.pdf")
assert "".join(expected_text.split()) == "".join(extract_text_from_pdf(pdf_file_path).strip().split())