This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: asyncio.Task's documentation says that loop arg is removed when it's not
Type: behavior Stage: resolved
Components: asyncio, Documentation Versions: Python 3.11
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, jack1142, yselivanov
Priority: normal Keywords: patch

Created on 2021-09-04 17:03 by jack1142, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 32166 merged asvetlov, 2022-03-28 23:00
Messages (7)
msg401047 - (view) Author: Jakub Kuczys (jack1142) * Date: 2021-09-04 17:03
The documentation here:

Says that `loop` parameter was removed but it's still part of the signature. It gets even more confusing when the deprecation right below it is saying that *not* passing it when there is no running event loop is deprecated :)

I could make a PR removing this information but I'm not sure whether there should be also some information put about it being deprecated in 3.8 but not actually getting removed in 3.10?
msg413393 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-17 09:30
User code should not create Task objects explicitly.
Please use `asyncio.create_task()` (or shiny new TaskGroup.create_task()) instead. They doesn't have 'loop' argument.
msg413396 - (view) Author: Jakub Kuczys (jack1142) * Date: 2022-02-17 09:48
I'm aware, I'm reporting this because as long as the instantiation of a Task is documented, the documentation should still contain accurate up-to-date information.
msg413462 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-17 22:53
I have a feeling that we need a low-level API section that describes *supported* API that is intended to task extenders only (guys who want to provide an alternative task factory for example).

I love to contribute but not sure when I can find time for this docs change. Please feel free to provide a pull request.
msg416459 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-03-31 21:06
New changeset ab89ccff3ca6efc2a8e6f5f45c30d568fb3d212f by Andrew Svetlov in branch 'main':
bpo-45099: Document asyncio internal API (GH-32166)
msg416469 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2022-04-01 02:22
> I have a feeling that we need a low-level API section that describes *supported* API that is intended to task extenders only (guys who want to provide an alternative task factory for example).

I'm not sure how exposing all private methods spiraled out of this issue. We haven't discussed documenting the low-level methods you just exposed Andrew. IMO this should be reverted.
msg416603 - (view) Author: Jakub Kuczys (jack1142) * Date: 2022-04-02 23:27
I'm not sure why this issue was mentioned in GH-32166 since it doesn't really address this but regardless, it appears that my issue has been fixed in PR-31388 and PR-31403 when Serhiy fixed the issue from bpo-46777 so thanks :)
Date User Action Args
2022-04-11 14:59:49adminsetgithub: 89262
2022-04-02 23:27:06jack1142setmessages: + msg416603
2022-04-01 02:22:33yselivanovsetmessages: + msg416469
2022-03-31 21:06:35asvetlovsetstatus: open -> closed
stage: patch review -> resolved
resolution: fixed
versions: - Python 3.9, Python 3.10
2022-03-31 21:06:11asvetlovsetmessages: + msg416459
2022-03-28 23:01:13asvetlovsetversions: + Python 3.9, Python 3.11
2022-03-28 23:00:20asvetlovsetkeywords: + patch
stage: patch review
pull_requests: + pull_request30244
2022-02-17 22:53:07asvetlovsetmessages: + msg413462
2022-02-17 09:48:45jack1142setmessages: + msg413396
2022-02-17 09:30:29asvetlovsetmessages: + msg413393
2021-09-04 17:04:04jack1142setnosy: + yselivanov, asvetlov
components: + asyncio
2021-09-04 17:03:48jack1142create