anyiostream

Getting Started

  • Getting Started
    • Installation
    • Your First Pipeline
    • What Just Happened?
    • Adding Concurrency
    • Using Pipe Syntax
    • Next Steps

Guide

  • Pipeline Basics
    • Stream Constructors
      • Stream.from_iterable(items)
      • Stream.from_callable(factory)
    • Transform Stages
      • .map(fn, *, workers=1, buffer_size=0, name=None)
      • .flat_map(fn, *, workers=1, buffer_size=0, name=None)
      • .filter(pred, *, workers=1, buffer_size=0, name=None)
      • .foreach(fn, *, workers=1, buffer_size=0, name=None)
    • Terminal Operations
      • .collect() → list[T]
      • .count() → int
      • .reduce(fn, initial) → U
      • .first() → T | None
      • .take(n) → list[T]
      • .open() → AsyncContextManager
      • .collect_split() → tuple[list, list]
    • Stage Options
  • Concurrency & Workers
    • Execution Model
    • Fan-Out Workers
    • Backpressure & Buffer Sizing
      • Tuning Guidelines
    • Structured Concurrency
    • Both Backends
  • Error Handling
    • The Problem
    • Result Types
      • Ok[T]
      • Err[E]
      • Pattern Matching (Python 3.12+)
    • Result-Aware Stages
      • try_map(fn, *, err=None)
      • try_flat_map(fn, *, err=None)
      • try_filter(pred)
      • try_foreach(fn, *, err=None)
    • The err=handler Option
    • Exit Ramps
      • recover(fn)
      • ok_only()
      • errors_only()
      • collect_split()
    • Full Example

API Reference

  • Stream
    • Stream
      • Stream.__init__()
      • Stream.from_iterable()
      • Stream.from_callable()
      • Stream.map()
      • Stream.flat_map()
      • Stream.filter()
      • Stream.foreach()
      • Stream.flatten()
      • Stream.collect()
      • Stream.count()
      • Stream.reduce()
      • Stream.first()
      • Stream.take()
      • Stream.open()
    • Constructors
      • Stream.from_iterable(source)
      • Stream.from_callable(factory)
    • Transform Stages
      • .map(fn, *, workers=1, buffer_size=0, name=None)
      • .flat_map(fn, *, workers=1, buffer_size=0, name=None)
      • .filter(pred, *, workers=1, buffer_size=0, name=None)
      • .foreach(fn, *, workers=1, buffer_size=0, name=None)
    • Result-Aware Stages
      • .try_map(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • .try_flat_map(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • .try_filter(pred, *, workers=1, buffer_size=0, name=None)
      • .try_foreach(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • .recover(fn, *, workers=1, buffer_size=0, name=None)
      • .ok_only()
      • .errors_only()
    • Terminal Operations
      • await stream.collect() → list[T]
      • await stream.count() → int
      • await stream.reduce(fn, initial) → U
      • await stream.first() → T | None
      • await stream.take(n) → list[T]
      • async with stream.open() as recv
      • await stream.collect_split() → tuple[list, list]
    • Pipe Operator
  • Pipe Operators
    • _Pipe
      • _Pipe.map()
      • _Pipe.flat_map()
      • _Pipe.filter()
      • _Pipe.foreach()
      • _Pipe.flatten()
      • _Pipe.collect()
      • _Pipe.count()
      • _Pipe.try_map()
      • _Pipe.try_flat_map()
      • _Pipe.try_filter()
      • _Pipe.try_foreach()
      • _Pipe.recover()
      • _Pipe.ok_only()
      • _Pipe.errors_only()
      • _Pipe.collect_split()
    • Transform Operators
      • pipe.map(fn, *, workers=1, buffer_size=0, name=None)
      • pipe.flat_map(fn, *, workers=1, buffer_size=0, name=None)
      • pipe.filter(pred, *, workers=1, buffer_size=0, name=None)
      • pipe.foreach(fn, *, workers=1, buffer_size=0, name=None)
    • Terminal Operators
      • pipe.collect()
      • pipe.count()
      • pipe.collect_split()
    • Result-Aware Operators
      • pipe.try_map(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • pipe.try_flat_map(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • pipe.try_filter(pred, *, workers=1, buffer_size=0, name=None)
      • pipe.try_foreach(fn, *, err=None, workers=1, buffer_size=0, name=None)
      • pipe.recover(fn, *, workers=1, buffer_size=0, name=None)
      • pipe.ok_only()
      • pipe.errors_only()
  • Result Types
    • PipelineError
      • PipelineError.exception
      • PipelineError.item
      • PipelineError.stage
      • PipelineError.traceback
      • PipelineError.exception
      • PipelineError.item
      • PipelineError.stage
      • PipelineError.traceback
      • PipelineError.__init__()
    • Ok
      • Ok.value
      • Ok.is_ok()
      • Ok.is_err()
      • Ok.unwrap()
      • Ok.unwrap_or()
      • Ok.unwrap_err()
      • Ok.map()
      • Ok.map_err()
      • Ok.__init__()
    • Err
      • Err.error
      • Err.is_ok()
      • Err.is_err()
      • Err.unwrap()
      • Err.unwrap_or()
      • Err.unwrap_err()
      • Err.map()
      • Err.map_err()
      • Err.__init__()
    • Result
    • Ok[T]
      • Methods
    • Err[E]
      • Methods
    • PipelineError
      • Fields
      • String Representation
    • Result Type Alias
    • Pattern Matching
  • Process & Pipeline Internals
    • ProcessKind
    • ProcessConfig
      • Fields
      • Validation
    • Process
      • Fields
      • Execution Model
    • ResultStages (mixin)
      • Stages
      • Exit Ramps

More

  • Comparison
    • anyiostream vs aiostream vs raw anyio
    • Concurrency Model: The Core Difference
      • aiostream — Generator Pull Chain
      • anyiostream — CSP Channel Graph
    • What Raw anyio Requires
    • When to Use What
    • Honest Gaps
anyiostream
  • Search

© Copyright 2025, randyt.

Built with Sphinx using a theme provided by Read the Docs.