Generator-based operators for asynchronous iteration

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for vxgmichel from gravatar.com vxgmichel

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

Generator-based operators for asynchronous iteration

Synopsis

aiostream provides a collection of stream operators that can be combined to create asynchronous pipelines of operations.

It can be seen as an asynchronous version of itertools, although some aspects are slightly different. Essentially, all the provided operators return a unified interface called a stream. A stream is an enhanced asynchronous iterable providing the following features:

  • Operator pipe-lining - using pipe symbol |

  • Repeatability - every iteration creates a different iterator

  • Safe iteration context - using async with and the stream method

  • Simplified execution - get the last element from a stream using await

  • Slicing and indexing - using square brackets []

  • Concatenation - using addition symbol +

Stream operators

The stream operators are separated in 7 categories:

creation

iterate, preserve, just, call, empty, throw, never, repeat, count, range

transformation

map, enumerate, starmap, cycle, chunks

selection

take, takelast, skip, skiplast, getitem, filter, until, takewhile, dropwhile

combination

map, zip, merge, chain, ziplatest

aggregation

accumulate, reduce, list

advanced

concat, flatten, switch, concatmap, flatmap, switchmap

timing

spaceout, timeout, delay

miscellaneous

action, print

Demonstration

The following example demonstrates most of the streams capabilities:

import asyncio
from aiostream import stream, pipe


async def main():

    # Create a counting stream with a 0.2 seconds interval
    xs = stream.count(interval=0.2)

    # Operators can be piped using '|'
    ys = xs | pipe.map(lambda x: x**2)

    # Streams can be sliced
    zs = ys[1:10:2]

    # Use a stream context for proper resource management
    async with zs.stream() as streamer:

        # Asynchronous iteration
        async for z in streamer:

            # Print 1, 9, 25, 49 and 81
            print('->', z)

    # Streams can be awaited and return the last value
    print('9² = ', await zs)

    # Streams can run several times
    print('9² = ', await zs)

    # Streams can be concatenated
    one_two_three = stream.just(1) + stream.range(2, 4)

    # Print [1, 2, 3]
    print(await stream.list(one_two_three))


# Run main coroutine
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()

More examples are available in the example section of the documentation.

Installation

You can install aiostream from PyPI as the aiostream package.

Contact

Vincent Michel: vxgmichel@gmail.com

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for vxgmichel from gravatar.com vxgmichel

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.7.1

0.7.0

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.6.0rc1 pre-release

0.5.2

0.5.1

0.5.0

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.6

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiostream-0.7.1.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiostream-0.7.1-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file aiostream-0.7.1.tar.gz.

File metadata

  • Download URL: aiostream-0.7.1.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aiostream-0.7.1.tar.gz
Algorithm Hash digest
SHA256 272aaa0d8f83beb906f5aa9022bb59046bb7a103fa3770f807c31f918595acf6
MD5 4289ce2b50c754a877cbe4c43a4bebd3
BLAKE2b-256 8b65b9b69695702b76a878c9879f2ee80cefce75bc5cb864fc100460bc1c5380

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiostream-0.7.1.tar.gz:

Publisher: ci.yml on vxgmichel/aiostream

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiostream-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: aiostream-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 41.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aiostream-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ea8739e9158ee6a606b3feedf3762721c3507344e540d09a10984c5e88a13b37
MD5 d7e28472fb7a0fa8b42440a758bdef51
BLAKE2b-256 52a0d7c6ca304140f3f49987d710e15bc164248924a35d8cdfac2f6e87fca041

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiostream-0.7.1-py3-none-any.whl:

Publisher: ci.yml on vxgmichel/aiostream

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page