Skip to content

Build and run agents you can see, understand and trust.

fix(utils): honour set_timestamp_factory in all entities (#2733)

lihongyuan9900d295b9d723
diff --git a/src/agentscope/event/_event.py b/src/agentscope/event/_event.py
index 40db34c7d..2e37fceb1 100644
--- a/src/agentscope/event/_event.py
+++ b/src/agentscope/event/_event.py
@@ -1,13 +1,12 @@
# -*- coding: utf-8 -*-
"""Event types for agent execution."""
-from datetime import datetime
from enum import StrEnum
from typing import Any, Dict, Literal, List, Self, TypeAlias
from pydantic import BaseModel, Field, ConfigDict, model_validator
from typing_extensions import deprecated
-from .._utils._common import _generate_id
+from .._utils._common import _generate_id, _generate_timestamp
from ..message import (
DataBlock,
TextBlock,
@@ -74,7 +73,7 @@ class EventBase(BaseModel):
id: str = Field(default_factory=_generate_id)
"""Unique event identifier."""
- created_at: str = Field(default_factory=lambda: datetime.now().isoformat())
+ created_at: str = Field(default_factory=_generate_timestamp)
"""ISO 8601 timestamp of when the event was created."""
metadata: Dict[str, Any] = Field(default_factory=dict)
"""Optional metadata attached to the event."""
diff --git a/src/agentscope/message/_base.py b/src/agentscope/message/_base.py
index 149f34d06..65205eb10 100644
--- a/src/agentscope/message/_base.py
+++ b/src/agentscope/message/_base.py
@@ -1,12 +1,11 @@
# -*- coding: utf-8 -*-
"""The message class in agentscope."""
import base64
-from datetime import datetime
from typing import Literal, List, overload, Sequence, Self, TYPE_CHECKING, Any
from pydantic import BaseModel, Field, model_validator
-from .._utils._common import _generate_id
+from .._utils._common import _generate_id, _generate_timestamp
from ._block import (
TextBlock,
ThinkingBlock,
@@ -92,7 +91,7 @@ class Msg(BaseModel):
metadata: dict = Field(default_factory=dict)
"""The metadata of the message"""
- created_at: str = Field(default_factory=lambda: datetime.now().isoformat())
+ created_at: str = Field(default_factory=_generate_timestamp)
"""The creation time of the message"""
usage: Usage | None = Field(default=None)
"""The token usage information of the message"""
@@ -574,7 +573,7 @@ def UserMsg(
`Msg`:
A :class:`Msg` instance with ``role="user"``.
"""
- created_at = created_at or datetime.now().isoformat()
+ created_at = created_at or _generate_timestamp()
if finished_at is None:
finished_at = created_at
return Msg(
@@ -637,7 +636,7 @@ def AssistantMsg(
content=_to_blocks(content),
role="assistant",
metadata=metadata or {},
- created_at=created_at or datetime.now().isoformat(),
+ created_at=created_at or _generate_timestamp(),
finished_at=finished_at,
finished_reason=finished_reason,
structured_output=structured_output,
@@ -683,7 +682,7 @@ def SystemMsg(
`Msg`:
A :class:`Msg` instance with ``role="system"``.
"""
- created_at = created_at or datetime.now().isoformat()
+ created_at = created_at or _generate_timestamp()
if finished_at is None:
finished_at = created_at
return Msg(
diff --git a/src/agentscope/model/_model_response.py b/src/agentscope/model/_model_response.py
index a7b68450c..ecffc70c8 100644
--- a/src/agentscope/model/_model_response.py
+++ b/src/agentscope/model/_model_response.py
@@ -2,12 +2,11 @@
"""The model response module."""
import base64
from dataclasses import dataclass, field
-from datetime import datetime
from enum import StrEnum
from typing import Any, Literal, Self, List
from ._model_usage import ChatUsage
-from .._utils._common import _generate_id
+from .._utils._common import _generate_id, _generate_timestamp
from .._utils._mixin import DictMixin
from ..message import (
TextBlock,
@@ -44,7 +43,7 @@ class ChatResponse(DictMixin):
id: str = field(default_factory=_generate_id)
"""The unique identifier."""
- created_at: str = field(default_factory=lambda: datetime.now().isoformat())
+ created_at: str = field(default_factory=_generate_timestamp)
"""When the response was created"""
type: Literal["chat_response"] = field(
@@ -328,7 +327,7 @@ class StructuredResponse:
id: str = field(default_factory=_generate_id)
"""The unique identifier."""
- created_at: str = field(default_factory=lambda: datetime.now().isoformat())
+ created_at: str = field(default_factory=_generate_timestamp)
"""When the response was created"""
type: Literal["structured_response"] = field(
diff --git a/src/agentscope/state/_task.py b/src/agentscope/state/_task.py
index ae594f1f3..9f68356c6 100644
--- a/src/agentscope/state/_task.py
+++ b/src/agentscope/state/_task.py
@@ -1,11 +1,10 @@
# -*- coding: utf-8 -*-
"""The task class."""
-from datetime import datetime
from typing import Any, Literal
from pydantic import BaseModel, Field
-from .._utils._common import _generate_id
+from .._utils._common import _generate_id, _generate_timestamp
class Task(BaseModel):
@@ -20,7 +19,7 @@ class Task(BaseModel):
metadata: dict[str, Any]
"""The additional metadata of the task."""
- created_at: str = Field(default_factory=lambda: datetime.now().isoformat())
+ created_at: str = Field(default_factory=_generate_timestamp)
"""The created timestamp."""
state: Literal["pending", "in_progress", "completed"] = "pending"
diff --git a/tests/id_factory_test.py b/tests/id_factory_test.py
index b3f58462d..baf852a32 100644
--- a/tests/id_factory_test.py
+++ b/tests/id_factory_test.py
@@ -1,23 +1,33 @@
# -*- coding: utf-8 -*-
-"""Tests for the configurable ID factory."""
+"""Tests for the configurable ID and timestamp factories."""
import re
from unittest.async_case import IsolatedAsyncioTestCase
-from agentscope import set_id_factory
-from agentscope.message import Msg, TextBlock
+from agentscope import set_id_factory, set_timestamp_factory
+from agentscope.event import ReplyStartEvent
+from agentscope.message import (
+ AssistantMsg,
+ Msg,
+ SystemMsg,
+ TextBlock,
+ UserMsg,
+)
+from agentscope.model import ChatResponse, StructuredResponse
+from agentscope.state import Task
_HEX32_RE = re.compile(r"^[0-9a-f]{32}$")
class IdFactoryTest(IsolatedAsyncioTestCase):
- """Tests for set_id_factory."""
+ """Tests for set_id_factory and set_timestamp_factory."""
async def asyncSetUp(self) -> None:
- """Save the current factory before each test."""
+ """Save the current factories before each test."""
import agentscope._utils._common as common
# pylint: disable=protected-access
self._saved_factory = common._id_factory
+ self._saved_timestamp_factory = common._timestamp_factory
async def test_default_id_factory_returns_hex32(self) -> None:
"""The default ID factory returns uuid.uuid4().hex."""
@@ -41,9 +51,59 @@ class IdFactoryTest(IsolatedAsyncioTestCase):
self.assertEqual(msg.id, "custom-entity-id")
self.assertEqual(msg.content[0].id, "custom-entity-id")
+ async def test_custom_timestamp_factory_affects_entities(self) -> None:
+ """After ``set_timestamp_factory``, entities use the custom factory."""
+ set_timestamp_factory(lambda: "custom-timestamp")
+
+ msg = Msg(name="test", content=[TextBlock(text="hello")], role="user")
+ self.assertDictEqual(
+ {
+ "block": msg.content[0].created_at,
+ "msg": msg.created_at,
+ "user_msg": UserMsg(name="test", content="hello").created_at,
+ "assistant_msg": AssistantMsg(
+ name="test",
+ content="hello",
+ ).created_at,
+ "system_msg": SystemMsg(
+ name="test",
+ content="hello",
+ ).created_at,
+ "event": ReplyStartEvent(
+ session_id="s",
+ reply_id="r",
+ name="test",
+ ).created_at,
+ "task": Task(
+ subject="s",
+ description="d",
+ metadata={},
+ ).created_at,
+ "chat_response": ChatResponse(
+ content=[],
+ is_last=True,
+ ).created_at,
+ "structured_response": StructuredResponse(
+ content={},
+ ).created_at,
+ },
+ {
+ "block": "custom-timestamp",
+ "msg": "custom-timestamp",
+ "user_msg": "custom-timestamp",
+ "assistant_msg": "custom-timestamp",
+ "system_msg": "custom-timestamp",
+ "event": "custom-timestamp",
+ "task": "custom-timestamp",
+ "chat_response": "custom-timestamp",
+ "structured_response": "custom-timestamp",
+ },
+ )
+
async def asyncTearDown(self) -> None:
- """Restore the original factory after each test."""
+ """Restore the original factories after each test."""
import agentscope._utils._common as common
# pylint: disable=protected-access
common._id_factory = self._saved_factory
+ common._timestamp_factory = self._saved_timestamp_factory