-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Enhance Type Safety and Type Hinting in CrewAI Core Components #2830
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
omkute10
wants to merge
1
commit into
crewAIInc:main
Choose a base branch
from
omkute10:feature/improve-crew-type-hinting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
from typing import ( | ||
Any, | ||
Callable, | ||
Dict, | ||
List, | ||
Optional, | ||
Protocol, | ||
TypedDict, | ||
Union, | ||
) | ||
|
||
from crewai.agent import Agent | ||
from crewai.task import Task | ||
from crewai.tools.base_tool import BaseTool | ||
|
||
|
||
class MemoryConfig(TypedDict, total=False): | ||
"""Typed dictionary for memory configuration.""" | ||
user_memory: Dict[str, Any] | ||
provider: str | ||
long_term: bool | ||
short_term: bool | ||
|
||
|
||
class CrewConfig(TypedDict, total=False): | ||
"""Typed dictionary for crew configuration.""" | ||
tasks: List[Task] | ||
agents: List[Agent] | ||
memory: bool | ||
memory_config: MemoryConfig | ||
max_rpm: int | ||
verbose: bool | ||
|
||
|
||
class AgentProtocol(Protocol): | ||
"""Protocol for defining agent-like objects.""" | ||
def __call__(self, *args: Any, **kwargs: Any) -> Any: ... | ||
role: str | ||
goal: str | ||
backstory: str | ||
tools: List[BaseTool] | ||
|
||
|
||
class TaskProtocol(Protocol): | ||
"""Protocol for defining task-like objects.""" | ||
def __call__(self, *args: Any, **kwargs: Any) -> Any: ... | ||
description: str | ||
expected_output: str | ||
agent: AgentProtocol | ||
|
||
|
||
def validate_agent(agent: Any) -> bool: | ||
"""Validate if an object conforms to the AgentProtocol.""" | ||
required_attrs = ['role', 'goal', 'backstory', 'tools'] | ||
return all(hasattr(agent, attr) for attr in required_attrs) | ||
|
||
|
||
def validate_task(task: Any) -> bool: | ||
"""Validate if an object conforms to the TaskProtocol.""" | ||
required_attrs = ['description', 'expected_output', 'agent'] | ||
return all(hasattr(task, attr) for attr in required_attrs) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't quite get why you added it or where it’s being used. Did you maybe forget to include some code in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh yes... Let me fix this!