Skip to content

extensions

ExtensionInfo dataclass

Detailed information about an extension.

Source code in zendriver/cdp/extensions.py 
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
@dataclass
class ExtensionInfo:
    """
    Detailed information about an extension.
    """

    #: Extension id.
    id_: str

    #: Extension name.
    name: str

    #: Extension version.
    version: str

    #: The path from which the extension was loaded.
    path: str

    #: Extension enabled status.
    enabled: bool

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["id"] = self.id_
        json["name"] = self.name
        json["version"] = self.version
        json["path"] = self.path
        json["enabled"] = self.enabled
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ExtensionInfo:
        return cls(
            id_=str(json["id"]),
            name=str(json["name"]),
            version=str(json["version"]),
            path=str(json["path"]),
            enabled=bool(json["enabled"]),
        )

enabled: bool instance-attribute

id_: str instance-attribute

name: str instance-attribute

path: str instance-attribute

version: str instance-attribute

__init__(id_, name, version, path, enabled)

from_json(json) classmethod

Source code in zendriver/cdp/extensions.py 
63
64
65
66
67
68
69
70
71
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ExtensionInfo:
    return cls(
        id_=str(json["id"]),
        name=str(json["name"]),
        version=str(json["version"]),
        path=str(json["path"]),
        enabled=bool(json["enabled"]),
    )

to_json()

Source code in zendriver/cdp/extensions.py 
54
55
56
57
58
59
60
61
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["id"] = self.id_
    json["name"] = self.name
    json["version"] = self.version
    json["path"] = self.path
    json["enabled"] = self.enabled
    return json

StorageArea

Bases: Enum

Storage areas.

Source code in zendriver/cdp/extensions.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class StorageArea(enum.Enum):
    """
    Storage areas.
    """

    SESSION = "session"
    LOCAL = "local"
    SYNC = "sync"
    MANAGED = "managed"

    def to_json(self) -> str:
        return self.value

    @classmethod
    def from_json(cls, json: str) -> StorageArea:
        return cls(json)

LOCAL = 'local' class-attribute instance-attribute

MANAGED = 'managed' class-attribute instance-attribute

SESSION = 'session' class-attribute instance-attribute

SYNC = 'sync' class-attribute instance-attribute

from_json(json) classmethod

Source code in zendriver/cdp/extensions.py 
28
29
30
@classmethod
def from_json(cls, json: str) -> StorageArea:
    return cls(json)

to_json()

Source code in zendriver/cdp/extensions.py 
25
26
def to_json(self) -> str:
    return self.value

clear_storage_items(id_, storage_area)

Clears extension storage in the given storageArea.

Parameters:

Name Type Description Default
id_ str

ID of extension.

 required
storage_area StorageArea

StorageArea to remove data from.

 required
Source code in zendriver/cdp/extensions.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def clear_storage_items(
    id_: str, storage_area: StorageArea
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears extension storage in the given ``storageArea``.

    :param id_: ID of extension.
    :param storage_area: StorageArea to remove data from.
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    params["storageArea"] = storage_area.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.clearStorageItems",
        "params": params,
    }
    json = yield cmd_dict

get_extensions()

Gets a list of all unpacked extensions. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging flag is set.

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, List[ExtensionInfo]]
Source code in zendriver/cdp/extensions.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def get_extensions() -> (
    typing.Generator[T_JSON_DICT, T_JSON_DICT, typing.List[ExtensionInfo]]
):
    """
    Gets a list of all unpacked extensions.
    Available if the client is connected using the --remote-debugging-pipe flag
    and the --enable-unsafe-extension-debugging flag is set.

    :returns:
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.getExtensions",
    }
    json = yield cmd_dict
    return [ExtensionInfo.from_json(i) for i in json["extensions"]]

get_storage_items(id_, storage_area, keys=None)

Gets data from extension storage in the given storageArea. If keys is specified, these are used to filter the result.

Parameters:

Name Type Description Default
id_ str

ID of extension.

 required
storage_area StorageArea

StorageArea to retrieve data from.

 required
keys Optional[List[str]]

(Optional) Keys to retrieve.

 None

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, dict]
Source code in zendriver/cdp/extensions.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
def get_storage_items(
    id_: str, storage_area: StorageArea, keys: typing.Optional[typing.List[str]] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, dict]:
    """
    Gets data from extension storage in the given ``storageArea``. If ``keys`` is
    specified, these are used to filter the result.

    :param id_: ID of extension.
    :param storage_area: StorageArea to retrieve data from.
    :param keys: *(Optional)* Keys to retrieve.
    :returns:
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    params["storageArea"] = storage_area.to_json()
    if keys is not None:
        params["keys"] = [i for i in keys]
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.getStorageItems",
        "params": params,
    }
    json = yield cmd_dict
    return dict(json["data"])

load_unpacked(path, enable_in_incognito=None)

Installs an unpacked extension from the filesystem similar to --load-extension CLI flags. Returns extension ID once the extension has been installed. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging flag is set.

Parameters:

Name Type Description Default
path str

Absolute file path.

 required
enable_in_incognito Optional[bool]

(Optional) Enable the extension in incognito

 None

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, str]

Extension id.
Source code in zendriver/cdp/extensions.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def load_unpacked(
    path: str, enable_in_incognito: typing.Optional[bool] = None
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, str]:
    """
    Installs an unpacked extension from the filesystem similar to
    --load-extension CLI flags. Returns extension ID once the extension
    has been installed. Available if the client is connected using the
    --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
    flag is set.

    :param path: Absolute file path.
    :param enable_in_incognito: *(Optional)* Enable the extension in incognito
    :returns: Extension id.
    """
    params: T_JSON_DICT = dict()
    params["path"] = path
    if enable_in_incognito is not None:
        params["enableInIncognito"] = enable_in_incognito
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.loadUnpacked",
        "params": params,
    }
    json = yield cmd_dict
    return str(json["id"])

remove_storage_items(id_, storage_area, keys)

Removes keys from extension storage in the given storageArea.

Parameters:

Name Type Description Default
id_ str

ID of extension.

 required
storage_area StorageArea

StorageArea to remove data from.

 required
keys List[str]

Keys to remove.

 required
Source code in zendriver/cdp/extensions.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def remove_storage_items(
    id_: str, storage_area: StorageArea, keys: typing.List[str]
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Removes ``keys`` from extension storage in the given ``storageArea``.

    :param id_: ID of extension.
    :param storage_area: StorageArea to remove data from.
    :param keys: Keys to remove.
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    params["storageArea"] = storage_area.to_json()
    params["keys"] = [i for i in keys]
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.removeStorageItems",
        "params": params,
    }
    json = yield cmd_dict

set_storage_items(id_, storage_area, values)

Sets values in extension storage in the given storageArea. The provided values will be merged with existing values in the storage area.

Parameters:

Name Type Description Default
id_ str

ID of extension.

 required
storage_area StorageArea

StorageArea to set data in.

 required
values dict

Values to set.

 required
Source code in zendriver/cdp/extensions.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def set_storage_items(
    id_: str, storage_area: StorageArea, values: dict
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Sets ``values`` in extension storage in the given ``storageArea``. The provided ``values``
    will be merged with existing values in the storage area.

    :param id_: ID of extension.
    :param storage_area: StorageArea to set data in.
    :param values: Values to set.
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    params["storageArea"] = storage_area.to_json()
    params["values"] = values
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.setStorageItems",
        "params": params,
    }
    json = yield cmd_dict

trigger_action(id_, target_id)

Runs an extension default action. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging flag is set.

Parameters:

Name Type Description Default
id_ str

Extension id.

 required
target_id str

A tab target ID to trigger the default extension action on.

 required
Source code in zendriver/cdp/extensions.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def trigger_action(
    id_: str, target_id: str
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Runs an extension default action.
    Available if the client is connected using the --remote-debugging-pipe
    flag and the --enable-unsafe-extension-debugging flag is set.

    :param id_: Extension id.
    :param target_id: A tab target ID to trigger the default extension action on.
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    params["targetId"] = target_id
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.triggerAction",
        "params": params,
    }
    json = yield cmd_dict

uninstall(id_)

Uninstalls an unpacked extension (others not supported) from the profile. Available if the client is connected using the --remote-debugging-pipe flag and the --enable-unsafe-extension-debugging.

Parameters:

Name Type Description Default
id_ str

Extension id.

 required
Source code in zendriver/cdp/extensions.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def uninstall(id_: str) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Uninstalls an unpacked extension (others not supported) from the profile.
    Available if the client is connected using the --remote-debugging-pipe flag
    and the --enable-unsafe-extension-debugging.

    :param id_: Extension id.
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_
    cmd_dict: T_JSON_DICT = {
        "method": "Extensions.uninstall",
        "params": params,
    }
    json = yield cmd_dict