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.

classification
Title: Document asyncio.test_utils
Type: enhancement Stage: resolved
Components: asyncio, Documentation Versions: Python 3.6, Python 3.4, Python 3.5
process
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, vstinner, yselivanov, zach.ware
Priority: normal Keywords:

Created on 2015-09-11 18:09 by zach.ware, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (5)
msg250482 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-09-11 18:09
asyncio.test_utils is not documented.  I'm unsure as to whether that's because it's meant to be private, or if it just hasn't been done yet.
msg250483 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-09-11 18:15
It's meant to be private.
msg250484 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2015-09-11 18:17
Agreed, but then why isn't it in the tests directory? There are some examples in the asyncio repo on GitHub that use test_utils.dummy_ssl_context(), and that's probably why; but that's a fairly bad practice plus it's really a one-liner.
msg250492 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-09-11 19:32
> Agreed, but then why isn't it in the tests directory?

I think that the main reason is to make it possible for tests to import some common functionality from 'asyncio' package, when you run them from the cloned github asyncio repo.

In fact, I think we should prefix the module with an underscore.
msg250494 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2015-09-11 20:15
The _ is a good idea. Please do fix up the examples!
History
Date User Action Args
2022-04-11 14:58:20adminsetgithub: 69260
2015-09-11 20:15:18gvanrossumsetmessages: + msg250494
2015-09-11 19:32:05yselivanovsetmessages: + msg250492
2015-09-11 18:17:01gvanrossumsetmessages: + msg250484
2015-09-11 18:15:43yselivanovsetstatus: open -> closed
resolution: not a bug
messages: + msg250483

stage: needs patch -> resolved
2015-09-11 18:09:38zach.warecreate