refac: modernize type annotations (PEP 604 / PEP 585)

This commit is contained in:
Timothy Jaeryang Baek committed 2026-05-12 17:10:15 +09:00
1 parent a59c967d7e
commit 6d0295588e
197 files changed
+3265 -3488

No files matched your search

+84 -93
View File
@@ -1,7 +1,8 @@
from __future__ import annotations
# TODO: Implement a more intelligent load balancing mechanism for distributing requests among multiple backend instances.
# Current implementation uses a simple round-robin approach (random.choice). Consider incorporating algorithms like weighted round-robin,
# least connections, or least response time for better resource utilization and performance optimization.
import asyncio
import json
import logging
@@ -10,70 +11,60 @@ import random
import re
import time
from datetime import datetime
from typing import Optional, Union
from urllib.parse import urlparse
import aiohttp
from aiocache import cached
from open_webui.utils.headers import include_user_info_headers
from open_webui.models.chats import Chats
from open_webui.models.users import UserModel
from open_webui.env import (
ENABLE_FORWARD_USER_INFO_HEADERS,
FORWARD_SESSION_INFO_HEADER_CHAT_ID,
)
from fastapi import (
APIRouter,
Depends,
FastAPI,
File,
HTTPException,
Request,
UploadFile,
APIRouter,
)
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import StreamingResponse
from pydantic import BaseModel, ConfigDict, validator
from sqlalchemy.ext.asyncio import AsyncSession
from open_webui.config import (
UPLOAD_DIR,
)
from open_webui.constants import ERROR_MESSAGES
from open_webui.env import (
AIOHTTP_CLIENT_SESSION_SSL,
AIOHTTP_CLIENT_TIMEOUT,
AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST,
BYPASS_MODEL_ACCESS_CONTROL,
ENABLE_FORWARD_USER_INFO_HEADERS,
ENV,
FORWARD_SESSION_INFO_HEADER_CHAT_ID,
MODELS_CACHE_TTL,
)
from open_webui.internal.db import get_async_session
from open_webui.models.models import Models
from open_webui.models.access_grants import AccessGrants
from open_webui.models.chats import Chats
from open_webui.models.groups import Groups
from open_webui.models.models import Models
from open_webui.models.users import UserModel
from open_webui.utils.access_control import check_model_access
from open_webui.utils.auth import get_admin_user, get_verified_user
from open_webui.utils.headers import include_user_info_headers
from open_webui.utils.misc import (
calculate_sha256,
)
from open_webui.utils.session_pool import (
cleanup_response,
get_session,
stream_wrapper,
)
from open_webui.utils.payload import (
apply_model_params_to_body_ollama,
apply_model_params_to_body_openai,
apply_system_prompt_to_body,
)
from open_webui.utils.auth import get_admin_user, get_verified_user
from open_webui.config import (
UPLOAD_DIR,
from open_webui.utils.session_pool import (
cleanup_response,
get_session,
stream_wrapper,
)
from open_webui.env import (
ENV,
MODELS_CACHE_TTL,
AIOHTTP_CLIENT_SESSION_SSL,
AIOHTTP_CLIENT_TIMEOUT,
AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST,
BYPASS_MODEL_ACCESS_CONTROL,
)
from open_webui.constants import ERROR_MESSAGES
from pydantic import BaseModel, ConfigDict, validator
from sqlalchemy.ext.asyncio import AsyncSession
log = logging.getLogger(__name__)
@@ -126,12 +117,12 @@ async def send_request(
url: str,
method: str = 'POST',
*,
payload: Optional[Union[str, bytes]] = None,
key: Optional[str] = None,
payload: Union[str, bytes | None] = None,
key: str | None = None,
user: UserModel = None,
stream: bool = False,
content_type: Optional[str] = None,
metadata: Optional[dict] = None,
content_type: str | None = None,
metadata: dict | None = None,
):
r = None
streaming = False
@@ -225,7 +216,7 @@ async def get_status():
class ConnectionVerificationForm(BaseModel):
url: str
key: Optional[str] = None
key: str | None = None
@router.post('/verify')
@@ -279,7 +270,7 @@ async def get_config(request: Request, user=Depends(get_admin_user)):
class OllamaConfigForm(BaseModel):
ENABLE_OLLAMA_API: Optional[bool] = None
ENABLE_OLLAMA_API: bool | None = None
OLLAMA_BASE_URLS: list[str]
OLLAMA_API_CONFIGS: dict
@@ -437,7 +428,7 @@ async def get_filtered_models(models, user, db=None):
@router.get('/api/tags')
@router.get('/api/tags/{url_idx}')
async def get_ollama_tags(request: Request, url_idx: Optional[int] = None, user=Depends(get_verified_user)):
async def get_ollama_tags(request: Request, url_idx: int | None = None, user=Depends(get_verified_user)):
if not request.app.state.config.ENABLE_OLLAMA_API:
raise HTTPException(status_code=503, detail=ERROR_MESSAGES.OLLAMA_API_DISABLED)
@@ -514,7 +505,7 @@ async def get_ollama_loaded_models(request: Request, user=Depends(get_admin_user
@router.get('/api/version')
@router.get('/api/version/{url_idx}')
async def get_ollama_versions(request: Request, url_idx: Optional[int] = None):
async def get_ollama_versions(request: Request, url_idx: int | None = None):
if request.app.state.config.ENABLE_OLLAMA_API:
if url_idx is None:
# returns lowest version
@@ -560,7 +551,7 @@ async def get_ollama_versions(request: Request, url_idx: Optional[int] = None):
class ModelNameForm(BaseModel):
model: Optional[str] = None
model: str | None = None
model_config = ConfigDict(
extra='allow',
)
@@ -654,8 +645,8 @@ async def pull_model(
class PushModelForm(BaseModel):
model: str
insecure: Optional[bool] = None
stream: Optional[bool] = None
insecure: bool | None = None
stream: bool | None = None
@router.delete('/api/push')
@@ -663,7 +654,7 @@ class PushModelForm(BaseModel):
async def push_model(
request: Request,
form_data: PushModelForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_admin_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -694,9 +685,9 @@ async def push_model(
class CreateModelForm(BaseModel):
model: Optional[str] = None
stream: Optional[bool] = None
path: Optional[str] = None
model: str | None = None
stream: bool | None = None
path: str | None = None
model_config = ConfigDict(extra='allow')
@@ -734,7 +725,7 @@ class CopyModelForm(BaseModel):
async def copy_model(
request: Request,
form_data: CopyModelForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_admin_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -769,7 +760,7 @@ async def copy_model(
async def delete_model(
request: Request,
form_data: ModelNameForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_admin_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -843,9 +834,9 @@ async def show_model_info(request: Request, form_data: ModelNameForm, user=Depen
class GenerateEmbedForm(BaseModel):
model: str
input: list[str] | str
truncate: Optional[bool] = None
options: Optional[dict] = None
keep_alive: Optional[Union[int, str]] = None
truncate: bool | None = None
options: dict | None = None
keep_alive: Union[int, str | None] = None
model_config = ConfigDict(
extra='allow',
@@ -857,7 +848,7 @@ class GenerateEmbedForm(BaseModel):
async def embed(
request: Request,
form_data: GenerateEmbedForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -907,8 +898,8 @@ async def embed(
class GenerateEmbeddingsForm(BaseModel):
model: str
prompt: str
options: Optional[dict] = None
keep_alive: Optional[Union[int, str]] = None
options: dict | None = None
keep_alive: Union[int, str | None] = None
@router.post('/api/embeddings')
@@ -916,7 +907,7 @@ class GenerateEmbeddingsForm(BaseModel):
async def embeddings(
request: Request,
form_data: GenerateEmbeddingsForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -965,17 +956,17 @@ async def embeddings(
class GenerateCompletionForm(BaseModel):
model: str
prompt: Optional[str] = None
suffix: Optional[str] = None
images: Optional[list[str]] = None
format: Optional[Union[dict, str]] = None
options: Optional[dict] = None
system: Optional[str] = None
template: Optional[str] = None
context: Optional[list[int]] = None
stream: Optional[bool] = True
raw: Optional[bool] = None
keep_alive: Optional[Union[int, str]] = None
prompt: str | None = None
suffix: str | None = None
images: list[str | None] = None
format: Union[dict, str | None] = None
options: dict | None = None
system: str | None = None
template: str | None = None
context: list[int | None] = None
stream: bool | None = True
raw: bool | None = None
keep_alive: Union[int, str | None] = None
@router.post('/api/generate')
@@ -983,7 +974,7 @@ class GenerateCompletionForm(BaseModel):
async def generate_completion(
request: Request,
form_data: GenerateCompletionForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
if not request.app.state.config.ENABLE_OLLAMA_API:
@@ -1027,9 +1018,9 @@ async def generate_completion(
class ChatMessage(BaseModel):
role: str
content: Optional[str] = None
tool_calls: Optional[list[dict]] = None
images: Optional[list[str]] = None
content: str | None = None
tool_calls: list[dict | None] = None
images: list[str | None] = None
model_config = ConfigDict(extra='allow')
@@ -1046,18 +1037,18 @@ class ChatMessage(BaseModel):
class GenerateChatCompletionForm(BaseModel):
model: str
messages: list[ChatMessage]
format: Optional[Union[dict, str]] = None
options: Optional[dict] = None
template: Optional[str] = None
stream: Optional[bool] = True
keep_alive: Optional[Union[int, str]] = None
tools: Optional[list[dict]] = None
format: Union[dict, str | None] = None
options: dict | None = None
template: str | None = None
stream: bool | None = True
keep_alive: Union[int, str | None] = None
tools: list[dict | None] = None
model_config = ConfigDict(
extra='allow',
)
async def get_ollama_url(request: Request, model: str, url_idx: Optional[int] = None):
async def get_ollama_url(request: Request, model: str, url_idx: int | None = None):
if url_idx is None:
models = request.app.state.OLLAMA_MODELS
if model not in models:
@@ -1075,7 +1066,7 @@ async def get_ollama_url(request: Request, model: str, url_idx: Optional[int] =
async def generate_chat_completion(
request: Request,
form_data: dict,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
bypass_system_prompt: bool = False,
):
@@ -1162,7 +1153,7 @@ class OpenAIChatMessageContent(BaseModel):
class OpenAIChatMessage(BaseModel):
role: str
content: Union[Optional[str], list[OpenAIChatMessageContent]]
content: Union[str | None, list[OpenAIChatMessageContent]]
model_config = ConfigDict(extra='allow')
@@ -1186,7 +1177,7 @@ class OpenAICompletionForm(BaseModel):
async def generate_openai_completion(
request: Request,
form_data: dict,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
# NOTE: We intentionally do NOT use Depends(get_async_session) here.
@@ -1248,7 +1239,7 @@ async def generate_openai_completion(
async def generate_openai_chat_completion(
request: Request,
form_data: dict,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
# NOTE: We intentionally do NOT use Depends(get_async_session) here.
@@ -1313,7 +1304,7 @@ async def generate_openai_chat_completion(
async def generate_anthropic_messages(
request: Request,
form_data: dict,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
"""
@@ -1371,7 +1362,7 @@ class ResponsesForm(BaseModel):
async def generate_responses(
request: Request,
form_data: ResponsesForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
):
"""
@@ -1422,7 +1413,7 @@ async def generate_responses(
@router.get('/v1/models/{url_idx}')
async def get_openai_models(
request: Request,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_verified_user),
db: AsyncSession = Depends(get_async_session),
):
@@ -1565,7 +1556,7 @@ async def download_file_stream(ollama_url, file_url, file_path, file_name, chunk
async def download_model(
request: Request,
form_data: UrlForm,
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_admin_user),
):
allowed_hosts = ['https://huggingface.co/', 'https://github.com/']
@@ -1598,7 +1589,7 @@ async def download_model(
async def upload_model(
request: Request,
file: UploadFile = File(...),
url_idx: Optional[int] = None,
url_idx: int | None = None,
user=Depends(get_admin_user),
):
if url_idx is None: