Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reactivex/rxpy

ReactiveX for Python
https://github.com/reactivex/rxpy

python reactive reactive-extensions reactivex rxpy

Last synced: 15 days ago
JSON representation

ReactiveX for Python

Awesome Lists containing this project

README 

        
===============================

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

`_.



ReactiveX for Python v4.x runs on `Python `_ 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

`_ 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

`_ section.



There is also a list of third party documentation available `here

`_.



Community

----------



Join the conversation on GitHub `Discussions

`_! if you have any questions or

suggestions.



Differences from .NET and RxJS

------------------------------



ReactiveX for Python is a fairly complete implementation of

`Rx `_ with more than

`120 operators `_, and

over `1300 passing unit-tests `_. 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 `_, 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

`_ 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 `_. Code is formatted

using `Black `_, `isort

`_. Code is statically type checked using `pyright

`_ and `mypy `_.



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