※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

assert_true と assert_false インターフェイス

このページではassert_trueとassert_false関数の各インターフェイスについて説明します。

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

assert_true関数のインターフェイスは指定されたBooleanの値が真（true）であることをチェックします。逆にassert_false関数のインターフェイスは指定されたBooleanの値が偽（false）であることをチェックします。

関連資料

基本的な使い方

assert_trueとassert_falseの各インターフェイスはvalue引数を必要とします。type_strictとmsg引数は省略可です。type_strict引数のデフォルト値はTrueとなります。

もしもtype_strict引数にTrueが指定された場合チェック処理はJavaScriptの厳密な型の比較（===による比較）によって行われます。たとえばもしvalue引数の値がInt(1)で且つtype_strict引数がTrueの場合チェック処理は真偽値と整数（Int）間の比較となるため失敗します。逆にtype_strictがFalseで且つ値がInt(1)であればassert_true関数によるチェック処理は通ります。

これらのインターフェイスによるチェック結果はブラウザ上のコンソールに表示されます。

以下のassert_true関数とBoolean(True)の値を使用した処理のコード例ではチェックを通ります:

import apysc as ap

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

bool_1: ap.Boolean = ap.Boolean(True)
ap.assert_true(bool_1, msg="Boolean value is not True!")

ap.save_overall_html(dest_dir_path="assert_true_basic_usage_1/")

[assert_true]
Right-side variable name: b_3
Left value: true right value: true

以下のassert_true関数とBoolean(False)の値を使った処理ではチェックが失敗します:

import apysc as ap

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

bool_1: ap.Boolean = ap.Boolean(False)
ap.assert_true(bool_1, msg="Boolean value is not True!")

ap.save_overall_html(dest_dir_path="assert_true_basic_usage_2/")

[assert_true]
Right-side variable name: b_3
Left value: true right value: false
...
Assertion failed: Boolean value is not True!

以下のassert_true関数とInt(1)の値を使い、type_strictにTrueを指定した例ではチェックが失敗します:

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(1)
ap.assert_true(int_1, type_strict=True, msg="Value is not Boolean(True)!")

ap.save_overall_html(dest_dir_path="assert_true_basic_usage_3/")

[assert_true]
Right-side variable name: i_11
Left value: true right value: 1
...
Assertion failed: Value is not Boolean(True)!

以下のassert_true関数とInt(1)の値を使いtype_strictにFalseを設定した処理ではチェックが通ります:

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(1)
ap.assert_true(int_1, type_strict=False, msg="Value is not True!")

ap.save_overall_html(dest_dir_path="assert_true_basic_usage_4/")

[assert_true]
Right-side variable name: i_11
Left value: true right value: 1

以下のassert_false関数とBoolean(False)の値を使った処理ではチェックを通ります:

import apysc as ap

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

bool_1: ap.Boolean = ap.Boolean(False)
ap.assert_false(bool_1, msg="Value is not False!")

ap.save_overall_html(dest_dir_path="assert_false_basic_usage_1/")

[assert_false]
Right-side variable name: b_3
Left value: false right value: false

assert_true API

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

[インターフェイスの構造] assert_true(value: Any, *, type_strict: bool = True, msg: str = '') -> None

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

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

[引数]

  • value: *

    • チェック対象の値。

  • type_strict: bool, default True

    • 厳密な型でのチェックを行うかどうかの設定です。たとえばtype_strictにTrueを指定した場合は整数の1ではテストは失敗します。逆にtype_strictがFalseの場合整数の1はテストを通過します。

  • msg: str, optional

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

[コードサンプル]

>>> import apysc as ap
>>> int_val: ap.Int = ap.Int(10)
>>> boolean: ap.Boolean = int_val == 10
>>> ap.assert_true(boolean)

assert_false API

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

[インターフェイスの構造] assert_false(value: Any, *, type_strict: bool = True, msg: str = '') -> None

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

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

[引数]

  • value: *

    • チェック対象の値。

  • type_strict: bool, default True

    • 厳密な型でのチェックを行うかどうかの設定です。たとえばtype_strictにTrueを指定した場合は整数の0ではテストは失敗します。逆にtype_strictがFalseの場合整数の0はテストを通過します。

  • msg: str, optional

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

[コードサンプル]

>>> import apysc as ap
>>> int_val: ap.Int = ap.Int(10)
>>> boolean: ap.Boolean = int_val == 11
>>> ap.assert_false(boolean)