Skip to main content

Codemod to convert synchronous Python code to async.

Project description

asyncify-codemod

asyncify-codemod is a codemod that converts synchronous Python code into async where possible. It focuses on a few common patterns (like requests, time.sleep, and file I/O) and rewrites them to async equivalents.

Usage

Run with pipx

pipx run asyncify-codemod [files you wish to transform ...]

E.g. if your python source files are located in src/:

pipx run asyncify-codemod src/**/*.py
pipx run asyncify-codemod --stdout path/to/file.py path/to/another.py

Comparison: asyncio.to_thread() vs async rewrites

Because “real async I/O” and “sync I/O in a thread” solve different problems, and they behave very differently at scale and under cancellation.

Where to_thread is great

Fast migration / compatibility shim: you can call existing blocking code from an async app without freezing the event loop. No behavioral rewrite: minimal code churn; good for legacy code you don’t want to touch yet. Sync-only dependencies: if there is no solid async alternative, threads are the pragmatic choice.

Where to_thread breaks down (and why a codemod helps)

  • Concurrency limits: to_thread is bounded by a thread pool. You can run thousands of concurrent await httpx/... calls; you generally can’t run thousands of threads. Under load, this becomes queueing/latency rather than throughput.
  • Cancellation semantics: cancelling an await to_thread(...) usually does not stop the underlying blocking call; it just stops waiting for it. With real async libs, cancellation is often propagated more cleanly (still not perfect everywhere, but materially better).
  • Resource efficiency: threads cost memory + scheduling overhead; async sockets/file ops can be much lighter per in-flight operation. You can’t “mix in” async behavior inside: if a function is wrapped, everything inside it stays sync. A codemod can turn the internals into await points (time.sleep → anyio.sleep, requests → httpx, open() → anyio.open_file), enabling cooperative scheduling throughout the call graph.
  • Observability/context: thread offloading can complicate tracing/log context propagation and debugging (it’s doable, just another layer). Pure async tends to integrate more directly with async frameworks’ middleware/instrumentation.

Use a codemod when you want the codebase to become natively async so it scales better, cancels better, and composes naturally with async frameworks—without hand-editing hundreds of mechanical changes.

Caveats

Sync-only dependencies

Currently, this codemod only rewrites commonly used I/O-bound operations with async alternatives (as mentioned above). If you're using custom libraries where there are no solid async alternatives, they will in your new async functions after a codemod. This is a huge performance blocker and the only way to resolve this right now is to manually update its usages (i.e. send it to asyncio.to_thread).

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

asyncify_codemod-0.3.0.tar.gz (37.1 kB view details)

Uploaded Source

Built Distribution

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

asyncify_codemod-0.3.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file asyncify_codemod-0.3.0.tar.gz.

File metadata

  • Download URL: asyncify_codemod-0.3.0.tar.gz
  • Upload date:
  • Size: 37.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for asyncify_codemod-0.3.0.tar.gz
Algorithm Hash digest
SHA256 974030fb14061445a04e72d9d986d80e7503fa0e4662a648c53adf2de6ab19af
MD5 79f4af005f8921c604e8760fc56be98b
BLAKE2b-256 673a7bbadf2a32b396af0e6d288227d53bbb138fedbf49ff894979c6da4558a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for asyncify_codemod-0.3.0.tar.gz:

Publisher: publish.yml on 7CaD/python-asyncify-codemod

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file asyncify_codemod-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for asyncify_codemod-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7601a254193df059ffb29bc48eded9f2e630e15c87df872d6ea0c504daba29a
MD5 09a801011957f4bb0d53c3b26bff3250
BLAKE2b-256 d22fc447ae8503c8708c7470e1c856061691ff283e88dab889c2de6a027b39c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for asyncify_codemod-0.3.0-py3-none-any.whl:

Publisher: publish.yml on 7CaD/python-asyncify-codemod

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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