Selenium Wire はもうメンテナンスされていません。サポートとすべての貢献に感謝します。

Selenium Wire

Selenium Wire は Selenium の <https://www.selenium.dev/documentation/en/>_ Python バインディングを拡張して、ブラウザによって行われる基盤となるリクエストにアクセスできるようにします。Selenium と同じ方法でコードを記述できますが、リクエストとレスポンスを検査し、その場で変更するための追加 API を利用できます。

.. image:: https://github.com/wkeeling/selenium-wire/workflows/build/badge.svg :target: https://github.com/wkeeling/selenium-wire/actions

.. image:: https://codecov.io/gh/wkeeling/selenium-wire/branch/master/graph/badge.svg :target: https://codecov.io/gh/wkeeling/selenium-wire

.. image:: https://img.shields.io/badge/python-3.7%2C%203.8%2C%203.9%2C%203.10-blue.svg :target: https://pypi.python.org/pypi/selenium-wire

.. image:: https://img.shields.io/pypi/v/selenium-wire.svg :target: https://pypi.python.org/pypi/selenium-wire

.. image:: https://img.shields.io/pypi/l/selenium-wire.svg :target: https://pypi.python.org/pypi/selenium-wire

.. image:: https://pepy.tech/badge/selenium-wire/month :target: https://pepy.tech/project/selenium-wire

簡単な例~~~~~~~~~~~~~~

.. code:: python

from seleniumwire import webdriver  # Import from seleniumwire

# Create a new instance of the Chrome driver
driver = webdriver.Chrome()

# Go to the Google home page
driver.get('https://www.google.com')

# Access requests via the `requests` attribute
for request in driver.requests:
    if request.response:
        print(
            request.url,
            request.response.status_code,
            request.response.headers['Content-Type']
        )

Prints:

.. code:: bash

https://www.google.com/ 200 text/html; charset=UTF-8
https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_120x44dp.png 200 image/png
https://consent.google.com/status?continue=https://www.google.com&pc=s&timestamp=1531511954&gl=GB 204 text/html; charset=utf-8
https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png 200 image/png
https://ssl.gstatic.com/gb/images/i2_2ec824b0.png 200 image/png
https://www.google.com/gen_204?s=webaft&t=aft&atyp=csi&ei=kgRJW7DBONKTlwTK77wQ&rt=wsrt.366,aft.58,prt.58 204 text/html; charset=UTF-8
...

Features

* Pure Python, user-friendly API
* HTTP and HTTPS requests captured
* Intercept requests and responses
* Modify headers, parameters, body content on the fly
* Capture websocket messages
* HAR format supported
* Proxy server support

Compatibilty

• Python 3.7+
• Selenium 4.0.0+
• Chrome, Firefox, Edge and Remote Webdriver supported

Table of Contents

- `インストール`_

  * `ブラウザーのセットアップ`_

  * `OpenSSL`_

- `Webdriver の作成`_

- `リクエストへのアクセス`_

- `リクエストオブジェクト`_

- `レスポンスオブジェクト`_

- `リクエストとレスポンスのインターセプト`_

  * `例: リクエストヘッダーを追加する`_
  * `例: 既存のリクエストヘッダーを置き換える`_
  * `例: レスポンスヘッダーを追加する`_
  * `例: リクエストパラメーターを追加する`_
  * `例: POST リクエストボディの JSON を更新する`_
  * `例: 基本認証`_
  * `例: リクエストをブロックする`_
  * `例: レスポンスをモックする`_
  * `インターセプターを解除する`_

- `リクエストキャプチャーの制限`_

- `リクエストストレージ`_

  * `インメモリストレージ`_

- `プロキシ`_

  * `SOCKS`_

  * `動的な切り替え`_

- `ボット検出`_

- `証明書`_

  * `独自の証明書を使用する`_

- `すべてのオプション`_

- `ライセンス`_

インストール~~~~~~~~~~~~

Install using pip:

.. code:: bash

    pip install selenium-wire

If you get an error about not being able to build cryptography you may be running an old version of pip. Try upgrading pip with ``python -m pip install --upgrade pip`` and then re-run the above command.

Browser Setup
-------------

No specific configuration should be necessary except to ensure that you have downloaded the relevent webdriver executable for your browser and placed it somewhere on your system PATH.

- `Download <https://sites.google.com/chromium.org/driver/>`__ webdriver for Chrome
- `Download <https://github.com/mozilla/geckodriver/>`__ webdriver for Firefox
- `Download <https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/>`__ webdriver for Edge

OpenSSL
-------

Selenium Wire requires OpenSSL for decrypting HTTPS requests. This is probably already installed on your system (you can check by running ``openssl version`` on the command line). If it's not installed you can install it with:

**Linux**

.. code:: bash

    # For apt based Linux systems
    sudo apt install openssl

    # For RPM based Linux systems
    sudo yum install openssl

    # For Linux alpine
    sudo apk add openssl

**MacOS**

.. code:: bash

    brew install openssl

**Windows**

No installation is required.

Creating the Webdriver

Ensure that you import webdriver from the seleniumwire package:

.. code:: python

from seleniumwire import webdriver

Then just instantiate the webdriver as you would if you were using Selenium directly. You can pass in any desired capabilities or browser specific options - such as the executable path, headless mode etc. Selenium Wire also has it's own options_ that can be passed in the seleniumwire_options attribute.

.. code:: python

# Create the driver with no options (use defaults)
driver = webdriver.Chrome()

# Or create using browser specific options and/or seleniumwire_options options
driver = webdriver.Chrome(
    options = webdriver.ChromeOptions(...),
    seleniumwire_options={...}
)

.. _own options: #all-options

Note that for sub-packages of webdriver, you should continue to import these directly from selenium. For example, to import WebDriverWait:

.. code:: python

# Sub-packages of webdriver must still be imported from `selenium` itself
from selenium.webdriver.support.ui import WebDriverWait

リモート Webdriver

Selenium Wire は、リモート webdriver クライアントの使用を限定的にサポートしています。リモート webdriver のインスタンスを作成するときは、Selenium Wire を実行しているマシン（またはコンテナ）のホスト名または IP アドレスを指定する必要があります。これにより、リモートインスタンスはリクエストとレスポンスを Selenium Wire に返信できます。

.. code:: python

options = {
    'addr': 'hostname_or_ip'  # Address of the machine running Selenium Wire. Explicitly use 127.0.0.1 rather than localhost if remote session is running locally.
}
driver = webdriver.Remote(
    command_executor='http://www.example.com',
    seleniumwire_options=options
)

ブラウザを実行しているマシンが Selenium Wire を実行しているマシンと通信するために別のアドレスを使用する必要がある場合は、ブラウザを手動で設定する必要があります。この issue <https://github.com/wkeeling/selenium-wire/issues/220>_ に詳細が記載されています。

リクエストへのアクセス~~~~~~~~~~~~~~~~~~

Selenium Wire captures all HTTP/HTTPS traffic made by the browser [1]_. The following attributes provide access to requests and responses.

driver.requests The list of captured requests in chronological order.

driver.last_request Convenience attribute for retrieving the most recently captured request. This is more efficient than using driver.requests[-1].

driver.wait_for_request(pat, timeout=10) This method will wait until it sees a request matching a pattern. The pat attribute will be matched within the request URL. pat can be a simple substring or a regular expression. Note that driver.wait_for_request() doesn't make a request, it just waits for a previous request made by some other action and it will return the first request it finds. Also note that since pat can be a regular expression, you must escape special characters such as question marks with a slash. A TimeoutException is raised if no match is found within the timeout period.

For example, to wait for an AJAX request to return after a button is clicked:

.. code:: python

    # Click a button that triggers a background request to https://server/api/products/12345/
    button_element.click()

    # Wait for the request/response to complete
    request = driver.wait_for_request('/api/products/12345/')

driver.har A JSON formatted HAR archive of HTTP transactions that have taken place. HAR capture is turned off by default and you must set the enable_har option_ to True before using driver.har.