Skip to content

CDP

The CDP module provides access to Chrome DevTools Protocol commands. For full usage examples, see CDP.

Chrome/Edge only, not part of BiDi

cdp.* commands are Chromium driver extensions — not in the W3C spec.

Methods

send_command

Send a raw CDP command:

result = await client.cdp.send_command(
    "Performance.getMetrics",
    params={},
    session=None,  # optional CDP session to target
)
# result is the raw response dict

get_session

Get the CDP session ID for a browsing context (context required):

session_id = await client.cdp.get_session("context-id-1")
# session_id = "cdp-session-id" or None

Reference

CDPModule

Module for sending CDP commands directly (Chromium only).

Allows access to Chrome DevTools Protocol APIs that are not covered by WebDriver BiDi.

Example

cdp_session = await client.cdp.get_session("context-id") result = await client.cdp.send_command("Page.reload", {})

Source code in bidiwave/modules/cdp.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class CDPModule:
    """Module for sending CDP commands directly (Chromium only).

    Allows access to Chrome DevTools Protocol APIs that are not
    covered by WebDriver BiDi.

    Example:
        cdp_session = await client.cdp.get_session("context-id")
        result = await client.cdp.send_command("Page.reload", {})
    """

    def __init__(self, connection: Connection) -> None:
        self._connection = connection

    async def get_session(self, context: str) -> str | None:
        """Gets the CDP session ID for a browsing context.

        Args:
            context: Browsing context ID. Required by the driver.

        Returns:
            CDP session ID or None if no active session.
        """
        result = await self._connection.send_command(
            BROWSER_CDP_GET_SESSION, {"context": context}
        )
        parsed = CDPGetSessionResult.model_validate(result)
        return parsed.session

    async def send_command(
        self,
        method: str,
        params: dict[str, Any] | None = None,
        session: str | None = None,
    ) -> dict[str, Any]:
        """Sends a CDP command directly to the browser.

        Args:
            method: CDP method name (e.g. "Page.reload", "Network.enable").
            params: Command parameters.
            session: CDP session ID to target (from get_session).

        Returns:
            CDP command result as dict.
        """
        send_params: dict[str, Any] = {"method": method}
        if params is not None:
            send_params["params"] = params
        if session is not None:
            send_params["session"] = session
        return await self._connection.send_command(
            BROWSER_CDP_SEND_COMMAND, send_params
        )

get_session async 

get_session(context: str) -> str | None

Gets the CDP session ID for a browsing context.

Parameters:

Name Type Description Default
context str

Browsing context ID. Required by the driver.

 required

Returns:

Type Description
str | None

CDP session ID or None if no active session.
Source code in bidiwave/modules/cdp.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
async def get_session(self, context: str) -> str | None:
    """Gets the CDP session ID for a browsing context.

    Args:
        context: Browsing context ID. Required by the driver.

    Returns:
        CDP session ID or None if no active session.
    """
    result = await self._connection.send_command(
        BROWSER_CDP_GET_SESSION, {"context": context}
    )
    parsed = CDPGetSessionResult.model_validate(result)
    return parsed.session

send_command async 

send_command(method: str, params: dict[str, Any] | None = None, session: str | None = None) -> dict[str, Any]

Sends a CDP command directly to the browser.

Parameters:

Name Type Description Default
method str

CDP method name (e.g. "Page.reload", "Network.enable").

 required
params dict[str, Any] | None

Command parameters.

 None
session str | None

CDP session ID to target (from get_session).

 None

Returns:

Type Description
dict[str, Any]

CDP command result as dict.
Source code in bidiwave/modules/cdp.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
async def send_command(
    self,
    method: str,
    params: dict[str, Any] | None = None,
    session: str | None = None,
) -> dict[str, Any]:
    """Sends a CDP command directly to the browser.

    Args:
        method: CDP method name (e.g. "Page.reload", "Network.enable").
        params: Command parameters.
        session: CDP session ID to target (from get_session).

    Returns:
        CDP command result as dict.
    """
    send_params: dict[str, Any] = {"method": method}
    if params is not None:
        send_params["params"] = params
    if session is not None:
        send_params["session"] = session
    return await self._connection.send_command(
        BROWSER_CDP_SEND_COMMAND, send_params
    )