Avatars reference¶

Generator class¶

class gravify.AvatarGenerator(size: int | None = None, *, default_image: str | DefaultImage | None = None, force_default: bool | None = False, rating: Rating | None = None, initials: str | None = None, name: str | None = None)[source]¶

Gravatar avatar URL generator.

__init__(size: int | None = None, *, default_image: str | DefaultImage | None = None, force_default: bool | None = False, rating: Rating | None = None, initials: str | None = None, name: str | None = None) → None[source]¶

Initialize the avatar generator with reusable options.

Parameters:

size – Side length of the square avatar in pixels (default is 80).
default_image – Default image type if no avatar is found (default is the Gravatar logo).
force_default – Force the default image to always return (default is False).
rating – Rating of the avatar (default is G).
initials – Initials to use for the avatar if no image is found.
name – Name to use for the avatar initials if no image is found.

Raises:

InitialsAndNameError – If both initials and name are provided.

generate_url(email: str) → str[source]¶

Generate the avatar URL for the given email.

Parameters:: email – The email address to generate the avatar for.
Returns:: The generated avatar URL.

Option enums¶

enum gravify.avatars.DefaultImage(value)[source]¶

Default image options for Gravatar.

Valid values are as follows:

INITIALS = <DefaultImage.INITIALS: 'initials'>¶

COLOR = <DefaultImage.COLOR: 'color'>¶

NOT_FOUND = <DefaultImage.NOT_FOUND: '404'>¶

MYSTERY_PERSON = <DefaultImage.MYSTERY_PERSON: 'mp'>¶

IDENTICON = <DefaultImage.IDENTICON: 'identicon'>¶

MONSTER_ID = <DefaultImage.MONSTER_ID: 'monsterid'>¶

WAVATAR = <DefaultImage.WAVATAR: 'wavatar'>¶

RETRO = <DefaultImage.RETRO: 'retro'>¶

ROBOHASH = <DefaultImage.ROBOHASH: 'robohash'>¶

BLANK = <DefaultImage.BLANK: 'blank'>¶

enum gravify.avatars.Rating(value)[source]¶

Rating options for Gravatar.

Valid values are as follows:

G = <Rating.G: 'g'>¶

PG = <Rating.PG: 'pg'>¶

R = <Rating.R: 'r'>¶

X = <Rating.X: 'x'>¶

Exceptions¶

Exception classes for the gravify.avatars module.

exception gravify.avatars.exceptions.GravifyAvatarError[source]¶: Base exception class for Gravify avatar errors.

exception gravify.avatars.exceptions.InitialsAndNameError[source]¶: Exception raised when both initials and name are specified.

exception gravify.avatars.exceptions.InitialsDefaultImageNotSetError[source]¶: Exception raised when the default image is not properly set to INITIALS.