software-agent-sdk/openhands-sdk/openhands/sdk/context/skills/__init__.py at bd3fc649dc6509d38bcbce149a21694aee07da47 · OpenHands/software-agent-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
"""Deprecated: Use openhands.sdk.skills instead.

This module is deprecated and will be removed in a future version.
All skill-related imports should come from `openhands.sdk.skills`.

Migration guide:
    # Old (deprecated):
    from openhands.sdk.context.skills import Skill, load_skills_from_dir

    # New:
    from openhands.sdk.skills import Skill, load_skills_from_dir
"""

from openhands.sdk.utils.deprecation import warn_deprecated


def __getattr__(name: str):
    """Lazily import from openhands.sdk.skills with deprecation warning."""
    # Import the canonical module
    from openhands.sdk import skills as _skills

    # List of valid exports that we re-export with deprecation warning
    _VALID_EXPORTS = {
        # Exceptions
        "SkillError",
        "SkillValidationError",
        # Core skill model and loading
        "Skill",
        "SkillInfo",
        "SkillResources",
        "load_skills_from_dir",
        "load_project_skills",
        "load_user_skills",
        "load_public_skills",
        "load_available_skills",
        "to_prompt",
        # Triggers
        "BaseTrigger",
        "KeywordTrigger",
        "TaskTrigger",
        # Types
        "SkillKnowledge",
        "InputMetadata",
        "SkillResponse",
        "SkillContentResponse",
        # Utilities
        "discover_skill_resources",
        "RESOURCE_DIRECTORIES",
        "validate_skill_name",
    }

    if name in _VALID_EXPORTS:
        warn_deprecated(
            f"Importing '{name}' from 'openhands.sdk.context.skills'",
            deprecated_in="1.16.0",
            removed_in="1.20.0",
            details=f"Use 'from openhands.sdk.skills import {name}' instead.",
            stacklevel=3,
        )
        return getattr(_skills, name)

    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


def __dir__():
    """List available attributes for tab-completion."""
    return [
        # Exceptions
        "SkillError",
        "SkillValidationError",
        # Core skill model and loading
        "Skill",
        "SkillInfo",
        "SkillResources",
        "load_skills_from_dir",
        "load_project_skills",
        "load_user_skills",
        "load_public_skills",
        "load_available_skills",
        "to_prompt",
        # Triggers
        "BaseTrigger",
        "KeywordTrigger",
        "TaskTrigger",
        # Types
        "SkillKnowledge",
        "InputMetadata",
        "SkillResponse",
        "SkillContentResponse",
        # Utilities
        "discover_skill_resources",
        "RESOURCE_DIRECTORIES",
        "validate_skill_name",
    ]


__all__ = [
    # Exceptions
    "SkillError",
    "SkillValidationError",
    # Core skill model and loading
    "Skill",
    "SkillInfo",
    "SkillResources",
    "load_skills_from_dir",
    "load_project_skills",
    "load_user_skills",
    "load_public_skills",
    "load_available_skills",
    "to_prompt",
    # Triggers
    "BaseTrigger",
    "KeywordTrigger",
    "TaskTrigger",
    # Types
    "SkillKnowledge",
    "InputMetadata",
    "SkillResponse",
    "SkillContentResponse",
    # Utilities
    "discover_skill_resources",
    "RESOURCE_DIRECTORIES",
    "validate_skill_name",
]