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) -- 终端文本的颜色。默认为无。

  • bgcolor (Union[Color, str], optional) -- 终端背景的颜色。默认为无。

  • bold (bool, optional) -- 启用粗体文本。默认为无。

  • dim (bool, optional) -- 启用暗显文本。默认为无。

  • italic (bool, optional) -- 启用斜体文本。默认为无。

  • underline (bool, optional) -- 启用带下划线的文本。默认为无。

  • blink (bool, optional) -- 已启用闪烁文本。默认为无。

  • blink2 (bool, optional) -- 启用快速闪烁文本。默认为无。

  • reverse (bool, optional) -- 已启用反转文本。默认为无。

  • conceal (bool, optional) -- 启用隐藏文本。默认为无。

  • strike (bool, optional) -- 启用删除线文本。默认为无。

  • underline2 (bool, optional) -- 启用双下划线文本。默认为无。

  • frame (bool, optional) -- 启用带框架的文本。默认为无。

  • encircle (bool, optional) -- 启用环绕文本。默认为无。

  • overline (bool, optional) -- 启用带上划线的文本。默认为无。

  • link (str, link) -- 链接URL。默认为无。

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

property background_style: Style

仅带背景的样式。

property bgcolor: Optional[Color]

背景颜色，如果未设置，则为无。

classmethod chain(*styles)[源代码]

将位置参数中的样式合并为单一样式。

参数

*styles (Iterable[Style]) -- 要组合的样式。

返回

一个新的样式实例。

返回类型

Style

获取此样式的副本，删除链接和元信息。

返回

新样式对象。

返回类型

Style

property color: Optional[Color]

前景色，如果未设置，则为无。

classmethod combine(styles)[源代码]

组合风格，获得效果。

参数

styles (Iterable[Style]) -- 要组合的样式。

返回

一个新的样式实例。

返回类型

Style

copy()[源代码]

买一件这种款式的。

返回

具有相同属性的新样式实例。

返回类型

Style

classmethod from_color(color=None, bgcolor=None)[源代码]

创建不带属性且带有颜色的新样式。

返回

一种(前景)颜色，或无，表示无颜色。默认为无。BGCOLOR(可选 [Color] )：一种(背景)颜色，或无，表示无颜色。默认为无。

返回类型

color (Optional[Color])

参数
classmethod from_meta(meta)[源代码]

使用元数据创建新样式。

返回

元数据词典。默认为无。

返回类型

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

参数

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

get_html_style(theme=None)[源代码]

获取一条css样式规则。

参数

theme (Optional[TerminalTheme]) --

返回类型

str

链接文本(如果设置)。

获取链接ID，在用于链接的ansi代码中使用。

property meta: Dict[str, Any]

获取元信息(构造后不能更改)。

classmethod normalize(style)[源代码]

规格化样式定义，使具有相同效果的样式具有相同的字符串表示形式。

参数

style (str) -- 样式定义。

返回

样式定义的范式。

返回类型

str

classmethod null()[源代码]

创建一个‘Null’样式，等同于style()，但更具表现力。

返回类型

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) -- 包含样式的字符串。

抛出

errors.StyleSyntaxError -- 如果样式定义语法无效。

返回

一个Style实例。

返回类型

Style

classmethod pick_first(*values)[源代码]

选择第一个非无样式。

参数

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

property transparent_background: bool

检查样式是否指定了透明背景。

获取具有不同LINK值的副本。

参数

link (str, optional) -- 链接的新值。默认为无。

返回

一个新的样式实例。

返回类型

Style

property without_color: Style

获取一份去掉颜色的样式副本。

class rich.style.StyleStack(default_style)[源代码]

一堆款式。

参数

default_style (Style) --

property current: Style

获取堆栈顶部的样式。

pop()[源代码]

弹出最后一种样式并放弃。

返回

新的当前样式(也可以作为stack.Current提供)

返回类型

Style

push(style)[源代码]

将新样式推送到堆栈上。

参数

style (Style) -- 与当前样式相结合的新样式。

返回类型

None