Skip to content

fix: idle timeout type #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bchatelard merged 1 commit into from
Nov 19, 2025
Merged

fix: idle timeout type #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions koyeb/sandbox/sandbox.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
from .utils import (
DEFAULT_INSTANCE_WAIT_TIMEOUT,
DEFAULT_POLL_INTERVAL,
IdleTimeout,
SandboxError,
SandboxTimeoutError,
async_wrapper,
Expand Down Expand Up @@ -110,7 +109,7 @@ def create(
region: Optional[str] = None,
api_token: Optional[str] = None,
timeout: int = 300,
idle_timeout: Optional[IdleTimeout] = 300,
idle_timeout: int = 300,
enable_tcp_proxy: bool = False,
privileged: bool = False,
_experimental_enable_light_sleep: bool = False,
Expand Down Expand Up @@ -191,7 +190,7 @@ def _create_sync(
region: Optional[str] = None,
api_token: Optional[str] = None,
timeout: int = 300,
idle_timeout: Optional[IdleTimeout] = 300,
idle_timeout: int = 300,
enable_tcp_proxy: bool = False,
privileged: bool = False,
_experimental_enable_light_sleep: bool = False,
Expand Down Expand Up @@ -849,7 +848,7 @@ async def create(
region: Optional[str] = None,
api_token: Optional[str] = None,
timeout: int = 300,
idle_timeout: Optional[IdleTimeout] = 300,
idle_timeout: int = 300,
enable_tcp_proxy: bool = False,
privileged: bool = False,
_experimental_enable_light_sleep: bool = False,
Expand Down
25 changes: 4 additions & 21 deletions koyeb/sandbox/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import logging
import os
import shlex
from typing import Any, Callable, Dict, List, Literal, Optional, TypedDict, Union
from typing import Any, Callable, Dict, List, Optional

from koyeb.api import ApiClient, Configuration
from koyeb.api.api import AppsApi, CatalogInstancesApi, InstancesApi, ServicesApi
Expand Down Expand Up @@ -47,23 +47,6 @@
"DIR_NOT_EMPTY": ["not empty", "Directory not empty"],
}

# Type definitions for idle timeout
IdleTimeoutSeconds = int


class IdleTimeoutConfig(TypedDict, total=False):
"""Configuration for idle timeout with light and deep sleep."""

light_sleep: IdleTimeoutSeconds # Optional, but if provided, deep_sleep is required
deep_sleep: IdleTimeoutSeconds # Required


IdleTimeout = Union[
Literal[0], # Disable scale-to-zero
IdleTimeoutSeconds, # Deep sleep only (standard and GPU instances)
IdleTimeoutConfig, # Explicit light_sleep/deep_sleep configuration
]

# Valid protocols for DeploymentPort (from OpenAPI spec: http, http2, tcp)
# For sandboxes, we only support http and http2
VALID_DEPLOYMENT_PORT_PROTOCOLS = ("http", "http2")
Expand Down Expand Up @@ -244,7 +227,7 @@ def create_deployment_definition(
exposed_port_protocol: Optional[str] = None,
region: Optional[str] = None,
routes: Optional[List[DeploymentRoute]] = None,
idle_timeout: Optional[IdleTimeout] = 300,
idle_timeout: int = 300,
enable_tcp_proxy: bool = False,
_experimental_enable_light_sleep: bool = False,
) -> DeploymentDefinition:
Expand Down Expand Up @@ -290,7 +273,7 @@ def create_deployment_definition(
deployment_type = DeploymentDefinitionType.SANDBOX

# Process idle_timeout
if idle_timeout is None or idle_timeout == 0:
if idle_timeout == 0:
sleep_idle_delay = None
elif _experimental_enable_light_sleep:
# Experimental mode: idle_timeout sets light_sleep value, deep_sleep is always 3900
Expand All @@ -306,7 +289,7 @@ def create_deployment_definition(

# Create scaling configuration
# If idle_timeout is 0, explicitly disable scale-to-zero (min=1, always-on)
# Otherwise (None or int > 0), enable scale-to-zero (min=0)
# Otherwise (int > 0), enable scale-to-zero (min=0)
min_scale = 1 if idle_timeout == 0 else 0
targets = None
if sleep_idle_delay is not None:
Expand Down