ogpy.types module

Type definitions.

Refs

• https://ogp.me/

class ogpy.types.ImageMetadata(url: str, secure_url: str | None = None, type: str | None = None, width: int | float | None = None, height: int | float | None = None, alt: str | None = None)

Bases: object

Image property structure.

Ref:

https://ogp.me/#structured

alt: str | None = None

height: int | float | None = None

secure_url: str | None = None

type: str | None = None

url: str

width: int | float | None = None

class ogpy.types.Metadata(title: str, type: str, url: str, images: list[~ogpy.types.ImageMetadata], *, audio: str | None = None, description: str | None = None, determiner: ~typing.Literal['a', 'an', 'the', '', 'auto'] = '', locale: str = 'en_US', locale_alternates: list[str] = <factory>, site_name: str | None = None, video: str | None = None)

Bases: _OptionalMetadata

Open Graph metadata structure.

This class raises error when content don’t have required properties.

Ref:

https://ogp.me/#metadata

images: list[ImageMetadata]

title: str

type: str

url: str

class ogpy.types.MetadataFuzzy(title: str | None = None, type: str | None = None, url: str | None = None, images: list[~ogpy.types.ImageMetadata] = <factory>, *, audio: str | None = None, description: str | None = None, determiner: ~typing.Literal['a', 'an', 'the', '', 'auto'] = '', locale: str = 'en_US', locale_alternates: list[str] = <factory>, site_name: str | None = None, video: str | None = None)

Bases: _OptionalMetadata

Open Graph metadata structure.

This class does not raise error if content don’t have any properties.

Ref:

https://ogp.me/#metadata

images: list[ImageMetadata]

title: str | None = None

type: str | None = None

url: str | None = None