mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-07 15:18:29 +00:00
3619d4dc50
- Replace Dict, List, Set, Tuple with dict, list, set, tuple throughout codebase - Add missing type annotations to crew_events.py methods - Add proper type annotations to test_crew_cancellation.py - Use type: ignore[method-assign] comments for mock assignments - Maintain backward compatibility while modernizing type hints This resolves lint and type-checker failures in CI while preserving the cancellation functionality. Co-Authored-By: João <joao@crewai.com>
54 lines
1.5 KiB
Python
54 lines
1.5 KiB
Python
"""Base class for flow state persistence."""
|
|
|
|
import abc
|
|
from typing import Any, Optional, Union
|
|
|
|
from pydantic import BaseModel
|
|
|
|
|
|
class FlowPersistence(abc.ABC):
|
|
"""Abstract base class for flow state persistence.
|
|
|
|
This class defines the interface that all persistence implementations must follow.
|
|
It supports both structured (Pydantic BaseModel) and unstructured (dict) states.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def init_db(self) -> None:
|
|
"""Initialize the persistence backend.
|
|
|
|
This method should handle any necessary setup, such as:
|
|
- Creating tables
|
|
- Establishing connections
|
|
- Setting up indexes
|
|
"""
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def save_state(
|
|
self,
|
|
flow_uuid: str,
|
|
method_name: str,
|
|
state_data: Union[dict[str, Any], BaseModel]
|
|
) -> None:
|
|
"""Persist the flow state after method completion.
|
|
|
|
Args:
|
|
flow_uuid: Unique identifier for the flow instance
|
|
method_name: Name of the method that just completed
|
|
state_data: Current state data (either dict or Pydantic model)
|
|
"""
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def load_state(self, flow_uuid: str) -> Optional[dict[str, Any]]:
|
|
"""Load the most recent state for a given flow UUID.
|
|
|
|
Args:
|
|
flow_uuid: Unique identifier for the flow instance
|
|
|
|
Returns:
|
|
The most recent state as a dictionary, or None if no state exists
|
|
"""
|
|
pass
|