Browser

browser_type.launch(). Browser を使用して Page を作成する例

Sync
Async

from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
    firefox = playwright.firefox
    browser = firefox.launch()
    page = browser.new_page()
    page.goto("https://example.com")
    browser.close()

with sync_playwright() as playwright:
    run(playwright)

import asyncio
from playwright.async_api import async_playwright, Playwright

async def run(playwright: Playwright):
    firefox = playwright.firefox
    browser = await firefox.launch()
    page = await browser.new_page()
    await page.goto("https://example.com")
    await browser.close()

async def main():
    async with async_playwright() as playwright:
        await run(playwright)
asyncio.run(main())

メソッド

close

v1.9より前に追加

browser.close

browser_type.launch() を使用してこのブラウザを取得した場合、ブラウザとそのすべてのページ（もしあれば）を閉じます。

このブラウザが接続されている場合、このブラウザに属する作成されたすべてのコンテキストをクリアし、ブラウザサーバーから切断します。

注意

これはブラウザを強制終了するのと似ています。ページを正常に閉じ、ページクローズイベントを確実に受信するには、browser_context.close() を、以前に browser.new_context() を使用して明示的に作成したすべての BrowserContext インスタンスに対して、browser.close() を呼び出す前に呼び出してください。

Browser オブジェクト自体は破棄されたとみなされ、もう使用できません。

使用方法

browser.close()
browser.close(**kwargs)

引数

reason str (オプション)追加バージョン: v1.40#

ブラウザの終了によって中断された操作に報告される理由。

戻り値

NoneType #

new_browser_cdp_session

追加バージョン: v1.11

browser.new_browser_cdp_session

注意

CDPセッションは、Chromiumベースのブラウザでのみサポートされています。

新しく作成されたブラウザセッションを返します。

使用方法

browser.new_browser_cdp_session()

戻り値

CDPSession #

new_context

v1.9より前に追加

browser.new_context

新しいブラウザコンテキストを作成します。他のブラウザコンテキストとCookie/キャッシュを共有しません。

注意

BrowserContext を作成するためにこのメソッドを直接使用する場合、コードが BrowserContext で完了したら、また browser.close() を呼び出す前に、browser_context.close() を介して返されたコンテキストを明示的に閉じることが推奨されます。これにより、context が正常に閉じられ、HARやビデオなどのアーティファクトが完全にフラッシュおよび保存されることが保証されます。

使用方法

Sync
Async

browser = playwright.firefox.launch() # or "chromium" or "webkit".
# create a new incognito browser context.
context = browser.new_context()
# create a new page in a pristine context.
page = context.new_page()
page.goto("https://example.com")

# gracefully close up everything
context.close()
browser.close()

browser = await playwright.firefox.launch() # or "chromium" or "webkit".
# create a new incognito browser context.
context = await browser.new_context()
# create a new page in a pristine context.
page = await context.new_page()
await page.goto("https://example.com")

# gracefully close up everything
await context.close()
await browser.close()

引数

accept_downloads bool (オプション)#

すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトは true で、すべてのダウンロードが受け入れられます。
base_url str (オプション)#

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 になります。
bypass_csp bool (オプション)#

ページのContent-Security-Policyのバイパスを切り替えます。デフォルトは false です。
client_certificates List[Dict] (オプション)追加バージョン: 1.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 です。デバイススケールファクターを使用したデバイスのエミュレートの詳細をご覧ください。
extra_http_headers Dict[str, str] (オプション)#

すべてのリクエストとともに送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。
forced_colors "active" | "none" | "null" (オプション)#

'forced-colors' メディア機能をエミュレートします。サポートされている値は 'active'、'none' です。詳細については、page.emulate_media() を参照してください。'null' を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'none' です。
geolocation Dict (オプション)#
- latitude float
  
  緯度（-90〜90）。
- longitude float
  
  経度（-180〜180）。
- accuracy float (オプション)
  
  負でない精度値。デフォルトは 0 です。
has_touch bool (オプション)#

ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは 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_https_errors bool (オプション)#

ネットワークリクエストの送信時にHTTPSエラーを無視するかどうか。デフォルトは false です。
is_mobile bool (オプション)#

meta viewport タグが考慮され、タッチイベントが有効になっているかどうか。isMobile はデバイスの一部であるため、手動で設定する必要はありません。デフォルトは false であり、Firefoxではサポートされていません。モバイルエミュレーションの詳細をご覧ください。
java_script_enabled bool (オプション)#

コンテキストでJavaScriptを有効にするかどうか。デフォルトは true です。JavaScriptの無効化の詳細をご覧ください。
locale str (オプション)#

ユーザーロケール（例：en-GB、de-DEなど）を指定します。ロケールは、navigator.language 値、Accept-Language リクエストヘッダー値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションガイドでエミュレーションの詳細をご覧ください。
no_viewport bool (オプション)#

固定ビューポートを適用せず、ヘッドレスモードでウィンドウのサイズ変更を許可します。
offline bool (オプション)#

ネットワークがオフラインになっている状態をエミュレートするかどうか。デフォルトは false です。ネットワークエミュレーションの詳細をご覧ください。
permissions List[str] (オプション)#

このコンテキストのすべてのページに付与する権限のリスト。詳細については、browser_context.grant_permissions() を参照してください。デフォルトはなし。
proxy Dict (オプション)#
- 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_har_url_filter str | Pattern (オプション)#
record_video_dir Union[str, pathlib.Path] (オプション)#

指定されたディレクトリにすべてのページのビデオ録画を有効にします。指定しない場合、ビデオは記録されません。ビデオを保存するには、必ず browser_context.close() を呼び出してください。
record_video_size Dict (オプション)#
- width int
  
  ビデオフレームの幅。
- height int
  
  ビデオフレームの高さ。
録画されたビデオの寸法。指定しない場合、サイズは viewport と同じになり、800x800に収まるように縮小されます。viewport が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。
reduced_motion "reduce" | "no-preference" | "null" (オプション)#

'prefers-reduced-motion' メディア機能をエミュレートします。サポートされている値は 'reduce'、'no-preference' です。詳細については、page.emulate_media() を参照してください。'null' を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'no-preference' です。
screen Dict (オプション)#
- width int
  
  ページの幅（ピクセル単位）。
- height int
  
  ページの高さ（ピクセル単位）。
window.screen を介してWebページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。viewport が設定されている場合にのみ使用されます。
service_workers "allow" | "block" (オプション)#

サイトがService Workerを登録できるようにするかどうか。デフォルトは 'allow' です。
- 'allow': Service Worker を登録できます。
- 'block': PlaywrightはService Workerのすべての登録をブロックします。
storage_state Union[str, pathlib.Path] | Dict (オプション)#
- cookies List[Dict]
  - name str
  - value str
  - domain str
    
    ドメインとパスは必須です。Cookieをすべてのサブドメインにも適用するには、ドメインの前にドットを付けます（例：".example.com"）。
  - path str
    
    ドメインとパスは必須
  - expires float
    
    Unix時間（秒単位）。
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
    
    sameSiteフラグ
  コンテキストに設定するCookie
- origins List[Dict]
  - origin str
  - localStorage List[Dict]
    - name str
    - value str
    コンテキストに設定するlocalStorage
ストレージ状態と認証の詳細をご覧ください。

指定されたストレージ状態でコンテキストを設定します。このオプションは、browser_context.storage_state() を介して取得したログイン情報でコンテキストを初期化するために使用できます。
strict_selectors bool (オプション)#

trueに設定すると、このコンテキストの厳密なセレクターモードを有効にします。厳密なセレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションは、Locator APIには影響しません（Locatorは常に厳密です）。デフォルトは false です。厳密モードの詳細については、Locator を参照してください。
timezone_id str (オプション)#

コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txt を参照してください。デフォルトはシステムのタイムゾーンです。
user_agent str (オプション)#

このコンテキストで使用する特定のユーザーエージェント。
viewport NoneType | Dict (オプション)#
- width int
  
  ページの幅（ピクセル単位）。
- height int
  
  ページの高さ（ピクセル単位）。
各ページに一貫したビューポートを設定します。デフォルトは1280x720ビューポートです。no_viewport は固定ビューポートを無効にします。ビューポートエミュレーションの詳細をご覧ください。

戻り値

BrowserContext #

new_page

v1.9より前に追加

browser.new_page

新しいブラウザコンテキストに新しいページを作成します。このページを閉じると、コンテキストも閉じられます。

これは、シングルページシナリオや短いスニペットでのみ使用する必要がある便利なAPIです。本番コードおよびテストフレームワークでは、browser.new_context() の後に browser_context.new_page() を明示的に作成して、正確なライフタイムを制御する必要があります。

使用方法

browser.new_page()
browser.new_page(**kwargs)

引数

accept_downloads bool (オプション)#

すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトは true で、すべてのダウンロードが受け入れられます。
base_url str (オプション)#

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 になります。
bypass_csp bool (オプション)#

ページのContent-Security-Policyのバイパスを切り替えます。デフォルトは false です。
client_certificates List[Dict] (オプション)追加バージョン: 1.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 です。デバイススケールファクターを使用したデバイスのエミュレートの詳細をご覧ください。
extra_http_headers Dict[str, str] (オプション)#

すべてのリクエストとともに送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。
forced_colors "active" | "none" | "null" (オプション)#

'forced-colors' メディア機能をエミュレートします。サポートされている値は 'active'、'none' です。詳細については、page.emulate_media() を参照してください。'null' を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'none' です。
geolocation Dict (オプション)#
- latitude float
  
  緯度（-90〜90）。
- longitude float
  
  経度（-180〜180）。
- accuracy float (オプション)
  
  負でない精度値。デフォルトは 0 です。
has_touch bool (オプション)#

ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは 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_https_errors bool (オプション)#

ネットワークリクエストの送信時にHTTPSエラーを無視するかどうか。デフォルトは false です。
is_mobile bool (オプション)#

meta viewport タグが考慮され、タッチイベントが有効になっているかどうか。isMobile はデバイスの一部であるため、手動で設定する必要はありません。デフォルトは false であり、Firefoxではサポートされていません。モバイルエミュレーションの詳細をご覧ください。
java_script_enabled bool (オプション)#

コンテキストでJavaScriptを有効にするかどうか。デフォルトは true です。JavaScriptの無効化の詳細をご覧ください。
locale str (オプション)#

ユーザーロケール（例：en-GB、de-DEなど）を指定します。ロケールは、navigator.language 値、Accept-Language リクエストヘッダー値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションガイドでエミュレーションの詳細をご覧ください。
no_viewport bool (オプション)#

固定ビューポートを適用せず、ヘッドレスモードでウィンドウのサイズ変更を許可します。
offline bool (オプション)#

ネットワークがオフラインになっている状態をエミュレートするかどうか。デフォルトは false です。ネットワークエミュレーションの詳細をご覧ください。
permissions List[str] (オプション)#

このコンテキストのすべてのページに付与する権限のリスト。詳細については、browser_context.grant_permissions() を参照してください。デフォルトはなし。
proxy Dict (オプション)#
- 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_har_url_filter str | Pattern (オプション)#
record_video_dir Union[str, pathlib.Path] (オプション)#

指定されたディレクトリにすべてのページのビデオ録画を有効にします。指定しない場合、ビデオは記録されません。ビデオを保存するには、必ず browser_context.close() を呼び出してください。
record_video_size Dict (オプション)#
- width int
  
  ビデオフレームの幅。
- height int
  
  ビデオフレームの高さ。
録画されたビデオの寸法。指定しない場合、サイズは viewport と同じになり、800x800に収まるように縮小されます。viewport が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。
reduced_motion "reduce" | "no-preference" | "null" (オプション)#

'prefers-reduced-motion' メディア機能をエミュレートします。サポートされている値は 'reduce'、'no-preference' です。詳細については、page.emulate_media() を参照してください。'null' を渡すと、エミュレーションがシステムデフォルトにリセットされます。デフォルトは 'no-preference' です。
screen Dict (オプション)#
- width int
  
  ページの幅（ピクセル単位）。
- height int
  
  ページの高さ（ピクセル単位）。
ウェブページ内で window.screen 経由で利用可能な一貫性のあるウィンドウの画面サイズをエミュレートします。viewport が設定されている場合のみ使用されます。
service_workers "allow" | "block" (オプション)#

サイトがService Workerを登録できるようにするかどうか。デフォルトは 'allow' です。
- 'allow': Service Worker を登録できます。
- 'block': PlaywrightはService Workerのすべての登録をブロックします。
storage_state Union[str, pathlib.Path] | Dict (オプション)#
- cookies List[Dict]
  - name str
  - value str
  - domain str
    
    ドメインとパスは必須です。Cookieをすべてのサブドメインにも適用するには、ドメインの前にドットを付けます（例：".example.com"）。
  - path str
    
    ドメインとパスは必須
  - expires float
    
    Unix時間（秒単位）。
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
    
    sameSiteフラグ
  コンテキストに設定するCookie
- origins List[Dict]
  - origin str
  - localStorage List[Dict]
    - name str
    - value str
    コンテキストに設定するlocalStorage
ストレージ状態と認証の詳細をご覧ください。

指定されたストレージ状態でコンテキストを設定します。このオプションは、browser_context.storage_state() を介して取得したログイン情報でコンテキストを初期化するために使用できます。
strict_selectors bool (オプション)#

trueに設定すると、このコンテキストの厳密なセレクターモードを有効にします。厳密なセレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合に例外をスローします。このオプションは、Locator APIには影響しません（Locatorは常に厳密です）。デフォルトは false です。厳密モードの詳細については、Locator を参照してください。
timezone_id str (オプション)#

コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txt を参照してください。デフォルトはシステムのタイムゾーンです。
user_agent str (オプション)#

このコンテキストで使用する特定のユーザーエージェント。
viewport NoneType | Dict (オプション)#
- width int
  
  ページの幅（ピクセル単位）。
- height int
  
  ページの高さ（ピクセル単位）。
各ページに一貫したビューポートを設定します。デフォルトは1280x720ビューポートです。no_viewport は固定ビューポートを無効にします。ビューポートエミュレーションの詳細をご覧ください。

戻り値

Page #

start_tracing

追加バージョン: v1.11

browser.start_tracing

注意

この API は、低レベルの chromium 固有のデバッグツールである Chromium Tracing を制御します。Playwright Tracing を制御する API は、こちらにあります。

browser.start_tracing() および browser.stop_tracing() を使用して、Chrome DevTools のパフォーマンスパネルで開くことができるトレースファイルを作成できます。

使用方法

Sync
Async

browser.start_tracing(page, path="trace.json")
page.goto("https://www.google.com")
browser.stop_tracing()

await browser.start_tracing(page, path="trace.json")
await page.goto("https://www.google.com")
await browser.stop_tracing()

引数

page Page (オプション)#

オプション。指定した場合、トレースには指定されたページのスクリーンショットが含まれます。
categories List[str] (オプション)#

デフォルトの代わりにカスタムカテゴリを使用するように指定します。
path Union[str, pathlib.Path] (オプション)#

トレースファイルを書き込むパス。
screenshots bool (オプション)#

トレースでスクリーンショットをキャプチャします。

戻り値

NoneType #

stop_tracing

追加バージョン: v1.11

browser.stop_tracing

注意

この API は、低レベルの chromium 固有のデバッグツールである Chromium Tracing を制御します。Playwright Tracing を制御する API は、こちらにあります。

トレースデータを含むバッファを返します。

使用方法

browser.stop_tracing()

戻り値

bytes #

プロパティ

browser_type

追加: v1.23

browser.browser_type

ブラウザが属するブラウザタイプ (chromium、firefox、または webkit) を取得します。

使用方法

browser.browser_type

戻り値

BrowserType #

contexts

v1.9より前に追加

browser.contexts

開いているすべてのブラウザコンテキストの配列を返します。新しく作成されたブラウザでは、これはゼロのブラウザコンテキストを返します。

使用方法

Sync
Async

browser = pw.webkit.launch()
print(len(browser.contexts)) # prints `0`
context = browser.new_context()
print(len(browser.contexts)) # prints `1`

browser = await pw.webkit.launch()
print(len(browser.contexts)) # prints `0`
context = await browser.new_context()
print(len(browser.contexts)) # prints `1`

戻り値

List[BrowserContext]#

is_connected

v1.9より前に追加

browser.is_connected

ブラウザが接続されていることを示します。

使用方法

browser.is_connected()

戻り値

bool #

version

v1.9より前に追加

browser.version

ブラウザのバージョンを返します。

使用方法

browser.version

戻り値

str #

イベント

on("disconnected")

v1.9より前に追加

browser.on("disconnected")

ブラウザがブラウザアプリケーションから切断されたときに発生します。これは、次のいずれかの理由で発生する可能性があります。

ブラウザアプリケーションが閉じられたか、クラッシュした。
browser.close() メソッドが呼び出された。

使用方法

browser.on("disconnected", handler)

イベントデータ

Browser

メソッド​

close​

new_browser_cdp_session​

new_context​

new_page​

start_tracing​

stop_tracing​

プロパティ​

browser_type​

contexts​

is_connected​

version​

イベント​

on("disconnected")​

メソッド

close

new_browser_cdp_session

new_context

new_page

start_tracing

stop_tracing

プロパティ

browser_type

contexts

is_connected

version

イベント

on("disconnected")