├── requirements.txt ├── .gitignore ├── setup.py ├── README.md ├── PyChromeDevTools └── __init__.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | websocket-client 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.sublime-project 3 | *.sublime-workspace -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | try: 2 | from setuptools import setup 3 | except ImportError: 4 | from distutils.core import setup 5 | 6 | setup( 7 | name="PyChromeDevTools", 8 | description="PyChromeDevTools : Interact with Google Chrome using the Chrome DevTools Protocol.", 9 | license="Apache License 2.0", 10 | version="1.0.4", 11 | author="Martino Trevisan", 12 | author_email="martino.trevisan@polito.it", 13 | maintainer="Martino Trevisan", 14 | maintainer_email="martino.trevisan@polito.it", 15 | url="https://github.com/marty90/PyChromeDevTools", 16 | download_url = 'https://github.com/marty90/PyChromeDevTools/tarball/1.0.4', 17 | packages=['PyChromeDevTools'], 18 | install_requires=['requests', 'websocket-client'] 19 | ) 20 | 21 | # Upload on pip with: 22 | # Create new version 23 | # python setup.py sdist 24 | # twine upload dist/* 25 | 26 | # Test it locally removing the pip installed one 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PyChromeDevTools 2 | 3 | # 1. Description 4 | PyChromeDevTools is a python module that allows one to interact with Google Chrome using [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) within a Python script. 5 | To use this tool, you must run an instance of Google Chrome with the `remote-debugging` option, like in the following example. 6 | ``` 7 | google-chrome --remote-debugging-port=9222 --remote-allow-origins=* 8 | ``` 9 | You may want to enable further Chrome benchmarking capabilities using the `--enable-benchmarking` and `--enable-net-benchmarking` options. You can run Chrome in headless mode using the option `--headless`. 10 | 11 | For information about this Readme file and this tool please write to 12 | [martino.trevisan@polito.it](mailto:martino.trevisan@polito.it) 13 | 14 | # 2. Prerequisites and Installation 15 | Very few dependencies must be satisfied: an updated Google-Chrome version and the python packages `requests` and `websocket-client`. 16 | You can install them using the `pip` tool. 17 | 18 | You can install `PyChromeDevTools` issuing the git command: 19 | ``` 20 | git clone https://github.com/marty90/PyChromeDevTools 21 | ``` 22 | Or, better, you install it and its dependencies by using `pip`: 23 | ``` 24 | sudo pip3 install PyChromeDevTools 25 | ``` 26 | 27 | # 3. Operation 28 | ## 3.1 Init 29 | In your python script, as first, you must create a ChromeInterface object, like in the following: 30 | ``` 31 | chrome = PyChromeDevTools.ChromeInterface() 32 | ``` 33 | You can specify the host and the port of Chrome manually writing: 34 | ``` 35 | chrome = PyChromeDevTools.ChromeInterface(host="1.1.1.1",port=1234) 36 | ``` 37 | By default it uses `localhost:9222`. 38 | 39 | **Note for Android:** The `ChromeInterface()` constructor accepts the `suppress_origin` argument which defaults to `False`. Set it to `True` to suppress the Origin Header in the created websockets. This is apparently needed in Android environments. 40 | 41 | You can connect directly to a `targetID` using the method `connect_targetID`. 42 | You must pass the `targetID` as parameter to this function. 43 | In this case, you avoid querying the json and finding the `tab id`. 44 | 45 | ## 3.1 Run commands 46 | To send a command to Chrome, just invoke the corresponding method on the ChromeInterface object, and pass the desired parameters. 47 | For example, to visit a page write: 48 | ``` 49 | return_value, messages = chrome.Page.navigate(url="http://example.com/") 50 | ``` 51 | The return value of the command is passed as return value of the function, already interpreted as JSON. 52 | In messages, there are all the messages received before. 53 | 54 | ## 3.1 Receive Events 55 | Chrome sends back messages for particular events in the browser. 56 | You can get them in three ways; they are returned already interpreted as JSON. 57 | All unread events are erased before any new command is run. 58 | 59 | a) You can pop one message from the queue of received ones writing: 60 | ``` 61 | message=chrome.wait_message() 62 | ``` 63 | The method accepts an optional parameter `timeout` which is the value in seconds after which it gives up and returns `None`. 64 | Default is 1. 65 | 66 | b) You can wait for a specific event writing: 67 | ``` 68 | matching_event,all_events=chrome.wait_event(event_name) 69 | ``` 70 | It waits until an event with the name `event_name` arrives, or a timeout elapses. 71 | `matching_event` contains the first found event that has `event_name`, while `all_events` contains all events arrived before. 72 | Timeout value can be configured as in the previous method. 73 | 74 | c) You can get all already received messages writing: 75 | ``` 76 | messages=chrome.pop_messages() 77 | ``` 78 | This method is not blocking, and, thus, no timeout is used. 79 | 80 | # 4. Examples 81 | ## 4.1 Page Loading Time 82 | ``` 83 | import PyChromeDevTools 84 | import time 85 | 86 | chrome = PyChromeDevTools.ChromeInterface() 87 | chrome.Network.enable() 88 | chrome.Page.enable() 89 | 90 | start_time=time.time() 91 | chrome.Page.navigate(url="http://www.google.com/") 92 | chrome.wait_event("Page.loadEventFired", timeout=60) 93 | end_time=time.time() 94 | 95 | print ("Page Loading Time:", end_time-start_time) 96 | ``` 97 | 98 | ## 4.2 Print all installed cookies 99 | ``` 100 | import PyChromeDevTools 101 | import time 102 | 103 | chrome = PyChromeDevTools.ChromeInterface() 104 | chrome.Network.enable() 105 | chrome.Page.enable() 106 | 107 | chrome.Page.navigate(url="http://www.nytimes.com/") 108 | chrome.wait_event("Page.frameStoppedLoading", timeout=60) 109 | 110 | #Wait last objects to load 111 | time.sleep(5) 112 | 113 | cookies,messages = chrome.Network.getCookies() 114 | for cookie in cookies["result"]["cookies"]: 115 | print ("Cookie:") 116 | print ("\tDomain:", cookie["domain"]) 117 | print ("\tKey:", cookie["name"]) 118 | print ("\tValue:", cookie["value"]) 119 | print ("\n") 120 | ``` 121 | 122 | ## 4.3 Print all object URLs of a page 123 | ``` 124 | import PyChromeDevTools 125 | 126 | chrome = PyChromeDevTools.ChromeInterface() 127 | chrome.Network.enable() 128 | chrome.Page.enable() 129 | 130 | chrome.Page.navigate(url="http://www.facebook.com") 131 | event,messages=chrome.wait_event("Page.frameStoppedLoading", timeout=60) 132 | 133 | for m in messages: 134 | if "method" in m and m["method"] == "Network.responseReceived": 135 | try: 136 | url=m["params"]["response"]["url"] 137 | print (url) 138 | except: 139 | pass 140 | ``` 141 | 142 | 143 | -------------------------------------------------------------------------------- /PyChromeDevTools/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | import json 4 | import time 5 | 6 | import requests 7 | import websocket 8 | 9 | 10 | TIMEOUT = 1 11 | 12 | 13 | class GenericElement(object): 14 | def __init__(self, name, parent): 15 | self.name = name 16 | self.parent = parent 17 | 18 | def __getattr__(self, attr): 19 | func_name = '{}.{}'.format(self.name, attr) 20 | 21 | def generic_function(**args): 22 | self.parent.pop_messages() 23 | self.parent.message_counter += 1 24 | message_id = self.parent.message_counter 25 | call_obj = {'id': message_id, 'method': func_name, 'params': args} 26 | self.parent.ws.send(json.dumps(call_obj)) 27 | result, messages = self.parent.wait_result(message_id) 28 | return result, messages 29 | return generic_function 30 | 31 | 32 | class ChromeInterface(object): 33 | message_counter = 0 34 | 35 | def __init__( 36 | self, 37 | host='localhost', 38 | port=9222, 39 | tab=0, 40 | timeout=TIMEOUT, 41 | auto_connect=True, 42 | suppress_origin=False 43 | ): 44 | self.host = host 45 | self.port = port 46 | self.ws = None 47 | self.tabs = None 48 | self.timeout = timeout 49 | self.suppress_origin = suppress_origin 50 | 51 | if auto_connect: 52 | self.connect(tab=tab) 53 | 54 | def get_tabs(self): 55 | response = requests.get(f'http://{self.host}:{self.port}/json') 56 | self.tabs = json.loads(response.text) 57 | 58 | def connect(self, tab=0, update_tabs=True): 59 | if update_tabs or self.tabs is None: 60 | self.get_tabs() 61 | wsurl = self.tabs[tab]['webSocketDebuggerUrl'] 62 | self.close() 63 | self.ws = websocket.create_connection(wsurl, suppress_origin=self.suppress_origin) 64 | self.ws.settimeout(self.timeout) 65 | 66 | def connect_targetID(self, targetID): 67 | try: 68 | wsurl = f'ws://{self.host}:{self.port}/devtools/page/{targetID}' 69 | self.close() 70 | self.ws = websocket.create_connection(wsurl, suppress_origin=self.suppress_origin) 71 | self.ws.settimeout(self.timeout) 72 | except Exception: 73 | wsurl = self.tabs[0]['webSocketDebuggerUrl'] 74 | self.ws = websocket.create_connection(wsurl, suppress_origin=self.suppress_origin) 75 | self.ws.settimeout(self.timeout) 76 | 77 | def close(self): 78 | if self.ws: 79 | self.ws.close() 80 | 81 | # Blocking 82 | def wait_message(self, timeout=None): 83 | timeout = timeout if timeout is not None else self.timeout 84 | self.ws.settimeout(timeout) 85 | try: 86 | message = self.ws.recv() 87 | except Exception: 88 | return None 89 | finally: 90 | self.ws.settimeout(self.timeout) 91 | return json.loads(message) 92 | 93 | # Blocking 94 | def wait_event(self, event, timeout=None): 95 | timeout = timeout if timeout is not None else self.timeout 96 | start_time = time.time() 97 | messages = [] 98 | matching_message = None 99 | while True: 100 | now = time.time() 101 | if now-start_time > timeout: 102 | break 103 | try: 104 | message = self.ws.recv() 105 | parsed_message = json.loads(message) 106 | messages.append(parsed_message) 107 | if ('method' in parsed_message 108 | and parsed_message['method'] == event): 109 | matching_message = parsed_message 110 | break 111 | except websocket.WebSocketTimeoutException: 112 | continue 113 | except Exception: 114 | break 115 | return matching_message, messages 116 | 117 | # Blocking 118 | def wait_result(self, result_id, timeout=None): 119 | timeout = timeout if timeout is not None else self.timeout 120 | start_time = time.time() 121 | messages = [] 122 | matching_result = None 123 | while True: 124 | now = time.time() 125 | if now-start_time > timeout: 126 | break 127 | try: 128 | message = self.ws.recv() 129 | parsed_message = json.loads(message) 130 | messages.append(parsed_message) 131 | if ('result' in parsed_message 132 | and parsed_message['id'] == result_id): 133 | matching_result = parsed_message 134 | break 135 | except websocket.WebSocketTimeoutException: 136 | continue 137 | except Exception: 138 | break 139 | return matching_result, messages 140 | 141 | # Non Blocking 142 | def pop_messages(self): 143 | messages = [] 144 | self.ws.settimeout(0) 145 | while True: 146 | try: 147 | message = self.ws.recv() 148 | messages.append(json.loads(message)) 149 | except Exception: 150 | break 151 | self.ws.settimeout(self.timeout) 152 | return messages 153 | 154 | def __getattr__(self, attr): 155 | genericelement = GenericElement(attr, self) 156 | self.__setattr__(attr, genericelement) 157 | return genericelement 158 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------