Skip to main content

Async functions to compare with anyio and asyncio, and toolkit to read excel with async/await.

Project description

asynctor

Python Versions LatestVersionInPypi GithubActionResult pre-commit Coverage Status Mypy coverage Ruff

Some async functions that using anyio, and toolkit for excel read.

Installation

$ pip install asynctor
---> 100%
Successfully installed asynctor

with extras:

pip install "asynctor[xlsx,redis,fastapi]"

Or by pdm:

pdm add "asynctor[redis]"

Or by uv:

uv add asynctor

Or install the latest from github

uv pip install "asynctor @git+https://github.com/waketzheng/asynctor"

Or install by ssh

uv pip install "asynctor[redis] @git+ssh://git@github.com/waketzheng/asynctor.git"

Usage

  • Async function that compare asyncio but use anyio: bulk_gather/gather/run
>>> import asynctor
>>> async def foo():
...     return 1
...
>>> await asynctor.bulk_gather([foo(), foo()], limit=200)
(1, 1)
>>> await asynctor.gather(foo(), foo())
(1, 1)
>>> asynctor.run(gather(foo(), foo()))
(1, 1)
  • run_async: start a new thread to run async function and get result of it
>>> from asynctor import run_async
>>> async def foo(a=1):
...     return a
...
>>> run_async(foo) == run_async(foo()) == run_async(foo, 1) == 1
True
  • timeit/Timer
>>> import time
>>> import anyio
>>> from asynctor import timeit
>>> @timeit
... async def sleep_test():
...     await anyio.sleep(3)
...
>>> await sleep()
sleep_test Cost: 3.0 seconds

>>> @timeit
... def sleep_test2():
...     time.sleep(3.1)
...
>>> sleep_test2()
sleep_test2 Cost: 3.1 seconds
>>> with timeit('Sleeping'):
...     sleep()
...
Sleeping Cost: 3.0 seconds
>>> from loguru import logger
>>> with Timer('doing sth', verbose=False) as t:
...     time.sleep(0.222)
...
>>> logger.debug(t)
2026-06-10 12:07:55.658 | DEBUG    | __main__:<module>:1 - doing sth Cost: 0.2 seconds
>>> Timer.beijing_now()
datetime.datetime(2026, 6, 10, 12, 9, 1, 577094, tzinfo=asynctor.timing.ZoneInfo(key='Asia/Shanghai'))
  • AioRedis

pip install "asynctor[redis]"

from asynctor.contrib.fastapi import AioRedisDep, register_aioredis
from fastapi import FastAPI

app = FastAPI()
register_aioredis(app)

@app.get('/')
async def root(redis: AioRedisDep) -> list[str]:
    return await redis.keys()

@app.get('/redis')
async def get_value_from_redis_by_key(redis: AioRedisDep, key: str) -> str:
    value = await redis.get(key)
    if not value:
        return ''
    return value.decode()
  • Async Test Fixtures

pip install "asynctor[testing]"

import pytest
from asynctor.testing import anyio_backend_fixture, async_client_fixture
from httpx import AsyncClient

from main import app

anyio_backend = anyio_backend_fixture()
client = async_client_fixture(app)

@pytest.mark.anyio
async def test_api(client: AsyncClient):
    response = await client.get("/")
    assert response.status_code == 200
  • runserver for fastapi projects

pip install asynctor fastapi uvicorn

from fastapi import FastAPI

app = FastAPI()


def main() -> None:
    from asynctor.contrib.fastapi import runserver

    runserver(app)


if __name__ == '__main__':
    main()
  • Read Excel File

pandas/openpyxl is required, can be installed with xlsx extra: pip install "asynctor[xlsx]"

>>> from asynctor.xlsx import load_xlsx
>>> await load_xlsx('tests/demo.xlsx')
[{'Column1': 'row1-\\t%c', 'Column2\nMultiLines': 0, 'Column 3': 1, 4: ''}, {'Column1': 'r2c1\n00', 'Column2\nMultiLines': 'r2 c2', 'Column 3': 2, 4: ''}]
  • json

Auto use orjson if it's installed, fallback to standard json module.

>>> from asynctor.jsons import json_dump_bytes
>>> json_dump_bytes({'a': 1})
b'{"a":1}'
>>> json_dump_bytes({'a': 1}, pretty=True)
b'{\n  "a": 1\n}'
  • utils
  1. load_bool
>>> from asynctor.utils import load_bool
>>> load_bool('NOT_EXIST')
False
>>> import os
>>> os.environ['MY_ENV'] = '0'
>>> load_bool('MY_ENV')
False
>>> os.environ['MY_ENV'] = '1'
>>> load_bool('MY_ENV')
True
  1. ExtendSyspath
>>> import conftest
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    import conftest
ModuleNotFoundError: No module named 'conftest'
>>> from pathlib import Path
>>> from asynctor.utils import ExtendSyspath
>>> with ExtendSyspath('tests'):
...     import conftest
...
>>> Path(conftest.__file__).relative_to(Path.cwd()).as_posix()
'tests/conftest.py'

Project details


Download files

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

Source Distribution

asynctor-0.12.12.tar.gz (49.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asynctor-0.12.12-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

Details for the file asynctor-0.12.12.tar.gz.

File metadata

  • Download URL: asynctor-0.12.12.tar.gz
  • Upload date:
  • Size: 49.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for asynctor-0.12.12.tar.gz
Algorithm Hash digest
SHA256 566ec52deb85ea587a070141716a6819422ca3d60930b2cde12cffa57474b6dc
MD5 92695610c5b1fd62ddebe58f0a9d078f
BLAKE2b-256 39e8443f980098103712e9b27be564d28345bb0a2478c8f12209ee329c95c83f

See more details on using hashes here.

File details

Details for the file asynctor-0.12.12-py3-none-any.whl.

File metadata

  • Download URL: asynctor-0.12.12-py3-none-any.whl
  • Upload date:
  • Size: 53.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for asynctor-0.12.12-py3-none-any.whl
Algorithm Hash digest
SHA256 77c6cc51b8d8dd8e25bf22ccfaa175177f3592ec83bed5086a8c141e18bc9496
MD5 277484d18a5b18d62edc60fa5a4116e5
BLAKE2b-256 50b7dcea1705885bc725729cdcea455fbfd99a60076849d31b2e0b7c7fde066d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page