mirror of
https://github.com/OpenHands/OpenHands.git
synced 2026-03-22 13:47:19 +08:00
66 lines
2.0 KiB
Python
66 lines
2.0 KiB
Python
from abc import ABC, abstractmethod
|
|
|
|
from openhands.app_server.services.injector import Injector
|
|
from openhands.app_server.user.user_models import (
|
|
UserInfo,
|
|
)
|
|
from openhands.integrations.provider import PROVIDER_TOKEN_TYPE, ProviderType
|
|
from openhands.sdk.secret import SecretSource
|
|
from openhands.sdk.utils.models import DiscriminatedUnionMixin
|
|
|
|
|
|
class UserContext(ABC):
|
|
"""Service for managing users."""
|
|
|
|
# Read methods
|
|
|
|
@abstractmethod
|
|
async def get_user_id(self) -> str | None:
|
|
"""Get the user id"""
|
|
|
|
@abstractmethod
|
|
async def get_user_info(self) -> UserInfo:
|
|
"""Get the user info."""
|
|
|
|
@abstractmethod
|
|
async def get_authenticated_git_url(
|
|
self, repository: str, is_optional: bool = False
|
|
) -> str:
|
|
"""Get an authenticated git URL for a repository.
|
|
|
|
Args:
|
|
repository: Repository name (owner/repo)
|
|
is_optional: If True, logs at debug level instead of error level
|
|
when repository is not found. Use for optional repositories.
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def get_provider_tokens(
|
|
self, as_env_vars: bool = False
|
|
) -> PROVIDER_TOKEN_TYPE | dict[str, str] | None:
|
|
"""Get the latest tokens for all provider types.
|
|
|
|
Args:
|
|
as_env_vars: When True, return a ``dict[str, str]`` mapping env
|
|
var names (e.g. ``github_token``) to plain-text token values.
|
|
When False (default), return the raw provider token mapping.
|
|
"""
|
|
|
|
@abstractmethod
|
|
async def get_latest_token(self, provider_type: ProviderType) -> str | None:
|
|
"""Get the latest token for the provider type given"""
|
|
|
|
@abstractmethod
|
|
async def get_secrets(self) -> dict[str, SecretSource]:
|
|
"""Get custom secrets and github provider secrets for the conversation."""
|
|
|
|
@abstractmethod
|
|
async def get_mcp_api_key(self) -> str | None:
|
|
"""Get an MCP API Key."""
|
|
|
|
|
|
class UserContextInjector(DiscriminatedUnionMixin, Injector[UserContext], ABC):
|
|
"""Injector for user contexts."""
|
|
|
|
pass
|