DiffResult

class DiffResult(base_image: Image, comparing_image: Image, diff_image: Image | None, status: CompareStatus, diff_pixel_count: int | None, diff_percentage: float | None, diff_lines: list[int], use_checker_transparency: bool = True)

Result container for odiff comparison.

Attributes Summary

__annotations__
__dataclass_fields__
__dataclass_params__
__dict__
__doc__
__hash__
__match_args__
__module__
__weakref__	list of weak references to the object (if defined)
use_checker_transparency

Methods Summary

__delattr__	Implement delattr(self, name).
__dir__	Default dir() implementation.
__eq__	Return self==value.
__format__	Default object formatter.
__ge__	Return self>=value.
__getattribute__	Return getattr(self, name).
__gt__	Return self>value.
__init__
__init_subclass__	This method is called when a class is subclassed.
__le__	Return self<=value.
__lt__	Return self<value.
__ne__	Return self!=value.
__new__
__reduce__	Helper for pickle.
__reduce_ex__	Helper for pickle.
__repr__	Return repr(self).
__setattr__	Implement setattr(self, name, value).
__sizeof__	Size of object in memory, in bytes.
__str__	Return str(self).
__subclasshook__	Abstract classes can override this to customize issubclass().
_repr_markdown_	Magic method for rendering automatically in jupyter notebooks.
create_apng	Create an apng from the images and their diff if there is any.

Methods Documentation

__delattr__(name, /)

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__(other)

Return self==value.

__format__(format_spec, /)

Default object formatter.

__ge__(value, /)

Return self>=value.

__getattribute__(name, /)

Return getattr(self, name).

__gt__(value, /)

Return self>value.

__init__(base_image: Image, comparing_image: Image, diff_image: Image | None, status: CompareStatus, diff_pixel_count: int | None, diff_percentage: float | None, diff_lines: list[int], use_checker_transparency: bool = True) → None

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__new__(**kwargs)

__reduce__()

Helper for pickle.

__reduce_ex__(protocol, /)

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

_repr_markdown_() → str

Magic method for rendering automatically in jupyter notebooks.

create_apng(*, delay_num: int = 500, delay_den: int = 1000) → APNG

Create an apng from the images and their diff if there is any.

Parameters:

• delay_num (int) – The delay numerator for frames. Defaults to 500

• delay_den (int) – The delay denominator for frames. Defaults to 1000

Return type:

APNG