Port of Sodium - Functional Reactive Programming (FRP) library - to Python.
Just pip install sodiumfrp
.
This library is based on two types:
Stream
and Cell
.
Stream
represents a stream of events, while Cell
represents a value that changes over time.
There is also a bunch of primitives that you can use to build streams/cells and to compose them together.
They provide means for doing common operations like mapping, filtering, reduction, flat-mapping and more.
All of them are implemented as members of
Stream
and Cell
classes.
In situations, where a stream or cell needs to be referenced before it is assigned, use
StreamLoop
or
CellLoop
.
Stream
and Cell
lets you model your business logic in a purely functional way.
In order to provide your model with input data, use
StreamSink
and
CellSink
.
And, whenever you need to get data out of the model, use
Stream.listen()
and Cell.listen()
.
When an input value is pushed into a stream or cell, Sodium automatically starts a transaction.
Any state changes, that occur as a result of that input, are performed within the same transaction.
Most of the time you don't need to do anything, but it is possible to start a transaction explicitly via
Transaction.run()
.
For example:
- It often makes sense for all the program initialization to be wrapped in a single, big transaction.
StreamLoop
andCellLoop
require an explicit transaction.
The most comprehensive guide on FRP and this library would be the book Functional Reactive Programming by Stephen Blackheath. Even though, the book aims Java, it is pretty straightforward to map it into Python.
See examples directory.
To run the tests, execute pytest
from the package directory.
To build API reference, go to docs
directory and run make html
.
It requires sphinx
and sphinx-rtd-theme
packages to be installed.
Distributed under BSD 3-Clause.