Skip to content

common_browser.schemas.configs.browser

Validated runtime and context inputs supplied by application settings.

Classes

BrowserConfig

Bases: BaseModel

Connection inputs; no engine means Chromium locally or inference when borrowed.

Fields and properties declared here; inherited members belong to the bases above.

args

args: tuple[str, ...] = Field(default=(), repr=False)

channel

channel: str | None = None

context

context: ContextConfig = Field(default_factory=ContextConfig)

endpoint

endpoint: SecretStr | None = Field(default=None, repr=False)

engine

engine: Literal['chromium', 'firefox', 'webkit'] | None = None

executable_path

executable_path: Path | None = Field(default=None, repr=False)

headers

headers: dict[str, SecretStr] = Field(default_factory=dict, repr=False)

headless

headless: bool | None = None

max_artifact_bytes

max_artifact_bytes: int = Field(default=(64 * 1024 * 1024), ge=1)

max_observed_elements

max_observed_elements: int = Field(default=1000, ge=1, le=100000)

mode

mode: Literal['launch', 'persistent', 'remote', 'cdp', 'borrowed'] = 'launch'

operation_timeout

operation_timeout: float = Field(default=30.0, gt=0, allow_inf_nan=False)

profile_dir

profile_dir: Path | None = Field(default=None, repr=False)

proxy

proxy: dict[str, SecretStr] | None = Field(default=None, repr=False)

timeout

timeout: float = Field(default=30.0, gt=0, allow_inf_nan=False)

ContextConfig

Bases: BaseModel

One isolated context; secrets and storage never appear in its display.

Fields and properties declared here; inherited members belong to the bases above.

accept_downloads

accept_downloads: bool = True

allowed_origins

allowed_origins: tuple[str, ...] | None = None

extra_http_headers

extra_http_headers: dict[str, SecretStr] = Field(default_factory=dict, repr=False)

http_credentials

http_credentials: dict[str, SecretStr] | None = Field(default=None, repr=False)

ignore_https_errors

ignore_https_errors: bool = False

java_script_enabled

java_script_enabled: bool = True

locale

locale: str | None = None

permissions

permissions: tuple[str, ...] = ()

service_workers

service_workers: Literal['allow', 'block'] = 'allow'

storage

storage: StorageSnapshot | None = Field(default=None, repr=False)

timezone_id

timezone_id: str | None = None

user_agent

user_agent: str | None = None

viewport

viewport: tuple[int, int] | None = (1440, 900)

sdk_options

def sdk_options() -> dict[str, Any]

Explicit SDK boundary export; no environment lookup or I/O.