feat: replace the workspace field in the project object with a workspace object #1429

Bainianzzz · 2026-01-28T01:02:26Z

Description

将project对象中的workspace替换为workspace对象

example code:

if __name__ == '__main__':
    api = swanlab.Api()
    projects = api.projects(workspace='bainiantest')
    for project in projects:
        print(project.workspace.json())

* feat: get all project of a group * update unit test using magicMock * update unit test & fix bug * opt import and rename some file - move api from folder core_python to api * fix wrong comment * remove pending status when getting entity projects * opt Project class - add EN comment for Project properties - add __str__ method for project label - adapt snake_case naming for project properties - change some project property name: projectLabels -> label - change api.projects() param name: entity -> workspace - delete some project properties (group, cuid) - prase url inside Project class * dynamically request project data according to the traversal of the project, rather than requesting all project information at once * opt import * iteratively request project data inside the Projects class - move api form api package to core_python package * fix bug & add type * move api's type.py to core_python

* feat: get runs metadata - add api in core_python to get all exps in a project - add new type and class to parse exps * update unit test & fix bugs * opt code style & add comment * raise value error if user's path is invaded * fix bug of Incorrectly raised ValueError * get single exp through OpenApi * resolve conflicts: filtering exp (basic implement) - get full single exp info through filter func # Conflicts: # swanlab/core_python/api/experiment.py * opt __dict__ for project and experiment * resolve conflict: update run.history() * feat: update run.scan_history() - add example codes * resolve conflict: fix bugs when importing pandas * import pandas only when used * fix: pandas warning * feat: run and user features of OpenApi - get metric data in batch - recover old OpenApi version for smooth transition - create & delete api_key through Api.user * opt Client importing in core_python's api * opt logic of run.history() - get latest api_keys when user delete api_key * rename the deprecated openApi folder * refactored run.history() & add return type - add return type for the backend interfaces - simplified get_experiment_metrics() and handle the csv inside HistoryPool * removed redundant types * update unit test using mock * feat: get user's team * feat: create user if user is the root user in self-hosted swanlab - refactor the models in OpenApi * feat: update unit test for create user and get user teams * delete test code of OpenApi * use ThreadPoolExecutor in HistoryPool * Refactor Api class and cleanup api module structure Moved the Api class implementation from swanlab/api/api.py to swanlab/api/__init__.py and deleted the redundant api.py file. Updated imports and references accordingly. Minor docstring and comment improvements, and fixed a message in thread.py to reference 'Api' instead of 'OpenApi'. * Fix circular import by updating Api export Combined the import of OpenApi and Api from .api to prevent circular import issues and simplify the export process. --------- Co-authored-by: ZeYi Lin <944270057@qq.com> Co-authored-by: Kang Li <cunykang@gmail.com>

* Refactor the OpenAPI codes, managing the code with a modular approach * combine 3 kinds of user into one - use @cached_property to cache some property of user * Place the API's custom type into a separate module - place class ApiBase into a single model * get the user identity at the init of the OpenApi - only the root user get by api.user() can create new account * refactor module name & structure in api and core_python * Modified parameter passing convention & add client property to ApiBase - pass param through kwargs except client in OpenApi and core_python * update code commit - opt str() of Label class

* add unit test - add unit test and fix bugs of getting all projects through OpenApi - add unit tests for OpenApi runs and run.history() * add unit test for api.user() * accept suggestions from gemini

* delete class ApiBase * accept suggestions - place yield inside the loop of the projects - check if creating & deleting user or api_keys inside the api func - add property is_self in user * opt user api func * fix bugs in projects * accept gemini suggestions - fix type error in self_hosted.py and user's api func - add a constant for project page size * opt over-encapsulated code - discard constant PAGE_SIZE - let adapter handle the exception when creating & deleting user info - opt unit test for projects * delete unused utils

…1425) * use a wrapper to check self_hosted info for some functions - update unit tests for user (add self_hosted context) * fix bug in OpenApi.list_workspaces() * accept gemini suggestions * raise value error when not being self_hosted * raise value error when self_hosted is not available - raise error when accessing unsupported user functions

…ject

gemini-code-assist · 2026-01-28T01:03:08Z

Summary of Changes

Hello @Bainianzzz, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors the SwanLab Python API, transitioning from a procedural OpenApi interface to a modern, object-oriented Api design. This change provides developers with a clearer and more consistent way to interact with SwanLab resources such as users, projects, experiments, and workspaces. The refactoring improves code organization, enhances the expressiveness of the API, and lays the groundwork for future feature development, particularly around self-hosted deployments and detailed data retrieval.

Highlights

New Object-Oriented API (Api class): Introduced a new top-level Api class to replace the monolithic OpenApi, providing a more structured and intuitive interface for interacting with SwanLab resources. The OpenApi class is now deprecated.
Dedicated Resource Objects: The API now exposes dedicated objects for User, Project, Experiment, and Workspace, allowing for direct interaction with these entities and their specific properties and methods.
Workspace Object Integration: The workspace field within the Project object has been replaced with a dedicated Workspace object, enhancing the representation and functionality related to workspaces.
Enhanced Experiment History Retrieval: A new HistoryPool and Experiment.history() method provide efficient, concurrent fetching of experiment metric data, including support for custom x-axes and pandas DataFrame output.
Self-Hosted Features Support: New API endpoints and a self_hosted decorator are introduced to support self-hosted SwanLab instances, including user creation and permission checks.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request significantly refactors the SwanLab OpenAPI by introducing a new Api class and restructuring the API client into a more modular, object-oriented design. The changes involve creating dedicated classes for Experiment, Projects, User, Workspace, and Workspaces, which greatly improves code organization and maintainability. The deprecated OpenApi class is moved to a deprecated module with a warning for future removal. Additionally, new API endpoints and utility functions are added, and the core Client class now includes a delete method. Test files have been updated and new tests introduced to cover the new API structure. Overall, this is a positive change towards a more robust and user-friendly API.

gemini-code-assist · 2026-01-28T01:05:19Z

swanlab/api/__init__.py

+            path=proj_path,
+            web_host=self._web_host,
+            login_user=self._login_user,
+            line_count=1,


The line_count parameter in the Experiment constructor is hardcoded to 1. This seems incorrect, as line_count is intended to represent the total number of historical experiments in the project. Hardcoding it to 1 will provide misleading information to the user when accessing experiment.history_line_count.

Suggested change

line_count=1,

line_count=len(data),

gemini-code-assist · 2026-01-28T01:05:19Z

swanlab/api/experiment/thread.py

+        if self._x_axis is not None:
+            self._history = self._history.reset_index().iloc[:, 1:]
+            self._history = self._history.set_index(self._history.columns[0])


In HistoryPool.execute, when self._x_axis is not None, the code self._history = self._history.reset_index().iloc[:, 1:] drops the first column after resetting the index. This assumes that the first column is always the original index. If the original index was not named 'step' or if _history was already modified, this could lead to unintended data loss or incorrect data alignment. It's safer to explicitly specify the column to drop or rename, or ensure the index is always 'step' before this operation.

gemini-code-assist · 2026-01-28T01:05:19Z

test/unit/api/test_history.py

+        self.metrics_data = metrics_data
+
+    def __enter__(self):
+        self.mock_get_metrics = patch('swanlab.api.experiment.thread.get_experiment_metrics').start()


The patch for get_experiment_metrics is targeting swanlab.api.experiment.thread.get_experiment_metrics. However, get_experiment_metrics is imported into swanlab.api.experiment.thread from swanlab.core_python.api.experiment. To correctly mock the function where it is originally defined and used, the patch should target swanlab.core_python.api.experiment.get_experiment_metrics.

Suggested change

self.mock_get_metrics = patch('swanlab.api.experiment.thread.get_experiment_metrics').start()

self.mock_get_metrics = patch('swanlab.core_python.api.experiment.get_experiment_metrics').start()

gemini-code-assist · 2026-01-28T01:05:20Z

test/unit/api/test_user.py

+        self.seats = kwargs.get('seats', 99)
+
+    def __enter__(self):
+        self.mock_get_metrics = patch('swanlab.api.utils.get_self_hosted_init').start()


The patch for get_self_hosted_init is targeting swanlab.api.utils.get_self_hosted_init. However, get_self_hosted_init is imported into swanlab.api.utils from swanlab.core_python.api.user. To correctly mock the function where it is originally defined and used, the patch should target swanlab.core_python.api.user.get_self_hosted_init.

Suggested change

self.mock_get_metrics = patch('swanlab.api.utils.get_self_hosted_init').start()

self.mock_get_metrics = patch('swanlab.core_python.api.user.get_self_hosted_init').start()

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/api/__init__.py

+        :param path: 实验路径，格式为 'username/project/run_id'
+        :return: Experiment 实例，包含实验信息
+        """
+        # TODO: 待后端完善后替换成专用的接口


The TODO comment indicates that the backend needs to be improved for the run method. This suggests a potential future refactoring or an incomplete implementation that might affect the reliability or functionality of this method. It's important to address such TODOs to ensure the API is fully robust.

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/api/experiments/__init__.py

+        self._filters = filters
+
+    def __iter__(self) -> Iterator[Experiment]:
+        # TODO: 完善filter的功能（正则、条件判断）


The TODO comment indicates that the filter functionality needs to be improved (e.g., regex, conditional logic). This suggests an incomplete feature or a known limitation that could impact the flexibility and power of filtering experiments. Addressing this TODO would enhance the API's capabilities.

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/api/user/__init__.py

+        resp = get_user_groups(self._client, username=self._cur_username)
+        return [r['name'] for r in resp]
+
+    # TODO: 管理员可以对指定用户的api_key进行操作


The TODO comment indicates that administrators should be able to operate on other users' API keys. This suggests a missing feature that could be important for user management and security in a multi-user environment. Implementing this would enhance the API's administrative capabilities.

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/api/user/__init__.py

+        """
+        Refresh the list of api keys.
+        """
+        del self.api_keys


The _refresh_api_keys method attempts to delete a cached property (self.api_keys) using del self.api_keys. While cached_property typically recomputes the property when accessed after deletion, directly deleting it might not be the most robust or idiomatic way to invalidate a cached property. A more explicit way to invalidate a cached_property is often to delete the attribute from self.__dict__.

Suggested change

del self.api_keys

if 'api_keys' in self.__dict__:

del self.__dict__['api_keys']

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/api/utils.py

+        if name.startswith("_"):
+            continue
+        if isinstance(getattr(type(obj), name, None), property):
+            value = getattr(obj, name, None)


In get_properties, the recursive call get_properties(value) is made without a comprehensive check to ensure value is an object that defines properties. If value is a complex data structure (like a list of custom objects) or a non-property-containing object, this could lead to unexpected behavior or errors. The current check type(value).__module__ == 'builtins' only handles built-in types, but not other custom classes that don't have properties.

gemini-code-assist · 2026-01-28T01:05:20Z

swanlab/core_python/api/experiment/__init__.py

+    parsed_filters = (
+        [
+            {
+                "key": to_camel_case(key) if parse_column_type(key) == 'STABLE' else key.split('.', 1)[-1],


In get_project_experiments, the filters parsing logic key.split('.', 1)[-1] for non-'STABLE' types might be problematic if the key does not contain a dot (e.g., just "config" or "summary"). In such cases, split('.', 1)[-1] would return the original key, which might not be the intended sub-key for the backend. Consider adding a check for the presence of a dot or handling such cases explicitly.

Bainianzzz and others added 12 commits January 4, 2026 11:28

feat(init): api login (#1380)

dca98b1

feat: open api unit tests (#1420)

126e29c

* add unit test - add unit test and fix bugs of getting all projects through OpenApi - add unit tests for OpenApi runs and run.history() * add unit test for api.user() * accept suggestions from gemini

fix bugs in projects

5325e28

revert changes

943f227

resolve conflict

fc07300

feat: workspace and json() (#1428)

bfc0333

Replace the workspace field in the project object with a workspace ob…

6e32ba1

…ject

Bainianzzz requested review from SAKURA-CAT and Zeyi-Lin January 28, 2026 01:02

Bainianzzz self-assigned this Jan 28, 2026

Bainianzzz added 💪 enhancement New feature or request 🔌 api SwanLab OpenAPI labels Jan 28, 2026

Bainianzzz closed this Jan 28, 2026

Bainianzzz removed request for SAKURA-CAT and Zeyi-Lin January 28, 2026 01:04

gemini-code-assist bot reviewed Jan 28, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: replace the workspace field in the project object with a workspace object #1429

feat: replace the workspace field in the project object with a workspace object #1429

Uh oh!

Bainianzzz commented Jan 28, 2026

Uh oh!

gemini-code-assist bot commented Jan 28, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

gemini-code-assist bot Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	self.mock_get_metrics = patch('swanlab.api.experiment.thread.get_experiment_metrics').start()
	self.mock_get_metrics = patch('swanlab.core_python.api.experiment.get_experiment_metrics').start()

	del self.api_keys
	if 'api_keys' in self.__dict__:
	del self.__dict__['api_keys']

feat: replace the workspace field in the project object with a workspace object #1429

feat: replace the workspace field in the project object with a workspace object #1429

Uh oh!

Conversation

Bainianzzz commented Jan 28, 2026

Description

Uh oh!

gemini-code-assist bot commented Jan 28, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants