Sniff out which async library your code is running under
Switch branches/tags
Nothing to show
Clone or download
Latest commit 113123e Nov 24, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci
docs
newsfragments
sniffio Add test for curio Nov 15, 2018
.coveragerc
.gitignore Implement everything Jul 28, 2018
.readthedocs.yml
.style.yapf
.travis.yml
CHEATSHEET.rst
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
LICENSE.APACHE2
LICENSE.MIT
MANIFEST.in Initial commit Jul 28, 2018
README.rst
pyproject.toml
setup.py
test-requirements.txt

README.rst

Join chatroom Documentation Status Latest PyPi version Latest conda-forge version Automated test status Test coverage

sniffio: Sniff out which async library your code is running under

You're writing a library. You've decided to be ambitious, and support multiple async I/O packages, like Trio, and asyncio, and ... You've written a bunch of clever code to handle all the differences. But... how do you know which piece of clever code to run?

This is a tiny package whose only purpose is to let you detect which async library your code is running under.

This library is maintained by the Trio project, as a service to the async Python community as a whole.

Quickstart

from sniffio import current_async_library
import trio
import asyncio

async def print_library():
    library = current_async_library()
    print("This is:", library)

# Prints "This is trio"
trio.run(print_library)

# Prints "This is asyncio"
asyncio.run(print_library())

For more details, including how to add support to new async libraries, please peruse our fine manual.