Models

Classes used to facilitate the module's usage.

Variables

• options (list): all possible basic options (work for all styles)

• default_options (dict): a dict with all default options

• styles (list): all available styles

class DColor

def __init__()

All colors used for this module are made with this class. This uses HTML/hex color codes.

Note that html_code can also be transparent when used for the backgroundColor option!

def __init__(self,
    html_code: str | list[str] = "transparent"
) -> None

Returns: None: when called as string it will return the color code

Raises: IncorrectColor: an incorrect html color code is given

Parameter	Type	Default	Description
html_code	str | list[str]	"transparent"	HTML/hex color code. This can be a list of strings if backgroundType has been set to "gradientLinear"

def random()

Get a random valid HTML color code.

def random(
) -> DColor()

Returns: DColor: the DColor instance with a random color.

class DStyle

def __init__()

Not to be initialized!

def get_schema()

Returns a dict with the JSON schema (all properties) of the given avatar style.

def get_schema(
    style: str
) -> dict

Returns: dict: the dictionary containing the avatar style's schema.

Parameter	Type	Default	Description
style	str	N/A	The name of the style you want to get the schema of.

def random()

Get a random style for DStyle.

def random(
) -> str

Returns: str: returns a random Style string.

def from_str()

Get an avatar style from a string.

def from_str(
    style_str: str
) -> str

Returns: str: returns a Style string from the given string if the style exists.

Parameter	Type	Default	Description
style_str	str	N/A	The string to form a style.

Attributes

For more info check Styles.

• list = all_styles

• adventurer

• adventurer_neutral

• avataaars

• avataaars_neutral

• big_ears

• big_ears_neutral

• big_smile

• bottts

• bottts_neutral

• croodles

• croodles_neutral

• dylan

• fun_emoji

• glass

• icons

• identicon

• initials

• lorelei

• lorelei_neutral

• micah

• miniavs

• notionists

• notionists_neutral

• open_peeps

• personas

• pixel_art

• pixel_art_neutral

• rings

• shapes

• thumbs

• toon-head

class DFormat

def __init__()

Not to be initiated!

def from_str()

def from_str(
    format_str: str
) -> str

Returns: str: returns a Format string from the given string if the format exists.

Parameter	Type	Default	Description
format_str	str	N/A	The string to form a format.

Attributes

• list = all_formats

• svg

• webp

• avif

• png

• jpg

• jpeg

• json

class DOptions

def __init__()

def __init__(self,
    *,
    flip: bool = False,
    rotate: int = 0,
    scale: int = 100,
    radius: int = 0,
    size: int = 0,
    backgroundColor: DColor | list(DColor) = DColor(),
    backgroundType: str = "solid",
    backgroundRotation: int = 0,
    translateX: int = 0,
    translateY: int = 0,
    randomizeIds: bool = False
    **kwargs
) -> None

Returns: DOptions: the DOptions instance to use for DAvatar.

Parameter	Type	Default	Description
flip	bool	False	Whether to flip the image vertically
rotate	int	default 0 min 0, max 360	Rotate the avatar
scale	int	default 100 min 0, max 200	Scale of the drawn avatar
radius	int	default 0 min 0, max 50	Radius of the avatar (borders)
size	int	default 256 min 1, max 256	Size of the avatar (in pixels)
backgroundColor	DColor	DColor("transparent")	Background color for the avatar image
backgroundType	str	solid	The type of background (only solid or gradientLinear)
backgroundRotation	int	0	The background's rotation (only with gradientLinear)
translateX	int	default 0 min -100, max 100	Move the avatar horizontally
translateY	int	default 0 min -100, max 100	Move the avatar vertically
randomizeIds	bool	default False	Randomize the IDs in the generated SVG/XML, can be useful if the avatars are included directly in HTML and you want to avoid ID conflicts.
**kwargs	Any	N/A	Kwargs

Attributes

• empty

• default_options = default