Skip to main content

No project description provided

Project description


# aioshim


## Description

The main purpose of this lib is to provide *asyncio* compatible versions of the functions in the standard library. E.g. `itertools.chain()` doesn't work with `async_generators`, so there is `aioshim.itertools.chain()` to fill the gap. Etc.

I'm sure the stdlib will catch up with this sooner or later. This lib is for those who need a shim as soon as possible.

This could be a central repo for all such *asyncio* related shims.

If there is interest, this repo could be maintained by a github *aioshim* org or something.


## Requirements

aioshim requires Python `>= 3.6`


## Install

pip install aioshim

or

pipenv install aioshim


## Development

Just clone the repo and run:

pipenv install --dev

This project uses [yapf](https://github.com/google/yapf) formatter.


<br/>

# Library Documentation

* [builtins](#builtins)
* [aenumerate](#aenumerate)
* [itertools](#itertools)
* [chain](#itertoolschainiterables)
* [chain_from_iterable](#itertoolschain_from_iterableiterable)

## builtins

### `aenumerate`

Async version of: [enumerate](https://docs.python.org/3.6/library/functions.html#enumerate)

Example:

```python

async for i in aenumerate(chain(a_gen, range(10))):
print(i)

```

## itertools


### `itertools.chain(*iterables)`

Async version of: [itertools.chain](https://docs.python.org/3.6/library/itertools.html#itertools.chain)

This function can handle `AsyncGeneratorType`.

Example:

```python
# Use with async_generator:
async for i in chain(my_async_gen1, my_async_gen2):
print(i)

# Allows for mixing normal generators with async generators:
async for i in chain(my_async_gen, range(10)):
print(i)
```


### `itertools.chain_from_iterable(iterable)`

Async version of: [itertools.chain.from_iterable](https://docs.python.org/3.6/library/itertools.html#itertools.chain.from_iterable)

This function can handle `AsyncGeneratorType`.

Example:

```python
# Use with async_generator:
async for i in chain_from_iterable(my_async_generator):
print(i)

# Works with normal items as well:
async for i in chain_from_iterable([range(10)]):
print(i)tertoolschain_from_iterableiterable
```


## More items to come

Pull requests appreciated!



Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
aioshim-0.0.3-py3-none-any.whl (4.6 kB) Copy SHA256 hash SHA256 Wheel 3.6

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page