ogpy.client.browser module

Browser based client.

This module provide functions as same as ogpy.client. Functions uses Playwright and browser instead of httpx.

ogpy.client.browser.BrowserChannel

Chromium channel category of Playwright.

alias of Literal[‘chrome’, ‘msedge’, ‘chrome-beta’, ‘msedge-beta’, ‘chrome-dev’, ‘msedge-dev’, ‘chrome-canary’, ‘msedge-canary’]

ogpy.client.browser.BrowserLabel

Combined types that is accepted by functions.

alias of Literal[‘chromium’, ‘firefox’, ‘webkit’] | Literal[‘chrome’, ‘msedge’, ‘chrome-beta’, ‘msedge-beta’, ‘chrome-dev’, ‘msedge-dev’, ‘chrome-canary’, ‘msedge-canary’]

ogpy.client.browser.BrowserName

Browser type category of Playwright.

alias of Literal[‘chromium’, ‘firefox’, ‘webkit’]

class ogpy.client.browser.Engine(playwright: Playwright, fuzzy_mode: bool = False, browser_name: BrowserLabel = 'chromium')

Bases: object

Low-level class to fetch Open Graph metadata by Browser.

fetch(url: str) → Metadata | MetadataFuzzy

Fetch and parse HTTP content.

Parameters:

url – Target URL.

Returns:

Fetched meatadata.

fetch_for_cache(url: str) → Tuple[types.Metadata | types.MetadataFuzzy, int]

Fetch and parse HTTP content. return with max-age for caching.

Parameters:

url – Target URL.

Returns:

Fetched meatadata and cachable max-age (seconds).

ogpy.client.browser.fetch(url: str, fuzzy_mode: bool = False, browser_name: Literal['chromium', 'firefox', 'webkit', 'chrome', 'msedge', 'chrome-beta', 'msedge-beta', 'chrome-dev', 'msedge-dev', 'chrome-canary', 'msedge-canary'] = 'chromium') → Metadata | MetadataFuzzy

Fetch and parse HTTP content.

Parameters:

  • url – Target URL.

  • fuzzy_mode – Flag to enable “Fuzzy mode”, See Fuzzy mode.

  • browser_name – Using browser.

Returns:

Fetched meatadata.

ogpy.client.browser.fetch_for_cache(url: str, fuzzy_mode: bool = False, browser_name: BrowserLabel = 'chromium') → Tuple[types.Metadata | types.MetadataFuzzy, int | None]

Fetch and parse HTTP content. return with max-age for caching.

Parameters:

  • url – Target URL.

  • fuzzy_mode – Flag to enable “Fuzzy mode”, See Fuzzy mode.

  • browser_name – Using browser.

Returns:

Fetched meatadata and cachable max-age (seconds).

ogpy.client.browser.get_browser(playwright: Playwright, name: BrowserLabel) → Browser

Retrieve browser instance of Playwright.

This function works these automatically.

  • Detect browser ‘type’ or ‘channel’.

  • Download executable if it is not installed yet.

Parameters:

  • playwright – Playwright object.

  • name – Target browser for using.