bokeh.core.validation

検証モジュールは,Bokehモデル集合全体に対して完全性チェックを実行する能力を提供する.

Bokeh可視化を作成するためには,|boke.model|中の集合モデルオブジェクトをクライアントで作成すべきシーンを表す図形に組み立てるのが中心タスクである.この操作は,モデルオブジェクト“手動”を直接用いて行うことができる.しかし,このプロセスを簡略化するために,Bokehは|boke.ploting|のようなより高いレベルのインタフェースをユーザに提供する.

これらのインターフェースは、一貫した予測可能な方法でBokehオブジェクトマップが作成されることを確実にするために、一般的な“組み立て”ステップを自動的に実行する。しかしながら、どのインターフェースが使用されても、Bokehモデルは、不完全な方法またはいくつかの態様では意味のない方法で組み合わされる可能性がある。

潜在的な問題の診断を支援するために、Bokehは、表示のために可視化を出力するときに検証ステップを実行する。このモジュールは,誤りと警告コードと,検証検査を定義するためのブースタ関数を含む.

警告の1つの例は,ユーザがやりたくないかもしれないことをうっかりした場合,ユーザに正しい方向を大声で示す,たとえばEMPTY_Layoutがこの場合である.警告は必ずしも誤用を表すとは限らないので、それらは構成可能だ。警告をミュートさせるには、提供されているミュート機能を使用してください。

>>> from bokeh.core.validation import silence
>>> from bokeh.core.validation.warnings import EMPTY_LAYOUT
>>> silence(EMPTY_LAYOUT, True)

誤りコード.

これらは,Bokeh検証検査の標準エラーコードとメッセージを定義している.

1001 (BAD_COLUMN_NAME)

字形の属性はフィールド名とし,そのフィールド名は対応しない GlyphRenderer データソースです

1002 (MISSING_GLYPH)

A GlyphRenderer 未配置字形。

1003 (NO_SOURCE_FOR_GLYPH)

A GlyphRenderer データソースは構成されていません。

1004 (REQUIRED_RANGE)

A Plot 1つ以上の必要なデフォルト範囲が不足している(空白印刷をもたらす)。

1005 (MISSING_GOOGLE_API_KEY)

Google Maps APIは現在、使用するためにAPI鍵が必要です。自分の鍵の取得方法の詳細については、https://developers.google.com/aps/Documentation/javascript/Get-API-Keyを参照してください。 api_key あなたのGoogleマップブロックの属性です。

1006 (NON_MATCHING_DATA_SOURCES_ON_LEGEND_ITEM_RENDERERS)

すべてのデータソースを有効にする LegendItem.renderers LegendItem.Labelがタイプフィールドである場合は一致しなければならない。

1007 (MISSING_MERCATOR_DIMENSION)

MercatorTicker そして MercatorTickFormatter モデルは自分のものを持っていなければならない dimension 属性は、 'lat' あるいは…。 'lon' それがそうです。

1008 (REQUIRED_SCALE)

A Scale ONは、(空白印刷につながる)1つ以上の必要なデフォルト割合が不足しています。

1009 (INCOMPATIBLE_SCALE_AND_RANGE)

A Scale タイプは、同じ印刷サイズの1つ以上の範囲と互換性がない(空白印刷になる)。

1010 (CDSVIEW_SOURCE_DOESNT_MATCH)

A GlyphRenderer Vbl.ある CDSView その源と GlyphRenderer データソースです

1011 (MALFORMED_GRAPH_SOURCE)

♪the GraphSource 配置が正しくない。

1012 (INCOMPATIBLE_MAP_RANGE_TYPE)

地図印刷はサポートのみとなっております Range1d タイプは、データ範囲ではありません。

1013 (INCOMPATIBLE_POINT_DRAW_RENDERER)

♪the PointDrawTool レンダラは引用しかできません XYGlyph モデルたち。

1014 (INCOMPATIBLE_BOX_EDIT_RENDERER)

♪the BoxEditTool レンダラは引用しかできません Rect 字形モデル。

1015 (INCOMPATIBLE_POLY_DRAW_RENDERER)

♪the PolyDrawTool レンダラは引用しかできません MultiLine そして Patches 字形モデル。

1016 (INCOMPATIBLE_POLY_EDIT_RENDERER)

♪the PolyEditTool レンダラは引用しかできません MultiLine そして Patches 字形モデル。

1017 (INCOMPATIBLE_POLY_EDIT_VERTEX_RENDERER)

♪the PolyEditTool VERTEX_RENDERは参照しかできません XYGlyph モデルたち。

1018 (NO_RANGE_TOOL_RANGES)

♪the RangeTool 少なくとも一つはなければならない x_range あるいは…。 y_range 構成されています

1019 (DUPLICATE_FACTORS)

FactorRange 軸に一意のカテゴリ要素リストを指定しなければならない.

1020 (BAD_EXTRA_RANGE_NAME)

追加の範囲名は、どの範囲にも対応しない名前として構成される。

1021 (EQUAL_SLIDER_START_END)

noUiSlider ほとんどの人の出発点と終点は同じではない。

1022 (MIN_PREFERRED_MAX_WIDTH)

期待最小幅<=幅<=最大幅

1023 (MIN_PREFERRED_MAX_HEIGHT)

期待最小高<=高さ<=最大高さ

1024 (CDSVIEW_FILTERS_WITH_CONNECTED)

CDSView フィルタは、直線またはパッチのようなトポロジーを接続する字形と互換性がない。

1025 (INCOMPATIBLE_LINE_EDIT_RENDERER)

♪the LineEditTool レンダラは引用しかできません MultiLine そして Line 字形モデル。

1026 (INCOMPATIBLE_LINE_EDIT_INTERSECTION_RENDERER)

♪the LineEditTool INTERSION_ENLENDERは参照しかできません LineGlyph モデルたち。

1027 (REPEATED_LAYOUT_CHILD)

同一モデルは1つのレイアウトで複数回使用することはできない.

9999 (内線)

カスタムエラーチェック失敗を指示する.

警告コード

これらは,Bokeh検証チェックの標準警告コードとメッセージを定義している.

1000 (MISSING_RENDERERS)

A Plot オブジェクトにはレンダラーが構成されていません(空白印刷になります)。

1002 (EMPTY_LAYOUT)

レイアウトモデルにはサブ項がない(空白レイアウトになる).

1004 (BOTH_CHILD_AND_ROOT)

各コンポーネントは1つの位置にしか提示できず、根とレイアウトを同時にすることはできない。

9999 (内線)

カスタム警告チェックに失敗したことを指示します。

扶助器関数

これらのブースタ関数は、Bokehモデルのセットに対して完全性チェックを実行するために使用されてもよく、またはモデル上の方法を警告またはエラーチェックとしてマークするために使用されてもよい。

check_integrity(models)[ソース]

Bokehモデル集合に検証と完全性検査を適用する.

パラメータ

models (seq[Model]) -- テストするモデル集合

戻り値

なし

この関数は、検出されたすべてのエラーまたは警告条件に対してログ警告およびエラーメッセージを発行する。例えば、サブアイテムがないレイアウトは警告をトリガする:

>>> empty_row = Row

>>> check_integrity([empty_row])
W-1002 (EMPTY_LAYOUT): Layout has no children: Row(id='2404a029-c69b-4e30-9b7d-4b7b6cdaad5b', ...)
silence(warning: int, silence: bool = True) → Set[int][ソース]

Bokehモデルの特定の警告をすべてミュートさせます。

パラメータ
  • warning (Warning) -- Bokehは黙っているように警告した

  • silence (bool) -- 警告をミュートするかどうか

戻り値

すべてのミュート警告を含む集合

この関数は、運転時に参照される消音器のセットに警告を追加または削除するために使用される check_integrity それがそうです。消音器に警告を加えると,決して警告は出さない.

>>> from bokeh.core.validation.warnings import EMPTY_LAYOUT
>>> bokeh.core.validation.silence(EMPTY_LAYOUT, True)
{1002}

警告を再開するには、同じ方法を使用してくださいが、ハッシュパラメータをfalseに設定します。

>>> bokeh.core.validation.silence(EMPTY_LAYOUT, False)
set()
error(code_or_name)[ソース]

Bokehエラー条件をマークするためのベリファイア方法のための修飾器

パラメータ

code_or_name (int or str) -- コードは bokeh.validation.errors カスタムチェックのための文字列タグ

戻り値

Bokehモデル方法の装飾器

戻り値の型

callable

修飾関数の名称は _check 不良が検出された場合に文字列メッセージを返し, None もし不良が検出されなければ。

例:

第1の例はデジタルコード表現を使用する bokeh.validation.errors それがそうです。Bokehコア開発者は主にこの使い方に興味を持っている。

from bokeh.validation.errors import REQUIRED_RANGES

@error(REQUIRED_RANGES)
def _check_no_glyph_renderers(self):
    if bad_condition: return "message"

第2の例は、任意の文字列タグを装飾器に渡すことによってカスタム警告チェックを実現する方法を示す。自分のカスタマイズモデルを用いてBokehを拡張した人は誰でもこの使い方に興味を持つ.

@error("MY_CUSTOM_WARNING")
def _check_my_custom_warning(self):
    if bad_condition: return "message"
warning(code_or_name)[ソース]

Bokehエラー条件をマークするためのベリファイア方法のための修飾器

パラメータ

code_or_name (int or str) -- コードは bokeh.validation.errors カスタムチェックのための文字列タグ

戻り値

Bokehモデル方法の装飾器

戻り値の型

callable

修飾関数の名称は _check 不良が検出された場合に文字列メッセージを返し, None もし不良が検出されなければ。

例:

第1の例はデジタルコード表現を使用する bokeh.validation.warnings それがそうです。Bokehコア開発者は主にこの使い方に興味を持っている。

from bokeh.validation.warnings import MISSING_RENDERERS

@warning(MISSING_RENDERERS)
def _check_no_glyph_renderers(self):
    if bad_condition: return "message"

第2の例は、任意の文字列タグを装飾器に渡すことによってカスタム警告チェックを実現する方法を示す。自分のカスタマイズモデルを用いてBokehを拡張した人は誰でもこの使い方に興味を持つ.

@warning("MY_CUSTOM_WARNING")
def _check_my_custom_warning(self):
    if bad_condition: return "message"