Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Target

Supports additional targets discovery and allows to attach to them.

- Types

- Commands

- Events

## Types

Generally, you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.

class TargetID

class SessionID

  Unique identifier of attached debugging session.

class TargetInfo(target_id, type_, title, url, attached, can_access_opener, opener_id=None, opener_frame_id=None, parent_frame_id=None, browser_context_id=None, subtype=None)
  target_id: `TargetID`
  type_: `str`

    //source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22

    Type:

      List of types

    Type:

      https

  title: `str`
  url: `str`
  attached: `bool`

    Whether the target has an attached client.

  can_access_opener: `bool`

    Whether the target has access to the originating window.

  opener_id: `Optional`[`TargetID`] = None

    Opener target Id

  opener_frame_id: `Optional`[`FrameId`] = None

    Frame id of originating window (is only set if target has an opener).

  parent_frame_id: `Optional`[`FrameId`] = None

    Id of the parent frame, only present for the “iframe” targets.

  browser_context_id: `Optional`[`BrowserContextID`] = None
  subtype: `Optional`[`str`] = None

    Provides additional details for specific target types. For example, for the type of “page”, this may be set to “prerender”.

class FilterEntry(exclude=None, type_=None)

  A filter used by target query/discovery/auto-attach operations.

  exclude: `Optional`[`bool`] = None

    If set, causes exclusion of matching targets from the list.

  type_: `Optional`[`str`] = None

    If not present, matches any type.

class TargetFilter(iterable=(), /)

  The entries in TargetFilter are matched sequentially against targets and the first entry that matches determines if the target is included or not, depending on the value of `exclude` field in the entry. If filter is not specified, the one assumed is [{type: “browser”, exclude: true}, {type: “tab”, exclude: true}, {}] (i.e. include everything but `browser` and `tab`).

class RemoteLocation(host, port)
  host: `str`
  port: `int`

class WindowState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

  The state of the target window.

  NORMAL = 'normal'
  MINIMIZED = 'minimized'
  MAXIMIZED = 'maximized'
  FULLSCREEN = 'fullscreen'

## Commands

Each command is a generator function. The return type `Generator[x, y, z]` indicates that the generator yields arguments of type `x`, it must be resumed with an argument of type `y`, and it returns type `z`. In this library, types `x` and `y` are the same for all commands, and `z` is the return type you should pay attention to. For more information, see Getting Started: Commands.

activate_target(target_id)

  Activates (focuses) the target.

  Parameters:

    target_id (`TargetID`) –

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

attach_to_browser_target()

  Attaches to the browser target, only uses flat sessionId mode.

  EXPERIMENTAL

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `SessionID`]

  Returns:

    Id assigned to the session.

attach_to_target(target_id, flatten=None)

  Attaches to the target with given id.

  Parameters:

    - target_id (`TargetID`) –

    - flatten (`Optional`[`bool`]) – (Optional) Enables “flat” access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `SessionID`]

  Returns:

    Id assigned to the session.

auto_attach_related(target_id, wait_for_debugger_on_start, filter_=None)

  Adds the specified target to the list of targets that will be monitored for any related target creation (such as child frames, child workers and new versions of service worker) and reported through `attachedToTarget`. The specified target is also auto-attached. This cancels the effect of any previous `setAutoAttach` and is also cancelled by subsequent `setAutoAttach`. Only available at the Browser target.

  EXPERIMENTAL

  Parameters:

    - target_id (`TargetID`) –

    - wait_for_debugger_on_start (`bool`) – Whether to pause new targets when attaching to them. Use ``Runtime.runIfWaitingForDebugger`` to run paused targets.

    - filter – (EXPERIMENTAL) (Optional) Only targets matching filter will be attached.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

close_target(target_id)

  Closes the target. If the target is a page that gets closed too.

  Parameters:

    target_id (`TargetID`) –

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `bool`]

  Returns:

    Always set to true. If an error occurs, the response indicates protocol error.

create_browser_context(dispose_on_detach=None, proxy_server=None, proxy_bypass_list=None, origins_with_universal_network_access=None)

  Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than one.

  Parameters:

    - dispose_on_detach (`Optional`[`bool`]) – (EXPERIMENTAL) (Optional) If specified, disposes this context when debugging session disconnects.

    - proxy_server (`Optional`[`str`]) – (EXPERIMENTAL) (Optional) Proxy server, similar to the one passed to –proxy-server

    - proxy_bypass_list (`Optional`[`str`]) – (EXPERIMENTAL) (Optional) Proxy bypass list, similar to the one passed to –proxy-bypass-list

    - origins_with_universal_network_access (`Optional`[`List`[`str`]]) – (EXPERIMENTAL) (Optional) An optional list of origins to grant unlimited cross-origin access to. Parts of the URL other than those constituting origin are ignored.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `BrowserContextID`]

  Returns:

    The id of the context created.

create_target(url, left=None, top=None, width=None, height=None, window_state=None, browser_context_id=None, enable_begin_frame_control=None, new_window=None, background=None, for_tab=None, hidden=None)

  Creates a new page.

  Parameters:

    - url (`str`) – The initial URL the page will be navigated to. An empty string indicates about:blank.

    - left (`Optional`[`int`]) – (EXPERIMENTAL) (Optional) Frame left origin in DIP (requires newWindow to be true or headless shell).

    - top (`Optional`[`int`]) – (EXPERIMENTAL) (Optional) Frame top origin in DIP (requires newWindow to be true or headless shell).

    - width (`Optional`[`int`]) – (Optional) Frame width in DIP (requires newWindow to be true or headless shell).

    - height (`Optional`[`int`]) – (Optional) Frame height in DIP (requires newWindow to be true or headless shell).

    - window_state (`Optional`[`WindowState`]) – (Optional) Frame window state (requires newWindow to be true or headless shell). Default is normal.

    - browser_context_id (`Optional`[`BrowserContextID`]) – (EXPERIMENTAL) (Optional) The browser context to create the page in.

    - enable_begin_frame_control (`Optional`[`bool`]) – (EXPERIMENTAL) (Optional) Whether BeginFrames for this target will be controlled via DevTools (headless shell only, not supported on MacOS yet, false by default).

    - new_window (`Optional`[`bool`]) – (Optional) Whether to create a new Window or Tab (false by default, not supported by headless shell).

    - background (`Optional`[`bool`]) – (Optional) Whether to create the target in background or foreground (false by default, not supported by headless shell).

    - for_tab (`Optional`[`bool`]) – (EXPERIMENTAL) (Optional) Whether to create the target of type “tab”.

    - hidden (`Optional`[`bool`]) – (EXPERIMENTAL) (Optional) Whether to create a hidden target. The hidden target is observable via protocol, but not present in the tab UI strip. Cannot be created with ``forTab: true```, ```newWindow: true``` or ```background: false``. The life-time of the tab is limited to the life-time of the session.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `TargetID`]

  Returns:

    The id of the page opened.

detach_from_target(session_id=None, target_id=None)

  Detaches session with given id.

  Parameters:

    - session_id (`Optional`[`SessionID`]) – (Optional) Session to detach.

    - target_id (`Optional`[`TargetID`]) – (DEPRECATED) (Optional) Deprecated.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

dispose_browser_context(browser_context_id)

  Deletes a BrowserContext. All the belonging pages will be closed without calling their beforeunload hooks.

  Parameters:

    browser_context_id (`BrowserContextID`) –

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

expose_dev_tools_protocol(target_id, binding_name=None, inherit_permissions=None)

  Inject object to the target’s main frame that provides a communication channel with browser target.

  Injected object will be available as `window[bindingName]`.

  The object has the following API: - `binding.send(json)` - a method to send messages over the remote debugging protocol - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.

  EXPERIMENTAL

  Parameters:

    - target_id (`TargetID`) –

    - binding_name (`Optional`[`str`]) – (Optional) Binding name, ‘cdp’ if not specified.

    - inherit_permissions (`Optional`[`bool`]) – (Optional) If true, inherits the current root session’s permissions (default: false).

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

get_browser_contexts()

  Returns all browser contexts created with `Target.createBrowserContext` method.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `List`[`BrowserContextID`]]

  Returns:

    An array of browser context ids.

get_target_info(target_id=None)

  Returns information about a target.

  EXPERIMENTAL

  Parameters:

    target_id (`Optional`[`TargetID`]) – (Optional)

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `TargetInfo`]

  Returns:

get_targets(filter_=None)

  Retrieves a list of available targets.

  Parameters:

    filter – (EXPERIMENTAL) (Optional) Only targets matching filter will be reported. If filter is not specified and target discovery is currently enabled, a filter used for target discovery is used for consistency.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `List`[`TargetInfo`]]

  Returns:

    The list of targets.

open_dev_tools(target_id)

  Opens a DevTools window for the target.

  EXPERIMENTAL

  Parameters:

    target_id (`TargetID`) – This can be the page or tab target ID.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `TargetID`]

  Returns:

    The targetId of DevTools page target.

send_message_to_target(message, session_id=None, target_id=None)

  Sends protocol message over session with given id. Consider using flat mode instead; see commands attachToTarget, setAutoAttach, and crbug.com/991325.

  Deprecated since version 1.3.

  Parameters:

    - message (`str`) –

    - session_id (`Optional`[`SessionID`]) – (Optional) Identifier of the session.

    - target_id (`Optional`[`TargetID`]) – (DEPRECATED) (Optional) Deprecated.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

  Deprecated since version 1.3.

set_auto_attach(auto_attach, wait_for_debugger_on_start, flatten=None, filter_=None)

  Controls whether to automatically attach to new targets which are considered to be directly related to this one (for example, iframes or workers). When turned on, attaches to all existing related targets as well. When turned off, automatically detaches from all currently attached targets. This also clears all targets added by `autoAttachRelated` from the list of targets to watch for creation of related targets. You might want to call this recursively for auto-attached targets to attach to all available targets.

  Parameters:

    - auto_attach (`bool`) – Whether to auto-attach to related targets.

    - wait_for_debugger_on_start (`bool`) – Whether to pause new targets when attaching to them. Use ``Runtime.runIfWaitingForDebugger`` to run paused targets.

    - flatten (`Optional`[`bool`]) – (EXPERIMENTAL) (Optional) Enables “flat” access to the session via specifying sessionId attribute in the commands. We plan to make this the default, deprecate non-flattened mode, and eventually retire it. See crbug.com/991325.

    - filter – (EXPERIMENTAL) (Optional) Only targets matching filter will be attached.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_discover_targets(discover, filter_=None)

  Controls whether to discover available targets and notify via `targetCreated/targetInfoChanged/targetDestroyed` events.

  Parameters:

    - discover (`bool`) – Whether to discover available targets.

    - filter – (EXPERIMENTAL) (Optional) Only targets matching filter will be attached. If ``discover``` is false, ```filter`` must be omitted or empty.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

set_remote_locations(locations)

  Enables target discovery for the specified locations, when `setDiscoverTargets` was set to `true`.

  EXPERIMENTAL

  Parameters:

    locations (`List`[`RemoteLocation`]) – List of remote locations.

  Return type:

    `Generator`[`Dict`[`str`, `Any`], `Dict`[`str`, `Any`], `None`]

## Events

Generally, you do not need to instantiate CDP events yourself. Instead, the API creates events for you and then you use the event’s attributes.

class AttachedToTarget(session_id, target_info, waiting_for_debugger)

  EXPERIMENTAL

  Issued when attached to target because of auto-attach or `attachToTarget` command.

  session_id: `SessionID`

    Identifier assigned to the session used to send/receive messages.

  target_info: `TargetInfo`
  waiting_for_debugger: `bool`

class DetachedFromTarget(session_id, target_id)

  EXPERIMENTAL

  Issued when detached from target for any reason (including `detachFromTarget` command). Can be issued multiple times per target if multiple sessions have been attached to it.

  session_id: `SessionID`

    Detached session identifier.

  target_id: `Optional`[`TargetID`]

    Deprecated.

class ReceivedMessageFromTarget(session_id, message, target_id)

  Notifies about a new protocol message received from the session (as reported in `attachedToTarget` event).

  session_id: `SessionID`

    Identifier of a session which sends a message.

  message: `str`
  target_id: `Optional`[`TargetID`]

    Deprecated.

class TargetCreated(target_info)

  Issued when a possible inspection target is created.

  target_info: `TargetInfo`

class TargetDestroyed(target_id)

  Issued when a target is destroyed.

  target_id: `TargetID`

class TargetCrashed(target_id, status, error_code)

  Issued when a target has crashed.

  target_id: `TargetID`
  status: `str`

    Termination status type.

  error_code: `int`

    Termination error code.

class TargetInfoChanged(target_info)

  Issued when some information about a target has changed. This only happens between `targetCreated` and `targetDestroyed`.

  target_info: `TargetInfo`