1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
===============================
The ReactiveX for Python (RxPY)
===============================
.. image:: https://github.com/ReactiveX/RxPY/workflows/Python%20package/badge.svg
:target: https://github.com/ReactiveX/RxPY/actions
:alt: Build Status
.. image:: https://img.shields.io/coveralls/ReactiveX/RxPY.svg
:target: https://coveralls.io/github/ReactiveX/RxPY
:alt: Coverage Status
.. image:: https://img.shields.io/pypi/v/reactivex.svg
:target: https://pypi.org/project/reactivex/
:alt: PyPY Package Version
.. image:: https://img.shields.io/readthedocs/rxpy.svg
:target: https://readthedocs.org/projects/rxpy/builds/
:alt: Documentation Status
*A library for composing asynchronous and event-based programs using observable
collections and query operator functions in Python*
ReactiveX for Python v4
-----------------------
For v3.X please go to the `v3 branch
<https://github.com/ReactiveX/RxPY/tree/release/v3.2.x>`_.
ReactiveX for Python v4.x runs on `Python <http://www.python.org/>`_ 3.7 or above. To
install:
.. code:: console
pip3 install reactivex
About ReactiveX
---------------
ReactiveX for Python (RxPY) is a library for composing asynchronous and event-based
programs using observable sequences and pipable query operators in Python. Using Rx,
developers represent asynchronous data streams with Observables, query asynchronous data
streams using operators, and parameterize concurrency in data/event streams using
Schedulers.
.. code:: python
import reactivex as rx
from reactivex import operators as ops
source = rx.of("Alpha", "Beta", "Gamma", "Delta", "Epsilon")
composed = source.pipe(
ops.map(lambda s: len(s)),
ops.filter(lambda i: i >= 5)
)
composed.subscribe(lambda value: print("Received {0}".format(value)))
Learning ReactiveX
------------------
Read the `documentation
<https://rxpy.readthedocs.io/en/latest/>`_ to learn
the principles of ReactiveX and get the complete reference of the available
operators.
If you need to migrate code from RxPY v1.x or v3.x, read the `migration
<https://rxpy.readthedocs.io/en/latest/migration.html>`_ section.
There is also a list of third party documentation available `here
<https://rxpy.readthedocs.io/en/latest/additional_reading.html>`_.
Community
----------
Join the conversation on GitHub `Discussions
<https://github.com/ReactiveX/RxPY/discussions>`_! if you have any questions or
suggestions.
Differences from .NET and RxJS
------------------------------
ReactiveX for Python is a fairly complete implementation of
`Rx <http://reactivex.io/>`_ with more than
`120 operators <https://rxpy.readthedocs.io/en/latest/operators.html>`_, and
over `1300 passing unit-tests <https://coveralls.io/github/ReactiveX/RxPY>`_. RxPY
is mostly a direct port of RxJS, but also borrows a bit from Rx.NET and RxJava in
terms of threading and blocking operators.
ReactiveX for Python follows `PEP 8 <http://legacy.python.org/dev/peps/pep-0008/>`_, so
all function and method names are ``snake_cased`` i.e lowercase with words separated by
underscores as necessary to improve readability.
Thus .NET code such as:
.. code:: c#
var group = source.GroupBy(i => i % 3);
need to be written with an ``_`` in Python:
.. code:: python
group = source.pipe(ops.group_by(lambda i: i % 3))
With ReactiveX for Python you should use `named keyword arguments
<https://docs.python.org/3/glossary.html>`_ instead of positional arguments when an
operator has multiple optional arguments. RxPY will not try to detect which arguments
you are giving to the operator (or not).
Development
-----------
This project is managed using `Poetry <https://python-poetry.org/>`_. Code is formatted
using `Black <https://github.com/psf/black>`_, `isort
<https://github.com/PyCQA/isort>`_. Code is statically type checked using `pyright
<https://github.com/microsoft/pyright>`_ and `mypy <http://mypy-lang.org/>`_.
If you want to take advantage of the default VSCode integration, then
first configure Poetry to make its virtual environment in the
repository:
.. code:: console
poetry config virtualenvs.in-project true
After cloning the repository, activate the tooling:
.. code:: console
poetry install
poetry run pre-commit install
Run unit tests:
.. code:: console
poetry run pytest
Run code checks (manually):
.. code:: console
poetry run pre-commit run --all-files
|
