Types¶

imgproxykit.types.Argument = Argument¶

Scalar value accepted in an option’s positional arguments.

Values in arguments. Booleans become 1 or 0. None leaves an empty argument position; trailing None values are omitted by the default serializer.

See imgproxy processing options.

imgproxykit.types.FormatType = FormatType¶

Image format identifiers accepted by imgproxykit.

Formats for Format, FormatQuality, and the format keyword of Transform. For example, use jpg for JPEG and jxl for JPEG XL.

An identifier in this type does not guarantee output support on your server. Supported input and output formats depend on the imgproxy build; SVG output has additional restrictions.

See imgproxy format and the image formats support matrix.

imgproxykit.types.OptionType = OptionType¶

Processing option names represented by imgproxykit’s built-in options.

Names in name identify URL segments. These are protocol names; scalar keywords in Transform replace hyphens with underscores. For example, min-width corresponds to min_width.

This type describes the library’s supported names, rather than every option available in every imgproxy version or edition.

See imgproxy processing options.

imgproxykit.types.Position = Position¶

Gravity codes for Gravity and Crop.

See imgproxy gravity.

imgproxykit.types.ResizeType = ResizeType¶

Resizing modes for Resize and ResizingType.

See imgproxy resizing type.

imgproxykit.types.WatermarkPosition = WatermarkPosition¶

Placement codes for Watermark.

See imgproxy watermark.