BrowserType
BrowserType は、特定のブラウザインスタンスを起動したり、既存のブラウザインスタンスに接続したりするためのメソッドを提供します。以下は、Playwright を使用して自動化を駆動する典型的な例です。
- 同期
- 非同期
from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
chromium = playwright.chromium
browser = chromium.launch()
page = browser.new_page()
page.goto("https://example.com")
# other actions...
browser.close()
with sync_playwright() as playwright:
run(playwright)
import asyncio
from playwright.async_api import async_playwright, Playwright
async def run(playwright: Playwright):
chromium = playwright.chromium
browser = await chromium.launch()
page = await browser.new_page()
await page.goto("https://example.com")
# other actions...
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
メソッド
connect
v1.9 より前に追加このメソッドは、Node.js の BrowserType.launchServer
を介して作成された既存のブラウザインスタンスに Playwright をアタッチします。
接続する Playwright インスタンスのメジャーバージョンとマイナーバージョンは、ブラウザを起動する Playwright のバージョンと一致する必要があります (1.2.3 → 1.2.x と互換性があります)。
使用方法
browser_type.connect(ws_endpoint)
browser_type.connect(ws_endpoint, **kwargs)
引数
-
接続先の Playwright ブラウザの WebSocket エンドポイント。このエンドポイントは、
BrowserServer.wsEndpoint
を介して取得します。 -
expose_network
str (オプション)v1.37 で追加#このオプションは、接続元のクライアントで利用可能なネットワークを、接続先のブラウザに公開します。カンマ区切りのルールリストで構成されます。
利用可能なルール
- ホスト名パターン。例:
example.com
、*.org:99
、x.*.y.com
、*foo.org
。 - IP リテラル。例:
127.0.0.1
、0.0.0.0:99
、[::1]
、[0:0::1]:99
。 <loopback>
。ローカルループバックインターフェース (localhost
、*.localhost
、127.0.0.1
、[::1]
) に一致します。
一般的な例
"*"
。すべてのネットワークを公開します。"<loopback>"
。localhost ネットワークを公開します。"*.test.internal-domain,*.staging.internal-domain,<loopback>"
。テスト/ステージング環境と localhost を公開します。
- ホスト名パターン。例:
-
headers
Dict[str, str] (オプション)v1.11 で追加#WebSocket 接続リクエストとともに送信される追加の HTTP ヘッダー。オプション。
-
slow_mo
float (オプション)v1.10 で追加#Playwright の操作を指定されたミリ秒数だけ遅くします。何が起こっているかを確認するのに役立ちます。デフォルトは 0 です。
-
timeout
float (オプション)v1.10 で追加#接続が確立されるまで待機する最大時間 (ミリ秒単位)。デフォルトは
0
(タイムアウトなし) です。
戻り値
connect_over_cdp
v1.9 で追加このメソッドは、Chrome DevTools Protocol を使用して、既存のブラウザインスタンスに Playwright をアタッチします。
デフォルトのブラウザコンテキストは、browser.contexts を介してアクセスできます。
Chrome DevTools Protocol 経由での接続は、Chromium ベースのブラウザでのみサポートされています。
この接続は、browser_type.connect() を介した Playwright プロトコル接続よりも忠実度が大幅に低くなります。問題が発生した場合、または高度な機能を使用しようとする場合は、browser_type.connect() を使用することをお勧めします。
使用方法
- 同期
- 非同期
browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
default_context = browser.contexts[0]
page = default_context.pages[0]
browser = await playwright.chromium.connect_over_cdp("http://localhost:9222")
default_context = browser.contexts[0]
page = default_context.pages[0]
引数
-
接続先の CDP WebSocket エンドポイントまたは HTTP URL。例:
http://localhost:9222/
またはws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4
。 -
headers
Dict[str, str] (オプション)v1.11 で追加#接続リクエストとともに送信される追加の HTTP ヘッダー。オプション。
-
slow_mo
float (オプション)v1.11 で追加#Playwright の操作を指定されたミリ秒数だけ遅くします。何が起こっているかを確認するのに役立ちます。デフォルトは 0 です。
-
timeout
float (オプション)v1.11 で追加#接続が確立されるまで待機する最大時間 (ミリ秒単位)。デフォルトは
30000
(30 秒) です。0
を渡すとタイムアウトが無効になります。
戻り値
launch
v1.9 より前に追加ブラウザインスタンスを返します。
使用方法
ignore_default_args を使用して、デフォルト引数から `--mute-audio` を除外できます。
- 同期
- 非同期
browser = playwright.chromium.launch( # or "firefox" or "webkit".
ignore_default_args=["--mute-audio"]
)
browser = await playwright.chromium.launch( # or "firefox" or "webkit".
ignore_default_args=["--mute-audio"]
)
Chromium のみ Playwright は、Google Chrome または Microsoft Edge ブラウザを制御するためにも使用できますが、バンドルされている Chromium のバージョンで最適に動作します。他のバージョンで動作することは保証されていません。executable_path オプションは、細心の注意を払って使用してください。
Google Chrome (Chromium ではなく) が推奨される場合は、Chrome Canary または Dev Channel ビルドが推奨されます。
Google Chrome や Microsoft Edge などの標準ブラウザは、ビデオ再生に独自のメディアコーデックを必要とするテストに適しています。Chromium と Chrome のその他の違いについては、この記事 を参照してください。Linux ユーザー向けの違いについては、この記事 で説明しています。
引数
-
警告
カスタムブラウザ引数は、Playwright の機能を損なう可能性があるため、自己責任で使用してください。
ブラウザインスタンスに渡す追加の引数。Chromium フラグのリストは こちら にあります。
-
ブラウザの配布チャネル。
新しいヘッドレスモードを選択するには、"chromium" を使用してください (新しいヘッドレスモードにオプトイン)。
ブランド版 Google Chrome および Microsoft Edge を使用するには、"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、または "msedge-canary" を使用してください。
-
chromium_sandbox
bool (オプション)#Chromium サンドボックスを有効にします。デフォルトは
false
です。 -
非推奨
代わりに デバッグツール を使用してください。
Chromium のみ 各タブに対して Developer Tools パネルを自動的に開くかどうか。このオプションが
true
の場合、headless オプションはfalse
に設定されます。 -
downloads_path
Union[str, pathlib.Path] (オプション)#指定された場合、承認されたダウンロードはこのディレクトリにダウンロードされます。それ以外の場合は、一時ディレクトリが作成され、ブラウザが閉じられるときに削除されます。いずれの場合も、ダウンロードは、作成されたブラウザコンテキストが閉じられると削除されます。
-
env
Dict[str, str | float | bool] (オプション)#ブラウザに表示される環境変数を指定します。デフォルトは
process.env
です。 -
executable_path
Union[str, pathlib.Path] (オプション)#バンドルされているブラウザの代わりに実行するブラウザ実行可能ファイルへのパス。executable_path が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。Playwright はバンドルされた Chromium、Firefox、または WebKit でのみ動作することに注意してください。自己責任で使用してください。
-
firefox_user_prefs
Dict[str, str | float | bool] (オプション)#Firefox ユーザー設定。Firefox ユーザー設定の詳細については、
about:config
を参照してください。 -
SIGHUP でブラウザプロセスを閉じます。デフォルトは
true
です。 -
Ctrl-C でブラウザプロセスを閉じます。デフォルトは
true
です。 -
SIGTERM でブラウザプロセスを閉じます。デフォルトは
true
です。 -
ブラウザをヘッドレスモードで実行するかどうか。Chromium および Firefox の詳細。デフォルトは
true
です。ただし、devtools オプションがtrue
の場合は `false` になります。 -
ignore_default_args
bool | List[str] (オプション)#true
の場合、Playwright は独自の設定引数を渡さず、args からの引数のみを使用します。配列が指定された場合は、指定されたデフォルト引数を除外します。危険なオプションです。注意して使用してください。デフォルトはfalse
です。 -
-
server
strすべてのリクエストに使用されるプロキシ。HTTP および SOCKS プロキシがサポートされています。例:
http://myproxy.com:3128
またはsocks5://myproxy.com:3128
。短縮形myproxy.com:3128
は HTTP プロキシと見なされます。 -
bypass
str (オプション)プロキシをバイパスするオプションのカンマ区切りドメイン。例:
".com, chromium.org, .domain.com"
。 -
username
str (オプション)HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。
-
password
str (オプション)HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。
ネットワークプロキシの設定。
-
-
Playwright の操作を指定されたミリ秒数だけ遅くします。何が起こっているかを確認するのに役立ちます。
-
ブラウザインスタンスが起動するまで待機する最大時間 (ミリ秒単位)。デフォルトは
30000
(30 秒) です。0
を渡すとタイムアウトが無効になります。 -
traces_dir
Union[str, pathlib.Path] (オプション)#指定された場合、トレースはこのディレクトリに保存されます。
戻り値
launch_persistent_context
v1.9 より前に追加永続的なブラウザコンテキストインスタンスを返します。
user_data_dir にある永続ストレージを使用するブラウザを起動し、唯一のコンテキストを返します。このコンテキストを閉じると、ブラウザが自動的に閉じられます。
使用方法
browser_type.launch_persistent_context(user_data_dir)
browser_type.launch_persistent_context(user_data_dir, **kwargs)
引数
-
user_data_dir
Union[str, pathlib.Path]#Cookie やローカルストレージなどのブラウザセッションデータを保存するユーザーデータディレクトリへのパス。Chromium および Firefox の詳細。Chromium のユーザーデータディレクトリは、
chrome://version
に表示される「プロファイルパス」の親ディレクトリであることに注意してください。一時ディレクトリを使用するには、空の文字列を渡します。 -
accept_downloads
bool (オプション)#すべてのアタッチメントを自動的にダウンロードするかどうか。デフォルトは
true
で、すべてのダウンロードが承認されます。 -
警告
カスタムブラウザ引数は、Playwright の機能を損なう可能性があるため、自己責任で使用してください。
ブラウザインスタンスに渡す追加の引数。Chromium フラグのリストは こちら にあります。
-
page.goto()、page.route()、page.wait_for_url()、page.expect_request()、または page.expect_response() を使用する場合、対応する URL を構築するために `URL()` コンストラクターを使用することで、ベース URL が考慮されます。デフォルトでは設定されていません。例:
- baseURL:
http://localhost:3000
で `/bar.html` に移動すると、`http://localhost:3000/bar.html` になります。 - baseURL:
http://localhost:3000/foo/
で `./bar.html` に移動すると、`http://localhost:3000/foo/bar.html` になります。 - baseURL:
http://localhost:3000/foo
(末尾のスラッシュなし) で `./bar.html` に移動すると、`http://localhost:3000/bar.html` になります。
- baseURL:
-
ページの Content-Security-Policy のバイパスを切り替えます。デフォルトは
false
です。 -
ブラウザの配布チャネル。
新しいヘッドレスモードを選択するには、"chromium" を使用してください (新しいヘッドレスモードにオプトイン)。
ブランド版 Google Chrome および Microsoft Edge を使用するには、"chrome"、"chrome-beta"、"chrome-dev"、"chrome-canary"、"msedge"、"msedge-beta"、"msedge-dev"、または "msedge-canary" を使用してください。
-
chromium_sandbox
bool (オプション)#Chromium サンドボックスを有効にします。デフォルトは
false
です。 -
client_certificates
List[Dict] (オプション)v1.46 で追加#-
origin
str証明書が有効な正確なオリジン。オリジンには、
https
プロトコル、ホスト名、およびオプションでポートが含まれます。 -
certPath
Union[str, pathlib.Path] (オプション)PEM 形式の証明書を含むファイルへのパス。
-
cert
bytes (オプション)PEM 形式の証明書の直接の値。
-
keyPath
Union[str, pathlib.Path] (オプション)PEM 形式の秘密鍵を含むファイルへのパス。
-
key
bytes (オプション)PEM 形式の秘密鍵の直接の値。
-
pfxPath
Union[str, pathlib.Path] (オプション)PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンへのパス。
-
pfx
bytes (オプション)PFX または PKCS12 エンコードされた秘密鍵と証明書チェーンの直接の値。
-
passphrase
str (オプション)秘密鍵 (PEM または PFX) のパスフレーズ。
TLS クライアント認証により、サーバーはクライアント証明書を要求して検証できます。
詳細
使用するクライアント証明書の配列。各証明書オブジェクトは、
certPath
とkeyPath
の両方、単一のpfxPath
、または対応する直接の値の同等物 (`cert` と `key`、または `pfx`) のいずれかを持っている必要があります。オプションで、証明書が暗号化されている場合は、passphrase
プロパティを提供する必要があります。origin
プロパティは、証明書が有効なリクエストオリジンと正確に一致するように提供する必要があります。注macOS で WebKit を使用する場合、
localhost
にアクセスしてもクライアント証明書は取得されません。localhost
をlocal.playwright
に置き換えることで動作させることができます。 -
-
color_scheme
"light" | "dark" | "no-preference" | "null" (オプション)#prefers-colors-scheme メディア機能をエミュレートします。サポートされている値は
'light'
と'dark'
です。詳細については、page.emulate_media() を参照してください。'null'
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'light'
です。 -
contrast
"no-preference" | "more" | "null" (オプション)#'prefers-contrast'
メディア機能をエミュレートします。サポートされている値は'no-preference'
、'more'
です。詳細については、page.emulate_media() を参照してください。'null'
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
device_scale_factor
float (オプション)#デバイススケールファクター (dpr と考えることができます) を指定します。デフォルトは
1
です。デバイススケールファクターを使用した デバイスのエミュレーション の詳細をご覧ください。 -
非推奨
代わりに デバッグツール を使用してください。
Chromium のみ 各タブに対して Developer Tools パネルを自動的に開くかどうか。このオプションが
true
の場合、headless オプションはfalse
に設定されます。 -
downloads_path
Union[str, pathlib.Path] (オプション)#指定された場合、承認されたダウンロードはこのディレクトリにダウンロードされます。それ以外の場合は、一時ディレクトリが作成され、ブラウザが閉じられるときに削除されます。いずれの場合も、ダウンロードは、作成されたブラウザコンテキストが閉じられると削除されます。
-
env
Dict[str, str | float | bool] (オプション)#ブラウザに表示される環境変数を指定します。デフォルトは
process.env
です。 -
executable_path
Union[str, pathlib.Path] (オプション)#バンドルされているブラウザの代わりに実行するブラウザ実行可能ファイルへのパス。 executable_path が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。Playwright はバンドルされている Chromium、Firefox、または WebKit でのみ動作することに注意してください。自己責任で使用してください。
-
extra_http_headers
Dict[str, str] (オプション)#すべてのリクエストとともに送信される追加の HTTP ヘッダーを含むオブジェクト。デフォルトは none です。
-
firefox_user_prefs
Dict[str, str | float | bool] (オプション)追加: v1.40#Firefox ユーザー設定。Firefox ユーザー設定の詳細については、
about:config
を参照してください。 -
forced_colors
"active" | "none" | "null" (オプション)#'forced-colors'
メディア機能をエミュレートします。サポートされている値は'active'
、'none'
です。詳細については、page.emulate_media() を参照してください。'null'
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'none'
です。 -
SIGHUP でブラウザプロセスを閉じます。デフォルトは
true
です。 -
Ctrl-C でブラウザプロセスを閉じます。デフォルトは
true
です。 -
SIGTERM でブラウザプロセスを閉じます。デフォルトは
true
です。 -
ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは false です。モバイルエミュレーションの詳細をご覧ください。
-
ブラウザをヘッドレスモードで実行するかどうか。Chromium および Firefox の詳細。デフォルトは
true
です。ただし、devtools オプションがtrue
の場合は `false` になります。 -
http_credentials
Dict (オプション)#-
username
str -
password
str -
origin
str (オプション)特定のオリジン (scheme://host:port).
-
send
"unauthorized" | "always" (オプション)このオプションは、対応する APIRequestContext から送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。
'always'
- 基本認証クレデンシャルを含むAuthorization
ヘッダーが各 API リクエストとともに送信されます。'unauthorized'
- クレデンシャルは、WWW-Authenticate
ヘッダーを含む 401 (Unauthorized) レスポンスを受信した場合にのみ送信されます。デフォルトは'unauthorized'
です。
HTTP 認証のクレデンシャル。オリジンが指定されていない場合、ユーザー名とパスワードは、認証されていないレスポンスに応じて任意のサーバーに送信されます。
-
-
ignore_default_args
bool | List[str] (オプション)#true
の場合、Playwright は独自の設定引数を渡さず、args の引数のみを使用します。配列が指定された場合、指定されたデフォルト引数をフィルタリングします。危険なオプションです。注意して使用してください。デフォルトはfalse
です。 -
ignore_https_errors
bool (オプション)#ネットワークリクエストを送信するときに HTTPS エラーを無視するかどうか。デフォルトは
false
です。 -
meta viewport
タグが考慮され、タッチイベントが有効になっているかどうか。isMobile はデバイスの一部であるため、手動で設定する必要はありません。デフォルトはfalse
であり、Firefox ではサポートされていません。モバイルエミュレーションの詳細をご覧ください。 -
java_script_enabled
bool (オプション)#コンテキストで JavaScript を有効にするかどうか。デフォルトは
true
です。JavaScript の無効化の詳細をご覧ください。 -
ユーザーロケールを指定します (例:
en-GB
、de-DE
など)。ロケールは、navigator.language
値、Accept-Language
リクエストヘッダー値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションガイドのエミュレーションの詳細をご覧ください。 -
固定ビューポートを強制せず、ヘッドレスモードでウィンドウのサイズ変更を許可します。
-
ネットワークをオフラインにするかどうかをエミュレートします。デフォルトは
false
です。ネットワークエミュレーションの詳細をご覧ください。 -
permissions
List[str] (オプション)#このコンテキストのすべてのページに付与する権限のリスト。詳細については、browser_context.grant_permissions() を参照してください。デフォルトは none です。
-
-
server
strすべてのリクエストに使用されるプロキシ。HTTP および SOCKS プロキシがサポートされています。例:
http://myproxy.com:3128
またはsocks5://myproxy.com:3128
。短縮形myproxy.com:3128
は HTTP プロキシと見なされます。 -
bypass
str (オプション)プロキシをバイパスするオプションのカンマ区切りドメイン。例:
".com, chromium.org, .domain.com"
。 -
username
str (オプション)HTTP プロキシが認証を必要とする場合に使用するオプションのユーザー名。
-
password
str (オプション)HTTP プロキシが認証を必要とする場合に使用するオプションのパスワード。
ネットワークプロキシの設定。
-
-
record_har_content
"omit" | "embed" | "attach" (オプション)#リソースコンテンツの管理を制御するためのオプション設定。
omit
が指定されている場合、コンテンツは永続化されません。attach
が指定されている場合、リソースは個別のファイルとして永続化され、これらのファイルはすべて HAR ファイルとともにアーカイブされます。デフォルトはembed
であり、HAR 仕様に従ってコンテンツを HAR ファイルにインラインで格納します。 -
record_har_mode
"full" | "minimal" (オプション)#minimal
に設定すると、HAR からのルーティングに必要な情報のみが記録されます。これにより、HAR から再生するときに使用されないサイズ、タイミング、ページ、Cookie、セキュリティ、およびその他の種類の HAR 情報が省略されます。デフォルトはfull
です。 -
record_har_omit_content
bool (オプション)#HAR からリクエストコンテンツを省略するかどうかを制御するためのオプション設定。デフォルトは
false
です。 -
record_har_path
Union[str, pathlib.Path] (オプション)#ファイルシステム上の指定された HAR ファイルにすべてのページの HAR 記録を有効にします。指定しない場合、HAR は記録されません。HAR を保存するには、必ず browser_context.close() を呼び出してください。
-
record_video_dir
Union[str, pathlib.Path] (オプション)#指定されたディレクトリにすべてのページのビデオ録画を有効にします。指定しない場合、ビデオは記録されません。ビデオを保存するには、必ず browser_context.close() を呼び出してください。
-
record_video_size
Dict (オプション)#録画されたビデオの寸法。指定しない場合、サイズは 800x800 に収まるように縮小された
viewport
と同じになります。viewport
が明示的に設定されていない場合、ビデオサイズはデフォルトで 800x450 になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。 -
reduced_motion
"reduce" | "no-preference" | "null" (オプション)#'prefers-reduced-motion'
メディア機能をエミュレートします。サポートされている値は'reduce'
、'no-preference'
です。詳細については、page.emulate_media() を参照してください。'null'
を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
window.screen
を介して Web ページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。viewport が設定されている場合にのみ使用されます。 -
service_workers
"allow" | "block" (オプション)#サイトが Service Worker を登録できるようにするかどうか。デフォルトは
'allow'
です。'allow'
: Service Worker を登録できます。'block'
: Playwright は Service Worker のすべての登録をブロックします。
-
Playwright の操作を指定されたミリ秒数だけ遅くします。何が起こっているかを確認するのに役立ちます。
-
strict_selectors
bool (オプション)#true に設定すると、このコンテキストで厳密なセレクターモードが有効になります。厳密なセレクターモードでは、単一のターゲット DOM 要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合にスローされます。このオプションは、Locator API には影響しません (Locator は常に厳密です)。デフォルトは
false
です。厳密モードの詳細については、Locator を参照してください。 -
ブラウザインスタンスが起動するまで待機する最大時間 (ミリ秒単位)。デフォルトは
30000
(30 秒) です。0
を渡すとタイムアウトが無効になります。 -
コンテキストのタイムゾーンを変更します。サポートされているタイムゾーン ID のリストについては、ICU's metaZones.txt を参照してください。デフォルトはシステムのタイムゾーンです。
-
traces_dir
Union[str, pathlib.Path] (オプション)#指定された場合、トレースはこのディレクトリに保存されます。
-
このコンテキストで使用する特定のユーザーエージェント。
-
viewport
NoneType | Dict (オプション)#各ページに一貫したビューポートを設定します。デフォルトは 1280x720 ビューポートです。
no_viewport
は固定ビューポートを無効にします。ビューポートエミュレーションの詳細をご覧ください。
戻り値
プロパティ
executable_path
v1.9 より前に追加Playwright がバンドルされたブラウザ実行可能ファイルを見つけることを期待するパス。
使用方法
browser_type.executable_path
戻り値
name
v1.9 より前に追加ブラウザ名を返します。例: 'chromium'
、'webkit'
、または 'firefox'
。
使用方法
browser_type.name
戻り値