API Reference

Module attributes

resvg_py.__version__

Package version string, e.g. "0.3.2".

Type:

str

resvg_py.__author__

Package author.

Type:

str

resvg_py.__resvg_version__

Version of the underlying resvg Rust crate.

Type:

str

svg_to_bytes

resvg_py.svg_to_bytes(svg_string=None, svg_path=None, background=None, skip_system_fonts=False, log_information=False, width=None, height=None, zoom=None, dpi=0, style_sheet=None, resources_dir=None, languages=Ellipsis, font_size=16, font_family=None, serif_family=None, sans_serif_family=None, cursive_family=None, fantasy_family=None, monospace_family=None, font_files=None, font_dirs=None, shape_rendering=Ellipsis, text_rendering=Ellipsis, image_rendering=Ellipsis)

Render an SVG to PNG bytes.

Accepts either svg_string or svg_path (not both required). svg_path also supports .svgz (gzip-compressed) files.

Parameters:

  • svg_string (str | None) – SVG markup as a UTF-8 string.

  • svg_path (str | None) – File path to an SVG (or .svgz) file.

  • background (str | None) – CSS color for the canvas background, e.g. "#ffffff".

  • skip_system_fonts (bool) – Skip loading system fonts. Pass font files/dirs manually if enabled.

  • log_information (bool) – Print resvg debug logs to stdout.

  • width (int | None) – Target render width in pixels.

  • height (int | None) – Target render height in pixels.

  • zoom (int | None) – Integer zoom multiplier applied to the original size.

  • dpi (int) – Dots-per-inch for the render (0 = SVG default).

  • style_sheet (str | None) – CSS stylesheet string applied during parsing.

  • resources_dir (str | None) – Directory resolved for xlink:href resource references.

  • languages (list[str]) – Preferred language list for <switch> elements.

  • font_size (int) – Default font size in pixels.

  • font_family (str | None) – Default (generic) font family.

  • serif_family (str | None) – Serif generic font family override.

  • sans_serif_family (str | None) – Sans-serif generic font family override.

  • cursive_family (str | None) – Cursive generic font family override.

  • fantasy_family (str | None) – Fantasy generic font family override.

  • monospace_family (str | None) – Monospace generic font family override.

  • font_files (list[str] | None) – Explicit font file paths (.ttf, .otf, etc.) to load.

  • font_dirs (list[str] | None) – Directories recursively scanned for font files.

  • shape_rendering (str) – Shape rendering policy. One of "optimize_speed", "crisp_edges", "geometric_precision".

  • text_rendering (str) – Text rendering policy. One of "optimize_speed", "optimize_legibility", "geometric_precision".

  • image_rendering (str) – Image rendering policy. One of "optimize_quality", "optimize_speed".

Returns:

PNG-encoded image data.

Return type:

bytes

Raises:

ValueError – On empty/invalid SVG, bad option values, unparseable background color, or render failure.

Parameter reference

Parameter

Type

Default

Description

svg_string

str | None

None

SVG markup as a UTF-8 string. Preferred over svg_path.

svg_path

str | None

None

Path to an SVG file. .svgz auto-decompresses.

background

str | None

None

CSS color for the canvas background.

skip_system_fonts

bool

False

Skip loading system fonts. Provide font_files or font_dirs.

log_information

bool

False

Enable resvg debug logging to stdout.

width

int | None

None

Target pixel width.

height

int | None

None

Target pixel height.

zoom

int | None

None

Integer zoom multiplier.

dpi

int

0

DPI override (0 = SVG default).

style_sheet

str | None

None

CSS stylesheet string applied during parse.

resources_dir

str | None

None

Directory for xlink:href resource references.

languages

list[str]

[]

Preferred languages for <switch> elements.

font_size

int

16

Default font size in pixels.

font_family

str | None

OS-dependent

Default (generic) font family.

serif_family

str | None

OS-dependent

Serif generic family override.

sans_serif_family

str | None

OS-dependent

Sans-serif generic family override.

cursive_family

str | None

OS-dependent

Cursive generic family override.

fantasy_family

str | None

OS-dependent

Fantasy generic family override.

monospace_family

str | None

OS-dependent

Monospace generic family override.

font_files

list[str] | None

None

Explicit font file paths to load.

font_dirs

list[str] | None

None

Directories recursively scanned for fonts.

shape_rendering

str

"geometric_precision"

Shape rendering policy.

text_rendering

str

"optimize_legibility"

Text rendering policy.

image_rendering

str

"optimize_quality"

Image rendering policy.

Rendering policies

Default: "geometric_precision"

Value

Behavior

"geometric_precision"

Highest quality. Full geometric accuracy.

"crisp_edges"

Sharp edges over curves. Good for pixel art.

"optimize_speed"

Fastest. May approximate curves.