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.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.SourceEncoding = SourceEncoding¶

Source URL representations accepted by Client.

Values for the source_encoding keyword of Client and PathSerializer. Use base64 for URL-safe Base64 without padding or plain for full UTF-8 percent-encoding. The default is base64.

See imgproxy source URLs.

imgproxykit.types.WatermarkPosition = WatermarkPosition¶

Placement codes for Watermark.

See imgproxy watermark.