asyncer - GitLite

KO | EN

gitlite — search

#javascript #react #ai #typescript #go #deep-learning #docker #macos #java #awesome #cli #kubernetes #vue #openai

asyncer

(★ 2,483)

Asyncer, async and await, focused on developer experience.

파일 탐색기

최종 버전 다운로드 (.zip)

- - add-to-project.yml
  - build-docs.yml
  - bump-pre-commit-hooks.yml
  - create-draft-release.yml
  - deploy-docs.yml
  - detect-conflicts.yml
  - guard-dependencies.yml
  - issue-manager.yml
  - pre-commit.yml
  - prepare-release.yml
  - publish.yml
  - smokeshow.yml
  - test-redistribute.yml
  - test.yml
  - zizmor.yml
- dependabot.yml
- latest-changes.yml
- pr-push.yml
- pr-submit.yml
- __init__.py
- _compat.py
- _main.py
- py.typed
- - index.md
- - custom.css
  - termynal.css
- - favicon.png
  - github-social-preview.png
  - github-social-preview.svg
  - icon-white.svg
  - icon.svg
- - custom.js
  - termynal.js
- - index.md
- - asyncify.md
  - first-steps.md
  - index.md
  - install.md
  - runnify.md
  - soonify-return.md
  - soonify.md
  - syncify-no-raise.md
  - syncify.md
- contributing.md
- help.md
- index.md
- management.md
- release-notes.md
- - __init__.py
- __init__.py
- add_latest_release_date.py
- deploy_docs_status.py
- docs.py
- format.sh
- lint.sh
- prepare_release.py
- test.sh
- - __init__.py
- __init__.py
- conftest.py
- test_others.py
- test_param_cancellable.py
- test_prepare_release.py
- test_syncify_no_raise.py
.gitignore
.pre-commit-config.yaml
.python-version
CITATION.cff
LICENSE
mkdocs.env.yml
mkdocs.yml
pyproject.toml
README.md
uv.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/fastapi/asyncer

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd asyncer

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Python

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

pip install .

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <a href="https://asyncer.tiangolo.com"><img src="https://asyncer.tiangolo.com/img/logo-margin/logo-margin-vector.svg" alt="Asyncer"></a>
</p>
<p align="center">
    <em>Asyncer, async and await, focused on developer experience.</em>
</p>
<p align="center">
<a href="https://github.com/fastapi/asyncer/actions?query=workflow%3ATest+event%3Apush+branch%3Amain">
    <img src="https://github.com/fastapi/asyncer/actions/workflows/test.yml/badge.svg?event=push&branch=main" alt="Test">
</a>
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/asyncer">
    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/asyncer.svg" alt="Coverage">
<a href="https://pypi.org/project/asyncer">
    <img src="https://img.shields.io/pypi/v/asyncer?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
</p>

---

**Documentation**: [https://asyncer.tiangolo.com](https://asyncer.tiangolo.com)

**Source Code**: [https://github.com/fastapi/asyncer](https://github.com/fastapi/asyncer)

---

**Asyncer** is a small library built on top of [AnyIO](https://anyio.readthedocs.io/en/stable/).

**Asyncer** has a small number of utility functions that allow working with `async`, `await`, and concurrent code in a more convenient way under my ([@tiangolo - Sebastián Ramírez](https://twitter.com/tiangolo)) very opinionated and subjective point of view.

The main goal of **Asyncer** is to improve **developer experience** by providing better support for **autocompletion** and **inline errors** in the editor, and **more certainty** that the code is **bug-free** by providing better support for type checking tools like **mypy**.

**Asyncer** also tries to improve **convenience** and simplicity when working with **async** code **mixed** with regular <abbr title="synchronous code, code that is not async">**blocking code**</abbr>, allowing to use them together in a simpler way... again, under my very **subjective** point of view.

## Can I Use It?

Yes 🎉 (but continue reading).

This is a very small library, there are things that can change and improve in the future.

If you use it, **pin the exact Asyncer version** for your project, to make sure it all works.

Have **tests** for your project (as you should, anyway). And **upgrade the version** once you know that the new version continues to work correctly.

Still, it's **just 4 functions**, so there's not much to change, if you had to refactor your code to update something it would not be much.

And if you don't want to add `asyncer` as a dependency to your project, you can also just copy the main file and try out those functions, it's quite small (but in that case you won't get updates easily).

## Requirements

As **Asyncer** is based on **AnyIO** it will be also installed automatically when you install **Asyncer**.

## Installation

First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add Asyncer to your project:

<div class="termy">

```console
$ uv add asyncer
---> 100%
```

</div>

If you prefer to use `pip`, install `asyncer` inside a virtual environment. See the [installation guide](tutorial/install.md) for the alternative steps.

## How to Use

You can read more about each of the use cases and utility functions in **Asyncer** in the [tutorial](https://asyncer.tiangolo.com/tutorial/).

As a sneak preview of one of the utilities, you can **call sync code from async code** using `asyncify()`:

```Python
import time

import anyio
from asyncer import asyncify

def do_sync_work(name: str):
    time.sleep(1)
    return f"Hello, {name}"

async def main():
    message = await asyncify(do_sync_work)(name="World")
    print(message)

anyio.run(main)
```

**Asyncer**'s `asyncify()` will use AnyIO underneath to do *the smart thing*, avoid blocking the main **async** event loop, and run the **sync**/blocking function in a **worker thread**.

### Editor Support

Everything in **Asyncer** is designed to get the best **developer experience** possible, with the best editor support.

* **Autocompletion** for function arguments:

<img class="shadow" src="https://asyncer.tiangolo.com/img/tutorial/asyncify/image01.png">

* **Autocompletion** for return values:

<img class="shadow" src="https://asyncer.tiangolo.com/img/tutorial/asyncify/image02.png">

* **Inline errors** in editor:

<img class="shadow" src="https://asyncer.tiangolo.com/img/tutorial/soonify/image02.png">

* Support for tools like **mypy**, that can help you verify that your **code is correct**, and prevent many bugs.

## License

This project is licensed under the terms of the [MIT license](https://github.com/fastapi/asyncer/blob/main/LICENSE).