rs_rich.ext

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rs_rich.ext: the rs-rich-ext crate from Python (no Rich counterpart).

Everything the port adds on top of Rich: diagnostics and stack traces, structured data, diffs and test reports, transforms, workflow renderables, terminal capabilities, inspectors and the extension registry. Each Rust module is a submodule here (diagnostic, stacktrace, dashboard, hyperlink, highlighter, event, log_handler, data, transform, diff, workflow, cancel, transfer, countdown, notify, table, badge, size_bar, format, redact, capabilities, fidelity, a11y, ansi_explain, sanitize, encoding, target, frame, source_view, hex, unicode_inspect, env_inspect, derive, layout, live, theme, cli_doc, testing, qa); this package re-exports all of them.

MAX_TRACE_CAUSES module-attribute

MAX_TRACE_CAUSES: int

EVENT_KEYWORDS module-attribute

EVENT_KEYWORDS: List[Any]

DATA_FORMATS module-attribute

DATA_FORMATS: List[Any]

SECRET_KEYS module-attribute

SECRET_KEYS: List[Any]

DIFF_STYLES module-attribute

DIFF_STYLES: List[Any]

WORKFLOW_STATES module-attribute

WORKFLOW_STATES: List[Any]

WORKFLOW_STYLES module-attribute

WORKFLOW_STYLES: List[Any]

TRANSFER_STYLES module-attribute

TRANSFER_STYLES: List[Any]

TABLE_STYLES module-attribute

TABLE_STYLES: List[Any]

BADGE_STYLES module-attribute

BADGE_STYLES: List[Any]

SIZE_BAR_STYLES module-attribute

SIZE_BAR_STYLES: List[Any]

REDACT_DETECTORS module-attribute

REDACT_DETECTORS: List[Any]

CAPABILITY_OVERRIDE_VARS module-attribute

CAPABILITY_OVERRIDE_VARS: List[Any]

FIDELITY_LEVELS module-attribute

FIDELITY_LEVELS: List[Any]

MAX_BYTES_PER_LINE module-attribute

MAX_BYTES_PER_LINE: int

OS_PATH_SEPARATOR module-attribute

OS_PATH_SEPARATOR: str

EXTRA_STYLES module-attribute

EXTRA_STYLES: List[Any]

STYLE_TABLES module-attribute

STYLE_TABLES: List[Any]

HELP_STYLES module-attribute

HELP_STYLES: List[Any]

HELP_STACK_BELOW module-attribute

HELP_STACK_BELOW: int

COMPLETION_SHELLS module-attribute

COMPLETION_SHELLS: List[Any]

Diagnostic

causes property

causes: Any

code property writable

code: Any

code_url property writable

code_url: Any

help property

help: Any

hyperlinker property writable

hyperlinker: Any

labels property

labels: Any

level property writable

level: Any

location property writable

location: Any

message property

message: Any

notes property

notes: Any

overflow property writable

overflow: Any

suggestions property

suggestions: Any

trace property writable

trace: Any

view property writable

view: Any

add_cause

add_cause(message: Any) -> Any

add_help

add_help(message: Any) -> Any

add_label

add_label(message: Any) -> Any

add_metadata

add_metadata(key: Any, value: Any) -> Any

add_note

add_note(message: Any) -> Any

add_snippet

add_snippet(snippet: Any) -> Any

add_suggestion

add_suggestion(suggestion: Any) -> Any

error classmethod

error(message: Any, **kwargs: Any) -> Any

from_exception classmethod

from_exception(exception: Any, *, max_depth: Any = ..., level: Any = ..., trace: Any = ..., view: Any = ...) -> Any

warning classmethod

warning(message: Any, **kwargs: Any) -> Any

Location

column property

column: Any

line property

line: Any

path property

path: Any

SourceSnippet

location property

location: Any

name property

name: Any

primary

primary(start: Any, end: Any, label: Any = ...) -> Any

secondary

secondary(start: Any, end: Any, label: Any = ...) -> Any

Suggestion

message property

message: Any

replace classmethod

replace(message: Any, source: Any, start: Any, end: Any, replacement: Any) -> Any

DiagnosticSpanError

Bases: ExtError

StackTrace

cause property

cause: Any

cause_kind property

cause_kind: Any

frames property

frames: Any

hyperlinker property writable

hyperlinker: Any

kind property

kind: Any

language property

language: Any

location property

location: Any

message property

message: Any

omitted_causes property

omitted_causes: Any

origin property

origin: Any

show_library property writable

show_library: Any

chain

chain() -> Any

from_exception staticmethod

from_exception(exception: Any) -> Any

parse staticmethod

parse(text: Any, *, parsers: Any = ...) -> Any

TraceFrame

column property

column: Any

function property

function: Any

library property

library: Any

line property

line: Any

metadata property

metadata: Any

path property

path: Any

source property

source: Any

DiagnosticsDashboard

min_level property writable

min_level: Any

top_codes property writable

top_codes: Any

counts

counts() -> Any

extend

extend(diagnostics: Any) -> Any

push

push(diagnostic: Any) -> Any

Hyperlinker

enabled property

enabled: Any

disabled staticmethod

disabled() -> Any

file_url

file_url(path: Any, line: Any = ..., column: Any = ...) -> Any

find

find(text: Any) -> Any

highlight

highlight(text: Any) -> Any

location

location(path: Any, line: Any = ..., column: Any = ..., style: Any = ...) -> Any

reference_url

reference_url(number: Any, repo: Any = ...) -> Any

FoundLink

end property

end: Any

start property

start: Any

url property

url: Any

NumberHighlighter

highlight

highlight(text: Any) -> Any

StructuredEvent

fields property

fields: Any

message property

message: Any

severity property

severity: Any

add_diagnostic

add_diagnostic(diagnostic: Any) -> Any

field

field(key: Any, value: Any) -> Any

EventHandler

emit

emit(console: Any, event: Any) -> Any

level_text staticmethod

level_text(severity: Any) -> Any

render

render(event: Any) -> Any

render_message

render_message(event: Any) -> Any

HandledEvent

DataNode

alias property

alias: Any

anchor property

anchor: Any

comment property

comment: Any

is_container property

is_container: Any

position property

position: Any

type_name property

type_name: Any

value property

value: Any

xml_kind property

xml_kind: Any

at

at(path: Any) -> Any

from_python staticmethod

from_python(value: Any) -> Any

get

get(key: Any, default: Any = ...) -> Any

keys

keys() -> Any

redacted

redacted(redaction: Any) -> Any

to_json

to_json(*, indent: Any = ...) -> Any

to_python

to_python() -> Any

walk

walk() -> Any

Explorer

max_depth property writable

max_depth: Any

max_length property writable

max_length: Any

max_string property writable

max_string: Any

node property

node: Any

root_label property writable

root_label: Any

show_paths property writable

show_paths: Any

show_types property writable

show_types: Any

view property writable

view: Any

fold

fold(at: Any) -> Any

highlight

highlight(at: Any, style: Any) -> Any

TableView

FlatView

SearchQuery

SearchMatch

matched_on property

matched_on: Any

node property

node: Any

path property

path: Any

SearchResults

DataChange

kind property

kind: Any

new property

new: Any

old property

old: Any

path property

path: Any

DataDiffView

Redaction

matches_key

matches_key(key: Any) -> Any

secrets staticmethod

secrets() -> Any

ConfigFileView

DataJson

Document

highlights property

highlights: Any

label property

label: Any

node property

node: Any

explorer

explorer() -> Any

Select

expression property

expression: Any

apply

apply(document: Any) -> Any

Filter

expression property

expression: Any

apply

apply(document: Any) -> Any

Highlight

expression property

expression: Any

apply

apply(document: Any) -> Any

Redact

apply

apply(document: Any) -> Any

DataError

Bases: ExtError

SelectError

Bases: ExtError

Pipeline

apply

apply(value: Any) -> Any

names

names() -> Any

then

then(name: Any, stage: Any) -> Any

KeepLines

invert property

invert: Any

pattern property

pattern: Any

apply

apply(text: Any) -> Any

HighlightMatches

pattern property

pattern: Any

apply

apply(text: Any) -> Any

TransformError

Bases: ExtError

PipelineError

Bases: TransformError

Hunk

header property

header: Any

new_range property

new_range: Any

old_range property

old_range: Any

ops property

ops: Any

TextDiff

context property

context: Any

is_equal property

is_equal: Any

new_lines property

new_lines: Any

old_lines property

old_lines: Any

ops property

ops: Any

hunks

hunks() -> Any

stats

stats() -> Any

unified

unified(old_name: Any = ..., new_name: Any = ...) -> Any

DiffView

is_equal property

is_equal: Any

from_diff classmethod

from_diff(diff: Any, *, layout: Any = ..., line_numbers: Any = ..., wrap: Any = ..., titles: Any = ..., emphasis: Any = ...) -> Any

stats

stats() -> Any

style_changed_lines

style_changed_lines() -> Any

SourceDiff

view

view() -> Any

FilePatch

additions property

additions: Any

binary property

binary: Any

deletions property

deletions: Any

hunks property

hunks: Any

mode_changed property

mode_changed: Any

new_mode property

new_mode: Any

new_path property

new_path: Any

old_mode property

old_mode: Any

old_path property

old_path: Any

path property

path: Any

similarity property

similarity: Any

status property

status: Any

Patch

files property

files: Any

stats

stats() -> Any

Annotation

TemplateLinks

file_url

file_url(path: Any) -> Any

line_url

line_url(path: Any, line: Any) -> Any

PatchView

patch property

patch: Any

KeepFiles

apply

apply(patch: Any) -> Any

TestCase

actual property

actual: Any

classname property

classname: Any

details property

details: Any

duration property

duration: Any

expected property

expected: Any

full_name property

full_name: Any

is_failure property

is_failure: Any

message property

message: Any

name property

name: Any

status property

status: Any

stderr property

stderr: Any

stdout property

stdout: Any

TestSuite

cases property

cases: Any

duration property

duration: Any

name property

name: Any

time

time() -> Any

totals

totals() -> Any

TestRun

duration property

duration: Any

is_success property

is_success: Any

suites property

suites: Any

from_junit staticmethod

from_junit(xml: Any) -> Any

from_libtest staticmethod

from_libtest(json: Any) -> Any

time

time() -> Any

to_junit_xml

to_junit_xml() -> Any

totals

totals() -> Any

TestReport

run property

run: Any

PatchParseError

Bases: ExtError

TestParseError

Bases: ExtError

ManualClock

advance

advance(seconds: Any) -> Any

now

now() -> Any

set

set(seconds: Any) -> Any

TaskTree

is_finished property

is_finished: Any

title property

title: Any

add

add(label: Any, parent: Any = ...) -> Any

cancel

cancel(task: Any) -> Any

cancel_all

cancel_all() -> Any

children

children(task: Any) -> Any

counts

counts() -> Any

elapsed

elapsed(task: Any) -> Any

fail

fail(task: Any, message: Any) -> Any

get_note

get_note(task: Any) -> Any

get_progress

get_progress(task: Any) -> Any

label

label(task: Any) -> Any

leaves

leaves() -> Any

note

note(task: Any, note: Any) -> Any

overall

overall() -> Any

parent

parent(task: Any) -> Any

progress

progress(task: Any, completed: Any, total: Any = ...) -> Any

root_token

root_token() -> Any

roots

roots() -> Any

skip

skip(task: Any, reason: Any = ...) -> Any

start

start(task: Any) -> Any

state

state(task: Any) -> Any

succeed

succeed(task: Any) -> Any

summary

summary(*, next_steps: Any = ..., show_all_items: Any = ..., symbols: Any = ..., policy: Any = ...) -> Any

sync_cancelled

sync_cancelled() -> Any

tasks

tasks() -> Any

token

token(task: Any) -> Any

total_elapsed

total_elapsed() -> Any

view

view(*, collapse_finished: Any = ..., show_durations: Any = ..., symbols: Any = ..., animate: Any = ..., policy: Any = ...) -> Any

warn

warn(task: Any, message: Any) -> Any

TaskTreeView

SummaryItem

detail property

detail: Any

duration property

duration: Any

label property

label: Any

state property

state: Any

from_record classmethod

from_record(record: Any) -> Any

CompletionSummary

counts

counts() -> Any

overall

overall() -> Any

CommandRecord

args property

args: Any

command_line property

command_line: Any

cwd property

cwd: Any

detail property

detail: Any

duration property writable

duration: Any

lines property

lines: Any

program property

program: Any

returncode property

returncode: Any

state property

state: Any

status property writable

status: Any

success property

success: Any

diagnostic

diagnostic() -> Any

output

output(stream: Any = ...) -> Any

push

push(stream: Any, text: Any) -> Any

view

view(*, tail: Any = ..., full_on_failure: Any = ..., show_cwd: Any = ..., show_diagnostic: Any = ..., help: Any = ..., symbols: Any = ..., animate: Any = ..., policy: Any = ...) -> Any

CommandView

CancelToken

is_cancelled property

is_cancelled: Any

cancel

cancel() -> Any

child

child() -> Any

Transfer

attempt property

attempt: Any

completed property

completed: Any

direction property

direction: Any

error property

error: Any

eta property

eta: Any

finished property

finished: Any

fraction property

fraction: Any

name property

name: Any

rate property

rate: Any

state property

state: Any

total property writable

total: Any

advance

advance(nbytes: Any, *, now: Any = ...) -> Any

cancel

cancel() -> Any

fail

fail(reason: Any) -> Any

finish

finish(*, now: Any = ...) -> Any

pause

pause(*, now: Any = ...) -> Any

retry

retry(reason: Any) -> Any

start

start(*, now: Any = ...) -> Any

task_fields

task_fields() -> Any

update

update(nbytes: Any, *, now: Any = ...) -> Any

wrap_reader

wrap_reader(file: Any, *, cancel: Any = ...) -> Any

wrap_writer

wrap_writer(file: Any, *, cancel: Any = ...) -> Any

Transfers

summary property writable

summary: Any

finished

finished() -> Any

push

push(transfer: Any) -> Any

rate

rate() -> Any

TransferReader

read

read(size: Any = ...) -> Any

TransferWriter

flush

flush() -> Any

write

write(data: Any) -> Any

TransferCancelled

Bases: ExtError

Backoff

max_attempts property

max_attempts: Any

delay

delay(attempt: Any) -> Any

delays

delays(limit: Any = ...) -> Any

status

status(attempt: Any, reason: Any) -> Any

CountdownBar

RetryStatus

giving_up property

giving_up: Any

status property

status: Any

at

at(seconds: Any) -> Any

RateLimit

at

at(seconds: Any) -> Any

Notification

message property

message: Any

status property

status: Any

title property

title: Any

ttl property

ttl: Any

Notifications

dismiss

dismiss(id: Any) -> Any

expire

expire(now: Any) -> Any

messages

messages() -> Any

next_expiry

next_expiry() -> Any

push

push(notification: Any, now: Any) -> Any

take_log

take_log() -> Any

DataColumn

header property

header: Any

cell

cell(v: Any) -> Any

SortKey

column property

column: Any

descending property

descending: Any

lexical property

lexical: Any

Aggregate

column property

column: Any

compute

compute(values: Any) -> Any

custom staticmethod

custom(column: Any, function: Any) -> Any

GroupBy

column property

column: Any

label property

label: Any

TableData

headers property

headers: Any

rows property

rows: Any

extend

extend(rows: Any) -> Any

order

order() -> Any

push

push(values: Any) -> Any

sort_by

sort_by(keys: Any) -> Any

TableSort

apply

apply(data: Any) -> Any

TableGroup

apply

apply(data: Any) -> Any

StreamingTable

evicted property

evicted: Any

window property writable

window: Any

clear

clear() -> Any

get

get(key: Any) -> Any

invalidate

invalidate() -> Any

remove

remove(key: Any) -> Any

reset_stats

reset_stats() -> Any

rows

rows() -> Any

sort_by

sort_by(keys: Any) -> Any

stats

stats() -> Any

to_data

to_data() -> Any

update_cell

update_cell(key: Any, column: Any, v: Any) -> Any

upsert

upsert(key: Any, values: Any) -> Any

Badge

plain property

plain: Any

label staticmethod

label(text: Any, *, style: Any = ..., symbols: Any = ...) -> Any

link staticmethod

link(text: Any, url: Any, *, style: Any = ..., symbols: Any = ..., show_url: Any = ...) -> Any

meta staticmethod

meta(key: Any, value: Any, *, style: Any = ..., symbols: Any = ...) -> Any

status staticmethod

status(status: Any, message: Any, *, style: Any = ..., symbols: Any = ...) -> Any

Badges

plain property

plain: Any

SizeBar

is_high property

is_high: Any

is_over property

is_over: Any

ratio property

ratio: Any

limit staticmethod

limit(used: Any, limit: Any, *, label: Any = ..., units: Any = ..., bar_width: Any = ..., warn_at: Any = ..., show_sizes: Any = ..., show_percent: Any = ...) -> Any

Redactor

is_empty property

is_empty: Any

capture

capture(renderable: Any, *, width: Any = ..., color: Any = ...) -> Any

export_html

export_html(renderable: Any, *, width: Any = ..., inline_styles: Any = ...) -> Any

export_svg

export_svg(renderable: Any, *, width: Any = ..., title: Any = ..., unique_id: Any = ...) -> Any

export_text

export_text(renderable: Any, *, width: Any = ...) -> Any

find

find(line: Any) -> Any

redact

redact(text: Any) -> Any

redact_ansi

redact_ansi(text: Any) -> Any

redact_args

redact_args(args: Any) -> Any

redact_byte_chunks

redact_byte_chunks(chunks: Any) -> Any

redact_chunks

redact_chunks(chunks: Any) -> Any

redact_segments

redact_segments(segments: Any) -> Any

secrets staticmethod

secrets() -> Any

RedactMatch

end property

end: Any

kind property

kind: Any

start property

start: Any

Redacted

RedactPatternError

Bases: ExtError

CapabilityReport

animation property

animation: Any

ci property

ci: Any

color property

color: Any

color_system property

color_system: Any

graphics property

graphics: Any

height property

height: Any

hyperlinks property

hyperlinks: Any

interactive property

interactive: Any

sixel property

sixel: Any

terminal property

terminal: Any

unicode property

unicode: Any

warnings property

warnings: Any

width property

width: Any

rows

rows() -> Any

Degrade

AccessibilityPolicy

compact property

compact: Any

high_contrast property

high_contrast: Any

monochrome property

monochrome: Any

no_animation property

no_animation: Any

reduced_motion property

reduced_motion: Any

screen_reader property

screen_reader: Any

status_symbols property

status_symbols: Any

warnings property

warnings: Any

fidelity_ceiling

fidelity_ceiling() -> Any

for_high_contrast staticmethod

for_high_contrast() -> Any

for_monochrome staticmethod

for_monochrome() -> Any

for_reduced_motion staticmethod

for_reduced_motion() -> Any

for_screen_reader staticmethod

for_screen_reader() -> Any

from_env staticmethod

from_env(env: Any = ...) -> Any

status

status(status: Any) -> Any

theme

theme(theme: Any = ...) -> Any

ContrastFinding

kind property

kind: Any

ratio property

ratio: Any

severity property

severity: Any

style_name property

style_name: Any

suggestion property

suggestion: Any

describe

describe() -> Any

ContrastReport

AnsiToken

effects property

effects: Any

kind property

kind: Any

length property

length: Any

meaning property

meaning: Any

offset property

offset: Any

raw property

raw: Any

Explanation

tokens property

tokens: Any

visible_text property

visible_text: Any

escapes

escapes() -> Any

invalid

invalid() -> Any

ExplanationView

inline_text

inline_text(ascii: Any = ...) -> Any

EncodingError

Bases: ExtError

RenderTarget

capabilities property

capabilities: Any

kind property

kind: Any

frame

frame(renderable: Any) -> RenderFrame

segments

segments(renderable: Any) -> Any

text

text(renderable: Any) -> Any

RenderFrame

rs_rich.ext.frame.Frame: a render as rows of styled runs (rich_ext::frame).

height property

height: int

width property

width: int

ends_with_newline property

ends_with_newline: bool

run_count property

run_count: int

style_count property

style_count: int

from_segments staticmethod

from_segments(segments: Iterable[Segment]) -> RenderFrame

from_console staticmethod

from_console(console: Console, renderable: Any, options: Optional[ConsoleOptions] = None) -> RenderFrame

row_width

row_width(row: int) -> int

row

row(row: int) -> List[Tuple[str, int, Optional[Style]]]

cells

cells(row: int) -> List[Tuple[str, int, Optional[Style]]]

plain

plain() -> str

to_ansi

to_ansi(console: Console) -> str

to_ansi_merged

to_ansi_merged(console: Console) -> str

encode

encode(color_system: Optional[str] = 'truecolor', no_color: bool = False) -> str

encode_span

encode_span(row: int, start: int, end: int, color_system: Optional[str] = 'truecolor', no_color: bool = False) -> str

merged

merged() -> RenderFrame

diff

diff(previous: RenderFrame) -> List[Tuple[int, range]]

SourceView

matches

matches() -> Any

HexView

data property

data: Any

offset_digits property

offset_digits: Any

line_width

line_width(n: Any) -> Any

resolved_bytes_per_line

resolved_bytes_per_line(width: Any) -> Any

GraphemeCluster

code_points property

code_points: Any

data property

data: Any

escape property

escape: Any

hex property

hex: Any

kind property

kind: Any

offset property

offset: Any

text property

text: Any

width property

width: Any

display

display(ascii: Any = ...) -> Any

UnicodeView

clusters

clusters() -> Any

summary

summary() -> Any

summary_text

summary_text() -> Any

EnvView

is_redacted

is_redacted(name: Any) -> Any

vars

vars() -> Any

PathView

name property

name: Any

entries

entries() -> Any

problems

problems() -> Any

RecordField

label property

label: Any

value property

value: Any

Record

fields property

fields: Any

title property

title: Any

from_object classmethod

from_object(obj: Any, *, title: Any = ..., presentation: Any = ...) -> Any

RecordsTable

Constraint

flex property

flex: Any

max property

max: Any

min property

min: Any

preferred property

preferred: Any

fixed staticmethod

fixed(size: Any) -> Any

LayoutNode

split staticmethod

split(axis: Any, children: Any, *, width: Any = ..., height: Any = ..., content_width: Any = ..., content_height: Any = ..., align: Any = ..., overflow: Any = ...) -> Any

validate

validate() -> Any

Overflowing

overflow property

overflow: Any

ConstraintError

Bases: ExtError

LiveCoordinator

add

add(renderable: Any) -> Any

countdown

countdown(total: Any, frame: Any, *, tick: Any = ..., cancel: Any = ..., animate: Any = ..., policy: Any = ..., sleep: Any = ...) -> Any

finish

finish() -> Any

present

present(notifications: Any, now: Any) -> Any

print

print(renderable: Any) -> Any

refresh

refresh() -> Any

remove

remove(region: Any) -> Any

resize

resize(width: Any, height: Any) -> Any

update

update(region: Any, renderable: Any) -> Any

RegionId

LiveCoordinatorError

Bases: ExtError

ArgSpec

choices property

choices: Any

group property

group: Any

help property

help: Any

id property

id: Any

long property

long: Any

metavar property

metavar: Any

names property

names: Any

primary property

primary: Any

short property

short: Any

switches property

switches: Any

takes_value property

takes_value: Any

flag staticmethod

flag(long: Any, **kwargs: Any) -> Any

option staticmethod

option(long: Any, **kwargs: Any) -> Any

positional staticmethod

positional(name: Any, **kwargs: Any) -> Any

CommandSpec

about property

about: Any

args property

args: Any

display_name property

display_name: Any

name property

name: Any

subcommands property

subcommands: Any

version property

version: Any

completion

completion(shell: Any) -> Any

completion_catalog

completion_catalog() -> Any

config_reference

config_reference() -> Any

find_subcommand

find_subcommand(name: Any) -> Any

help

help(*, long: Any = ..., path: Any = ...) -> Any

markdown

markdown() -> Any

subcommand_names

subcommand_names() -> Any

switch_names

switch_names() -> Any

to_man

to_man(section: Any = ..., date: Any = ...) -> Any

to_man_pages

to_man_pages(section: Any = ..., date: Any = ...) -> Any

to_markdown

to_markdown() -> Any

unknown

unknown(argument: Any) -> Any

usage_lines

usage_lines() -> Any

HelpView

MarkdownReference

CompletionCatalog

items

items() -> Any

CliError

argument property

argument: Any

exit_code property

exit_code: Any

headline property

headline: Any

kind property

kind: Any

suggestions property

suggestions: Any

invalid_value classmethod

invalid_value(argument: Any, value: Any, possible: Any) -> Any

missing_required classmethod

missing_required(arguments: Any) -> Any

missing_value classmethod

missing_value(argument: Any) -> Any

to_diagnostic

to_diagnostic() -> Any

unknown_argument classmethod

unknown_argument(argument: Any, candidates: Any) -> Any

unknown_subcommand classmethod

unknown_subcommand(name: Any, candidates: Any) -> Any

ConfigEntry

ConfigReference

from_spec classmethod

from_spec(spec: Any, *, description: Any = ..., sources: Any = ..., entries: Any = ...) -> Any

to_markdown

to_markdown() -> Any

ConfigLayer

Precedence

explain

explain(key: Any) -> Any

resolve

resolve() -> Any

PrecedenceExplanation

key property

key: Any

shadowed property

shadowed: Any

value property

value: Any

winner property

winner: Any

ExtError

Bases: Exception

parse_stacktrace

parse_stacktrace(text: Any, *, parsers: Any = ...) -> Any

parse_data

parse_data(content: Any, format: Any = ..., *, name: Any = ...) -> Any

detect_format

detect_format(content: Any, name: Any = ...) -> Any

format_for

format_for(file_name: Any) -> Any

flatten

flatten(data: Any) -> Any

unflatten

unflatten(leaves: Any) -> Any

search

search(data: Any, query: Any = ..., **kwargs: Any) -> Any

select

select(data: Any, expression: Any, *, backend: Any = ...) -> Any

selector_backends

selector_backends() -> Any

diff_data

diff_data(old: Any, new: Any) -> Any

diff_sequences

diff_sequences(old: Any, new: Any) -> Any

diff_lines

diff_lines(old: Any, new: Any) -> Any

diff_words

diff_words(old: Any, new: Any) -> Any

diff_chars

diff_chars(old: Any, new: Any) -> Any

tokenize

tokenize(text: Any) -> Any

hunk_header

hunk_header(old: Any, new: Any) -> Any

group_hunks

group_hunks(ops: Any, context: Any = ...) -> Any

parse_patch

parse_patch(text: Any) -> Any

state_marker

state_marker(state: Any, symbols: Any = ...) -> Any

state_label

state_label(state: Any, count: Any) -> Any

run_command

run_command(args: Any, *, cwd: Any = ..., env: Any = ..., cancel: Any = ..., tick: Any = ..., on_update: Any = ...) -> Any

remaining_label

remaining_label(seconds: Any) -> Any

countdown_wait

countdown_wait(total: Any, *, tick: Any = ..., cancel: Any = ..., on_tick: Any = ..., sleep: Any = ...) -> Any

format_size

format_size(n: Any, *, units: Any = ...) -> Any

format_rate

format_rate(bytes_per_second: Any) -> Any

format_duration

format_duration(seconds: Any, *, ascii: Any = ...) -> Any

format_clock

format_clock(seconds: Any) -> Any

format_relative

format_relative(then: Any, now: Any) -> Any

format_timestamp

format_timestamp(t: Any) -> Any

format_percent

format_percent(ratio: Any, decimals: Any = ...) -> Any

format_number

format_number(n: Any) -> Any

format_compact

format_compact(n: Any) -> Any

is_secret_key

is_secret_key(key: Any) -> Any

detect_capabilities

detect_capabilities(env: Any = ..., *, terminal: Any = ..., size: Any = ..., windows: Any = ..., color: Any = ..., unicode: Any = ..., hyperlinks: Any = ..., graphics: Any = ..., sixel: Any = ..., animation: Any = ..., interactive: Any = ..., width: Any = ..., height: Any = ...) -> Any

select_fidelity

select_fidelity(*, unicode: Any = ..., color: Any = ..., interactive: Any = ..., animation: Any = ..., ceiling: Any = ..., floor: Any = ..., allow_animation: Any = ...) -> Any

degrade_segments

degrade_segments(segments: Any, level: Any) -> Any

ascii_text

ascii_text(text: Any) -> Any

status_marker

status_marker(status: Any, symbols: Any = ...) -> Any

contrast_ratio

contrast_ratio(a: Any, b: Any) -> Any

relative_luminance

relative_luminance(color: Any) -> Any

delta_e

delta_e(a: Any, b: Any) -> Any

to_lab

to_lab(color: Any) -> Any

simulate_deficiency

simulate_deficiency(color: Any, deficiency: Any) -> Any

suggest_color

suggest_color(fg: Any, bg: Any, min_ratio: Any = ...) -> Any

check_theme

check_theme(theme: Any = ..., *, backgrounds: Any = ..., min_ratio: Any = ..., error_ratio: Any = ..., cvd_threshold: Any = ..., groups: Any = ...) -> Any

semantic_text

semantic_text(renderable: Any, width: Any = ...) -> Any

accessible_text

accessible_text(renderable: Any, width: Any = ...) -> Any

explain

explain(text: Any) -> Any

sgr_effects

sgr_effects(params: Any) -> Any

csi_meaning

csi_meaning(params: Any, intermediates: Any, final: Any) -> Any

osc_meaning

osc_meaning(data: Any) -> Any

control_name

control_name(byte: Any) -> Any

escape_visible

escape_visible(raw: Any) -> Any

sanitize_terminal_controls

sanitize_terminal_controls(text: Any) -> Any

sanitize_terminal_and_bidi_controls

sanitize_terminal_and_bidi_controls(text: Any) -> Any

sanitize_single_line

sanitize_single_line(text: Any) -> Any

is_bidi_control

is_bidi_control(char: Any) -> Any

decode_text

decode_text(data: Any, encoding: Any) -> Any

has_utf16_bom

has_utf16_bom(data: Any) -> Any

resolve_target_capabilities

resolve_target_capabilities(*, width: Any = ..., height: Any = ..., is_terminal: Any = ..., color_system: Any = ..., unicode: Any = ..., hyperlinks: Any = ..., sixel: Any = ..., overrides: Any = ...) -> Any

find_all

find_all(haystack: Any, needle: Any) -> Any

byte_class

byte_class(byte: Any) -> Any

classify_cluster

classify_cluster(cluster: Any, width: Any) -> Any

control_picture

control_picture(char: Any, ascii: Any = ...) -> Any

is_secret_name

is_secret_name(name: Any) -> Any

redact_value

redact_value(value: Any) -> Any

name_matches

name_matches(pattern: Any, name: Any) -> Any

is_path_like

is_path_like(name: Any, value: Any, separator: Any = ...) -> Any

records_table

records_table(records: Any) -> Any

allocate

allocate(total: Any, constraints: Any) -> Any

fit_segments

fit_segments(segments: Any, width: Any, overflow: Any = ...) -> Any

extended_theme

extended_theme() -> Any

suggest

suggest(input: Any, candidates: Any) -> Any

render_snapshot

render_snapshot(renderable: Any, *, target: Any = ..., width: int = ...) -> Dict[str, Any]

assert_render_eq

assert_render_eq(renderable: Any, expected: str, width: int = ..., message: Optional[str] = ...) -> None

assert_str_eq

assert_str_eq(left: str, right: str, message: Optional[str] = ...) -> None

assert_json_eq

assert_json_eq(left: Any, right: Any, message: Optional[str] = ...) -> None

highlighter_conformance

highlighter_conformance(highlighter: Any, *, all_themes: bool = ..., scaling: bool = ...) -> None

qa_screenshot

qa_screenshot(name: str, renderable: Any, *, widths: Optional[List[int]] = ..., color: Optional[List[str]] = ..., unicode: Optional[List[bool]] = ..., hyperlinks: bool = ..., height: Optional[int] = ..., approvals: Any = ..., approve: Optional[bool] = ...) -> List[Dict[str, Any]]

qa_stress

qa_stress(renderable: Any, *, widths: Optional[List[int]] = ..., heights: Optional[List[Optional[int]]] = ..., unicode: bool = ..., line_tolerance: int = ..., strict_minimum: bool = ...) -> QaReport

qa_lint

qa_lint(renderable: Any, *, widths: Optional[List[int]] = ..., color: str = ..., unicode: bool = ..., hyperlinks: bool = ..., layout: bool = ...) -> QaReport

qa_explain

qa_explain(renderable: Any, target: Any = ..., *, width: int = ...) -> QaReport

qa_profile

qa_profile(renderable: Any, *, width: int = ..., iterations: int = ..., warmup: int = ..., frame: Optional[Tuple[int, int]] = ...) -> QaReport

qa_fuzz

qa_fuzz(seed: int = ..., cases: int = ...) -> QaReport

qa_matrix

qa_matrix(fixtures: Dict[str, Any], *, profiles: Optional[List[str]] = ..., width: int = ...) -> QaReport

qa_bench

qa_bench(name: str, renderable: Any, *, width: int = ..., warmup: float = ..., target_time: float = ..., min_samples: int = ..., max_samples: int = ...) -> QaReport