Add kwargs to HTTPEnvClient's from_docker_image method

Author: DarshanDeshpande

examples/local_git_env.py

@@ -22,7 +22,6 @@
 sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
 
 from envs.git_env import GitAction, GitEnv
-from core.containers.runtime import LocalDockerProvider
 
 
 def main():
@@ -47,16 +46,11 @@ def main():
             return False
 
         print("Creating client from Docker image with .env credentials...")
-        print("  Using LocalDockerProvider with env_vars")
+        print("  Using GitEnv.from_docker_image() factory method")
         print()
 
-        # Create provider and start container with environment variables
-        provider = LocalDockerProvider()
-        base_url = provider.start_container("git-env:latest", env_vars=env_vars)
-        provider.wait_for_ready(base_url)
-
-        # Create client connected to the container
-        client = GitEnv(base_url=base_url, provider=provider)
+        # Create client using from_docker_image factory method
+        client = GitEnv.from_docker_image("git-env:latest", env_vars=env_vars)
 
         print("✓ Client created and container started!\n")
 

src/core/http_env_client.py

@@ -46,6 +46,7 @@ def from_docker_image(
         cls: Type[EnvClientT],
         image: str,
         provider: Optional["ContainerProvider"] = None,
+        **kwargs: Any,
     ) -> EnvClientT:
         """
         Create an environment client by spinning up a Docker container locally.
@@ -61,6 +62,8 @@ def from_docker_image(
         Args:
             image: Docker image name to run (e.g., "echo-env:latest")
             provider: Container provider to use (defaults to LocalDockerProvider)
+            **kwargs: Additional arguments to pass to provider.start_container()
+                     (e.g., env_vars, port)
 
         Returns:
             An instance of the client class connected to the running container
@@ -72,6 +75,12 @@ def from_docker_image(
             >>> # Create environment from image
             >>> env = CodingEnv.from_docker_image("coding-env:latest")
             >>>
+            >>> # Create environment with custom env vars
+            >>> env = CodingEnv.from_docker_image(
+            ...     "coding-env:latest",
+            ...     env_vars={"MY_VAR": "value"}
+            ... )
+            >>>
             >>> # Use the environment
             >>> result = env.reset()
             >>> print(result.observation)
@@ -87,8 +96,8 @@ def from_docker_image(
         if provider is None:
             provider = LocalDockerProvider()
 
-        # 1. Start container
-        base_url = provider.start_container(image)
+        # 1. Start container with optional kwargs (e.g., env_vars, port)
+        base_url = provider.start_container(image, **kwargs)
 
         # 2. Wait for server to be ready
         provider.wait_for_ready(base_url)