rich.measure

クラス rich.measure.Measurement(minimum, maximum)[ソース]

オブジェクトをレンダリングするために必要な最小幅と最大幅 (文字数) を格納します。

パラメータ

  • minimum (int) –

  • maximum (int) –

clamp(min_width=None, max_width=None)[ソース]

測定値を指定された範囲内に制限します。

パラメータ

  • min_width (int) – 最小必要幅。最小値がない場合は None。既定値は None です。

  • max_width (int) – 最大必要幅。最大値がない場合は None。既定値は None です。

リターン

新しい Measurement オブジェクト。

リターン値の型

測定

classmethod get(console, options, renderable)[source]

レンダラブルの測定値を取得します。

パラメータ

  • console (Console) – コンソールインスタンス

  • options (ConsoleOptions) – コンソールオプション

  • renderable (RenderableType) – Rich でレンダリング可能なオブジェクト

送出

errors.NotRenderableError – オブジェクトがレンダリングできない場合

リターン

オブジェクトをレンダリングするために必要な文字幅の範囲を含む測定値オブジェクト

リターン値の型

測定

property maximum

レンダリングに必要な最大セル数

property minimum

レンダリングに必要な最小セル数

normalize()[source]

minimum <= maximum かつ minimum >= 0 を確実にする測定値を取得します

リターン

正規化された測定値

リターン値の型

測定

property span: int

maximum と minimum の差分を取得します

with_maximum(width)[source]

幅が <= width の RenderableWith を取得します。

パラメータ

width (int) – 最大希望の幅

リターン

新しい Measurement オブジェクト。

リターン値の型

測定

with_minimum(width)[source]

幅が >= width の RenderableWith を取得します。

パラメータ

width (int) – 最小希望の幅

リターン

新しい Measurement オブジェクト。

リターン値の型

測定

rich.measure.measure_renderables(console, options, renderables)[source]

複数のレンダラブルに収まる測定値を取得します。

パラメータ

  • console (Console) – コンソールインスタンス

  • options (ConsoleOptions) – コンソールオプション

  • renderables (Iterable[RenderableType]) – 1 つ以上のレンダラブルオブジェクト

リターン

指定されたすべてのレンダラブルを含めるために必要な

文字幅の範囲を含む測定値オブジェクト

リターン値の型

測定