selenium.webdriver.common.service

Classes

Service([executable_path, port, log_output, ...])

Abstract base class for all service objects that manage driver processes.

class selenium.webdriver.common.service.Service(executable_path: str | None = None, port: int = 0, log_output: int | str | IO[Any] | None = None, env: Mapping[Any, Any] | None = None, driver_path_env_key: str | None = None, **kwargs)

Abstract base class for all service objects that manage driver processes.

Services typically launch a child program in a new process as an interim process to communicate with a browser.

Args:

executable_path: (Optional) Install path of the executable. port: (Optional) Port for the service to run on, defaults to 0 where the operating system will decide. log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file. env: (Optional) Mapping of environment variables for the new process, defaults to os.environ. driver_path_env_key: (Optional) Environment variable to use to get the path to the driver executable.

property service_url: str

Gets the url of the Service.

abstract command_line_args() → list[str]

A List of program arguments (excluding the executable).

property path: str

start() → None

Starts the Service.

Raises:

WebDriverException: Raised either when it can’t start the service

or when it can’t connect to the service

assert_process_still_running() → None

Check if the underlying process is still running.

is_connectable() → bool

Check if the service is ready via the W3C WebDriver /status endpoint.

This makes an HTTP request to the /status endpoint and verifies if it is ready to accept new sessions.

Returns:

True if the service is ready to accept new sessions, False otherwise.

send_remote_shutdown_command() → None

Dispatch an HTTP request to the shutdown endpoint to stop the service.

stop() → None

Stops the service.

env_path() → str | None