chore: replace black with ruff, slim down pyproject.toml, remove editorconfig

ldming · ldming · commit d35b3788fad2 · 2026-03-19T14:36:25.000+08:00
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,10 @@
+[run]
+source = kb_cloud_client
+omit =
+    */kbcloud/api/*
+    */kbcloud/model/*
+    */kbcloud/admin/*
+
+[report]
+show_missing = true
+skip_covered = false
diff --git a/.editorconfig b/.editorconfig
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -8,20 +8,15 @@ on:
 
 jobs:
   test:
-    name: Test (Python ${{ matrix.python-version }})
+    name: Test
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
-
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: "3.12"
 
       - name: Install dependencies
         run: |
@@ -49,10 +44,13 @@ jobs:
       - name: Install dev dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install black
+          pip install ruff
 
       - name: Check formatting
-        run: black --check src/kb_cloud_client/*.py tests/ examples/
+        run: ruff format --check src/kb_cloud_client/*.py tests/ examples/
+
+      - name: Lint
+        run: ruff check src/kb_cloud_client/*.py tests/ examples/
 
   build:
     name: Build package
diff --git a/Makefile b/Makefile
@@ -15,11 +15,13 @@ install:  ## Install the package in editable mode with dev extras
 test:  ## Run tests
 	pytest tests/ -v --tb=short
 
-lint:  ## Check code formatting (black --check)
-	black --check src/kb_cloud_client/*.py tests/ examples/
+lint:  ## Lint and check formatting (ruff)
+	ruff check src/kb_cloud_client/*.py tests/ examples/
+	ruff format --check src/kb_cloud_client/*.py tests/ examples/
 
-fmt:  ## Auto-format code with black
-	black src/kb_cloud_client/*.py tests/ examples/
+fmt:  ## Auto-format and fix code with ruff
+	ruff format src/kb_cloud_client/*.py tests/ examples/
+	ruff check --fix src/kb_cloud_client/*.py tests/ examples/
 
 typecheck:  ## Run mypy type checks
 	mypy src/kb_cloud_client/ --ignore-missing-imports
diff --git a/examples/admin/get_current_user.py b/examples/admin/get_current_user.py
@@ -1,4 +1,5 @@
 """Example: Get the currently authenticated user's information (admin portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
diff --git a/examples/admin/list_clusters.py b/examples/admin/list_clusters.py
@@ -1,4 +1,5 @@
 """Example: List all clusters in an org with optional filters (admin portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
@@ -13,14 +14,17 @@ def main():
     )
 
     org_name = os.environ.get("KB_CLOUD_ORG", "my-org")
-    engine_filter = os.environ.get("KB_CLOUD_ENGINE")         # e.g. "postgresql"
-    environment_name = os.environ.get("KB_CLOUD_ENV_NAME")    # e.g. "production"
+    engine_filter = os.environ.get("KB_CLOUD_ENGINE")  # e.g. "postgresql"
+    environment_name = os.environ.get("KB_CLOUD_ENV_NAME")  # e.g. "production"
 
     with ApiClient(configuration) as api_client:
         cluster_api = ClusterApi(api_client)
 
-        print(f"Listing clusters in org '{org_name}' (admin view)" +
-              (f", engine={engine_filter}" if engine_filter else "") + "...")
+        print(
+            f"Listing clusters in org '{org_name}' (admin view)"
+            + (f", engine={engine_filter}" if engine_filter else "")
+            + "..."
+        )
 
         result = cluster_api.list_cluster(
             org_name=org_name,
diff --git a/examples/admin/list_engines.py b/examples/admin/list_engines.py
@@ -1,4 +1,5 @@
 """Example: List all available database engines and their versions (admin portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
@@ -17,8 +18,11 @@ def main():
     with ApiClient(configuration) as api_client:
         engine_api = EngineApi(api_client)
 
-        print("Fetching all engines (admin view)" +
-              (f" (filter: name={engine_name})" if engine_name else "") + "...")
+        print(
+            "Fetching all engines (admin view)"
+            + (f" (filter: name={engine_name})" if engine_name else "")
+            + "..."
+        )
 
         result = engine_api.list_all_engines(name=engine_name)
 
@@ -35,8 +39,9 @@ def main():
             ver_str = ", ".join(str(getattr(v, "version", v)) for v in versions[:5])
             if len(versions) > 5:
                 ver_str += f" ... (+{len(versions) - 5} more)"
-            print(f"  - {name}  type={engine_type}" +
-                  (f"  versions=[{ver_str}]" if ver_str else ""))
+            print(
+                f"  - {name}  type={engine_type}" + (f"  versions=[{ver_str}]" if ver_str else "")
+            )
 
 
 if __name__ == "__main__":
diff --git a/examples/admin/list_environments.py b/examples/admin/list_environments.py
@@ -1,4 +1,5 @@
 """Example: List all environments, optionally filtered by org or cloud provider (admin portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
@@ -18,9 +19,12 @@ def main():
     with ApiClient(configuration) as api_client:
         env_api = EnvironmentApi(api_client)
 
-        print("Fetching environments" +
-              (f" for org '{org_name}'" if org_name else "") +
-              (f" on provider '{cloud_provider}'" if cloud_provider else "") + "...")
+        print(
+            "Fetching environments"
+            + (f" for org '{org_name}'" if org_name else "")
+            + (f" on provider '{cloud_provider}'" if cloud_provider else "")
+            + "..."
+        )
 
         result = env_api.list_environment(
             org_name=org_name,
diff --git a/examples/admin/list_organizations.py b/examples/admin/list_organizations.py
@@ -1,4 +1,5 @@
 """Example: List all organizations on the platform (admin portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
@@ -28,8 +29,11 @@ def main():
             name = getattr(org, "name", "?")
             display_name = getattr(org, "display_name", "")
             status = getattr(org, "status", "")
-            print(f"  - {name}" + (f" ({display_name})" if display_name else "") +
-                  (f"  [{status}]" if status else ""))
+            print(
+                f"  - {name}"
+                + (f" ({display_name})" if display_name else "")
+                + (f"  [{status}]" if status else "")
+            )
 
 
 if __name__ == "__main__":
diff --git a/examples/admin/manage_organization.py b/examples/admin/manage_organization.py
@@ -1,8 +1,9 @@
 """Example: Create, read, and delete an organization (admin portal)."""
+
 import os
 import sys
 
-from kb_cloud_client import ApiClient, Configuration, ApiException
+from kb_cloud_client import ApiClient, ApiException, Configuration
 from kb_cloud_client.kbcloud.admin import OrganizationApi
 from kb_cloud_client.kbcloud.admin.model.org_create import OrgCreate
 
diff --git a/examples/user/create_cluster.py b/examples/user/create_cluster.py
@@ -1,4 +1,5 @@
 """Example: Create a new cluster (user portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
diff --git a/examples/user/list_clusters.py b/examples/user/list_clusters.py
@@ -1,4 +1,5 @@
 """Example: List all clusters in an organization (user portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
diff --git a/examples/user/list_organizations.py b/examples/user/list_organizations.py
@@ -1,4 +1,5 @@
 """Example: List all organizations (user portal)."""
+
 import os
 
 from kb_cloud_client import ApiClient, Configuration
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,21 +1,3 @@
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
-
-# ── pytest / coverage (tests live at repo root) ──────────────────────────────
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-addopts = "-v --tb=short"
-
-[tool.coverage.run]
-source = ["kb_cloud_client"]
-omit = [
-    "*/kbcloud/api/*",    # generated
-    "*/kbcloud/model/*",  # generated
-    "*/kbcloud/admin/*",  # generated
-]
-
-[tool.coverage.report]
-show_missing = true
-skip_covered = false
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,3 @@
+[pytest]
+testpaths = tests
+addopts = -v --tb=short
diff --git a/ruff.toml b/ruff.toml
@@ -0,0 +1,16 @@
+line-length = 100
+
+[lint]
+select = ["E", "F", "W", "I"]
+ignore = [
+    "E501",  # line too long – handled by formatter
+    "F401",  # unused import – generated code uses wildcard imports
+    "F403",  # star import – generated code
+]
+
+[lint.per-file-ignores]
+"src/kb_cloud_client/kbcloud/**" = ["F401", "F403", "E402"]  # generated
+
+[format]
+quote-style = "double"
+indent-style = "space"
diff --git a/setup.cfg b/setup.cfg
@@ -42,6 +42,7 @@ kb_cloud_client =
 dev =
     pytest>=7.0.0
     pytest-cov>=4.0.0
+    ruff>=0.4.0
     build>=1.0.0
     twine>=5.0.0
     pdoc>=14.0.0
diff --git a/src/kb_cloud_client/api_client.py b/src/kb_cloud_client/api_client.py
@@ -25,6 +25,7 @@
 # Sentinel for "parameter not provided" – mirrors DataDog's `unset`
 # ---------------------------------------------------------------------------
 
+
 class _Unset:
     """Sentinel singleton that distinguishes 'not provided' from ``None``."""
 
@@ -50,6 +51,7 @@ def __bool__(self) -> bool:
 # Datetime helper
 # ---------------------------------------------------------------------------
 
+
 def _parse_datetime(value: Any) -> Any:
     """Parse an ISO-8601 datetime string, handling the ``Z`` UTC suffix (Python 3.10 compat)."""
     if not isinstance(value, str):
@@ -64,6 +66,7 @@ def _parse_datetime(value: Any) -> Any:
 # Endpoint – declarative API operation descriptor (mirrors DataDog's pattern)
 # ---------------------------------------------------------------------------
 
+
 class Endpoint:
     """Encapsulates all metadata for a single API operation.
 
@@ -148,6 +151,7 @@ def call_with_http_info(self, **kwargs: Any) -> Any:
 # ApiClient
 # ---------------------------------------------------------------------------
 
+
 class ApiClient:
     """HTTP client for the KubeBlocks Cloud API.
 
@@ -203,12 +207,14 @@ def _create_session(self) -> requests.Session:
             session.mount("http://", adapter)
             session.mount("https://", adapter)
 
-        session.headers.update({
-            "User-Agent": f"kb-cloud-client-python/{_VERSION}",
-            "Accept": "application/json",
-            "Content-Type": "application/json",
-            **cfg.default_headers,
-        })
+        session.headers.update(
+            {
+                "User-Agent": f"kb-cloud-client-python/{_VERSION}",
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                **cfg.default_headers,
+            }
+        )
 
         return session
 
diff --git a/src/kb_cloud_client/configuration.py b/src/kb_cloud_client/configuration.py
@@ -8,7 +8,6 @@
 import os
 from typing import Any, Dict, Optional
 
-
 DEFAULT_HOST = "https://api.apecloud.com"
 
 
diff --git a/tests/test_api_client.py b/tests/test_api_client.py
diff --git a/tests/test_configuration.py b/tests/test_configuration.py
diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py
diff --git a/tests/test_models.py b/tests/test_models.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Example: Get the currently authenticated user's information (admin portal)."""`
	`2`	`+`
`2`	`3`	`import os`
`3`	`4`
`4`	`5`	`from kb_cloud_client import ApiClient, Configuration`