Write snippets of code in your documentation and execute them as regression tests.

View project on GitHub

Terminal Geometry

When byexample runs a set of examples, it spawns one or more runners inside a virtual terminal that is 24 lines high and 80 columns wide.

The dimension or geometry can affect how the runner will print in the terminal.

Consider the following Python examples that show a short and a long list of numbers:

>>> list(range(10))
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

>>> list(range(25))

Python’s pretty printer prints the first in one line because its width is less than 80; the second example, longer than the first, will span multiple lines.

byexample allows you to control the geometry of the virtual terminal:

>>> list(range(25))     # byexample: +geometry 24x127
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, <...>, 20, 21, 22, 23, 24]

The syntax is simply <number of lines>x<number of columns>

A warning note

Changing the geometry of the virtual terminal is totally dependent on the runner/interpreter used.

By default byexample sends a SIGWINCH signal to the interpreter which may or may not have an effect.

In addition to that, for Python, its pretty printer is modified too.

Changing geometry from the start

You may decide to set the geometry from the beginning. In this case it will affect all the interpreters.

Consider the examples in

$ byexample -l python,shell test/ds/
File "test/ds/", line 2
Failed example:
    echo ${LINES}x${COLUMNS}
File "test/ds/", line 6
Failed example:
    ['aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa']
['aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa', 'aaaaa']

They fail because the examples are expecting to be executed in a smaller terminal of size 24x60.

Here we have them pass:

$ byexample -l python,shell -o '+geometry 24x60' test/ds/
File test/ds/, 2/2 test ran in <...> seconds
[PASS] Pass: 2 Fail: 0 Skip: 0

byexample will pass the geometry to the runner in two special environment variables: LINES and COLUMNS.

This is only done at the beginning, if you change the geometry later these variables may not be updated.