scalebox-sdk 0.1.4__py3-none-any.whl → 0.1.25__py3-none-any.whl

scalebox/connection_config.py

@@ -1,92 +1,92 @@
-import os
-from typing import Dict, Literal, Optional
-
-from httpx._types import ProxyTypes
-
-# from .api.metadata import package_version
-
-REQUEST_TIMEOUT: float = 30.0  # 30 seconds
-
-KEEPALIVE_PING_INTERVAL_SEC = 50  # 50 seconds
-KEEPALIVE_PING_HEADER = "Keepalive-Ping-Interval"
-
-
-class ConnectionConfig:
-    """
-    Configuration for the connection to the API.
-    """
-
-    @staticmethod
-    def _domain():
-        return os.getenv("CSX_DOMAIN") or "api.scalebox.dev/v1"
-
-    @staticmethod
-    def _debug():
-        return os.getenv("CSX_DEBUG", "false").lower() == "true"
-
-    @staticmethod
-    def _api_key():
-        return os.getenv("CSX_API_KEY")
-
-    @staticmethod
-    def _access_token():
-        return os.getenv("CSX_ACCESS_TOKEN")
-
-    def __init__(
-        self,
-        domain: Optional[str] = None,
-        debug: Optional[bool] = None,
-        api_key: Optional[str] = None,
-        access_token: Optional[str] = None,
-        request_timeout: Optional[float] = None,
-        headers: Optional[Dict[str, str]] = None,
-        proxy: Optional[ProxyTypes] = None,
-    ):
-        self.domain = domain or ConnectionConfig._domain()
-        self.debug = debug or ConnectionConfig._debug()
-        self.api_key = api_key or ConnectionConfig._api_key()
-        self.access_token = access_token or ConnectionConfig._access_token()
-        self.headers = headers or {}
-        # self.headers["User-Agent"] = f"csx-python-sdk/{package_version}"
-
-        self.proxy = proxy
-
-        self.request_timeout = ConnectionConfig._get_request_timeout(
-            REQUEST_TIMEOUT,
-            request_timeout,
-        )
-
-        if request_timeout == 0:
-            self.request_timeout = None
-        elif request_timeout is not None:
-            self.request_timeout = request_timeout
-        else:
-            self.request_timeout = REQUEST_TIMEOUT
-
-        self.api_url = f"https://{self.domain}"
-
-    @staticmethod
-    def _get_request_timeout(
-        default_timeout: Optional[float],
-        request_timeout: Optional[float],
-    ):
-        if request_timeout == 0:
-            return None
-        elif request_timeout is not None:
-            return request_timeout
-        else:
-            return default_timeout
-
-    def get_request_timeout(self, request_timeout: Optional[float] = None):
-        return self._get_request_timeout(self.request_timeout, request_timeout)
-
-
-Username = Literal["root", "user"]
-"""
-User used for the operation in the sandbox.
-"""
-
-default_username: Username = "user"
-"""
-Default user used for the operation in the sandbox.
-"""
+import os
+from typing import Dict, Literal, Optional
+
+from httpx._types import ProxyTypes
+
+# from .api.metadata import package_version
+
+REQUEST_TIMEOUT: float = 30.0  # 30 seconds
+
+KEEPALIVE_PING_INTERVAL_SEC = 50  # 50 seconds
+KEEPALIVE_PING_HEADER = "Keepalive-Ping-Interval"
+
+
+class ConnectionConfig:
+    """
+    Configuration for the connection to the API.
+    """
+
+    @staticmethod
+    def _domain():
+        return os.getenv("SBX_DOMAIN") or "api.scalebox.dev/v1"
+
+    @staticmethod
+    def _debug():
+        return os.getenv("SBX_DEBUG", "false").lower() == "true"
+
+    @staticmethod
+    def _api_key():
+        return os.getenv("SBX_API_KEY")
+
+    @staticmethod
+    def _access_token():
+        return os.getenv("SBX_ACCESS_TOKEN")
+
+    def __init__(
+        self,
+        domain: Optional[str] = None,
+        debug: Optional[bool] = None,
+        api_key: Optional[str] = None,
+        access_token: Optional[str] = None,
+        request_timeout: Optional[float] = None,
+        headers: Optional[Dict[str, str]] = None,
+        proxy: Optional[ProxyTypes] = None,
+    ):
+        self.domain = domain or ConnectionConfig._domain()
+        self.debug = debug or ConnectionConfig._debug()
+        self.api_key = api_key or ConnectionConfig._api_key()
+        self.access_token = access_token or ConnectionConfig._access_token()
+        self.headers = headers or {}
+        # self.headers["User-Agent"] = f"csx-python-sdk/{package_version}"
+
+        self.proxy = proxy
+
+        self.request_timeout = ConnectionConfig._get_request_timeout(
+            REQUEST_TIMEOUT,
+            request_timeout,
+        )
+
+        if request_timeout == 0:
+            self.request_timeout = None
+        elif request_timeout is not None:
+            self.request_timeout = request_timeout
+        else:
+            self.request_timeout = REQUEST_TIMEOUT
+
+        self.api_url = f"https://{self.domain}"
+
+    @staticmethod
+    def _get_request_timeout(
+        default_timeout: Optional[float],
+        request_timeout: Optional[float],
+    ):
+        if request_timeout == 0:
+            return None
+        elif request_timeout is not None:
+            return request_timeout
+        else:
+            return default_timeout
+
+    def get_request_timeout(self, request_timeout: Optional[float] = None):
+        return self._get_request_timeout(self.request_timeout, request_timeout)
+
+
+Username = Literal["root", "user"]
+"""
+User used for the operation in the sandbox.
+"""
+
+default_username: Username = "user"
+"""
+Default user used for the operation in the sandbox.
+"""

scalebox/csx_desktop/main.py

@@ -228,10 +228,10 @@ class Sandbox(SandboxBase):
     #     :param timeout: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users
     #     :param metadata: Custom metadata for the sandbox
     #     :param envs: Custom environment variables for the sandbox
-    #     :param api_key: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable
-    #     :param domain: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable
-    #     :param debug: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable
-    #     :param sandbox_id: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable
+    #     :param api_key: API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
+    #     :param domain: Domain to use for authentication, defaults to `SBX_DOMAIN` environment variable
+    #     :param debug: If True, the sandbox will be created in debug mode, defaults to `SBX_DEBUG` environment variable
+    #     :param sandbox_id: Sandbox ID to connect to, defaults to `SBX_SANDBOX_ID` environment variable
     #     :param request_timeout: Timeout for the request in **seconds**
     #     :param proxy: Proxy to use for the request and for the requests made to the returned sandbox
     #
@@ -307,16 +307,16 @@ class Sandbox(SandboxBase):
         proxy: Optional[ProxyTypes] = None,
     ) -> "Sandbox":
         """
-        同步创建或连接到一个桌面沙箱。
+        Synchronously create or connect to a desktop sandbox.
 
-        参数含义与基类相同。首次创建时会自动启动 Xvfb + xfce4。
+        Parameters have the same meaning as the base class. Xvfb + xfce4 will be automatically started on first creation.
         """
         display = display or ":0"
         if envs is None:
             envs = {}
         envs["DISPLAY"] = display
 
-        # 1. 让父类工厂去实际创建 / 复用
+        # 1. Let the parent class factory actually create / reuse
         base = SandboxBase.create(
             template=template or cls.default_template,
             timeout=timeout,
@@ -330,27 +330,27 @@ class Sandbox(SandboxBase):
             proxy=proxy,
         )
 
-        # 2. 把类型动态升级成 Sandbox
+        # 2. Dynamically upgrade type to Sandbox
         base.__class__ = cls
         base._display = display
         base._last_xfce4_pid = None
 
-        # 3. 首次创建才启动桌面
+        # 3. Only start desktop on first creation
         if not sandbox_id:
             base._start_desktop(resolution, dpi)
         else:
-            # 连接已有沙箱，仅初始化 VNC
+            # Connect to existing sandbox, only initialize VNC
             base.__vnc_server = _VNCServer(base)
 
         return base
 
-    # ====================== 子类私有方法 ======================
+    # ====================== Subclass Private Methods ======================
     def _start_desktop(
         self,
         resolution: Optional[Tuple[int, int]] = None,
         dpi: Optional[int] = None,
     ) -> None:
-        """启动 Xvfb 并等待成功，然后起 xfce4 + VNC。"""
+        """Start Xvfb and wait for success, then start xfce4 + VNC."""
         width, height = resolution or (1024, 768)
         self.commands.run(
             f"Xvfb {self._display} -ac -screen 0 {width}x{height}x24 "

scalebox/generated/api_pb2_connect.py

@@ -8,69 +8,20 @@ from collections.abc import AsyncIterator, Iterable, Iterator
 
 import aiohttp
 import urllib3
-
-try:
-    from connectrpc.client_async import AsyncConnectClient
-    from connectrpc.client_connect import ConnectProtocolError
-    from connectrpc.client_protocol import ConnectProtocol
-    from connectrpc.client_sync import ConnectClient
-    from connectrpc.headers import HeaderInput
-    from connectrpc.server import (
-        ClientRequest,
-        ClientStream,
-        ServerResponse,
-        ServerStream,
-    )
-    from connectrpc.server_sync import ConnectWSGI
-    from connectrpc.streams import AsyncStreamOutput, StreamInput, StreamOutput
-    from connectrpc.unary import ClientStreamingOutput, UnaryOutput
-except ImportError:
-    # connectrpc not available, define dummy classes
-    class AsyncConnectClient:
-        pass
-
-    class ConnectProtocolError(Exception):
-        pass
-
-    class ConnectProtocol:
-        CONNECT_PROTOBUF = "connect_protobuf"
-
-    class ConnectClient:
-        pass
-
-    class HeaderInput:
-        pass
-
-    class ClientRequest:
-        pass
-
-    class ClientStream:
-        pass
-
-    class ServerResponse:
-        pass
-
-    class ServerStream:
-        pass
-
-    class ConnectWSGI:
-        pass
-
-    class AsyncStreamOutput:
-        pass
-
-    class StreamInput:
-        pass
-
-    class StreamOutput:
-        pass
-
-    class ClientStreamingOutput:
-        pass
-
-    class UnaryOutput:
-        pass
-
+from connectrpc.client_async import AsyncConnectClient
+from connectrpc.client_connect import ConnectProtocolError
+from connectrpc.client_protocol import ConnectProtocol
+from connectrpc.client_sync import ConnectClient
+from connectrpc.headers import HeaderInput
+from connectrpc.server import (
+    ClientRequest,
+    ClientStream,
+    ServerResponse,
+    ServerStream,
+)
+from connectrpc.server_sync import ConnectWSGI
+from connectrpc.streams import AsyncStreamOutput, StreamInput, StreamOutput
+from connectrpc.unary import ClientStreamingOutput, UnaryOutput
 
 if typing.TYPE_CHECKING:
     # wsgiref.types was added in Python 3.11.
@@ -739,7 +690,7 @@ class ProcessClient:
         extra_headers: HeaderInput | None = None,
         timeout_seconds: float | None = None,
     ) -> Iterator[api_pb2.ConnectResponse]:
-        stream_output = self.call_connect(req, extra_headers)
+        stream_output = self.call_connect(req, extra_headers,timeout_seconds)
         err = stream_output.error()
         if err is not None:
             raise err
@@ -774,7 +725,7 @@ class ProcessClient:
         extra_headers: HeaderInput | None = None,
         timeout_seconds: float | None = None,
     ) -> Iterator[api_pb2.StartResponse]:
-        stream_output = self.call_start(req, extra_headers)
+        stream_output = self.call_start(req, extra_headers,timeout_seconds)
         err = stream_output.error()
         if err is not None:
             raise err
@@ -992,7 +943,7 @@ class AsyncProcessClient:
         extra_headers: HeaderInput | None = None,
         timeout_seconds: float | None = None,
     ) -> AsyncIterator[api_pb2.StartResponse]:
-        stream_output = await self.call_start(req, extra_headers)
+        stream_output = await self.call_start(req, extra_headers,timeout_seconds)
         err = stream_output.error()
         if err is not None:
             raise err