Skip to content

extensions

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 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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_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 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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)

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

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, str]

Extension id.
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
def load_unpacked(path: str) -> 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.
    :returns: Extension id.
    """
    params: T_JSON_DICT = dict()
    params["path"] = path
    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 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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