rich.style

class rich.style.Style(*, color=None, bgcolor=None, bold=None, dim=None, italic=None, underline=None, blink=None, blink2=None, reverse=None, conceal=None, strike=None, underline2=None, frame=None, encircle=None, overline=None, link=None, meta=None)

ターミナルスタイル。

ターミナルスタイルは、色（color）、背景色（bgcolor）、および太字や斜体などの多数の属性で構成されます。属性には3つの状態があります。オン（True）、オフ（False）、または未設定（None）のいずれかです。

パラメーター

• color (Union[Color, str], optional) – ターミナルテキストの色。デフォルトはNone。

• bgcolor (Union[Color, str], optional) – ターミナルの背景色。デフォルトはNone。

• bold (bool, optional) – 太字テキストを有効にします。デフォルトはNone。

• dim (bool, optional) – ディムテキストを有効にします。デフォルトはNone。

• italic (bool, optional) – 斜体テキストを有効にします。デフォルトはNone。

• underline (bool, optional) – 下線付きテキストを有効にします。デフォルトはNone。

• blink (bool, optional) – 点滅テキストを有効にします。デフォルトはNone。

• blink2 (bool, optional) – 高速点滅テキストを有効にします。デフォルトはNone。

• reverse (bool, optional) – 反転テキストを有効にします。デフォルトはNone。

• conceal (bool, optional) – 隠蔽テキストを有効にします。デフォルトはNone。

• strike (bool, optional) – 取り消し線テキストを有効にします。デフォルトはNone。

• underline2 (bool, optional) – 二重下線付きテキストを有効にします。デフォルトはNone。

• frame (bool, optional) – フレーム付きテキストを有効にします。デフォルトはNone。

• encircle (bool, optional) – 丸で囲まれたテキストを有効にします。デフォルトはNone。

• overline (bool, optional) – 上線付きテキストを有効にします。デフォルトはNone。

• link (str, link) – リンクURL。デフォルトはNone。

• meta (Optional[Dict[str, Any]]) –

property background_style: Style

背景のみのスタイル。

property bgcolor: Optional[Color]

背景色。設定されていない場合はNone。

classmethod chain(*styles)

位置引数のスタイルを組み合わせて、単一のスタイルにします。

パラメーター

*styles (Iterable[Style]) – 組み合わせるスタイル。

戻り値

新しいスタイルインスタンス。

戻り値の型

Style

clear_meta_and_links()

リンクとメタ情報が削除されたこのスタイルのコピーを取得します。

戻り値

新しいスタイルオブジェクト。

戻り値の型

Style

property color: Optional[Color]

前景色。設定されていない場合はNone。

classmethod combine(styles)

スタイルを組み合わせて結果を取得します。

パラメーター

styles (Iterable[Style]) – 組み合わせるスタイル。

戻り値

新しいスタイルインスタンス。

戻り値の型

Style

copy()

このスタイルのコピーを取得します。

戻り値

同じ属性を持つ新しいStyleインスタンス。

戻り値の型

Style

classmethod from_color(color=None, bgcolor=None)

色のみを持ち、属性を持たない新しいスタイルを作成します。

戻り値

(前景色) color、または色なしの場合は None。デフォルトは None です。bgcolor (Optional[Color]): (背景色) color、または色なしの場合は None。デフォルトは None です。

戻り値の型

color (Optional[Color])

パラメーター

• color (Optional[Color]) –

• bgcolor (Optional[Color]) –

classmethod from_meta(meta)

メタデータを持つ新しいスタイルを作成します。

戻り値

メタデータの辞書。デフォルトは None です。

戻り値の型

meta (Optional[Dict[str, Any]])

パラメーター

meta (Optional[Dict[str, Any]]) –

get_html_style(theme=None)

CSS スタイルルールを取得します。

パラメーター

theme (Optional[TerminalTheme]) –

戻り値の型

str

property link: Optional[str]

設定されている場合、リンクテキスト。

property link_id: str

リンク用の ANSI コードで使用されるリンク ID を取得します。

property meta: Dict[str, Any]

メタ情報を取得します（構築後は変更できません）。

classmethod normalize(style)

同じ効果を持つスタイルが同じ文字列表現を持つように、スタイル定義を正規化します。

パラメーター

style (str) – スタイル定義。

戻り値

スタイル定義の正規形。

戻り値の型

str

classmethod null()

Style()と同等ですが、よりパフォーマンスの高い「null」スタイルを作成します。

戻り値の型

Style

classmethod on(meta=None, **handlers)

メタ情報付きの空白スタイルを作成します。

例

style = Style.on(click=self.on_click)

パラメーター

• meta (Optional[Dict[str, Any]], optional) – メタ情報のオプションの辞書。

• **handlers (Any) – キーワード引数はハンドラーに変換されます。

戻り値

メタ情報が添付されたスタイル。

戻り値の型

Style

classmethod parse(style_definition)

スタイル定義を解析します。

パラメーター

style_definition (str) – スタイルを含む文字列。

Raises

errors.StyleSyntaxError – スタイル定義の構文が無効な場合。

戻り値

スタイルインスタンス。

戻り値の型

Style

classmethod pick_first(*values)

最初に None でないスタイルを選択します。

パラメーター

values (Optional[Union[str, Style]]) –

戻り値の型

Union[str, Style]

render(text='', *, color_system=ColorSystem.TRUECOLOR, legacy_windows=False)

スタイルの ANSI コードをレンダリングします。

パラメーター

• text (str, optional) – スタイルを設定する文字列。デフォルトは "" です。

• color_system (Optional[ColorSystem], optional) – レンダリングする色システム。デフォルトは ColorSystem.TRUECOLOR です。

• legacy_windows (bool) –

戻り値

ANSI スタイルコードを含む文字列。

戻り値の型

str

test(text=None)

スタイル付きのテキストをターミナルに直接書き込みます。

このメソッドはテスト目的でのみ使用してください。

パラメーター

text (Optional[str], optional) – スタイルを設定するテキスト、またはスタイル名の場合は None。

戻り値の型

None

property transparent_background: bool

スタイルが透明な背景を指定しているかどうかを確認します。

update_link(link=None)

リンクの値が異なるコピーを取得します。

パラメーター

link (str, optional) – linkの新しい値。デフォルトはNoneです。

戻り値

新しいStyleインスタンス。

戻り値の型

Style

property without_color: Style

色を取り除いたスタイルのコピーを取得します。

class rich.style.StyleStack(default_style)

スタイルのスタック。

パラメーター

default_style (Style) –

property current: Style

スタックの最上部にあるStyleを取得します。

pop()

最後のスタイルをポップして破棄します。

戻り値

新しい現在のスタイル（stack.currentとしても利用可能）

戻り値の型

Style

push(style)

スタックに新しいスタイルをプッシュします。

パラメーター

style (Style) – 現在のスタイルと組み合わせる新しいスタイル。

戻り値の型

None