Skip to content

log

EntryAdded dataclass

Issued when new message was logged.

Source code in zendriver/cdp/log.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
@event_class("Log.entryAdded")
@dataclass
class EntryAdded:
    """
    Issued when new message was logged.
    """

    #: The entry.
    entry: LogEntry

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> EntryAdded:
        return cls(entry=LogEntry.from_json(json["entry"]))

entry: LogEntry instance-attribute

__init__(entry)

from_json(json) classmethod

Source code in zendriver/cdp/log.py 
201
202
203
@classmethod
def from_json(cls, json: T_JSON_DICT) -> EntryAdded:
    return cls(entry=LogEntry.from_json(json["entry"]))

LogEntry dataclass

Log entry.

Source code in zendriver/cdp/log.py 
 18
 19
 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
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@dataclass
class LogEntry:
    """
    Log entry.
    """

    #: Log entry source.
    source: str

    #: Log entry severity.
    level: str

    #: Logged text.
    text: str

    #: Timestamp when this entry was added.
    timestamp: runtime.Timestamp

    category: typing.Optional[str] = None

    #: URL of the resource if known.
    url: typing.Optional[str] = None

    #: Line number in the resource.
    line_number: typing.Optional[int] = None

    #: JavaScript stack trace.
    stack_trace: typing.Optional[runtime.StackTrace] = None

    #: Identifier of the network request associated with this entry.
    network_request_id: typing.Optional[network.RequestId] = None

    #: Identifier of the worker associated with this entry.
    worker_id: typing.Optional[str] = None

    #: Call arguments.
    args: typing.Optional[typing.List[runtime.RemoteObject]] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["source"] = self.source
        json["level"] = self.level
        json["text"] = self.text
        json["timestamp"] = self.timestamp.to_json()
        if self.category is not None:
            json["category"] = self.category
        if self.url is not None:
            json["url"] = self.url
        if self.line_number is not None:
            json["lineNumber"] = self.line_number
        if self.stack_trace is not None:
            json["stackTrace"] = self.stack_trace.to_json()
        if self.network_request_id is not None:
            json["networkRequestId"] = self.network_request_id.to_json()
        if self.worker_id is not None:
            json["workerId"] = self.worker_id
        if self.args is not None:
            json["args"] = [i.to_json() for i in self.args]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> LogEntry:
        return cls(
            source=str(json["source"]),
            level=str(json["level"]),
            text=str(json["text"]),
            timestamp=runtime.Timestamp.from_json(json["timestamp"]),
            category=str(json["category"])
            if json.get("category", None) is not None
            else None,
            url=str(json["url"]) if json.get("url", None) is not None else None,
            line_number=int(json["lineNumber"])
            if json.get("lineNumber", None) is not None
            else None,
            stack_trace=runtime.StackTrace.from_json(json["stackTrace"])
            if json.get("stackTrace", None) is not None
            else None,
            network_request_id=network.RequestId.from_json(json["networkRequestId"])
            if json.get("networkRequestId", None) is not None
            else None,
            worker_id=str(json["workerId"])
            if json.get("workerId", None) is not None
            else None,
            args=[runtime.RemoteObject.from_json(i) for i in json["args"]]
            if json.get("args", None) is not None
            else None,
        )

args: typing.Optional[typing.List[runtime.RemoteObject]] = None class-attribute instance-attribute

category: typing.Optional[str] = None class-attribute instance-attribute

level: str instance-attribute

line_number: typing.Optional[int] = None class-attribute instance-attribute

network_request_id: typing.Optional[network.RequestId] = None class-attribute instance-attribute

source: str instance-attribute

stack_trace: typing.Optional[runtime.StackTrace] = None class-attribute instance-attribute

text: str instance-attribute

timestamp: runtime.Timestamp instance-attribute

url: typing.Optional[str] = None class-attribute instance-attribute

worker_id: typing.Optional[str] = None class-attribute instance-attribute

__init__(source, level, text, timestamp, category=None, url=None, line_number=None, stack_trace=None, network_request_id=None, worker_id=None, args=None)

from_json(json) classmethod

Source code in zendriver/cdp/log.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@classmethod
def from_json(cls, json: T_JSON_DICT) -> LogEntry:
    return cls(
        source=str(json["source"]),
        level=str(json["level"]),
        text=str(json["text"]),
        timestamp=runtime.Timestamp.from_json(json["timestamp"]),
        category=str(json["category"])
        if json.get("category", None) is not None
        else None,
        url=str(json["url"]) if json.get("url", None) is not None else None,
        line_number=int(json["lineNumber"])
        if json.get("lineNumber", None) is not None
        else None,
        stack_trace=runtime.StackTrace.from_json(json["stackTrace"])
        if json.get("stackTrace", None) is not None
        else None,
        network_request_id=network.RequestId.from_json(json["networkRequestId"])
        if json.get("networkRequestId", None) is not None
        else None,
        worker_id=str(json["workerId"])
        if json.get("workerId", None) is not None
        else None,
        args=[runtime.RemoteObject.from_json(i) for i in json["args"]]
        if json.get("args", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/log.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["source"] = self.source
    json["level"] = self.level
    json["text"] = self.text
    json["timestamp"] = self.timestamp.to_json()
    if self.category is not None:
        json["category"] = self.category
    if self.url is not None:
        json["url"] = self.url
    if self.line_number is not None:
        json["lineNumber"] = self.line_number
    if self.stack_trace is not None:
        json["stackTrace"] = self.stack_trace.to_json()
    if self.network_request_id is not None:
        json["networkRequestId"] = self.network_request_id.to_json()
    if self.worker_id is not None:
        json["workerId"] = self.worker_id
    if self.args is not None:
        json["args"] = [i.to_json() for i in self.args]
    return json

ViolationSetting dataclass

Violation configuration setting.

Source code in zendriver/cdp/log.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@dataclass
class ViolationSetting:
    """
    Violation configuration setting.
    """

    #: Violation type.
    name: str

    #: Time threshold to trigger upon.
    threshold: float

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["threshold"] = self.threshold
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ViolationSetting:
        return cls(
            name=str(json["name"]),
            threshold=float(json["threshold"]),
        )

name: str instance-attribute

threshold: float instance-attribute

__init__(name, threshold)

from_json(json) classmethod

Source code in zendriver/cdp/log.py 
125
126
127
128
129
130
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ViolationSetting:
    return cls(
        name=str(json["name"]),
        threshold=float(json["threshold"]),
    )

to_json()

Source code in zendriver/cdp/log.py 
119
120
121
122
123
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["threshold"] = self.threshold
    return json

clear()

Clears the log.

Source code in zendriver/cdp/log.py 
133
134
135
136
137
138
139
140
def clear() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Clears the log.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Log.clear",
    }
    json = yield cmd_dict

disable()

Disables log domain, prevents further log entries from being reported to the client.

Source code in zendriver/cdp/log.py 
143
144
145
146
147
148
149
150
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables log domain, prevents further log entries from being reported to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Log.disable",
    }
    json = yield cmd_dict

enable()

Enables log domain, sends the entries collected so far to the client by means of the entryAdded notification.

Source code in zendriver/cdp/log.py 
153
154
155
156
157
158
159
160
161
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables log domain, sends the entries collected so far to the client by means of the
    ``entryAdded`` notification.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Log.enable",
    }
    json = yield cmd_dict

start_violations_report(config)

start violation reporting.

Parameters:

Name Type Description Default
config List[ViolationSetting]

Configuration for violations.

 required
Source code in zendriver/cdp/log.py 
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def start_violations_report(
    config: typing.List[ViolationSetting],
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    start violation reporting.

    :param config: Configuration for violations.
    """
    params: T_JSON_DICT = dict()
    params["config"] = [i.to_json() for i in config]
    cmd_dict: T_JSON_DICT = {
        "method": "Log.startViolationsReport",
        "params": params,
    }
    json = yield cmd_dict

stop_violations_report()

Stop violation reporting.

Source code in zendriver/cdp/log.py 
181
182
183
184
185
186
187
188
def stop_violations_report() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Stop violation reporting.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Log.stopViolationsReport",
    }
    json = yield cmd_dict