Refactor/core python (#1102)

* refactor: core for python

* fix: some tests

Author: SAKURA-CAT

swanlab/api/__init__.py

@@ -8,25 +8,13 @@
     API模块，封装api请求接口
 """
 from .auth.login import terminal_login, code_login
-from .http import create_http, get_http
 from .info import *
 
 
-def is_login() -> bool:
-    """判断是否登录(拥有http对象)"""
-    try:
-        return get_http() is not None
-    except ValueError:
-        return False
-
-
 __all__ = [
     "LoginInfo",
     'ExperimentInfo',
     'ProjectInfo',
     "code_login",
     'terminal_login',
-    'create_http',
-    'get_http',
-    'is_login',
 ]

swanlab/api/openapi/base.py

@@ -17,7 +17,6 @@
 
 from swanlab.api import LoginInfo
 from swanlab.api.auth.login import login_by_key
-from swanlab.api.http import HTTP
 from swanlab.api.openapi.types import ApiResponse
 from swanlab.log.log import SwanLog
 from swanlab.package import get_package_version
@@ -62,7 +61,7 @@ def handle_response(resp: requests.Response) -> ApiResponse:
 
 
 class ApiHTTP:
-    REFRESH_TIME = HTTP.REFRESH_TIME
+    REFRESH_TIME = 60 * 60 * 24 * 7  # 7天
 
     def __init__(self, login_info: LoginInfo):
         self.__logger = get_logger()

swanlab/cli/commands/sync/__init__.py

@@ -7,7 +7,8 @@
 
 import click
 
-from swanlab.api import terminal_login, create_http
+from swanlab.api import terminal_login
+from swanlab.core_python import create_client
 from swanlab.error import KeyFileError
 from swanlab.package import get_key, HostFormatter
 from swanlab.sync import sync as sync_logs
@@ -70,6 +71,6 @@ def sync(path, api_key, workspace, project, host):
     for path in path:
         # 1.3 登录，创建 http 对象
         log_info = terminal_login(api_key=api_key, save_key=False)
-        create_http(log_info)
+        create_client(log_info)
         # 2. 同步日志
         sync_logs(path, workspace=workspace, project_name=project, login_required=False, raise_error=len(path) == 1)

swanlab/core_python/__init__.py

@@ -0,0 +1,12 @@
+"""
+@author: cunyue
+@file: __init__.py.py
+@time: 2025/6/16 13:21
+@description: swanlab 核心业务代码 - python 版，将包含：
+1. 上传线程逻辑
+2. http 客户端代码
+"""
+
+from .client import *
+from .uploader import *
+from .uploader import thread

swanlab/api/http.py renamed to swanlab/core_python/client/__init__.py

@@ -1,12 +1,10 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-r"""
-@DATE: 2024/4/7 16:51
-@File: http.py
-@IDE: pycharm
-@Description:
-    http会话对象
 """
+@author: cunyue
+@file: __init__.py
+@time: 2025/6/16 13:29
+@description: swanlab 客户端，负责发送 http 请求
+"""
+
 import json
 from datetime import datetime
 from typing import Optional, Tuple, Dict, Union, List, AnyStr
@@ -17,12 +15,12 @@
 from swankit.log import FONT
 from urllib3.util.retry import Retry
 
+from swanlab.api import LoginInfo, ProjectInfo, ExperimentInfo
+from swanlab.api.auth.login import login_by_key
 from swanlab.error import NetworkError, ApiError
 from swanlab.log import swanlog
 from swanlab.package import get_package_version
-from .auth.login import login_by_key
 from .cos import CosClient
-from .info import LoginInfo, ProjectInfo, ExperimentInfo
 
 
 def decode_response(resp: requests.Response) -> Union[Dict, AnyStr, List]:
@@ -38,7 +36,7 @@ def decode_response(resp: requests.Response) -> Union[Dict, AnyStr, List]:
         return resp.text
 
 
-class HTTP:
+class Client:
     """
     封装请求函数，添加get、post、put、delete方法
     """
@@ -344,38 +342,38 @@ def _():
         FONT.loading("Updating experiment status...", _)
 
 
-http: Optional["HTTP"] = None
+client: Optional["Client"] = None
 """
-一个进程只有一个http请求对象
+一个进程只有一个客户端对象
 """
 
 
-def create_http(login_info: LoginInfo) -> HTTP:
+def create_client(login_info: LoginInfo) -> Client:
     """
-    创建http请求对象
+    创建客户端对象
     """
-    global http
-    http = HTTP(login_info)
-    return http
+    global client
+    client = Client(login_info)
+    return client
 
 
-def get_http() -> HTTP:
+def get_client() -> Client:
     """
-    创建http请求对象
-    :return: http请求对象
+    获取客户端对象
+    :return: client
     """
-    global http
-    if http is None:
-        raise ValueError("http object is not initialized")
-    return http
+    global client
+    if client is None:
+        raise ValueError("client object is not initialized")
+    return client
 
 
-def reset_http():
+def reset_client():
     """
-    重置http对象
+    重置client对象
     """
-    global http
-    http = None
+    global client
+    client = None
 
 
 def sync_error_handler(func):
@@ -396,3 +394,14 @@ def wrapper(*args, **kwargs) -> Tuple[Optional[Union[dict, str]], Optional[Excep
             return None, e
 
     return wrapper
+
+
+__all__ = [
+    "get_client",
+    "reset_client",
+    "create_client",
+    "sync_error_handler",
+    "decode_response",
+    "CosClient",
+    "Client",
+]

swanlab/api/cos.py renamed to swanlab/core_python/client/cos.py

@@ -1,12 +1,10 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-r"""
-@DATE: 2024/4/8 19:47
-@File: cos.py
-@IDE: pycharm
-@Description:
-    cloud object storage
 """
+@author: cunyue
+@file: cos.py
+@time: 2025/6/16 13:30
+@description: cos 对象，上传大文件到 Object Storage Service
+"""
+
 from concurrent.futures import ThreadPoolExecutor
 from datetime import datetime, timedelta
 from typing import List

swanlab/core_python/client/model.py

@@ -0,0 +1,37 @@
+"""
+@author: cunyue
+@file: model.py
+@time: 2025/6/16 14:55
+@description: 实验、项目元信息
+"""
+
+
+class ProjectInfo:
+    def __init__(self, data: dict):
+        self.__data = data
+
+    @property
+    def cuid(self):
+        return self.__data["cuid"]
+
+    @property
+    def name(self):
+        return self.__data["name"]
+
+    @property
+    def history_exp_count(self):
+        return self.__data.get('_count', {'experiments': 0})["experiments"]
+
+
+class ExperimentInfo:
+
+    def __init__(self, data: dict):
+        self.__data = data
+
+    @property
+    def cuid(self):
+        return self.__data["cuid"]
+
+    @property
+    def name(self):
+        return self.__data["name"]

swanlab/core_python/uploader/__init__.py

@@ -0,0 +1,9 @@
+"""
+@author: cunyue
+@file: __init__.py
+@time: 2025/6/16 14:06
+@description: 指标上传器，提供一个上传线程对象，内部存在线程池
+"""
+
+from .model import *
+from .upload import *

swanlab/api/upload/model.py renamed to swanlab/core_python/uploader/model.py

@@ -1,12 +1,10 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-r"""
-@DATE: 2024/4/22 16:42
-@File: model.py
-@IDE: pycharm
-@Description:
-    上传请求模型
 """
+@author: cunyue
+@file: model.py
+@time: 2025/6/16 14:12
+@description: 定义上传模型
+"""
+
 import json
 from datetime import datetime
 from enum import Enum
@@ -255,3 +253,12 @@ class LogModel(TypedDict):
     """
     当前日志级别的日志内容
     """
+
+
+__all__ = [
+    "LogModel",
+    "ColumnModel",
+    "ScalarModel",
+    "MediaModel",
+    "FileModel",
+]