Skip to content

Skills

Skills/tools related string generation functions.

Functions:

NameDescription
get_agent_skill_registration

Get an agent's skill registration string.

export_skills

Get the skills content and secrets.

SkillsExporter(flow_name: str, agents: List[WaldiezAgent], agent_names: Dict[str, str], skills: List[WaldiezSkill], skill_names: Dict[str, str], output_dir: Optional[Union[str, Path]] = None)

Bases: BaseExporter, ExporterMixin

Skill exporter.

Parameters:

NameTypeDescriptionDefault
flow_namestr

The name of the flow.

required
agentsList[WaldiezAgent]

The agents.

required
agent_namesDict[str, str]

The agent names.

required
skillsList[WaldiezSkill]

The skills.

required
skill_namesDict[str, str]

The skill names.

required
output_dirOptional[Union[str, Path]]

The output directory if any, by default None

None
Source code in waldiez/exporting/skills/skills_exporter.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def __init__(
    self,
    flow_name: str,
    agents: List[WaldiezAgent],
    agent_names: Dict[str, str],
    skills: List[WaldiezSkill],
    skill_names: Dict[str, str],
    output_dir: Optional[Union[str, Path]] = None,
) -> None:
    """Initialize the skill exporter.

    Parameters
    ----------
    flow_name : str
        The name of the flow.
    agents : List[WaldiezAgent]
        The agents.
    agent_names : Dict[str, str]
        The agent names.
    skills : List[WaldiezSkill]
        The skills.
    skill_names : Dict[str, str]
        The skill names.
    output_dir : Optional[Union[str, Path]], optional
        The output directory if any, by default None
    """
    self.flow_name = flow_name
    self.agents = agents
    self.agent_names = agent_names
    self.skills = skills
    self.skill_names = skill_names
    self.output_dir = output_dir
    self.skill_imports, self.skill_secrets, self.skills_contents = (
        export_skills(
            flow_name=flow_name,
            skills=skills,
            skill_names=skill_names,
            output_dir=output_dir,
        )
    )

export() -> ExporterReturnType

Export the skills.

Returns:

TypeDescription
ExporterReturnType

The exported skills content, the imports, the before export strings, the after export strings, and the environment variables.

Source code in waldiez/exporting/skills/skills_exporter.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def export(self) -> ExporterReturnType:
    """Export the skills.

    Returns
    -------
    ExporterReturnType
        The exported skills content, the imports,
        the before export strings, the after export strings,
        and the environment variables.
    """
    content = self.generate()
    imports = self.get_imports()
    after_export = self.get_after_export()
    environment_variables = self.get_environment_variables()
    result: ExporterReturnType = {
        "content": content,
        "imports": imports,
        "before_export": None,
        "after_export": after_export,
        "environment_variables": environment_variables,
    }
    return result

generate() -> Optional[str]

Generate the main export.

Returns:

TypeDescription
Optional[str]

The exported content.

Source code in waldiez/exporting/skills/skills_exporter.py 
117
118
119
120
121
122
123
124
125
def generate(self) -> Optional[str]:
    """Generate the main export.

    Returns
    -------
    Optional[str]
        The exported content.
    """
    return self.skills_contents

get_after_export() -> Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]

Generate the content after the main export.

Returns:

TypeDescription
Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]

The exported content after the main export and its position.

Source code in waldiez/exporting/skills/skills_exporter.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def get_after_export(
    self,
) -> Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]:
    """Generate the content after the main export.

    Returns
    -------
    Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]
        The exported content after the main export and its position.
    """
    agent_registrations: List[
        Tuple[str, Union[ExportPosition, AgentPosition]]
    ] = []
    for agent in self.agents:
        agent_registration = get_agent_skill_registrations(
            agent=agent,
            agent_names=self.agent_names,
            all_skills=self.skills,
            skill_names=self.skill_names,
            string_escape=self.string_escape,
        )
        if agent_registration:
            # after all agents since we use the executor
            # (it might not yet be defined)
            position = AgentPosition(None, AgentPositions.AFTER_ALL, 1)
            agent_registrations.append((agent_registration, position))
    return agent_registrations

get_before_export() -> Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]

Generate the content before the main export.

Returns:

TypeDescription
Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]

The exported content before the main export and its position.

Source code in waldiez/exporting/skills/skills_exporter.py 
106
107
108
109
110
111
112
113
114
115
def get_before_export(
    self,
) -> Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]:
    """Generate the content before the main export.

    Returns
    -------
    Optional[List[Tuple[str, Union[ExportPosition, AgentPosition]]]]
        The exported content before the main export and its position.
    """

get_environment_variables() -> List[Tuple[str, str]]

Get the environment variables to set.

Returns:

TypeDescription
List[Tuple[str, str]]

The environment variables to set.

Source code in waldiez/exporting/skills/skills_exporter.py 
74
75
76
77
78
79
80
81
82
def get_environment_variables(self) -> List[Tuple[str, str]]:
    """Get the environment variables to set.

    Returns
    -------
    List[Tuple[str, str]]
        The environment variables to set.
    """
    return self.skill_secrets

get_imports() -> List[Tuple[str, ImportPosition]]

"Generate the imports string.

Returns:

TypeDescription
Tuple[str, int]

The exported imports and the position of the imports.

Source code in waldiez/exporting/skills/skills_exporter.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def get_imports(self) -> List[Tuple[str, ImportPosition]]:
    """ "Generate the imports string.

    Returns
    -------
    Tuple[str, int]
        The exported imports and the position of the imports.
    """
    imports: List[Tuple[str, ImportPosition]] = []
    if not self.skill_imports:
        return imports
    # standard imports
    for import_statement in self.skill_imports[0]:
        imports.append((import_statement, ImportPosition.BUILTINS))
    # third party imports
    for import_statement in self.skill_imports[1]:
        imports.append((import_statement, ImportPosition.THIRD_PARTY))
    # secrets/local imports
    for import_statement in self.skill_imports[2]:
        imports.append((import_statement, ImportPosition.LOCAL))
    return imports