Define package specific errors

Author: miyakogi

pyppeteer/chromium_downloader.py

@@ -43,7 +43,7 @@ def curret_platform() -> str:
         if sys.maxsize > 2 ** 31 - 1:
             return 'win64'
         return 'win32'
-    raise Exception('Unsupported platform: ' + sys.platform)
+    raise OSError('Unsupported platform: ' + sys.platform)
 
 
 def get_url() -> str:
@@ -66,7 +66,7 @@ def extract_zip(data: bytes, path: Path) -> None:
         f.extractall(str(path))
     exec_path = chromium_excutable()
     if not exec_path.exists():
-        raise Exception('Failed to extract chromium.')
+        raise IOError('Failed to extract chromium.')
     exec_path.chmod(exec_path.stat().st_mode | stat.S_IXOTH | stat.S_IXGRP |
                     stat.S_IXUSR)
     logger.warn(f'chromium extracted to: {path}')

pyppeteer/connection.py

@@ -6,12 +6,13 @@
 import asyncio
 import json
 import logging
-
 from typing import Awaitable, TYPE_CHECKING
 
 from pyee import EventEmitter
 import websockets
 
+from pyppeteer.errors import NetworkError
+
 if TYPE_CHECKING:
     from typing import Callable, Dict, Optional  # noqa: F401
 
@@ -82,7 +83,7 @@ def _on_response(self, msg: dict) -> None:
         if 'error' in msg:
             error = msg['error']
             callback.set_exception(
-                Exception(f'Protocol Error: {error}'))
+                NetworkError(f'Protocol Error: {error}'))
         else:
             callback.set_result(msg.get('result'))
 
@@ -167,7 +168,7 @@ async def send(self, method: str, params: dict = None) -> dict:
         callback.method: str = method  # type: ignore
 
         if not self._connection:
-            raise Exception('Connection closed.')
+            raise NetworkError('Connection closed.')
         await self._connection.send('Target.sendMessageToTarget', {
             'sessionId': self._sessionId,
             'message': msg,
@@ -184,7 +185,7 @@ def _on_message(self, msg: str) -> None:
                 msg = error.get('message')
                 data = error.get('data')
                 callback.set_exception(
-                    Exception(f'Protocol Error: {msg} {data}')
+                    NetworkError(f'Protocol Error: {msg} {data}')
                 )
             else:
                 result = obj.get('result')

pyppeteer/element_handle.py

@@ -9,6 +9,7 @@
 
 from pyppeteer import helper
 from pyppeteer.connection import Session
+from pyppeteer.errors import ElementHandleError, BrowserError
 from pyppeteer.input import Mouse
 
 
@@ -33,7 +34,7 @@ async def dispose(self) -> None:
     async def evaluate(self, pageFunction: str, *args: Any) -> Any:
         """Evaluate the pageFunction on browser."""
         if self._disposed:
-            raise Exception('ElementHandle is disposed!')
+            raise ElementHandleError('ElementHandle is disposed!')
         _args = ['this']
         _args.extend(json.dumps(x) for x in args)
         stringifiedArgs = ','.join(_args)
@@ -52,8 +53,10 @@ async def evaluate(self, pageFunction: str, *args: Any) -> Any:
         exceptionDetails = obj.get('exceptionDetails', dict())
         remoteObject = obj.get('result', dict())
         if exceptionDetails:
-            raise Exception('Evaluation failed: ' +
-                            helper.getExceptionMessage(exceptionDetails))
+            raise BrowserError(
+                'Evaluation failed: ' +
+                helper.getExceptionMessage(exceptionDetails)
+            )
         return await helper.serializeRemoteObject(self._client, remoteObject)
 
     async def _visibleCenter(self) -> Dict[str, int]:
@@ -71,7 +74,7 @@ async def _visibleCenter(self) -> Dict[str, int]:
         ''')  # noqa: E501
         if not center:
             # raise Exception('No node found for selector: ' + selector)
-            raise Exception('No node found for selector: ')
+            raise BrowserError('No node found for selector: ')
         return center
 
     async def hover(self) -> None:

pyppeteer/errors.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""Exceptions for pyppeteer package."""
+
+
+class PyppeteerError(Exception):  # noqa: D204
+    """Base exception for pyppeteer."""
+    pass
+
+
+class BrowserError(PyppeteerError):  # noqa: D204
+    """Exception raised from browser."""
+    pass
+
+
+class ElementHandleError(PyppeteerError):  # noqa: D204
+    """ElementHandle related exception."""
+    pass
+
+
+class NetworkError(PyppeteerError):  # noqa: D204
+    """Network/Protocol related exception."""
+    pass
+
+
+class PageError(PyppeteerError):  # noqa: D204
+    """Page/Frame related exception."""
+    pass

pyppeteer/frame_manager.py

@@ -11,6 +11,7 @@
 
 from pyppeteer import helper
 from pyppeteer.connection import Session
+from pyppeteer.errors import BrowserError, NetworkError, PageError
 from pyppeteer.input import Mouse
 from pyppeteer.element_handle import ElementHandle
 
@@ -71,7 +72,7 @@ def _onFrameNavigated(self, framePayload: dict) -> None:
         else:
             self._frames.get(framePayload.get('id', ''))
         if not (isMainFrame or frame):
-            raise Exception('We either navigate top level or have old version '
+            raise PageError('We either navigate top level or have old version '
                             'of the navigated frame')
 
         # Detach all child frames first.
@@ -180,10 +181,11 @@ async def _rawEvaluate(self, pageFunction: str, *args: str) -> dict:
         exceptionDetails = obj.get('exceptionDetails', dict())
         remoteObject = obj.get('result', dict())
         if exceptionDetails:
-            raise Exception('Evaluation failed: ' +
-                            helper.getExceptionMessage(exceptionDetails) +
-                            f'\npageFunction:\n{pageFunction}'
-                            )
+            raise BrowserError(
+                'Evaluation failed: ' +
+                helper.getExceptionMessage(exceptionDetails) +
+                f'\npageFunction:\n{pageFunction}'
+            )
         return remoteObject
 
     @property
@@ -243,7 +245,7 @@ def waitFor(self, selectorOrFunctionOrTimeout: Union[str, int, float],
             return fut
         if not isinstance(selectorOrFunctionOrTimeout, str):
             fut = asyncio.get_event_loop().create_future()
-            fut.set_exception(Exception(
+            fut.set_exception(TypeError(
                 'Unsupported target type: ' +
                 str(type(selectorOrFunctionOrTimeout))
             ))
@@ -303,7 +305,7 @@ def _navigated(self, framePayload: dict) -> None:
     def _detach(self) -> None:
         for waitTask in self._waitTasks:
             waitTask.terminate(
-                Exception('waitForSelector failed: frame got detached.'))
+                PageError('waitForSelector failed: frame got detached.'))
         self._detached = True
         if self._parentFrame:
             self._parentFrame._childFrames.remove(self)
@@ -319,13 +321,13 @@ def __init__(self, frame: Frame, predicateBody: str,
         super().__init__()
         if isinstance(polling, str):
             if polling not in ('raf', 'mutation'):
-                raise Exception('Unknown polling option: ' + polling)
+                raise ValueError('Unknown polling option: ' + polling)
         elif isinstance(polling, (int, float)):
             if polling <= 0:
-                raise Exception(
+                raise ValueError(
                     f'Cannot poll with non-positive interval: {polling}')
         else:
-            raise Exception('Unknown polling options: ' + str(polling))
+            raise ValueError('Unknown polling options: ' + str(polling))
 
         self._frame: Frame = frame
         self._pageScript: str = helper.evaluationString(
@@ -339,7 +341,7 @@ def __init__(self, frame: Frame, predicateBody: str,
         self._timeoutTimer = loop.call_later(
             timeout / 1000,
             lambda: self.terminate(
-                Exception(f'waiting failed: timeout {timeout}ms exceeded')
+                NetworkError(f'waiting failed: timeout {timeout}ms exceeded')
             )
         )
         asyncio.ensure_future(self.rerun())

pyppeteer/helper.py

@@ -69,7 +69,8 @@ async def serializeRemoteObject(client: Session, remoteObject: dict) -> Any:
         if unserializableValue in unserializableValueMap:
             return unserializableValueMap[unserializableValue]
         else:
-            raise Exception(
+            # BrowserError may be better
+            raise ValueError(
                 'Unsupported unserializable value: ' + str(unserializableValue)
             )
 

pyppeteer/navigator_watcher.py

@@ -10,6 +10,7 @@
 
 from pyppeteer import helper
 from pyppeteer.connection import Session
+from pyppeteer.errors import NetworkError
 
 if TYPE_CHECKING:
     from typing import Callable, List, Set  # noqa: F401
@@ -31,7 +32,7 @@ def __init__(self, client: Session, ignoreHTTPSErrors: Any,
         self._idleInflight = options.get('networkIdleInflight', 2)
         self._waitUntil = options.get('waitUntil', 'load')
         if self._waitUntil not in ('load', 'networkidle'):
-            raise Exception(
+            raise ValueError(
                 f'Unknown value for options.waitUntil: {self._waitUntil}')
 
     def _raise_error(self, error: Exception = Exception()) -> None:
@@ -62,8 +63,8 @@ def watchdog_cb(fut: Awaitable) -> None:
                 helper.addEventListener(
                     self._client, 'Security.certificateError',
                     lambda event: certificateError.set_exception(
-                        Exception('SSL Certificate error: ' +
-                                  str(event.get('errorType')))
+                        NetworkError('SSL Certificate error: ' +
+                                     str(event.get('errorType')))
                     )
                 )
             )

pyppeteer/network_manager.py

@@ -14,6 +14,7 @@
 from pyee import EventEmitter
 
 from pyppeteer.connection import Session
+from pyppeteer.errors import NetworkError
 from pyppeteer.multimap import Multimap
 
 if TYPE_CHECKING:
@@ -81,8 +82,8 @@ def _onRequestIntercepted(self, event: dict) -> None:
         if event.get('redirectStatusCode'):
             request = self._interceptionIdToRequest[event['interceptionId']]
             if not request:
-                raise Exception('INTERNAL ERROR: failed to find request for '
-                                'interception redirect.')
+                raise NetworkError('INTERNAL ERROR: failed to find request '
+                                   'for interception redirect.')
             self._handleRequestRedirect(request,
                                         event['redirectStatusCode'],
                                         event['redirectHeaders'])