econagents 0.0.1__tar.gz → 0.0.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. econagents-0.0.3/LICENSE +21 -0
  2. {econagents-0.0.1 → econagents-0.0.3}/PKG-INFO +23 -16
  3. {econagents-0.0.1 → econagents-0.0.3}/README.md +8 -4
  4. {econagents-0.0.1 → econagents-0.0.3}/econagents/__init__.py +4 -2
  5. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/agent_role.py +19 -10
  6. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/game_runner.py +28 -5
  7. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/manager/base.py +64 -3
  8. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/manager/phase.py +36 -59
  9. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/state/game.py +23 -1
  10. econagents-0.0.3/econagents/llm/__init__.py +20 -0
  11. econagents-0.0.3/econagents/llm/base.py +62 -0
  12. econagents-0.0.3/econagents/llm/observability.py +282 -0
  13. econagents-0.0.3/econagents/llm/ollama.py +77 -0
  14. econagents-0.0.3/econagents/llm/openai.py +77 -0
  15. {econagents-0.0.1 → econagents-0.0.3}/pyproject.toml +50 -18
  16. econagents-0.0.1/econagents/llm/__init__.py +0 -3
  17. econagents-0.0.1/econagents/llm/openai.py +0 -61
  18. {econagents-0.0.1 → econagents-0.0.3}/econagents/_c_extension.pyi +0 -0
  19. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/__init__.py +0 -0
  20. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/events.py +0 -0
  21. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/logging_mixin.py +0 -0
  22. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/manager/__init__.py +0 -0
  23. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/state/__init__.py +0 -0
  24. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/state/fields.py +0 -0
  25. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/state/market.py +0 -0
  26. {econagents-0.0.1 → econagents-0.0.3}/econagents/core/transport.py +0 -0
  27. {econagents-0.0.1 → econagents-0.0.3}/econagents/py.typed +0 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) Delft University of Technology
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,24 +1,27 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: econagents
3
- Version: 0.0.1
3
+ Version: 0.0.3
4
4
  Summary:
5
- License: Apache-2.0
6
- Author: Dylan
7
- Requires-Python: >=3.10,<3.13
8
- Classifier: License :: OSI Approved :: Apache Software License
5
+ License: MIT
6
+ Author: Dylan Castillo
7
+ Author-email: dylan@iwanalabs.com
8
+ Requires-Python: >=3.10,<4
9
+ Classifier: License :: OSI Approved :: MIT License
9
10
  Classifier: Programming Language :: Python :: 3
10
11
  Classifier: Programming Language :: Python :: 3.10
11
12
  Classifier: Programming Language :: Python :: 3.11
12
13
  Classifier: Programming Language :: Python :: 3.12
13
- Requires-Dist: langsmith (>=0.3.13,<0.4.0)
14
- Requires-Dist: numpy (>=2.2.3,<3.0.0)
15
- Requires-Dist: openai (>=1.65.5,<2.0.0)
16
- Requires-Dist: pydantic (>=2.10.6,<3.0.0)
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Provides-Extra: all
16
+ Provides-Extra: default
17
+ Provides-Extra: langfuse
18
+ Provides-Extra: langsmith
19
+ Provides-Extra: ollama
20
+ Provides-Extra: openai
21
+ Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
22
+ Requires-Dist: pydantic (>=2.11.3,<3.0.0)
17
23
  Requires-Dist: requests (>=2.32.3,<3.0.0)
18
- Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
19
24
  Requires-Dist: websockets (>=15.0,<16.0)
20
- Project-URL: Homepage, https://github.com/iwanalabs/econagents
21
- Project-URL: Repository, https://github.com/iwanalabs/econagents
22
25
  Description-Content-Type: text/markdown
23
26
 
24
27
  <div align="center">
@@ -61,13 +64,15 @@ econagents consists of four key components:
61
64
 
62
65
  ## Example Experiments
63
66
 
64
- The repository includes two example experiments:
67
+ The repository includes three example games:
65
68
 
66
69
  1. **`prisoner`**: An iterated Prisoner's Dilemma game with 5 rounds and 2 LLM agents.
67
- 2. **`tudeflt/harberger`**: A Harberger Tax simulation with LLM agents.
68
- 3. **`tudeflt/futarchy`**: A Futarchy simulation with LLM agents.
70
+ 2. **`ibex_tudelft/harberger`**: A Harberger Tax simulation with LLM agents.
71
+ 3. **`ibex_tudelft/futarchy`**: A Futarchy simulation with LLM agents.
69
72
 
70
- ### Running the Prisoner's Dilemma Experiment
73
+ ### Running the Prisoner's Dilemma game
74
+
75
+ The simplest game to run is a version of the repeated prisoner's dilemma game that runs on your local machine.
71
76
 
72
77
  ```shell
73
78
  # Run the server
@@ -77,6 +82,8 @@ python examples/server/prisoner/server.py
77
82
  python examples/prisoner/run_game.py
78
83
  ```
79
84
 
85
+ Note: you still have to set up the connection to the agents.
86
+
80
87
  ## Key Features
81
88
 
82
89
  - **Flexible Agent Customization**: Customize agent behavior with Jinja templates or custom Python methods
@@ -38,13 +38,15 @@ econagents consists of four key components:
38
38
 
39
39
  ## Example Experiments
40
40
 
41
- The repository includes two example experiments:
41
+ The repository includes three example games:
42
42
 
43
43
  1. **`prisoner`**: An iterated Prisoner's Dilemma game with 5 rounds and 2 LLM agents.
44
- 2. **`tudeflt/harberger`**: A Harberger Tax simulation with LLM agents.
45
- 3. **`tudeflt/futarchy`**: A Futarchy simulation with LLM agents.
44
+ 2. **`ibex_tudelft/harberger`**: A Harberger Tax simulation with LLM agents.
45
+ 3. **`ibex_tudelft/futarchy`**: A Futarchy simulation with LLM agents.
46
46
 
47
- ### Running the Prisoner's Dilemma Experiment
47
+ ### Running the Prisoner's Dilemma game
48
+
49
+ The simplest game to run is a version of the repeated prisoner's dilemma game that runs on your local machine.
48
50
 
49
51
  ```shell
50
52
  # Run the server
@@ -54,6 +56,8 @@ python examples/server/prisoner/server.py
54
56
  python examples/prisoner/run_game.py
55
57
  ```
56
58
 
59
+ Note: you still have to set up the connection to the agents.
60
+
57
61
  ## Key Features
58
62
 
59
63
  - **Flexible Agent Customization**: Customize agent behavior with Jinja templates or custom Python methods
@@ -1,17 +1,18 @@
1
1
  """
2
- econagents: A Python library for setting up and running economic experiments with LLMs or human subjects.
2
+ econagents: A Python library that lets you use LLM agents in economic experiments.
3
3
  """
4
4
 
5
5
  from econagents.core.agent_role import AgentRole
6
6
  from econagents.core.game_runner import GameRunner, HybridGameRunnerConfig, TurnBasedGameRunnerConfig
7
7
  from econagents.core.manager import AgentManager
8
+ from econagents.core.transport import WebSocketTransport
8
9
  from econagents.core.manager.phase import PhaseManager, HybridPhaseManager, TurnBasedPhaseManager
9
10
  from econagents.core.state.fields import EventField
10
11
  from econagents.core.state.game import GameState, MetaInformation, PrivateInformation, PublicInformation
11
12
  from econagents.llm.openai import ChatOpenAI
12
13
 
13
14
  # Don't manually change, let poetry-dynamic-versioning handle it.
14
- __version__ = "0.0.1"
15
+ __version__ = "0.0.3"
15
16
 
16
17
  __all__: list[str] = [
17
18
  "AgentRole",
@@ -28,4 +29,5 @@ __all__: list[str] = [
28
29
  "TurnBasedGameRunnerConfig",
29
30
  "HybridGameRunnerConfig",
30
31
  "EventField",
32
+ "WebSocketTransport",
31
33
  ]
@@ -3,13 +3,14 @@ import logging
3
3
  import re
4
4
  from abc import ABC
5
5
  from pathlib import Path
6
+ from jinja2 import FileSystemLoader
6
7
  from typing import Any, Callable, ClassVar, Dict, Generic, Literal, Optional, Pattern, Protocol, TypeVar
7
8
 
8
9
  from jinja2.sandbox import SandboxedEnvironment
9
10
 
10
11
  from econagents.core.logging_mixin import LoggerMixin
11
12
  from econagents.core.state.game import GameStateProtocol
12
- from econagents.llm.openai import ChatOpenAI
13
+ from econagents.llm.base import BaseLLM
13
14
 
14
15
  StateT_contra = TypeVar("StateT_contra", bound=GameStateProtocol, contravariant=True)
15
16
 
@@ -17,7 +18,7 @@ StateT_contra = TypeVar("StateT_contra", bound=GameStateProtocol, contravariant=
17
18
  class AgentProtocol(Protocol):
18
19
  role: ClassVar[int]
19
20
  name: ClassVar[str]
20
- llm: ChatOpenAI
21
+ llm: BaseLLM
21
22
  task_phases: ClassVar[list[int]]
22
23
 
23
24
 
@@ -41,12 +42,12 @@ class AgentRole(ABC, Generic[StateT_contra], LoggerMixin):
41
42
  """Unique identifier for this role"""
42
43
  name: ClassVar[str]
43
44
  """Human-readable name for this role"""
44
- llm: ChatOpenAI
45
+ llm: BaseLLM
45
46
  """Language model instance for generating responses"""
46
47
  task_phases: ClassVar[list[int]] = [] # Empty list means no specific phases are required
47
48
  """List of phases this agent should participate in (empty means all phases)"""
48
49
  task_phases_excluded: ClassVar[list[int]] = [] # Empty list means no phases are excluded
49
-
50
+ """ Alternative way to specify phases this agent should participate in, listed phases are excluded (empty means nothing excluded)"""
50
51
  # Regex patterns for method name extraction
51
52
  _SYSTEM_PROMPT_PATTERN: ClassVar[Pattern] = re.compile(r"get_phase_(\d+)_system_prompt")
52
53
  _USER_PROMPT_PATTERN: ClassVar[Pattern] = re.compile(r"get_phase_(\d+)_user_prompt")
@@ -109,9 +110,9 @@ class AgentRole(ABC, Generic[StateT_contra], LoggerMixin):
109
110
 
110
111
  Template resolution order:
111
112
 
112
- 1. Agent-specific phase prompt (e.g., "agent_name_system_phase_1.jinja2")
113
+ 1. Role-specific phase prompt (e.g., "role_name_system_phase_1.jinja2")
113
114
 
114
- 2. Agent-specific general prompt (e.g., "agent_name_system.jinja2")
115
+ 2. Role-specific general prompt (e.g., "role_name_system.jinja2")
115
116
 
116
117
  3. All-role phase prompt (e.g., "all_system_phase_1.jinja2")
117
118
 
@@ -129,12 +130,20 @@ class AgentRole(ABC, Generic[StateT_contra], LoggerMixin):
129
130
  Raises:
130
131
  FileNotFoundError: If no matching prompt template is found
131
132
  """
133
+ # Initialize Jinja environment with a file system loader
134
+ env = SandboxedEnvironment(loader=FileSystemLoader(prompts_path))
135
+
132
136
  # Try role-specific prompt first, then fall back to 'all'
133
137
  for role in [self.name, "all"]:
134
- if prompt_file := self._resolve_prompt_file(prompt_type, phase, role, prompts_path):
135
- with prompt_file.open() as f:
136
- template = SandboxedEnvironment().from_string(f.read())
137
- return template.render(**context)
138
+ if prompt_file_path := self._resolve_prompt_file(prompt_type, phase, role, prompts_path):
139
+ # Get filename relative to the prompts_path for the loader
140
+ template_filename = str(prompt_file_path.relative_to(prompts_path))
141
+ try:
142
+ template = env.get_template(template_filename)
143
+ return template.render(**context)
144
+ except Exception as e: # Catch potential Jinja errors during loading/rendering
145
+ self.logger.error(f"Error loading/rendering template {template_filename}: {e}")
146
+ raise # Re-raise after logging
138
147
 
139
148
  raise FileNotFoundError(
140
149
  f"No prompt template found for type={prompt_type}, phase={phase}, "
@@ -4,14 +4,14 @@ import queue
4
4
  from contextvars import ContextVar
5
5
  from logging.handlers import QueueHandler, QueueListener
6
6
  from pathlib import Path
7
- from typing import Optional, Type
7
+ from typing import Literal, Optional, Type
8
8
 
9
9
  from pydantic import BaseModel, Field
10
10
 
11
- from econagents.core.manager.base import AgentManager
12
11
  from econagents.core.manager.phase import PhaseManager
13
12
  from econagents.core.state.game import GameState
14
13
  from econagents.core.transport import AuthenticationMechanism, SimpleLoginPayloadAuth
14
+ from econagents.llm.observability import get_observability_provider
15
15
 
16
16
  ctx_agent_id: ContextVar[str] = ContextVar("agent_id", default="N/A")
17
17
 
@@ -59,6 +59,14 @@ class GameRunnerConfig(BaseModel):
59
59
  state_class: Optional[Type[GameState]] = None
60
60
  """Class to use for the state"""
61
61
 
62
+ # Observability configuration
63
+ observability_provider: Optional[Literal["langsmith", "langfuse"]] = None
64
+ """Name of the observability provider to use. Options: 'langsmith' or 'langfuse'"""
65
+
66
+ # Agent stop configuration
67
+ end_game_event: str = "game-over"
68
+ """Event type that signals the end of the game and should stop the agent."""
69
+
62
70
 
63
71
  class TurnBasedGameRunnerConfig(GameRunnerConfig):
64
72
  """Configuration class for TurnBasedGameRunner."""
@@ -299,12 +307,26 @@ class GameRunner:
299
307
  agent_manager.auth_mechanism = self.config.auth_mechanism
300
308
  agent_manager.logger.debug(f"Injected default auth mechanism: {agent_manager.auth_mechanism}")
301
309
 
310
+ if agent_manager.end_game_event_type != self.config.end_game_event:
311
+ agent_manager.end_game_event_type = self.config.end_game_event
312
+ agent_manager.logger.debug(f"Injected default end game event: {agent_manager.end_game_event_type}")
313
+
314
+ if agent_manager.llm_provider and self.config.observability_provider:
315
+ try:
316
+ provider = get_observability_provider(self.config.observability_provider)
317
+ agent_manager.llm_provider.observability = provider
318
+ agent_manager.logger.debug(
319
+ f"Injected {self.config.observability_provider} observability provider into LLM provider"
320
+ )
321
+ except Exception as e:
322
+ agent_manager.logger.error(f"Failed to initialize observability provider: {e}")
323
+
302
324
  if isinstance(self.config, HybridGameRunnerConfig):
303
325
  agent_manager.continuous_phases = set(self.config.continuous_phases)
304
326
  agent_manager.min_action_delay = self.config.min_action_delay
305
327
  agent_manager.max_action_delay = self.config.max_action_delay
306
328
  agent_manager.logger.debug(
307
- f"Injected default continuous phases: {agent_manager.continuous_phases}, min action delay: {agent_manager.min_action_delay}, max action delay: {agent_manager.max_action_delay}"
329
+ f"Injected default continuous-time phases: {agent_manager.continuous_phases}, min action delay: {agent_manager.min_action_delay}, max action delay: {agent_manager.max_action_delay}"
308
330
  )
309
331
 
310
332
  def _inject_agent_logger(self, agent_manager: PhaseManager, agent_id: int) -> None:
@@ -335,7 +357,7 @@ class GameRunner:
335
357
  agent_manager.logger.info(f"Connecting to WebSocket URL: {agent_manager.url}")
336
358
  await agent_manager.start()
337
359
  except Exception:
338
- agent_manager.logger.exception(f"Error in simulation for Agent {agent_id}")
360
+ agent_manager.logger.exception(f"Error in game for Agent {agent_id}")
339
361
  raise
340
362
 
341
363
  async def run_game(self) -> None:
@@ -346,7 +368,7 @@ class GameRunner:
346
368
 
347
369
  try:
348
370
  tasks = []
349
- game_logger.info("Starting simulations")
371
+ game_logger.info("Starting game")
350
372
 
351
373
  for i, agent_manager in enumerate(self.agents, start=1):
352
374
  tasks.append(self.spawn_agent(agent_manager, i))
@@ -355,4 +377,5 @@ class GameRunner:
355
377
  game_logger.exception(f"Failed to run game: {e}")
356
378
  raise
357
379
  finally:
380
+ game_logger.info("Game over")
358
381
  self.cleanup_logging()
@@ -68,6 +68,10 @@ class AgentManager(LoggerMixin):
68
68
  self._global_pre_event_hooks: list[Callable[[Message], Any]] = []
69
69
  self._global_post_event_hooks: list[Callable[[Message], Any]] = []
70
70
 
71
+ # Default event type to trigger stopping the agent
72
+ self._end_game_event_type: str = "game-over"
73
+ self.register_event_handler(self._end_game_event_type, self._handle_end_game)
74
+
71
75
  # Initialize transport if URL is provided
72
76
  if url:
73
77
  self._initialize_transport()
@@ -156,6 +160,30 @@ class AgentManager(LoggerMixin):
156
160
  return None
157
161
  return Message(message_type=message_type, event_type=event_type, data=data)
158
162
 
163
+ @property
164
+ def end_game_event_type(self) -> str:
165
+ """Get the event type that triggers the agent to stop."""
166
+ return self._end_game_event_type
167
+
168
+ @end_game_event_type.setter
169
+ def end_game_event_type(self, value: str):
170
+ """
171
+ Set the event type that triggers the agent to stop.
172
+
173
+ Unregisters the stop handler from the old event type and registers it
174
+ for the new event type.
175
+
176
+ Args:
177
+ value (str): The new event type to listen for.
178
+ """
179
+ if self._end_game_event_type != value:
180
+ # Unregister from the old event type
181
+ self.unregister_event_handler(self._end_game_event_type, self._handle_end_game)
182
+ # Register for the new event type
183
+ self._end_game_event_type = value
184
+ self.register_event_handler(self._end_game_event_type, self._handle_end_game)
185
+ self.logger.info(f"End game event type set to: {value}")
186
+
159
187
  async def on_message(self, message: Message):
160
188
  """
161
189
  Default implementation to handle incoming messages from the server.
@@ -202,6 +230,7 @@ class AgentManager(LoggerMixin):
202
230
  self.running = False
203
231
  if self.transport:
204
232
  await self.transport.stop()
233
+ self.logger.info("Agent manager stopped and connection closed.")
205
234
 
206
235
  async def on_event(self, message: Message):
207
236
  """
@@ -270,6 +299,16 @@ class AgentManager(LoggerMixin):
270
299
  if hasattr(result, "__await__"):
271
300
  await result
272
301
 
302
+ async def _handle_end_game(self, message: Message):
303
+ """
304
+ Default handler for the 'end_game_event_type'. Stops the agent manager.
305
+
306
+ Args:
307
+ message (Message): The event message triggering the end game.
308
+ """
309
+ self.logger.info(f"Received end game event ({message.event_type}). Stopping agent manager...")
310
+ await self.stop()
311
+
273
312
  # Event handler registration
274
313
  def register_event_handler(self, event_type: str, handler: Callable[[Message], Any]):
275
314
  """
@@ -355,7 +394,17 @@ class AgentManager(LoggerMixin):
355
394
  if handler is None:
356
395
  self._event_handlers.pop(event_type)
357
396
  else:
358
- self._event_handlers[event_type] = [h for h in self._event_handlers[event_type] if h != handler]
397
+ # Use list comprehension to avoid modifying list while iterating
398
+ handlers_to_keep = [h for h in self._event_handlers[event_type] if h != handler]
399
+ if not handlers_to_keep:
400
+ # Remove the key if the list becomes empty
401
+ self._event_handlers.pop(event_type, None)
402
+ else:
403
+ self._event_handlers[event_type] = handlers_to_keep
404
+ # Explicitly handle removal of the default end game handler
405
+ if event_type == self._end_game_event_type and handler == self._handle_end_game:
406
+ self.logger.warning(f"Default end game handler for '{event_type}' unregistered.")
407
+
359
408
  return self
360
409
 
361
410
  def unregister_global_event_handler(self, handler: Optional[Callable] = None):
@@ -384,7 +433,13 @@ class AgentManager(LoggerMixin):
384
433
  if hook is None:
385
434
  self._pre_event_hooks.pop(event_type)
386
435
  else:
387
- self._pre_event_hooks[event_type] = [h for h in self._pre_event_hooks[event_type] if h != hook]
436
+ # Use list comprehension to avoid modifying list while iterating
437
+ hooks_to_keep = [h for h in self._pre_event_hooks[event_type] if h != hook]
438
+ if not hooks_to_keep:
439
+ # Remove the key if the list becomes empty
440
+ self._pre_event_hooks.pop(event_type, None)
441
+ else:
442
+ self._pre_event_hooks[event_type] = hooks_to_keep
388
443
  return self
389
444
 
390
445
  def unregister_global_pre_event_hook(self, hook: Optional[Callable] = None):
@@ -413,7 +468,13 @@ class AgentManager(LoggerMixin):
413
468
  if hook is None:
414
469
  self._post_event_hooks.pop(event_type)
415
470
  else:
416
- self._post_event_hooks[event_type] = [h for h in self._post_event_hooks[event_type] if h != hook]
471
+ # Use list comprehension to avoid modifying list while iterating
472
+ hooks_to_keep = [h for h in self._post_event_hooks[event_type] if h != hook]
473
+ if not hooks_to_keep:
474
+ # Remove the key if the list becomes empty
475
+ self._post_event_hooks.pop(event_type, None)
476
+ else:
477
+ self._post_event_hooks[event_type] = hooks_to_keep
417
478
  return self
418
479
 
419
480
  def unregister_global_post_event_hook(self, hook: Optional[Callable] = None):
@@ -3,30 +3,28 @@ import json
3
3
  import logging
4
4
  import random
5
5
  from abc import ABC, abstractmethod
6
- from typing import Any, Callable, Optional
7
6
  from pathlib import Path
7
+ from typing import Any, Callable, Optional
8
8
 
9
9
  from econagents.core.agent_role import AgentRole
10
10
  from econagents.core.events import Message
11
11
  from econagents.core.manager.base import AgentManager
12
12
  from econagents.core.state.game import GameState
13
- from econagents.core.transport import AuthenticationMechanism, SimpleLoginPayloadAuth
13
+ from econagents.core.transport import AuthenticationMechanism
14
14
 
15
15
 
16
16
  class PhaseManager(AgentManager, ABC):
17
17
  """
18
18
  Abstract manager that handles the concept of 'phases' in a game.
19
19
 
20
- This manager standardizes the interface for phase-based games with hooks for
21
- phase transitions and optional continuous phase handling.
20
+ This manager standardizes the interface for phase-based games with optional
21
+ continuous-time phase handling.
22
22
 
23
23
  Features:
24
24
  1. Standardized interface for starting a phase
25
25
 
26
26
  2. Optional continuous "tick loop" for phases
27
27
 
28
- 3. Hooks for "on phase start," "on phase end," and "on phase transition event"
29
-
30
28
  All configuration parameters can be:
31
29
 
32
30
  1. Provided at initialization time
@@ -38,8 +36,8 @@ class PhaseManager(AgentManager, ABC):
38
36
  phase_transition_event (Optional[str]): Event name for phase transitions
39
37
  phase_identifier_key (Optional[str]): Key in the event data that identifies the phase
40
38
  continuous_phases (Optional[set[int]]): set of phase numbers that should be treated as continuous
41
- min_action_delay (Optional[int]): Minimum delay in seconds between actions in continuous phases
42
- max_action_delay (Optional[int]): Maximum delay in seconds between actions in continuous phases
39
+ min_action_delay (Optional[int]): Minimum delay in seconds between actions in continuous-time phases
40
+ max_action_delay (Optional[int]): Maximum delay in seconds between actions in continuous-time phases
43
41
  state (Optional[GameState]): Game state object to track game state
44
42
  agent_role (Optional[AgentRole]): Agent role instance to handle game phases
45
43
  auth_mechanism (Optional[AuthenticationMechanism]): Authentication mechanism to use
@@ -145,12 +143,12 @@ class PhaseManager(AgentManager, ABC):
145
143
 
146
144
  @property
147
145
  def continuous_phases(self) -> set[int]:
148
- """Get the set of continuous phases."""
146
+ """Get the set of continuous-time phases."""
149
147
  return self._continuous_phases # type: ignore
150
148
 
151
149
  @continuous_phases.setter
152
150
  def continuous_phases(self, value: set[int]):
153
- """Set the continuous phases."""
151
+ """Set the continuous-time phases."""
154
152
  self._continuous_phases = value
155
153
 
156
154
  @property
@@ -183,6 +181,13 @@ class PhaseManager(AgentManager, ABC):
183
181
  """Set the prompts directory."""
184
182
  self._prompts_dir = value
185
183
 
184
+ @property
185
+ def llm_provider(self):
186
+ """Get the LLM provider from the agent role."""
187
+ if self._agent_role and hasattr(self._agent_role, "llm"):
188
+ return self._agent_role.llm
189
+ return None
190
+
186
191
  async def start(self):
187
192
  """Start the manager."""
188
193
  # TODO: is there a better place to do this?
@@ -220,38 +225,27 @@ class PhaseManager(AgentManager, ABC):
220
225
  Handle a phase transition.
221
226
 
222
227
  This method is the main orchestrator for phase transitions:
223
- 1. If leaving a continuous phase, stops the continuous task
224
- 2. Calls the on_phase_end hook for the old phase
225
- 3. Updates the current phase
226
- 4. Calls the on_phase_start hook for the new phase
227
- 5. Starts a continuous task if entering a continuous phase
228
- 6. Executes a single action if entering a non-continuous phase
228
+ 1. If leaving a continuous-time phase, stops the continuous task
229
+ 2. Updates the current phase
230
+ 3. Starts a continuous task if entering a continuous-time phase
231
+ 4. Executes a single action if entering a non-continuous-time phase
229
232
 
230
233
  Args:
231
234
  new_phase (Optional[int]): The new phase number
232
235
  """
233
236
  self.logger.info(f"Transitioning to phase {new_phase}")
234
237
 
235
- # If we were in a continuous phase, stop it
238
+ # If we were in a continuous-time phase, stop it
236
239
  if self.in_continuous_phase and new_phase != self.current_phase:
237
- self.logger.info(f"Stopping continuous phase {self.current_phase}")
240
+ self.logger.info(f"Stopping continuous-time phase {self.current_phase}")
238
241
  self.in_continuous_phase = False
239
242
  if self._continuous_task:
240
243
  self._continuous_task.cancel()
241
244
  self._continuous_task = None
242
245
 
243
- # Call the on_phase_end hook for the old phase
244
- old_phase = self.current_phase
245
- if old_phase is not None:
246
- await self.on_phase_end(old_phase)
247
-
248
- # Update current phase
249
246
  self.current_phase = new_phase
250
247
 
251
248
  if new_phase is not None:
252
- # Call the on_phase_start hook for the new phase
253
- await self.on_phase_start(new_phase)
254
-
255
249
  # If the new phase is continuous, start a continuous task
256
250
  if self.continuous_phases and new_phase in self.continuous_phases:
257
251
  self.in_continuous_phase = True
@@ -260,12 +254,12 @@ class PhaseManager(AgentManager, ABC):
260
254
  # Execute an initial action
261
255
  await self.execute_phase_action(new_phase)
262
256
  else:
263
- # Execute a single action for non-continuous phases
257
+ # Execute a single action for non-continuous-time phases
264
258
  await self.execute_phase_action(new_phase)
265
259
 
266
260
  async def _continuous_phase_loop(self, phase: int):
267
261
  """
268
- Run a loop that periodically executes actions for a continuous phase.
262
+ Run a loop that periodically executes actions for a continuous-time phase.
269
263
 
270
264
  Args:
271
265
  phase (int): The phase number
@@ -277,16 +271,16 @@ class PhaseManager(AgentManager, ABC):
277
271
  self.logger.debug(f"Waiting {delay} seconds before next action in phase {phase}")
278
272
  await asyncio.sleep(delay)
279
273
 
280
- # Check if we're still in the same continuous phase
274
+ # Check if we're still in the same continuous-time phase
281
275
  if not self.in_continuous_phase or self.current_phase != phase:
282
276
  break
283
277
 
284
278
  # Execute the action
285
279
  await self.execute_phase_action(phase)
286
280
  except asyncio.CancelledError:
287
- self.logger.info(f"Continuous phase {phase} loop cancelled")
281
+ self.logger.info(f"Continuous-time phase {phase} loop cancelled")
288
282
  except Exception as e:
289
- self.logger.exception(f"Error in continuous phase {phase} loop: {e}")
283
+ self.logger.exception(f"Error in continuous-time phase {phase} loop: {e}")
290
284
 
291
285
  @abstractmethod
292
286
  async def execute_phase_action(self, phase: int):
@@ -301,30 +295,8 @@ class PhaseManager(AgentManager, ABC):
301
295
  """
302
296
  pass
303
297
 
304
- async def on_phase_start(self, phase: int):
305
- """
306
- Hook that is called when a phase starts.
307
-
308
- Subclasses can override this to implement custom behavior.
309
-
310
- Args:
311
- phase (int): The phase number
312
- """
313
- pass
314
-
315
- async def on_phase_end(self, phase: int):
316
- """
317
- Hook that is called when a phase ends.
318
-
319
- Subclasses can override this to implement custom behavior.
320
-
321
- Args:
322
- phase (int): The phase number
323
- """
324
- pass
325
-
326
298
  async def stop(self):
327
- """Stop the manager and cancel any continuous phase tasks."""
299
+ """Stop the manager and cancel any continuous-time phase tasks."""
328
300
  self.in_continuous_phase = False
329
301
  if self._continuous_task:
330
302
  self._continuous_task.cancel()
@@ -337,7 +309,8 @@ class TurnBasedPhaseManager(PhaseManager):
337
309
  A manager for turn-based games that handles phase transitions.
338
310
 
339
311
  This manager inherits from PhaseManager and provides a concrete implementation
340
- for executing actions in each phase.
312
+ for executing actions in each phase. All phases are treated as turn-based,
313
+ meaning actions are only taken when explicitly triggered (no continuous actions).
341
314
 
342
315
  Args:
343
316
  url (Optional[str]): WebSocket server URL
@@ -416,7 +389,11 @@ class HybridPhaseManager(PhaseManager):
416
389
  A manager for games that combine turn-based and continuous action phases.
417
390
 
418
391
  This manager extends PhaseManager and configures it with specific phases
419
- that should be treated as continuous.
392
+ that should be treated as continuous. By default, all phases are treated as
393
+ turn-based unless explicitly included in the continuous_phases parameter.
394
+
395
+ For continuous-time phases, the manager will automatically execute actions periodically
396
+ with random delays between min_action_delay and max_action_delay seconds.
420
397
 
421
398
  Args:
422
399
  continuous_phases (Optional[set[int]]): Set of phase numbers that should be treated as continuous
@@ -425,8 +402,8 @@ class HybridPhaseManager(PhaseManager):
425
402
  auth_mechanism_kwargs (Optional[dict[str, Any]]): Keyword arguments for the authentication mechanism
426
403
  phase_transition_event (Optional[str]): Event name for phase transitions
427
404
  phase_identifier_key (Optional[str]): Key in the event data that identifies the phase
428
- min_action_delay (Optional[int]): Minimum delay in seconds between actions in continuous phases
429
- max_action_delay (Optional[int]): Maximum delay in seconds between actions in continuous phases
405
+ min_action_delay (Optional[int]): Minimum delay in seconds between actions in continuous-time phases
406
+ max_action_delay (Optional[int]): Maximum delay in seconds between actions in continuous-time phases
430
407
  state (Optional[GameState]): Game state object to track game state
431
408
  agent_role (Optional[AgentRole]): Agent role instance to handle game phases
432
409
  logger (Optional[logging.Logger]): Logger instance for tracking events