Skip to content

console

ConsoleMessage dataclass

Console message.

Source code in zendriver/cdp/console.py 
14
15
16
17
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
@dataclass
class ConsoleMessage:
    """
    Console message.
    """

    #: Message source.
    source: str

    #: Message severity.
    level: str

    #: Message text.
    text: str

    #: URL of the message origin.
    url: typing.Optional[str] = None

    #: Line number in the resource that generated this message (1-based).
    line: typing.Optional[int] = None

    #: Column number in the resource that generated this message (1-based).
    column: typing.Optional[int] = 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
        if self.url is not None:
            json["url"] = self.url
        if self.line is not None:
            json["line"] = self.line
        if self.column is not None:
            json["column"] = self.column
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> ConsoleMessage:
        return cls(
            source=str(json["source"]),
            level=str(json["level"]),
            text=str(json["text"]),
            url=str(json["url"]) if json.get("url", None) is not None else None,
            line=int(json["line"]) if json.get("line", None) is not None else None,
            column=(
                int(json["column"]) if json.get("column", None) is not None else None
            ),
        )

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

level: str instance-attribute

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

source: str instance-attribute

text: str instance-attribute

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

__init__(source, level, text, url=None, line=None, column=None)

from_json(json) classmethod

Source code in zendriver/cdp/console.py 
51
52
53
54
55
56
57
58
59
60
61
62
@classmethod
def from_json(cls, json: T_JSON_DICT) -> ConsoleMessage:
    return cls(
        source=str(json["source"]),
        level=str(json["level"]),
        text=str(json["text"]),
        url=str(json["url"]) if json.get("url", None) is not None else None,
        line=int(json["line"]) if json.get("line", None) is not None else None,
        column=(
            int(json["column"]) if json.get("column", None) is not None else None
        ),
    )

to_json()

Source code in zendriver/cdp/console.py 
38
39
40
41
42
43
44
45
46
47
48
49
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["source"] = self.source
    json["level"] = self.level
    json["text"] = self.text
    if self.url is not None:
        json["url"] = self.url
    if self.line is not None:
        json["line"] = self.line
    if self.column is not None:
        json["column"] = self.column
    return json

MessageAdded dataclass

Issued when new console message is added.

Source code in zendriver/cdp/console.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
@event_class("Console.messageAdded")
@dataclass
class MessageAdded:
    """
    Issued when new console message is added.
    """

    #: Console message that has been added.
    message: ConsoleMessage

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> MessageAdded:
        return cls(message=ConsoleMessage.from_json(json["message"]))

message: ConsoleMessage instance-attribute

__init__(message)

from_json(json) classmethod

Source code in zendriver/cdp/console.py 
106
107
108
@classmethod
def from_json(cls, json: T_JSON_DICT) -> MessageAdded:
    return cls(message=ConsoleMessage.from_json(json["message"]))

clear_messages()

Does nothing.

Source code in zendriver/cdp/console.py 
65
66
67
68
69
70
71
72
def clear_messages() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Does nothing.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Console.clearMessages",
    }
    json = yield cmd_dict

disable()

Disables console domain, prevents further console messages from being reported to the client.

Source code in zendriver/cdp/console.py 
75
76
77
78
79
80
81
82
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disables console domain, prevents further console messages from being reported to the client.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Console.disable",
    }
    json = yield cmd_dict

enable()

Enables console domain, sends the messages collected so far to the client by means of the messageAdded notification.

Source code in zendriver/cdp/console.py 
85
86
87
88
89
90
91
92
93
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enables console domain, sends the messages collected so far to the client by means of the
    ``messageAdded`` notification.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "Console.enable",
    }
    json = yield cmd_dict