assert_equal と assert_not_equal インターフェイス¶

各インターフェイスの概要¶

assert_equal関数のインターフェイスは2つのJavaScript上の値が等値かどうかをチェックします。逆にassert_not_equal関数のインターフェイスは2つの値が等値ではないことをチェックします。

関連資料¶

• JavaScriptの各アサーションのインターフェイスの基本的な挙動

基本的な使い方¶

assert_equalとassert_not_equalインターフェイスはleftとrightの各引数の指定を必要とします。msg引数は省略可です。

もしもleft引数の値とright引数の値が一致していない場合、assert_equal関数によるチェックは失敗しブラウザ上のコンソールにエラーメッセージが表示されます。

import apysc as ap

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

int_1: ap.Int = ap.Int(10)
ap.assert_equal(left=11, right=int_1, msg="Values are not equal!")

ap.save_overall_html(dest_dir_path="assert_equal_basic_usage/")

[assert_equal]
Left-side variable name: i_11
Left value: 11 right value: 10
...
Assertion failed: Values are not equal!

assert_not_equalインターフェイスも同様の引数を持っており、もしleft引数の値がright引数の値と等値の場合チェック処理は失敗します:

import apysc as ap

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

int_1: ap.Int = ap.Int(10)
ap.assert_not_equal(left=10, right=int_1, msg="Values are equal!")

ap.save_overall_html(dest_dir_path="assert_not_equal_basic_usage/")

[assert_not_equal]
Right-side variable name: i_11
Left value: 10 right value: 10
...
Assertion failed: Values are equal!

assert_equal API¶

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] assert_equal(left: Any, right: Any, *, msg: str = '') -> None

[インターフェイス概要]

等値条件のためのJavaScript上のアサーションのインターフェイスです。

[引数]

• left: *

  • 比較用の左辺の値。

• right: *

  • 比較用の右辺の値。

• msg: str, optional

  • チェックに失敗した際に表示するメッセージ。

[特記事項]

・もしも引数にArrayやlistの値が指定された場合、このインターフェイスの処理の代わりにassert_arrays_equal関数が呼ばれます。
・もしも引数にDictionaryやdictの値が指定された場合、このインターフェイスの処理の代わりにassert_dicts_equal関数が呼ばれます。

[コードサンプル]

>>> import apysc as ap
>>> int_1: ap.Int = ap.Int(10)
>>> int_2: ap.Int = ap.Int(10)
>>> ap.assert_equal(int_1, int_2)

assert_not_equal API¶

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] assert_not_equal(left: Any, right: Any, *, msg: str = '') -> None

[インターフェイス概要]

非等値条件のためのJavaScript上のアサーションのインターフェイスです。

[引数]

• left: *

  • 比較用の左辺の値。

• right: *

  • 比較用の右辺の値。

• msg: str, optional

  • チェックに失敗した際に表示するメッセージ。

[特記事項]

・もしも引数にArrayやlistの値が指定された場合、このインターフェイスの処理の代わりにassert_arrays_not_equal関数が呼ばれます。
・もしも引数にDictionaryやdictの値が指定された場合、このインターフェイスの代わりにassert_dicts_not_equal関数が呼ばれます。

[コードサンプル]

>>> import apysc as ap
>>> int_1: ap.Int = ap.Int(10)
>>> int_2: ap.Int = ap.Int(11)
>>> ap.assert_not_equal(int_1, int_2)