Spaces:
Build error
Build error
File size: 2,739 Bytes
51ff9e5 |
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 |
# OpenHands Utilities
This directory contains various utility functions and classes used throughout OpenHands.
## Runtime Implementation Substitution
OpenHands provides an extensibility mechanism through the `get_impl` and `import_from` functions in `import_utils.py`. This mechanism allows applications built on OpenHands to customize behavior by providing their own implementations of OpenHands base classes.
### How It Works
1. Base classes define interfaces through abstract methods and properties
2. Default implementations are provided by OpenHands
3. Applications can provide custom implementations by:
- Creating a class that inherits from the base class
- Implementing all required methods
- Configuring OpenHands to use the custom implementation via configuration
### Example
```python
# In OpenHands base code:
class ConversationManager:
@abstractmethod
async def attach_to_conversation(self, sid: str) -> Conversation:
"""Attach to an existing conversation."""
# Default implementation in OpenHands:
class StandaloneConversationManager(ConversationManager):
async def attach_to_conversation(self, sid: str) -> Conversation:
# Single-server implementation
...
# In your application:
class ClusteredConversationManager(ConversationManager):
async def attach_to_conversation(self, sid: str) -> Conversation:
# Custom distributed implementation
...
# In configuration:
server_config.conversation_manager_class = 'myapp.ClusteredConversationManager'
```
### Common Extension Points
OpenHands provides several components that can be extended:
1. Server Components:
- `ConversationManager`: Manages conversation lifecycles
- `UserAuth`: Handles user authentication
- `MonitoringListener`: Provides monitoring capabilities
2. Storage:
- `ConversationStore`: Stores conversation data
- `SettingsStore`: Manages user settings
- `SecretsStore`: Handles sensitive data
3. Service Integrations:
- GitHub service
- GitLab service
### Implementation Details
The mechanism is implemented through two key functions:
1. `import_from(qual_name: str)`: Imports any Python value from its fully qualified name
```python
UserAuth = import_from('openhands.server.user_auth.UserAuth')
```
2. `get_impl(cls: type[T], impl_name: str | None) -> type[T]`: Imports and validates a class implementation
```python
ConversationManagerImpl = get_impl(
ConversationManager,
server_config.conversation_manager_class
)
```
The `get_impl` function ensures type safety by validating that the imported class is either the same as or a subclass of the specified base class. It also caches results to avoid repeated imports.
|