assert_arrays_equal and assert_arrays_not_equal interfaces¶

What interfaces are these?¶

The assert_arrays_equal function interface asserts that the two arrays are equal. Conversely, the assert_arrays_not_equal function interface asserts that the two arrays are not equal.

See also¶

• JavaScript assertion interface basic behavior

Basic usage¶

Both of the assert_arrays_equal and assert_arrays_not_equal interfaces require the left and right arguments. The msg argument is optional.

The arguments accept a Python built-in list value and Array value.

The following example (assert_arrays_equal and values are equal) passes:

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

arr_1: ap.Array = ap.Array([1, 2, 3])
ap.assert_arrays_equal(left=[1, 2, 3], right=arr_1, msg="Values are not equal!")

ap.save_overall_html(dest_dir_path="assert_arrays_equal_basic_usage_1/")

[assert_arrays_equal]
Left value: [1, 2, 3] right value: arr_2

The following example (assert_arrays_equal and values are not equal) fails:

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

arr_1: ap.Array = ap.Array([1, 2, 3])
ap.assert_arrays_equal(left=[1, 2], right=arr_1, msg="Values are not equal!")

ap.save_overall_html(dest_dir_path="assert_arrays_equal_basic_usage_2/")

[assert_arrays_equal]
Left value: [1, 2] right value: arr_2
...
Assertion failed: Values are not equal!

The following example (assert_arrays_not_equal and values are not equal) passes:

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

arr_1: ap.Array = ap.Array([1, 2, 3])
ap.assert_arrays_not_equal(left=[1, 2], right=arr_1, msg="Values are equal!")

ap.save_overall_html(dest_dir_path="assert_arrays_not_equal_basic_usage_1/")

Notes for the assert_equal and assert_not_equal interfaces¶

If an Array value is specified to the assert_equal or assert_not_equal interface’s values, then the assert_arrays_equal or assert_arrays_not_equal interfaces will be called instead of the assert_equal or assert_not_equal interfaces automatically.

import apysc as ap

stage: ap.Stage = ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

arr_1: ap.Array = ap.Array([1, 2, 3, 4, 5])
ap.assert_equal(left=[1, 2, 3, 4, 5], right=arr_1, msg="Values are equal!")

ap.save_overall_html(dest_dir_path="assert_arrays_equal_notes_for_the_assert_equal/")

[assert_arrays_equal]
Left value: [1, 2, 3, 4, 5] right value: arr_2

assert_arrays_equal API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] assert_arrays_equal(left: Any, right: Any, *, msg: str = '', outer_frames_index_adjustment: int = 0) -> None

[Interface summary]

JavaScript assertion interface for the Array values equal condition.

[Parameters]

• left: *

  • Left-side value to compare.

• right: *

  • Right-side value to compare.

• msg: str, optional

  • Message to display when assertion failed.

• outer_frames_index_adjustment: int, optional

  • The trace’s outer frames index adjustment setting. This function uses this argument to adjust the caller’s information. Also, this function only uses this argument in internal logic.

[Notes]

This interface is used instead of assert_equal for Array class comparison (JavaScript can not compare arrays directly, like a Python, for example, [1, 2] === [1, 2] becomes false).

[Examples]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> arr_1: ap.Array = ap.Array([1, 2, 3])
>>> arr_2: ap.Array = ap.Array([1, 2, 3])
>>> ap.assert_arrays_equal(arr_1, arr_2)

assert_arrays_not_equal API¶

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] assert_arrays_not_equal(left: Any, right: Any, *, msg: str = '', outer_frames_index_adjustment: int = 0) -> None

[Interface summary]

JavaScript assertion interface for the Array values not equal condition.

[Parameters]

• left: *

  • Left-side value to compare.

• right: *

  • Right-side value to compare.

• msg: str, optional

  • Message to display when assertion failed.

• outer_frames_index_adjustment: int, optional

  • The trace’s outer frames index adjustment setting. This function uses this argument to adjust the caller’s information. Also, this function only uses this argument in internal logic.

[Notes]

This interface is used instead of assert_not_equal for Array class comparison (JavaScript can not compare arrays directly, like a Python, for example, [1, 2] === [1, 2] becomes false).

[Examples]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> arr_1: ap.Array = ap.Array([1, 2, 3])
>>> arr_2: ap.Array = ap.Array([4, 5, 6])
>>> ap.assert_arrays_not_equal(arr_1, arr_2)