Improve library

- Add private tabs
- Minor fixes

Author: rushter

pychrome/__init__.py

@@ -7,4 +7,4 @@
 from .tab import *
 from .exceptions import *
 
-__version__ = '0.2.3'
+__version__ = '0.2.4'

pychrome/browser.py

@@ -16,12 +16,33 @@ class Browser(object):
 
     def __init__(self, url="http://127.0.0.1:9222"):
         self.dev_url = url
+        self.context_ids = {}
+        self._ws_api = None
 
         if self.dev_url not in self._all_tabs:
             self._tabs = self._all_tabs[self.dev_url] = {}
         else:
             self._tabs = self._all_tabs[self.dev_url]
 
+    def _get_websocket_url(self):
+        r = requests.get("%s/json/version" % self.dev_url)
+        r.raise_for_status()
+        version_data = r.json()
+        return version_data['webSocketDebuggerUrl']
+
+    @property
+    def ws_api(self):
+        """The main Websocket API connection."""
+        if not self._ws_api:
+            #
+            # This object is just a websocket with event handling, not a new Tab.
+            #
+            self._ws_api = Tab(
+                id='browser', type='browser', webSocketDebuggerUrl=self._get_websocket_url()
+            )
+            self._ws_api.start()
+        return self._ws_api
+
     def new_tab(self, url=None, timeout=None):
         url = url or ''
         rp = requests.get("%s/json/new?%s" % (self.dev_url, url), json=True, timeout=timeout)
@@ -36,7 +57,8 @@ def list_tab(self, timeout=None):
             if tab_json['type'] != 'page':  # pragma: no cover
                 continue
 
-            if tab_json['id'] in self._tabs and self._tabs[tab_json['id']].status != Tab.status_stopped:
+            active_tab = tab_json['id'] in self._tabs
+            if active_tab and self._tabs[tab_json['id']].status != Tab.status_stopped:
                 tabs_map[tab_json['id']] = self._tabs[tab_json['id']]
             else:
                 tabs_map[tab_json['id']] = Tab(**tab_json)
@@ -56,6 +78,13 @@ def close_tab(self, tab_id, timeout=None):
             tab_id = tab_id.id
 
         tab = self._tabs.pop(tab_id, None)
+
+        if tab and tab_id in self.context_ids:
+            self.ws_api.call_method(
+                'Target.disposeBrowserContext',
+                browserContextId=self.context_ids[tab_id]
+            )
+
         if tab and tab.status == Tab.status_started:  # pragma: no cover
             tab.stop()
 
@@ -69,4 +98,37 @@ def version(self, timeout=None):
     def __str__(self):
         return '<Browser %s>' % self.dev_url
 
+    def new_private_tab(self, timeout=None):
+        """Create a new tab in a new browser context.
+
+        This tab will be isolated from other tabs.
+
+        https://chromedevtools.github.io/devtools-protocol/tot/Target/#method-createBrowserContext
+
+        :param timeout: The timeout for API calls.
+        :rtype: Tab
+        """
+        context = self.ws_api.Target.createBrowserContext(_timeout=timeout)
+        try:
+            context_id = context['browserContextId']
+        except KeyError:
+            raise RuntimeError("Can't create a new private context.")
+
+        target = self.ws_api.Target.createTarget(
+            url='about:blank', browserContextId=context_id, _timeout=timeout
+        )
+
+        self.list_tab(timeout=timeout)
+
+        if target['targetId'] in self._tabs:
+            tab = self._tabs[target['targetId']]
+            tab.context_id = context_id
+            self.context_ids[tab.id] = context_id
+        else:
+            raise RuntimeError("Failed to create a new private tab: %s" % target['targetId'])
+        return tab
+
+    def __del__(self):
+        self.ws_api.stop()
+
     __repr__ = __str__

pychrome/tab.py

@@ -3,23 +3,17 @@
 
 from __future__ import unicode_literals
 
-import os
+import functools
 import json
 import logging
-import warnings
+import queue
 import threading
-import functools
+import warnings
 
 import websocket
 
 from .exceptions import *
 
-try:
-    import Queue as queue
-except ImportError:
-    import queue
-
-
 __all__ = ["Tab"]
 
 
@@ -52,7 +46,6 @@ class Tab(object):
     def __init__(self, **kwargs):
         self.id = kwargs.get("id")
         self.type = kwargs.get("type")
-        self.debug = os.getenv("DEBUG", False)
 
         self._websocket_url = kwargs.get("webSocketDebuggerUrl")
         self._kwargs = kwargs
@@ -73,6 +66,7 @@ def __init__(self, **kwargs):
         self.event_handlers = {}
         self.method_results = {}
         self.event_queue = queue.Queue()
+        self.context_id = None
 
     def _send(self, message, timeout=None):
         if 'id' not in message:
@@ -81,8 +75,7 @@ def _send(self, message, timeout=None):
 
         message_json = json.dumps(message)
 
-        if self.debug:  # pragma: no cover
-            print("SEND > %s" % message_json)
+        logging.debug("SEND > %s" % message_json)
 
         if not isinstance(timeout, (int, float)) or timeout > 1:
             q_timeout = 1
@@ -128,8 +121,7 @@ def _recv_loop(self):
                     self._stopped.set()
                 return
 
-            if self.debug:  # pragma: no cover
-                print('< RECV %s' % message_json)
+            logging.debug('< RECV %s' % message_json)
 
             if "method" in message:
                 self.event_queue.put(message)
@@ -174,7 +166,9 @@ def call_method(self, _method, *args, **kwargs):
         result = self._send({"method": _method, "params": kwargs}, timeout=timeout)
         if 'result' not in result and 'error' in result:
             warnings.warn("%s error: %s" % (_method, result['error']['message']))
-            raise CallMethodException("calling method: %s error: %s" % (_method, result['error']['message']))
+            raise CallMethodException(
+                "calling method: %s error: %s" % (_method, result['error']['message'])
+            )
 
         return result['result']
 

setup.cfg

@@ -1,2 +1,5 @@
 [bdist_wheel]
-universal = 1
+universal = 1
+
+[flake8]
+max-line-length = 100