aio-libs / aio-libs/aiohttp

Proposal: rename `async def close()` to `async def aclose()` across aiohttp

Open
#12,922 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
16.5k
Forks
2.4k
Avg merge
17h 22m
Merged PRs (30d)
212

Description

### Describe the solution you'd like

`contextlib.aclosing()` expects the object to provide an `aclose()` coroutine, which it awaits automatically. This makes `aclose` the de-facto naming convention for asynchronous close methods.
For consistency with this convention, I propose renaming `async def close()` to `async def aclose()` on all aiohttp classes that currently expose an async `close()`. Backward compatibility should be preserved: the old `close()` should keep working but emit a `DeprecationWarning` when called.

### Related component

Server and Client

### Code of Conduct

- [x] I agree to follow the aio-libs Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.