_debugger.py

# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from typing import Dict, Optional

from playwright._impl._api_structures import PausedDetails, PausedDetailsLocation
from playwright._impl._connection import ChannelOwner


class Debugger(ChannelOwner):
    Events = {"PausedStateChanged": "pausedStateChanged"}

    def __init__(
        self, parent: ChannelOwner, type: str, guid: str, initializer: Dict
    ) -> None:
        super().__init__(parent, type, guid, initializer)
        self._paused_details: Optional[PausedDetails] = None
        self._channel.on(
            "pausedStateChanged",
            lambda params: self._on_paused_state_changed(params.get("pausedDetails")),
        )

    def _on_paused_state_changed(self, paused_details: Optional[PausedDetails]) -> None:
        self._paused_details = paused_details
        self.emit(Debugger.Events["PausedStateChanged"])

    async def request_pause(self) -> None:
        await self._channel.send("requestPause", None)

    async def resume(self) -> None:
        await self._channel.send("resume", None)

    async def next(self) -> None:
        await self._channel.send("next", None)

    async def run_to(self, location: PausedDetailsLocation) -> None:
        await self._channel.send("runTo", None, {"location": location})

    @property
    def paused_details(self) -> Optional[PausedDetails]:
        return self._paused_details