Operators¶

Chaining Operators¶

Each language-specific implementation of ReactiveX implements a set of operators. These are the operators specific to the Python implementation (RxPY).

Most operators operate on an Observable and return an Observable. This allows you to apply these operators one after the other, in a chain. Each operator in the chain modifies the Observable that results from the operation of the previous operator.

A chain of Observable operators do not operate independently on the original Observable that originates the chain, but they operate in turn, each one operating on the Observable generated by the operator immediately previous in the chain.

The Operators of RxPY¶

This page first lists what could be considered the core operators in ReactiveX, and links to pages that have more in-depth information on how these operators work and how particular language-specific ReactiveX versions have implemented these operators.

Next is a decision tree that may help you choose the operator that is most appropriate to your use case.

Finally, there is an alphabetical list of the operators available in RxPY. Other implementations of ReactiveX may implement different operators.

Creating Observables¶

Operators that originate new Observables.

• create – create an Observable from scratch by calling observer methods programmatically
• defer — do not create the Observable until the observer subscribes, and create a fresh Observable for each observer
• empty/never/throw — create Observables that have very precise and limited behavior
• from_ — convert some other object or data structure into an Observable
• interval — create an Observable that emits a sequence of integers spaced by a particular time interval
• just — convert an object or a set of objects into an Observable that emits that or those objects
• range — create an Observable that emits a range of sequential integers
• repeat — create an Observable that emits a particular item or sequence of items repeatedly
• start — create an Observable that emits the return value of a function
• timer — create an Observable that emits a single item after a given delay

Transforming Observables¶

Operators that transform items that are emitted by an Observable.

• buffer — periodically gather items from an Observable into bundles and emit these bundles rather than emitting the items one at a time
• flat_map — transform the items emitted by an Observable into Observables, then flatten the emissions from those into a single Observable
• group_by — divide an Observable into a set of Observables that each emit a different group of items from the original Observable, organized by key
• map — transform the items emitted by an Observable by applying a function to each item
• scan — apply a function to each item emitted by an Observable, sequentially, and emit each successive value
• window — periodically subdivide items from an Observable into Observable windows and emit these windows rather than emitting the items one at a time

Filtering Observables¶

Operators that selectively emit items from a source Observable.

• debounce — only emit an item from an Observable if a particular timespan has passed without it emitting another item
• distinct — suppress duplicate items emitted by an Observable
• element_at — emit only item n emitted by an Observable
• filter — emit only those items from an Observable that pass a predicate test
• first — emit only the first item, or the first item that meets a condition, from an Observable
• ignore_elements — do not emit any items from an Observable but mirror its termination notification
• last — emit only the last item emitted by an Observable
• sample — emit the most recent item emitted by an Observable within periodic time intervals
• skip — suppress the first n items emitted by an Observable
• skip_last — suppress the last n items emitted by an Observable
• take — emit only the first n items emitted by an Observable
• take_last — emit only the last n items emitted by an Observable

Combining Observables¶

Operators that work with multiple source Observables to create a single Observable

• and_/then/when — combine sets of items emitted by two or more Observables by means of Pattern and Plan intermediaries
• combine_latest — when an item is emitted by either of two Observables, combine the latest item emitted by each Observable via a specified function and emit items based on the results of this function
• join — combine items emitted by two Observables whenever an item from one Observable is emitted during a time window defined according to an item emitted by the other Observable
• merge — combine multiple Observables into one by merging their emissions
• start_with — emit a specified sequence of items before beginning to emit the items from the source Observable
• switch_latest/ — convert an Observable that emits Observables into a single Observable that emits the items emitted by the most-recently-emitted of those Observables
• zip — combine the emissions of multiple Observables together via a specified function and emit single items for each combination based on the results of this function

Error Handling Operators¶

Operators that help to recover from error notifications from an Observable

• catch_exception — recover from an onError notification by continuing the sequence without error
• retry — if a source Observable sends an onError notification, resubscribe to it in the hopes that it will complete without error

Observable Utility Operators¶

A toolbox of useful Operators for working with Observables

• delay — shift the emissions from an Observable forward in time by a particular amount
• do_action — register an action to take upon a variety of Observable lifecycle events
• materialize/dematerialize — represent both the items emitted and the notifications sent as emitted items, or reverse this process
• observe_on — specify the scheduler on which an observer will observe this Observable
• subscribe — operate upon the emissions and notifications from an Observable
• subscribe_on — specify the scheduler an Observable should use when it is subscribed to
• time_interval — convert an Observable that emits items into one that emits indications of the amount of time elapsed between those emissions
• timeout — mirror the source Observable, but issue an error notification if a particular period of time elapses without any emitted items
• timestamp — attach a timestamp to each item emitted by an Observable
• using — create a disposable resource that has the same lifespan as the Observable

Conditional and Boolean Operators¶

Operators that evaluate one or more Observables or items emitted by Observables

• all — determine whether all items emitted by an Observable meet some criteria
• amb — given two or more source Observables, emit all of the items from only the first of these Observables to emit an item
• contains — determine whether an Observable emits a particular item or not
• default_if_empty — emit items from the source Observable, or a default item if the source Observable emits nothing
• sequence_equal — determine whether two Observables emit the same sequence of items
• skip_until — discard items emitted by an Observable until a second Observable emits an item
• skip_while — discard items emitted by an Observable until a specified condition becomes false
• take_until — discard items emitted by an Observable after a second Observable emits an item or terminates
• take_while — discard items emitted by an Observable after a specified condition becomes false

Mathematical and Aggregate Operators¶

Operators that operate on the entire sequence of items emitted by an Observable

• average — calculates the average of numbers emitted by an Observable and emits this average
• concat — emit the emissions from two or more Observables without interleaving them
• count — count the number of items emitted by the source Observable and emit only this value
• max — determine, and emit, the maximum-valued item emitted by an Observable
• min — determine, and emit, the minimum-valued item emitted by an Observable
• reduce — apply a function to each item emitted by an Observable, sequentially, and emit the final value
• sum — calculate the sum of numbers emitted by an Observable and emit this sum

Backpressure Operators¶

• backpressure operators — strategies for coping with Observables that produce items more rapidly than their observers consume them

Connectable Observable Operators¶

Specialty Observables that have more precisely-controlled subscription dynamics

• publish — convert an ordinary Observable into a connectable Observable

• replay — ensure that all observers see the same sequence of emitted items, even if they subscribe after the Observable has begun emitting items

Operators to Convert Observables¶

• to — convert an Observable into another object or data structure