Add docstrings

Author: jakubno

js/src/codeInterpreter.ts

@@ -52,12 +52,30 @@ async function* readLines(stream: ReadableStream<Uint8Array>) {
   }
 }
 
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
 export class JupyterExtension {
   private static readonly execTimeoutMs = 300_000
   private static readonly defaultKernelID = 'default'
 
   constructor(private readonly url: string, private readonly connectionConfig: ConnectionConfig) { }
 
+  /**
+   * Runs the code in the specified context, if not specified, the default context is used.
+   * You can reference previously defined variables, imports, and functions in the code.
+   *
+   * @param code The code to execute
+   * @param opts Options for executing the code
+   * @param opts.kernelID The context ID to run the code in
+   * @param opts.onStdout Callback for handling stdout messages
+   * @param opts.onStderr Callback for handling stderr messages
+   * @param opts.onResult Callback for handling the final result
+   * @param opts.envs Environment variables to set for the execution
+   * @param opts.timeoutMs Max time to wait for the execution to finish
+   * @param opts.requestTimeoutMs Max time to wait for the request to finish
+   * @returns Execution object
+   */
   async execCell(
     code: string,
     opts?: {
@@ -132,6 +150,14 @@ export class JupyterExtension {
     }
   }
 
+  /**
+   * Creates a new context to run code in.
+   *
+   * @param cwd The working directory for the context
+   * @param kernelName The name of the context
+   * @param requestTimeoutMs Max time to wait for the request to finish
+   * @returns The context ID
+   */
   async createKernel({
     cwd,
     kernelName,
@@ -168,6 +194,13 @@ export class JupyterExtension {
     }
   }
 
+  /**
+   * Restarts the context.
+   * Restarting will clear all variables, imports, and other settings set during previous executions.
+   *
+   * @param kernelID The context ID to restart
+   * @param requestTimeoutMs Max time to wait for the request to finish
+   */
   async restartKernel({
     kernelID,
     requestTimeoutMs,
@@ -195,6 +228,12 @@ export class JupyterExtension {
     }
   }
 
+  /**
+   * Shuts down the context.
+   *
+   * @param kernelID The context ID to shut down
+   * @param requestTimeoutMs Max time to wait for the request to finish
+   */
   async shutdownKernel({
     kernelID,
     requestTimeoutMs,
@@ -221,6 +260,12 @@ export class JupyterExtension {
     }
   }
 
+  /**
+   * Lists all available contexts.
+   *
+   * @param requestTimeoutMs Max time to wait for the request to finish
+   * @returns List of context IDs and names
+   */
   async listKernels({
     requestTimeoutMs,
   }: {
@@ -244,6 +289,9 @@ export class JupyterExtension {
   }
 }
 
+/**
+ * Code interpreter module for executing code in a stateful context.
+ */
 export class CodeInterpreter extends Sandbox {
   protected static override readonly defaultTemplate: string = 'code-interpreter-beta'
   protected static readonly jupyterPort = 49999

js/src/graphs.ts

@@ -1,3 +1,6 @@
+/**
+ * Graph types
+ */
 export enum GraphType {
   LINE = 'line',
   SCATTER = 'scatter',
@@ -8,6 +11,10 @@ export enum GraphType {
   UNKNOWN = 'unknown',
 }
 
+
+/**
+ * Ax scale types
+ */
 export enum ScaleType {
   LINEAR = "linear",
   DATETIME = "datetime",

js/tests/graphs/line.test.ts

@@ -39,6 +39,9 @@ plt.show()
   expect(graph.x_label).toBe('Time (s)')
   expect(graph.y_label).toBe('Amplitude (Hz)')
 
+  expect(graph.x_scale).toBe('datetime')
+  expect(graph.y_scale).toBe('linear')
+
   expect(graph.x_unit).toBe('s')
   expect(graph.y_unit).toBe('Hz')
 

python/e2b_code_interpreter/code_interpreter_async.py

@@ -29,6 +29,10 @@
 
 
 class JupyterExtension:
+    """
+    Code interpreter module for executing code in a stateful context.
+    """
+
     _exec_timeout = 300
 
     @property
@@ -56,6 +60,20 @@ async def exec_cell(
         timeout: Optional[float] = None,
         request_timeout: Optional[float] = None,
     ) -> Execution:
+        """
+        Runs the code in the specified context, if not specified, the default context is used.
+        You can reference previously defined variables, imports, and functions in the code.
+
+        :param code: The code to execute
+        :param kernel_id: The context id
+        :param on_stdout: Callback for stdout messages
+        :param on_stderr: Callback for stderr messages
+        :param on_result: Callback for the `Result` object
+        :param envs: Environment variables
+        :param timeout: Max time to wait for the execution to finish
+        :param request_timeout: Max time to wait for the request to finish
+        :return: Execution object
+        """
         logger.debug(f"Executing code {code}")
 
         timeout = None if timeout == 0 else (timeout or self._exec_timeout)
@@ -98,9 +116,18 @@ async def create_kernel(
         self,
         cwd: Optional[str] = None,
         kernel_name: Optional[str] = None,
-        request_timeout: Optional[float] = None,
         envs: Optional[Dict[str, str]] = None,
+        request_timeout: Optional[float] = None,
     ) -> str:
+        """
+        Creates a new context to run code in.
+
+        :param cwd: Set the current working directory for the context
+        :param kernel_name: Type of the context
+        :param envs: Environment variables
+        :param request_timeout: Max time to wait for the request to finish
+        :return: Context id
+        """
         logger.debug(f"Creating new kernel {kernel_name}")
 
         data = {}
@@ -132,6 +159,12 @@ async def shutdown_kernel(
         kernel_id: Optional[str] = None,
         request_timeout: Optional[float] = None,
     ) -> None:
+        """
+        Shuts down a context.
+
+        :param kernel_id: Context id
+        :param request_timeout: Max time to wait for the request to finish
+        """
         kernel_id = kernel_id or DEFAULT_KERNEL_ID
 
         logger.debug(f"Shutting down a kernel with id {kernel_id}")
@@ -153,6 +186,13 @@ async def restart_kernel(
         kernel_id: Optional[str] = None,
         request_timeout: Optional[float] = None,
     ) -> None:
+        """
+        Restarts the context.
+        Restarting will clear all variables, imports, and other settings set during previous executions.
+
+        :param kernel_id: Context id
+        :param request_timeout: Max time to wait for the request to finish
+        """
         kernel_id = kernel_id or DEFAULT_KERNEL_ID
 
         logger.debug(f"Restarting kernel {kernel_id}")
@@ -173,6 +213,14 @@ async def list_kernels(
         self,
         request_timeout: Optional[float] = None,
     ) -> List[Kernel]:
+        """
+        Lists all available contexts.
+
+        :param request_timeout: Max time to wait for the request to finish
+        :return: List of Kernel objects
+        """
+        logger.debug("Listing kernels")
+
         try:
             response = await self._client.get(
                 f"{self._url}/contexts",
@@ -194,6 +242,9 @@ class AsyncCodeInterpreter(AsyncSandbox):
 
     @property
     def notebook(self) -> JupyterExtension:
+        """
+        Code interpreter module for executing code in a stateful context.
+        """
         return self._notebook
 
     def __init__(self, sandbox_id: str, connection_config: ConnectionConfig):

python/e2b_code_interpreter/code_interpreter_sync.py

@@ -28,6 +28,10 @@
 
 
 class JupyterExtension:
+    """
+    Code interpreter module for executing code in a stateful context.
+    """
+
     _exec_timeout = 300
 
     @property
@@ -55,6 +59,20 @@ def exec_cell(
         timeout: Optional[float] = None,
         request_timeout: Optional[float] = None,
     ) -> Execution:
+        """
+        Runs the code in the specified context, if not specified, the default context is used.
+        You can reference previously defined variables, imports, and functions in the code.
+
+        :param code: The code to execute
+        :param kernel_id: The context id
+        :param on_stdout: Callback for stdout messages
+        :param on_stderr: Callback for stderr messages
+        :param on_result: Callback for the `Result` object
+        :param envs: Environment variables
+        :param timeout: Max time to wait for the execution to finish
+        :param request_timeout: Max time to wait for the request to finish
+        :return: Execution object
+        """
         logger.debug(f"Executing code {code}")
 
         timeout = None if timeout == 0 else (timeout or self._exec_timeout)
@@ -96,15 +114,27 @@ def create_kernel(
         self,
         cwd: Optional[str] = None,
         kernel_name: Optional[str] = None,
+        envs: Optional[Dict[str, str]] = None,
         request_timeout: Optional[float] = None,
     ) -> str:
+        """
+        Creates a new context to run code in.
+
+        :param cwd: Set the current working directory for the context
+        :param kernel_name: Type of the context
+        :param envs: Environment variables
+        :param request_timeout: Max time to wait for the request to finish
+        :return: Context id
+        """
         logger.debug(f"Creating new kernel {kernel_name}")
 
         data = {}
         if kernel_name:
             data["name"] = kernel_name
         if cwd:
             data["cwd"] = cwd
+        if envs:
+            data["env_vars"] = envs
 
         try:
             response = self._client.post(
@@ -127,6 +157,12 @@ def shutdown_kernel(
         kernel_id: Optional[str] = None,
         request_timeout: Optional[float] = None,
     ) -> None:
+        """
+        Shuts down a context.
+
+        :param kernel_id: Context id to shut down
+        :param request_timeout: Max time to wait for the request to finish
+        """
         kernel_id = kernel_id or DEFAULT_KERNEL_ID
 
         logger.debug(f"Shutting down a kernel with id {kernel_id}")
@@ -147,6 +183,13 @@ def restart_kernel(
         kernel_id: Optional[str] = None,
         request_timeout: Optional[float] = None,
     ) -> None:
+        """
+        Restarts the context.
+        Restarting will clear all variables, imports, and other settings set during previous executions.
+
+        :param kernel_id: Context id
+        :param request_timeout: Max time to wait for the request to finish
+        """
         kernel_id = kernel_id or DEFAULT_KERNEL_ID
 
         logger.debug(f"Restarting kernel {kernel_id}")
@@ -167,6 +210,12 @@ def list_kernels(
         self,
         request_timeout: Optional[float] = None,
     ) -> List[Kernel]:
+        """
+        Lists all available contexts.
+
+        :param request_timeout: Max time to wait for the request to finish
+        :return: List of Kernel objects
+        """
         logger.debug("Listing kernels")
 
         try:
@@ -190,6 +239,9 @@ class CodeInterpreter(Sandbox):
 
     @property
     def notebook(self) -> JupyterExtension:
+        """
+        Code interpreter module for executing code in a stateful context.
+        """
         return self._notebook
 
     def __init__(

python/e2b_code_interpreter/graphs.py

@@ -3,6 +3,10 @@
 
 
 class GraphType(str, enum.Enum):
+    """
+    Graph types
+    """
+
     LINE = "line"
     SCATTER = "scatter"
     BAR = "bar"
@@ -13,6 +17,10 @@ class GraphType(str, enum.Enum):
 
 
 class ScaleType(str, enum.Enum):
+    """
+    Ax scale types
+    """
+
     LINEAR = "linear"
     DATETIME = "datetime"
     CATEGORICAL = "categorical"
@@ -26,6 +34,10 @@ class ScaleType(str, enum.Enum):
 
 
 class Graph:
+    """
+    Extracted data from a graph. It's useful for building an interactive graphs or custom visualizations.
+    """
+
     type: GraphType
     title: str