Printing (and using) formatted text¶

`echo`¶

quo.echo() prints a message plus a newline to the given file or stdout. On first sight, this looks like the print function, but it has improved support for handling Unicode, binary data and formatted text. It will emit newline by default, which cab be suppressed by passing :param: nl=False

Parameters

text – the string to style with ansi or rgb color codes.
fg – if provided this will become the foreground color.
bg – if provided this will become the background color.
bold – if provided this will enable or disable bold mode.
dim – if provided this will enable or disable dim mode.
nl - if provided this will print a new line.
ul or underline – if provided this will enable or disable underline.
italic - if provided this will print data in italic.
blink – if provided this will enable or disable blinking.
strike -if provided this will print a strikethrough text.
hidden - if privided this will prevent the input from getting printed.
reverse – if provided this will enable or disable inverse rendering (foreground becomes background and the other way round).
reset – by default a reset-all code is added at the end of the string which means that styles do not carry over. This can be disabled to compose styles.

from quo import echo

echo("Hello, world!", nl=False)

from quo import echo

echo(b'\xe2\x98\x83')

Printing to Standard error¶

You can easily print to standard error by passing :param:err=True

from quo import echo

echo('Hello World!', err=True)

Here’s a list of supported color names:

black (might be a gray)
red
green
yellow (might be an orange)
blue
magenta
cyan
white (might be light gray)
vblack vibrant black
vblue
vmagenta
vwhite
vcyan
vred
vgreen
vyellow

`print`¶

quo ships with a print() function that’s meant to be (as much as possible) compatible with the built-in print function, and quo.echo(). It also supports color and formatting just like quo.echo() On Linux systems, this will output VT100 escape sequences, while on Windows it will use Win32 API calls or VT100 sequences, depending on what is available.

Parameters

color_depth - Instance of quo.color.ColorDepth
style - quo.style.Style instance for the color style.
fmt bool - Default is False, when True, you will be able to utilize an instance of quo.text.FormattedText. Added on v2022.4

Note

This page is also useful if you’d like to learn how to use formatting in other places, like in a prompt or a toolbar.

`Formatted text`¶

There are several ways to display colors:

By creating a quo.echo() function.
By creating a quo.print() function.
By creating a list of (style, text) tuples mapped to quo.print().

An instance of any of these three kinds of objects is called “formated text”.

Using quo.echo¶

from quo import echo

echo("This is bold", bold=True)
echo("This is italic", italic=True)
echo("This is underlined", underline=True)

# Colors from the ANSI palette

echo("This is red", fg="red")
echo("This is green", fg="green")

Using quo.print¶

print() can be used to indicate that a string contains HTML-like formatting. It recognizes the basic tags for bold, italic and underline: <b>, <i> and <u>.

Changed since v2022.3.5

from quo import print

print('<b>This is bold</b>')
print('<i>This is italic</i>')
print('<u>This is underlined</u>')

# Colors from the ANSI palette.
print('<red>This is red</red>')
print('<green>This is green</green>')

# Named colors (256 color palette, or true color, depending on the output).
print('<skyblue>This is sky blue</skyblue>')
print('<seagreen>This is sea green</seagreen>')
print('<violet>This is violet</violet>')

Both foreground and background colors can also be specified setting the fg and bg attributes of any Text tag:

# Colors from the ANSI palette.
print('<aaa fg="white" bg="green">White on green</aaa>')

Underneath, all Text tags are mapped to classes from a stylesheet, so you can assign a style for a custom tag.

from quo import print
from quo.style import Style

style = Style.add({
    'aaa': 'fg:red',
    'bbb': 'fg:blue italic'
    })

print('<aaa>Hello</aaa> <bbb>world</bbb>!', style=style)

`Using (style, text) tuples`¶

Note

» (style, text) tuples are currently unstable, however its a work in progress and stabiliy may improve on later versions of quo

It is possible to create a list of manually with :param:fmt

from quo import print
f

text = FormattedText([
    ('fg:red', 'Hello'),
    ('', ' '),
    ('fg:purple italic', 'World'),
  ])
print(text, fmt=True)

It is also possible to use class names, and separate the styling in a style sheet.

from quo import print
from quo.style import Style
from quo.text import FormattedText

# The text.
text = FormattedText([
     ('class:aaa', 'Hello'),
     ('', ' '),
     ('class:bbb', 'World'),
   ])

# The style sheet.
style = Style.add({
     'aaa': 'fg:green',
     'bbb': 'fg:blue italic',
  })

print(text, fmt=True, style=style)

» Check out more examples here

Printing (and using) formatted text¶

echo¶