grasp-sdk 0.1.9__py3-none-any.whl → 0.2.0b1__py3-none-any.whl

grasp_sdk/services/terminal.py

@@ -0,0 +1,182 @@
+#!/usr/bin/env python3
+"""
+Terminal service for managing terminal command operations.
+
+This module provides Python implementation of the terminal service,
+equivalent to the TypeScript version in src/services/terminal.service.ts
+"""
+
+import asyncio
+import io
+from typing import Optional, Any, Dict, Callable
+from ..models import ICommandOptions
+from ..utils.logger import get_logger, Logger
+from .sandbox import SandboxService, CommandEventEmitter
+from .browser import CDPConnection
+
+
+class StreamableCommandResult:
+    """
+    Streamable command result with event-based output streaming and json result.
+    """
+    
+    def __init__(self, emitter: CommandEventEmitter, task):
+        self.emitter = emitter
+        self._task = task
+        # For backward compatibility, provide stdout/stderr as StringIO
+        self.stdout = io.StringIO()
+        self.stderr = io.StringIO()
+        
+        # Set up internal event handlers to populate StringIO streams
+        def on_stdout(data: str) -> None:
+            self.stdout.write(data)
+            self.stdout.flush()
+        
+        def on_stderr(data: str) -> None:
+            self.stderr.write(data)
+            self.stderr.flush()
+        
+        # Register internal handlers
+        self.emitter.on('stdout', on_stdout)
+        self.emitter.on('stderr', on_stderr)
+    
+    def on(self, event: str, callback: Callable) -> None:
+        """Register event listener for stdout, stderr, or exit events.
+        
+        Args:
+            event: Event name ('stdout', 'stderr', 'exit')
+            callback: Callback function to handle the event
+        """
+        self.emitter.on(event, callback)
+    
+    def off(self, event: str, callback: Callable) -> None:
+        """Remove event listener.
+        
+        Args:
+            event: Event name ('stdout', 'stderr', 'exit')
+            callback: Callback function to remove
+        """
+        self.emitter.off(event, callback)
+    
+    async def end(self) -> None:
+        """Wait until the command finishes."""
+        try:
+            await self._task
+        except Exception as e:
+            # Log error but don't raise to avoid breaking cleanup
+            pass
+    
+    async def kill(self) -> None:
+        """Kill the running command and cleanup resources."""
+        try:
+            await self.emitter.kill()
+            # Close the streams
+            self.stdout.close()
+            self.stderr.close()
+        except Exception as e:
+            # Log error but don't raise to avoid breaking cleanup
+            pass
+    
+    async def json(self) -> Any:
+        """Get the final command result as JSON."""
+        try:
+            return await self._task
+        except Exception as e:
+            # 如果任务中发生异常，返回异常信息作为结果
+            return {
+                'error': str(e),
+                'exit_code': getattr(e, 'exit_code', -1),
+                'stdout': '',
+                'stderr': str(e)
+            }
+
+
+class Commands:
+    """
+    Command execution operations for terminal service.
+    """
+    
+    def __init__(self, sandbox: SandboxService, connection: CDPConnection):
+        self.sandbox = sandbox
+        self.connection = connection
+        self.logger = self._get_default_logger()
+    
+    def _get_default_logger(self) -> Logger:
+        """Gets or creates a default logger instance.
+        
+        Returns:
+            Logger instance
+        """
+        try:
+            return get_logger().child('TerminalService')
+        except Exception:
+            # If logger is not initialized, create a default one
+            from ..utils.logger import Logger
+            default_logger = Logger({
+                'level': 'debug' if self.sandbox.is_debug else 'info',
+                'console': True
+            })
+            return default_logger.child('TerminalService')
+    
+    async def run_command(
+        self, command: str, options: Optional[ICommandOptions] = None
+    ) -> StreamableCommandResult:
+        """Run command in sandbox with streaming output.
+        
+        Args:
+            command: Command to execute
+            options: Command execution options
+            
+        Returns:
+            StreamableCommandResult with event-based streaming
+        """
+        ws = None
+        try:            
+            if options is None:
+                options = {}
+            
+            # Force background execution for streaming
+            bg_options: ICommandOptions = {**options, 'inBackground': True, 'nohup': False}
+            
+            # Set browser endpoint in environment variables
+            if 'envs' not in bg_options:
+                bg_options['envs'] = {}
+            bg_options['envs']['BROWSER_ENDPOINT'] = self.connection.ws_url
+            
+            emitter: Optional[CommandEventEmitter] = await self.sandbox.run_command(
+                command, bg_options
+            )
+            
+            if emitter is None:
+                raise RuntimeError(f"Failed to start command: {command}")
+            
+            # Create task for final result
+            async def get_result():
+                result = await emitter.wait()
+                return result
+            
+            task = asyncio.create_task(get_result())
+            
+            return StreamableCommandResult(emitter, task)
+        except Exception as error:
+            self.logger.error('Run command failed', {'error': str(error)})
+            raise error
+
+
+class TerminalService(Commands):
+    """
+    Terminal service for managing terminal command operations.
+    """
+    
+    def __init__(self, sandbox: SandboxService, connection: CDPConnection):
+        """Initialize terminal service.
+        
+        Args:
+            sandbox: The sandbox service instance
+            connection: The CDP connection for browser integration
+        """
+        super().__init__(sandbox, connection)
+    
+    def close(self) -> None:
+        """Close terminal service and cleanup resources."""
+        self.logger.info('Terminal service closed')

grasp_sdk/utils/__init__.py

@@ -4,7 +4,7 @@ This package contains utility functions and classes for configuration,
 logging, authentication, and other common functionality."""
 
 # Import all utility modules
-from .config import get_config, get_sandbox_config, get_browser_config, DEFAULT_CONFIG
+from .config import get_config, get_sandbox_config, DEFAULT_CONFIG
 from .logger import Logger, init_logger, get_logger, debug, info, warn, error
 from .auth import verify, login, AuthError, KeyVerificationError, AuthManager
 
@@ -12,7 +12,6 @@ __all__ = [
     # Configuration
     'get_config',
     'get_sandbox_config', 
-    'get_browser_config',
     'DEFAULT_CONFIG',
     # Logging
     'Logger',

grasp_sdk/utils/auth.py

@@ -16,8 +16,6 @@ except ImportError:
 if TYPE_CHECKING:
     from aiohttp import ClientSession
 
-from ..models import ISandboxConfig
-
 
 class AuthError(Exception):
     """Exception raised for authentication errors."""
@@ -69,11 +67,11 @@ async def login(token: str) -> Dict[str, Any]:
             raise AuthError(f"Unexpected error during authentication: {str(e)}")
 
 
-async def verify(config: ISandboxConfig) -> Dict[str, Any]:
-    """Verifies the sandbox configuration and authenticates.
+async def verify(config: Dict[str, str]) -> Dict[str, Any]:
+    """Verifies the configuration and authenticates.
     
     Args:
-        config: Sandbox configuration containing the API key
+        config: Configuration containing the API key (format: {'key': 'your-key'})
         
     Returns:
         Dict[str, Any]: Authentication response
@@ -82,7 +80,7 @@ async def verify(config: ISandboxConfig) -> Dict[str, Any]:
         KeyVerificationError: If the key is missing or invalid
         AuthError: If authentication fails
     """
-    if not config['key']:
+    if not config.get('key'):
         raise KeyVerificationError('Grasp key is required')
     
     try:
@@ -93,11 +91,11 @@ async def verify(config: ISandboxConfig) -> Dict[str, Any]:
         raise KeyVerificationError(f"Key verification failed: {str(e)}")
 
 
-def verify_sync(config: ISandboxConfig) -> Dict[str, Any]:
+def verify_sync(config: Dict[str, str]) -> Dict[str, Any]:
     """Synchronous wrapper for the verify function.
     
     Args:
-        config: Sandbox configuration containing the API key
+        config: Configuration containing the API key (format: {'key': 'your-key'})
         
     Returns:
         Dict[str, Any]: Authentication response

grasp_sdk/utils/config.py

@@ -25,9 +25,10 @@ def get_config() -> Dict[str, Any]:
             'key': os.getenv('GRASP_KEY', ''),
             'timeout': int(os.getenv('GRASP_SERVICE_TIMEOUT', '900000')),
             'debug': os.getenv('GRASP_DEBUG', 'false').lower() == 'true',
+            'keepAliveMs': int(os.getenv('GRASP_KEEP_ALIVE_MS', '10000')),
         },
         'logger': {
-            'level': os.getenv('GRASP_LOG_LEVEL', 'info'),
+            'level': os.getenv('GRASP_LOG_LEVEL', None),
             'console': True,
             'file': os.getenv('GRASP_LOG_FILE'),
         },
@@ -54,40 +55,9 @@ def get_sandbox_config() -> ISandboxConfig:
     
     return sandbox_config
 
-
-def get_browser_config() -> IBrowserConfig:
-    """Gets browser-specific configuration.
-    
-    Returns:
-        IBrowserConfig: Browser configuration object.
-    """
-    return IBrowserConfig(
-        args=[
-            '--no-sandbox',
-            '--disable-setuid-sandbox',
-            '--disable-dev-shm-usage',
-            '--disable-gpu',
-            '--remote-debugging-port=9222',
-            '--remote-debugging-address=0.0.0.0',
-        ],
-        headless=os.getenv('GRASP_HEADLESS', 'true').lower() == 'true',
-        launchTimeout=int(os.getenv('GRASP_LAUNCH_TIMEOUT', '30000')),
-        envs={
-            'PLAYWRIGHT_BROWSERS_PATH': '0',
-            'DISPLAY': ':99',
-        },
-    )
-
-
 # Default configuration constants
 DEFAULT_CONFIG = {
-    'PLAYWRIGHT_BROWSERS_PATH': '0',
     'WORKING_DIRECTORY': '/home/user',
-    'SCREENSHOT_PATH': '/home/user',
-    'DEFAULT_VIEWPORT': {
-        'width': 1280,
-        'height': 720,
-    },
 }
 
 

{grasp_sdk-0.1.9.dist-info → grasp_sdk-0.2.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grasp_sdk
-Version: 0.1.9
+Version: 0.2.0b1
 Summary: Python SDK for Grasp E2B - Browser automation and sandbox management
 Home-page: https://github.com/grasp-team/grasp-e2b
 Author: Grasp Team
@@ -27,6 +27,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: typing-extensions>=4.8.0
+Requires-Dist: websockets>=12.0
 Requires-Dist: e2b>=1.5.0
 Requires-Dist: e2b-code-interpreter>=1.5.0
 Provides-Extra: dev
@@ -37,8 +38,6 @@ Requires-Dist: flake8>=6.0.0; extra == "dev"
 Requires-Dist: mypy>=1.0.0; extra == "dev"
 Provides-Extra: browser
 Requires-Dist: playwright>=1.40.0; extra == "browser"
-Provides-Extra: websocket
-Requires-Dist: websockets>=12.0; extra == "websocket"
 Provides-Extra: validation
 Requires-Dist: pydantic>=2.5.0; extra == "validation"
 Dynamic: author

grasp_sdk-0.2.0b1.dist-info/RECORD

@@ -0,0 +1,33 @@
+examples/example_async_context.py,sha256=Ml-WDaKWTZQKeFMoYEPwEFm1W1k7_8Uqyqa6bRTLrNg,4022
+examples/example_binary_file_support.py,sha256=katDD0u8Wd0D3-8QbsNIK7-dnMwWQSPNdl3kqHOQgq0,4432
+examples/example_grasp_usage.py,sha256=mFC04yD_ONaIO_z6jlOvKbgI01WW_F1m17sseiiKTyI,2722
+examples/example_readfile_usage.py,sha256=2KM0lJoMdlroIogaZr_dIqsh_BOrc3GmY1AD2N-2nK8,4505
+examples/grasp_terminal.py,sha256=LRgW1e2jTPkYDytBaM3c1JolEGDIuQMeDZqOW9WhR8k,3442
+examples/grasp_usage.py,sha256=kOq2eU51TX6C8oWXC19-JLWshCssBoc_8Y9h2Yv901Y,3806
+examples/test_async_context.py,sha256=0iDq7ofGM8gUcH5m6MUrgLiRbaEka3mgKO-s9DWZdpM,2379
+examples/test_grasp_classes.py,sha256=MOf3I6V1jZSltHVM1LmZOTkYXLmj3l1CVsUWYooJVVE,3059
+examples/test_python_script.py,sha256=dqJSmvmrq2fdNXynJtMjqMXorrrM08ho6pFibIAZMpI,5265
+examples/test_removed_methods.py,sha256=xGF_AMjoGOB3b70hBosZCnEHj_jEfnvc1yC_fJaI31o,2793
+examples/test_terminal_updates.py,sha256=LihPUOVBOeM5Ee2A4ka4IwZH2vf9ZCiCesvpHWwD2Lk,6694
+grasp_sdk/__init__.py,sha256=1whV0tf-vAQnc0CdU1sza1OWllka0E0tP3giKODhhMo,5161
+grasp_sdk/grasp/__init__.py,sha256=op-QqDUSLjuVhoztmmFfw1ubDDKwAPSAYCTsPFwW6vY,442
+grasp_sdk/grasp/browser.py,sha256=2DWAsDjKpg1MKycQFIpMPHlxVew-Aatdh98Syj-lEkE,5734
+grasp_sdk/grasp/index.py,sha256=PMEFUDvPlW76pf2uBfht6h6rSLpqOrQYuSygx3vfbF8,4352
+grasp_sdk/grasp/server.py,sha256=arAYJZuJNozDuQTCX7HFgO9p9pA_TC-Sz5fz68jnKKY,8053
+grasp_sdk/grasp/session.py,sha256=IxzpWyN8RIxZusgHkAPZGJP81OL2KO62r7gJehPGgng,5579
+grasp_sdk/grasp/utils.py,sha256=j22tUI9yZacsdURObs-a5hxVM7sHsPBO4msRxdVb3MY,2691
+grasp_sdk/models/__init__.py,sha256=M8ZpJARtNqZ5pczXxShUcfieJSCXSrfGARWcsefMi6A,3181
+grasp_sdk/services/__init__.py,sha256=tfiAU211-iMObTflMX4y4TYPU6uXr8g5J0tcc7hLzYs,540
+grasp_sdk/services/browser.py,sha256=oNRmg795NPivlYI5rq17cTHJVV7tVbyhN2pBa03Qv6s,15316
+grasp_sdk/services/filesystem.py,sha256=mDLDqlLA70MnWqTUxnmpVr-6WZJZLZADa42IWjG7QaM,4184
+grasp_sdk/services/sandbox.py,sha256=h6balEQg-CqblkdaqHQwltB-unXPTjAP-dCZGICBFsY,35766
+grasp_sdk/services/terminal.py,sha256=Y7v3H1l_-fQp9C31lEf-57TP1ls9DwpiE7JfumVIDv8,6037
+grasp_sdk/utils/__init__.py,sha256=0Z_1QTXQg4XQhCEgLdnNK0o3q927n15zAHc16QxtAtE,770
+grasp_sdk/utils/auth.py,sha256=W51xyswim48wy2x3xGFFOfWXFAmG4jAwh5wxDgWjKP4,7261
+grasp_sdk/utils/config.py,sha256=FAuAFNXPwtm6E463w6-QUBPDV9VgyfvZlmCncMI_oDQ,3183
+grasp_sdk/utils/logger.py,sha256=k6WDmzL3cPTcQbiiTD4Q6fsDdUO_kyXQHz7nlmtv7G4,7228
+grasp_sdk-0.2.0b1.dist-info/METADATA,sha256=uUyabbGeDiLb50cWVQNZ2pS2H889c-FQaFmKA1-AonU,10121
+grasp_sdk-0.2.0b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+grasp_sdk-0.2.0b1.dist-info/entry_points.txt,sha256=roDjUu4JR6b1tUtRmq018mw167AbfC5zQiOtv3o6IMo,45
+grasp_sdk-0.2.0b1.dist-info/top_level.txt,sha256=TCCFvqgXTCdDpREPkfO5su7ymn5KEA0WuzSSDjvA8Es,19
+grasp_sdk-0.2.0b1.dist-info/RECORD,,

{grasp_sdk-0.1.9.dist-info → grasp_sdk-0.2.0b1.dist-info}/top_level.txt

@@ -1 +1,2 @@
+examples
 grasp_sdk

grasp_sdk-0.1.9.dist-info/RECORD

@@ -1,14 +0,0 @@
-grasp_sdk/__init__.py,sha256=JEmSRZJblEfD09I_775_DMTDiEs4owE6cyVCLWr6CLc,8431
-grasp_sdk/models/__init__.py,sha256=mUfYvCX2S9Fmir9sTsQVV7LdLIPhq2UXQs5fSTRc0eM,2619
-grasp_sdk/services/__init__.py,sha256=HqRD-WRedLwOb2gZPXPFzI-3892VT9IknKSbuDyiss8,327
-grasp_sdk/services/browser.py,sha256=cvp-fxKDxwLFz0evJh2FckDrNdnS8vspkZ0NgZghEzY,14003
-grasp_sdk/services/sandbox.py,sha256=HdR5e30TW2_TPlsE6IBUIeUGnF8yssbsXGEzHrwdK58,21960
-grasp_sdk/utils/__init__.py,sha256=IQzRV-iZJXanSlaXBcgXBCcOXTVBCY6ZujxQpDTGW9w,816
-grasp_sdk/utils/auth.py,sha256=M_SX3uKTjjfi6fzk384IqPvUtqt98bif22HHMgio1D4,7258
-grasp_sdk/utils/config.py,sha256=NhHnUwmYOaaV_DZVep_BXsKoZPNT_-yRsiV04q83IXw,3967
-grasp_sdk/utils/logger.py,sha256=k6WDmzL3cPTcQbiiTD4Q6fsDdUO_kyXQHz7nlmtv7G4,7228
-grasp_sdk-0.1.9.dist-info/METADATA,sha256=p--L6e8fH_AqboS--urzcHvrW3_sEso49r5Rl0CcJuU,10167
-grasp_sdk-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-grasp_sdk-0.1.9.dist-info/entry_points.txt,sha256=roDjUu4JR6b1tUtRmq018mw167AbfC5zQiOtv3o6IMo,45
-grasp_sdk-0.1.9.dist-info/top_level.txt,sha256=C9GL798_aP9Hgjq7UUlaGHLDfUohO2PSGYuGDV0cMx8,10
-grasp_sdk-0.1.9.dist-info/RECORD,,