openwpm.commands.types module

class openwpm.commands.types.BaseCommand[source]

Bases: ABC

Base class for all Commands in OpenWPM

See custom_command.py for instructions on how to implement your own and openwpm/commands for all commands that are already implemented

abstract execute(webdriver: WebDriver, browser_params: BrowserParamsInternal, manager_params: ManagerParamsInternal, extension_socket: ClientSocket) → None[source]

This method gets called in the Browser process

Parameters:

  • webdriver – WebDriver is a Selenium class used to control browser. You can simulate arbitrary interactions and extract almost all browser state with the tools that Selenium gives you

  • browser_params – Contains the per browser configuration E.g. which instruments are enabled

  • manager_params – Per crawl parameters E.g. where to store files

  • extension_socket –

    Communication channel to the storage provider

    TODO: Further document this once the StorageProvider PR has landed This allows you to send data to be persisted to storage.

set_start_time(start_time)[source]
set_visit_browser_id(visit_id, browser_id)[source]
class openwpm.commands.types.ShutdownSignal[source]

Bases: object