vectorvein 0.3.1__tar.gz → 0.3.3__tar.gz

{vectorvein-0.3.1 → vectorvein-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vectorvein
-Version: 0.3.1
+Version: 0.3.3
 Summary: VectorVein Python SDK
 Author-Email: Anderson <andersonby@163.com>
 License: MIT

{vectorvein-0.3.1 → vectorvein-0.3.3}/pyproject.toml

@@ -17,7 +17,7 @@ description = "VectorVein Python SDK"
 name = "vectorvein"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "0.3.1"
+version = "0.3.3"
 
 [project.license]
 text = "MIT"
@@ -59,6 +59,30 @@ excludes = [
 cmd = "python"
 env_file = ".env"
 
+[tool.ruff]
+line-length = 180
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "B",
+    "C4",
+    "UP",
+]
+ignore = [
+    "E501",
+    "I001",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+
 [tool.codeflash]
 module-root = "src"
 tests-root = "tests"

{vectorvein-0.3.1 → vectorvein-0.3.3}/src/vectorvein/api/client.py

@@ -4,7 +4,7 @@ import time
 import base64
 import asyncio
 from urllib.parse import quote
-from typing import List, Optional, Dict, Any, Union, Literal, overload
+from typing import Any, Literal, overload
 
 import httpx
 from Crypto.Cipher import AES
@@ -33,7 +33,7 @@ class VectorVeinClient:
     API_VERSION = "20240508"
     BASE_URL = "https://vectorvein.com/api/v1/open-api"
 
-    def __init__(self, api_key: str, base_url: Optional[str] = None):
+    def __init__(self, api_key: str, base_url: str | None = None):
         """Initialize the client
 
         Args:
@@ -64,11 +64,11 @@ class VectorVeinClient:
         self,
         method: str,
         endpoint: str,
-        params: Optional[Dict[str, Any]] = None,
-        json: Optional[Dict[str, Any]] = None,
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
         **kwargs,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Send HTTP request
 
         Args:
@@ -107,13 +107,13 @@ class VectorVeinClient:
                 raise VectorVeinAPIError(message=result.get("msg", "Unknown error"), status_code=result["status"])
             return result
         except httpx.HTTPError as e:
-            raise RequestError(f"Request failed: {str(e)}")
+            raise RequestError(f"Request failed: {str(e)}") from e
 
     @overload
     def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: Literal[False] = False,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
@@ -124,7 +124,7 @@ class VectorVeinClient:
     def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: Literal[True] = True,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
@@ -134,12 +134,12 @@ class VectorVeinClient:
     def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: bool = False,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
         timeout: int = 30,
-    ) -> Union[str, WorkflowRunResult]:
+    ) -> str | WorkflowRunResult:
         """Run workflow
 
         Args:
@@ -161,10 +161,7 @@ class VectorVeinClient:
             "wid": wid,
             "output_scope": output_scope,
             "wait_for_completion": wait_for_completion,
-            "input_fields": [
-                {"node_id": field.node_id, "field_name": field.field_name, "value": field.value}
-                for field in input_fields
-            ],
+            "input_fields": [{"node_id": field.node_id, "field_name": field.field_name, "value": field.value} for field in input_fields],
         }
 
         result = self._request("POST", "workflow/run", json=payload, api_key_type=api_key_type)
@@ -191,18 +188,12 @@ class VectorVeinClient:
             time.sleep(5)
 
     @overload
-    def check_workflow_status(
-        self, rid: str, wid: Optional[str] = None, api_key_type: Literal["WORKFLOW"] = "WORKFLOW"
-    ) -> WorkflowRunResult: ...
+    def check_workflow_status(self, rid: str, wid: str | None = None, api_key_type: Literal["WORKFLOW"] = "WORKFLOW") -> WorkflowRunResult: ...
 
     @overload
-    def check_workflow_status(
-        self, rid: str, wid: str, api_key_type: Literal["VAPP"] = "VAPP"
-    ) -> WorkflowRunResult: ...
+    def check_workflow_status(self, rid: str, wid: str, api_key_type: Literal["VAPP"] = "VAPP") -> WorkflowRunResult: ...
 
-    def check_workflow_status(
-        self, rid: str, wid: Optional[str] = None, api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW"
-    ) -> WorkflowRunResult:
+    def check_workflow_status(self, rid: str, wid: str | None = None, api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW") -> WorkflowRunResult:
         """Check workflow run status
 
         Args:
@@ -232,9 +223,7 @@ class VectorVeinClient:
         else:
             raise WorkflowError(f"Workflow execution failed: {response['msg']}")
 
-    def get_access_keys(
-        self, access_keys: Optional[List[str]] = None, get_type: Literal["selected", "all"] = "selected"
-    ) -> List[AccessKey]:
+    def get_access_keys(self, access_keys: list[str] | None = None, get_type: Literal["selected", "all"] = "selected") -> list[AccessKey]:
         """Get access key information
 
         Args:
@@ -256,22 +245,22 @@ class VectorVeinClient:
             return [AccessKey(**key) for key in result["data"]]
         except VectorVeinAPIError as e:
             if e.status_code == 404:
-                raise AccessKeyError("Access key does not exist")
+                raise AccessKeyError("Access key does not exist") from e
             elif e.status_code == 403:
-                raise AccessKeyError("Access key has expired")
+                raise AccessKeyError("Access key has expired") from e
             raise
 
     def create_access_keys(
         self,
         access_key_type: Literal["O", "M", "L"],
-        app_id: Optional[str] = None,
-        app_ids: Optional[List[str]] = None,
+        app_id: str | None = None,
+        app_ids: list[str] | None = None,
         count: int = 1,
-        expire_time: Optional[str] = None,
-        max_credits: Optional[int] = None,
-        max_use_count: Optional[int] = None,
-        description: Optional[str] = None,
-    ) -> List[AccessKey]:
+        expire_time: str | None = None,
+        max_credits: int | None = None,
+        max_use_count: int | None = None,
+        description: str | None = None,
+    ) -> list[AccessKey]:
         """Create access key
 
         Args:
@@ -316,9 +305,9 @@ class VectorVeinClient:
             return [AccessKey(**key) for key in result["data"]]
         except VectorVeinAPIError as e:
             if e.status_code == 404:
-                raise AccessKeyError("The specified application does not exist")
+                raise AccessKeyError("The specified application does not exist") from e
             elif e.status_code == 403:
-                raise AccessKeyError("No permission to create access key")
+                raise AccessKeyError("No permission to create access key") from e
             raise
 
     def list_access_keys(
@@ -327,9 +316,9 @@ class VectorVeinClient:
         page_size: int = 10,
         sort_field: str = "create_time",
         sort_order: str = "descend",
-        app_id: Optional[str] = None,
-        status: Optional[List[str]] = None,
-        access_key_type: Optional[Literal["O", "M", "L"]] = None,
+        app_id: str | None = None,
+        status: list[str] | None = None,
+        access_key_type: Literal["O", "M", "L"] | None = None,
     ) -> AccessKeyListResponse:
         """List access keys
 
@@ -357,7 +346,7 @@ class VectorVeinClient:
         result = self._request("POST", "vapp/access-key/list", json=payload)
         return AccessKeyListResponse(**result["data"])
 
-    def delete_access_keys(self, app_id: str, access_keys: List[str]) -> None:
+    def delete_access_keys(self, app_id: str, access_keys: list[str]) -> None:
         """Delete access key
 
         Args:
@@ -369,15 +358,15 @@ class VectorVeinClient:
 
     def update_access_keys(
         self,
-        access_key: Optional[str] = None,
-        access_keys: Optional[List[str]] = None,
-        app_id: Optional[str] = None,
-        app_ids: Optional[List[str]] = None,
-        expire_time: Optional[str] = None,
-        max_use_count: Optional[int] = None,
-        max_credits: Optional[int] = None,
-        description: Optional[str] = None,
-        access_key_type: Optional[Literal["O", "M", "L"]] = None,
+        access_key: str | None = None,
+        access_keys: list[str] | None = None,
+        app_id: str | None = None,
+        app_ids: list[str] | None = None,
+        expire_time: str | None = None,
+        max_use_count: int | None = None,
+        max_credits: int | None = None,
+        description: str | None = None,
+        access_key_type: Literal["O", "M", "L"] | None = None,
     ) -> None:
         """Update access key
 
@@ -414,7 +403,7 @@ class VectorVeinClient:
 
         self._request("POST", "vapp/access-key/update", json=payload)
 
-    def add_apps_to_access_keys(self, access_keys: List[str], app_ids: List[str]) -> None:
+    def add_apps_to_access_keys(self, access_keys: list[str], app_ids: list[str]) -> None:
         """Add applications to access keys
 
         Args:
@@ -424,7 +413,7 @@ class VectorVeinClient:
         payload = {"access_keys": access_keys, "app_ids": app_ids}
         self._request("POST", "vapp/access-key/add-apps", json=payload)
 
-    def remove_apps_from_access_keys(self, access_keys: List[str], app_ids: List[str]) -> None:
+    def remove_apps_from_access_keys(self, access_keys: list[str], app_ids: list[str]) -> None:
         """Remove applications from access keys
 
         Args:
@@ -474,7 +463,7 @@ class AsyncVectorVeinClient:
     API_VERSION = "20240508"
     BASE_URL = "https://vectorvein.com/api/v1/open-api"
 
-    def __init__(self, api_key: str, base_url: Optional[str] = None):
+    def __init__(self, api_key: str, base_url: str | None = None):
         """Initialize the async client
 
         Args:
@@ -505,11 +494,11 @@ class AsyncVectorVeinClient:
         self,
         method: str,
         endpoint: str,
-        params: Optional[Dict[str, Any]] = None,
-        json: Optional[Dict[str, Any]] = None,
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
         **kwargs,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Send asynchronous HTTP request
 
         Args:
@@ -548,13 +537,13 @@ class AsyncVectorVeinClient:
                 raise VectorVeinAPIError(message=result.get("msg", "Unknown error"), status_code=result["status"])
             return result
         except httpx.HTTPError as e:
-            raise RequestError(f"Request failed: {str(e)}")
+            raise RequestError(f"Request failed: {str(e)}") from e
 
     @overload
     async def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: Literal[False] = False,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
@@ -565,7 +554,7 @@ class AsyncVectorVeinClient:
     async def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: Literal[True] = True,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
@@ -575,12 +564,12 @@ class AsyncVectorVeinClient:
     async def run_workflow(
         self,
         wid: str,
-        input_fields: List[WorkflowInputField],
+        input_fields: list[WorkflowInputField],
         output_scope: Literal["all", "output_fields_only"] = "output_fields_only",
         wait_for_completion: bool = False,
         api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW",
         timeout: int = 30,
-    ) -> Union[str, WorkflowRunResult]:
+    ) -> str | WorkflowRunResult:
         """Async run workflow
 
         Args:
@@ -602,10 +591,7 @@ class AsyncVectorVeinClient:
             "wid": wid,
             "output_scope": output_scope,
             "wait_for_completion": wait_for_completion,
-            "input_fields": [
-                {"node_id": field.node_id, "field_name": field.field_name, "value": field.value}
-                for field in input_fields
-            ],
+            "input_fields": [{"node_id": field.node_id, "field_name": field.field_name, "value": field.value} for field in input_fields],
         }
 
         result = await self._request("POST", "workflow/run", json=payload, api_key_type=api_key_type)
@@ -632,18 +618,12 @@ class AsyncVectorVeinClient:
             await asyncio.sleep(5)
 
     @overload
-    async def check_workflow_status(
-        self, rid: str, wid: Optional[str] = None, api_key_type: Literal["WORKFLOW"] = "WORKFLOW"
-    ) -> WorkflowRunResult: ...
+    async def check_workflow_status(self, rid: str, wid: str | None = None, api_key_type: Literal["WORKFLOW"] = "WORKFLOW") -> WorkflowRunResult: ...
 
     @overload
-    async def check_workflow_status(
-        self, rid: str, wid: str, api_key_type: Literal["VAPP"] = "VAPP"
-    ) -> WorkflowRunResult: ...
+    async def check_workflow_status(self, rid: str, wid: str, api_key_type: Literal["VAPP"] = "VAPP") -> WorkflowRunResult: ...
 
-    async def check_workflow_status(
-        self, rid: str, wid: Optional[str] = None, api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW"
-    ) -> WorkflowRunResult:
+    async def check_workflow_status(self, rid: str, wid: str | None = None, api_key_type: Literal["WORKFLOW", "VAPP"] = "WORKFLOW") -> WorkflowRunResult:
         """Async check workflow run status
 
         Args:
@@ -670,9 +650,7 @@ class AsyncVectorVeinClient:
         else:
             raise WorkflowError(f"Workflow execution failed: {response['msg']}")
 
-    async def get_access_keys(
-        self, access_keys: Optional[List[str]] = None, get_type: Literal["selected", "all"] = "selected"
-    ) -> List[AccessKey]:
+    async def get_access_keys(self, access_keys: list[str] | None = None, get_type: Literal["selected", "all"] = "selected") -> list[AccessKey]:
         """Async get access key information
 
         Args:
@@ -694,22 +672,22 @@ class AsyncVectorVeinClient:
             return [AccessKey(**key) for key in result["data"]]
         except VectorVeinAPIError as e:
             if e.status_code == 404:
-                raise AccessKeyError("Access key does not exist")
+                raise AccessKeyError("Access key does not exist") from e
             elif e.status_code == 403:
-                raise AccessKeyError("Access key has expired")
+                raise AccessKeyError("Access key has expired") from e
             raise
 
     async def create_access_keys(
         self,
         access_key_type: Literal["O", "M", "L"],
-        app_id: Optional[str] = None,
-        app_ids: Optional[List[str]] = None,
+        app_id: str | None = None,
+        app_ids: list[str] | None = None,
         count: int = 1,
-        expire_time: Optional[str] = None,
-        max_credits: Optional[int] = None,
-        max_use_count: Optional[int] = None,
-        description: Optional[str] = None,
-    ) -> List[AccessKey]:
+        expire_time: str | None = None,
+        max_credits: int | None = None,
+        max_use_count: int | None = None,
+        description: str | None = None,
+    ) -> list[AccessKey]:
         """Async create access key
 
         Args:
@@ -754,9 +732,9 @@ class AsyncVectorVeinClient:
             return [AccessKey(**key) for key in result["data"]]
         except VectorVeinAPIError as e:
             if e.status_code == 404:
-                raise AccessKeyError("The specified application does not exist")
+                raise AccessKeyError("The specified application does not exist") from e
             elif e.status_code == 403:
-                raise AccessKeyError("No permission to create access key")
+                raise AccessKeyError("No permission to create access key") from e
             raise
 
     async def list_access_keys(
@@ -765,9 +743,9 @@ class AsyncVectorVeinClient:
         page_size: int = 10,
         sort_field: str = "create_time",
         sort_order: str = "descend",
-        app_id: Optional[str] = None,
-        status: Optional[List[str]] = None,
-        access_key_type: Optional[Literal["O", "M", "L"]] = None,
+        app_id: str | None = None,
+        status: list[str] | None = None,
+        access_key_type: Literal["O", "M", "L"] | None = None,
     ) -> AccessKeyListResponse:
         """Async list access keys
 
@@ -795,7 +773,7 @@ class AsyncVectorVeinClient:
         result = await self._request("POST", "vapp/access-key/list", json=payload)
         return AccessKeyListResponse(**result["data"])
 
-    async def delete_access_keys(self, app_id: str, access_keys: List[str]) -> None:
+    async def delete_access_keys(self, app_id: str, access_keys: list[str]) -> None:
         """Async delete access key
 
         Args:
@@ -807,15 +785,15 @@ class AsyncVectorVeinClient:
 
     async def update_access_keys(
         self,
-        access_key: Optional[str] = None,
-        access_keys: Optional[List[str]] = None,
-        app_id: Optional[str] = None,
-        app_ids: Optional[List[str]] = None,
-        expire_time: Optional[str] = None,
-        max_use_count: Optional[int] = None,
-        max_credits: Optional[int] = None,
-        description: Optional[str] = None,
-        access_key_type: Optional[Literal["O", "M", "L"]] = None,
+        access_key: str | None = None,
+        access_keys: list[str] | None = None,
+        app_id: str | None = None,
+        app_ids: list[str] | None = None,
+        expire_time: str | None = None,
+        max_use_count: int | None = None,
+        max_credits: int | None = None,
+        description: str | None = None,
+        access_key_type: Literal["O", "M", "L"] | None = None,
     ) -> None:
         """Async update access key
 
@@ -852,7 +830,7 @@ class AsyncVectorVeinClient:
 
         await self._request("POST", "vapp/access-key/update", json=payload)
 
-    async def add_apps_to_access_keys(self, access_keys: List[str], app_ids: List[str]) -> None:
+    async def add_apps_to_access_keys(self, access_keys: list[str], app_ids: list[str]) -> None:
         """Async add applications to access keys
 
         Args:
@@ -862,7 +840,7 @@ class AsyncVectorVeinClient:
         payload = {"access_keys": access_keys, "app_ids": app_ids}
         await self._request("POST", "vapp/access-key/add-apps", json=payload)
 
-    async def remove_apps_from_access_keys(self, access_keys: List[str], app_ids: List[str]) -> None:
+    async def remove_apps_from_access_keys(self, access_keys: list[str], app_ids: list[str]) -> None:
         """Async remove applications from access keys
 
         Args:

{vectorvein-0.3.1 → vectorvein-0.3.3}/src/vectorvein/api/exceptions.py

@@ -1,12 +1,10 @@
 """VectorVein API Exception Definitions"""
 
-from typing import Optional
-
 
 class VectorVeinAPIError(Exception):
     """Base exception class for VectorVein API"""
 
-    def __init__(self, message: str, status_code: Optional[int] = None):
+    def __init__(self, message: str, status_code: int | None = None):
         super().__init__(message)
         self.status_code = status_code
 

{vectorvein-0.3.1 → vectorvein-0.3.3}/src/vectorvein/api/models.py

@@ -1,7 +1,7 @@
 """VectorVein API data model definitions"""
 
 from dataclasses import dataclass
-from typing import List, Dict, Optional, Any
+from typing import Any
 
 
 @dataclass
@@ -11,8 +11,8 @@ class VApp:
     app_id: str
     title: str
     description: str
-    info: Dict[str, Any]
-    images: List[str]
+    info: dict[str, Any]
+    images: list[str]
 
 
 @dataclass
@@ -22,18 +22,18 @@ class AccessKey:
     access_key: str
     access_key_type: str  # O: one-time, M: multiple, L: long-term
     use_count: int
-    max_use_count: Optional[int]
-    max_credits: Optional[int]
+    max_use_count: int | None
+    max_credits: int | None
     used_credits: int
-    v_app: Optional[VApp]
-    v_apps: List[VApp]
-    records: List[Any]
+    v_app: VApp | None
+    v_apps: list[VApp]
+    records: list[Any]
     status: str  # AC: valid, IN: invalid, EX: expired, US: used
     access_scope: str  # S: single application, M: multiple applications
     description: str
     create_time: str
     expire_time: str
-    last_use_time: Optional[str]
+    last_use_time: str | None
 
 
 @dataclass
@@ -61,14 +61,14 @@ class WorkflowRunResult:
     rid: str
     status: int
     msg: str
-    data: List[WorkflowOutput]
+    data: list[WorkflowOutput]
 
 
 @dataclass
 class AccessKeyListResponse:
     """Access key list response"""
 
-    access_keys: List[AccessKey]
+    access_keys: list[AccessKey]
     total: int
     page_size: int
     page: int