tt - the Boolean expression toolbox¶
Welcome to the documentation site for tt.
Warning
tt is heavily tested and fully usable, but is still pre-1.0/stable software with no guarantees of avoiding breaking API changes until hitting version 1.0.
Synopsis¶
tt is a Python library and command-line tool for working with Boolean expressions. Please check out the project site for more information.
Installation¶
tt is tested on CPython 2.7, 3.3, 3.4, 3.5, and 3.6 as well as PyPy. tt is written in pure Python with no dependencies, so it only requires a compatible Python installation to run. You can get the latest release from PyPI with:
pip install ttable
Basic Usage¶
Below are a couple of examples to show you the kind of things tt can do. For more examples and further documentation, take a look at the project site.
As a Library¶
tt aims to provide a Pythonic interface for working with Boolean expressions. Here are some simple examples from the REPL:
>>> from tt import BooleanExpression, TruthTable
>>> b = BooleanExpression('A xor (B and 1)')
>>> b.tokens
['A', 'xor', '(', 'B', 'and', '1', ')']
>>> b.symbols
['A', 'B']
>>> print(b.tree)
xor
`----A
`----and
`----B
`----1
>>> b.evaluate(A=True, B=False)
True
>>> t = TruthTable(b)
>>> print(t)
+---+---+---+
| A | B | |
+---+---+---+
| 0 | 0 | 0 |
+---+---+---+
| 0 | 1 | 1 |
+---+---+---+
| 1 | 0 | 1 |
+---+---+---+
| 1 | 1 | 0 |
+---+---+---+
>>> t = TruthTable('A or B', fill_all=False)
>>> print(t)
Empty!
>>> t.fill(A=0)
>>> print(t)
+---+---+---+
| A | B | |
+---+---+---+
| 0 | 0 | 0 |
+---+---+---+
| 0 | 1 | 1 |
+---+---+---+
>>> t.fill(A=1)
>>> print(t)
+---+---+---+
| A | B | |
+---+---+---+
| 0 | 0 | 0 |
+---+---+---+
| 0 | 1 | 1 |
+---+---+---+
| 1 | 0 | 1 |
+---+---+---+
| 1 | 1 | 1 |
+---+---+---+
From the Command Line¶
tt also provides a command-line interface for working with expressions. Here are a couple of examples:
$ tt tokens "(op1 nand op2) xnor op3"
(
op1
nand
op2
)
xnor
op3
$ tt table A or B
+---+---+---+
| A | B | |
+---+---+---+
| 0 | 0 | 0 |
+---+---+---+
| 0 | 1 | 1 |
+---+---+---+
| 1 | 0 | 1 |
+---+---+---+
| 1 | 1 | 1 |
+---+---+---+
$ tt tree A or or B
Error! Unexpected binary operator "or":
A or or B
^
API Docs¶
Feel free to peruse through the source, or take a look through the auto-generated api docs below.