aiter() Function in Python Syntax, Parameters, and Examples

What is aiter() Function in Python?

In Python 3.10, the aiter() function was added. This function returns an asynchronous iterator for an asynchronous iterable. This article will show you how to use the aiter() function in Python. We will look at how to change an asynchronous iterator into an asynchronous iterable.

aiter() Syntax

The syntax of the aiter() function in Python is as follows:

aiter(iter)

aiter() Parameters

aiter() Return Value

aiter() Function returns asynchronous iterator.

Example of aiter() Function in Python

Now, we’ll look at some examples of the aiter() function in Python.

If you want to test the Python code in this lesson, you will need to use a code editor like PyCharm. But if you want to run this code online, we also have a free Online Compiler in Python that you can use to test your Python code.

Example 1

In this example, we will find the sum.

async def sum(iterable, start=0):
    async for x in aiter(iterable):
        start += x
 
    return start

Example 2

In this example, we will use the if-else statement to check True/False in any element.

async def any(iterable):
    async for element in aiter(iterable):
        if element:
            return True
    return False

The any() function checks whether or not any element is True. You can check some additional information regarding any() function in the Python documentation about any() built-in function.

Example 3

In this example, we will check if all the elements are True or False.

async def all(iterable):
    async for element in aiter(iterable):
        if not element:
            return False
    return True

The all() function checks whether or not all of the elements are True. It seems to work the same way in Python.

Example 4

In this example, we will sort the iterable.

async def sorted(iterable, *args, **kwargs):
    return aiter(sorted(await aitersync(iterable), *args, **kwargs))

The sorted() function sorts items asynchronously.

Example 5

In this example, we will find the maximum element.

async def max(iterable, key=None, default=_missing):
    if key is None:
        key = lambda x: x
    key = wrapsync(key)
 
    value = _missing
    kvalue = _missing
 
    async for x in aiter(iterable):
        kx = await key(x)
 
        if value is _missing:
            value = x
            kvalue = kx
        else:
            if kx > kvalue:
                value = x
                kvalue = kx
 
    if value is _missing:
        if default is not _missing:
            return default
 
        raise ValueError('max() arg is an empty sequence')
 
    return value

The max() function finds the maximum number of elements asynchronously.

Conclusion

In this tutorial, we’ve discussed the aiter() function is now the latest feature of Python 3.10 and is used to convert the asynchronous iterator for an asynchronous iterable. This is the end of our lesson on how to use the aiter() in Python with an example.

By the way, if you want additional knowledge about built-in functions in Python you can check out our article about Complete Python Built-in Functions with Syntax and Examples.

Lastly, I hope you now know what the aiter() function is and how to use it. If you missed any of our lessons, you can look at our list of Python Tutorial Topics.