bpo-32972: Document IsolatedAsyncioTestCase of unittest module #15878

tirkarthi · 2019-09-10T15:49:14Z

Document unittest.IsolatedAsyncioTestCase API
Add a simple example with respect to order of evaluation of setup and teardown calls.

https://bugs.python.org/issue32972

Automerge-Triggered-By: @asvetlov

asvetlov

Looks good, thank you.

Please fix a couple notes

Doc/library/unittest.rst

Misc/NEWS.d/3.8.0b1.rst

asvetlov

import paths should be fixed before the merge

bedevere-bot · 2019-09-10T18:23:42Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

tirkarthi · 2019-09-11T09:39:37Z

Thanks Andrew, I didn't know about the import. It makes it more clean and user doesn't need to know about async_case module too. I have fixed the imports as per comments. I think this feature also deserves a better attention so I have added it to the What's new document under unittest section with a simple example. Thoughts?

asvetlov · 2019-09-11T09:43:11Z

I think this feature also deserves a better attention so I have added it to the What's new document under unittest section with a simple example. Thoughts?

Excellent idea! Please do

tirkarthi · 2019-09-11T09:44:22Z

Sure, added at https://github.com/python/cpython/pull/15878/files#diff-77c703d9a958f6a4b0dc2f692b3fd5b3R1114 . Please review the wording and example.

asvetlov

The example is fine. Please address my last comments.

Doc/whatsnew/3.8.rst

Doc/library/unittest.rst

tirkarthi · 2019-09-11T10:28:42Z

Thanks Andrew, I have reworded ExpensiveAsyncConnection to AsyncConnection . I have removed the sync_connection example and moved the events assertion out to docs with a statement as suggested.

Yes, test discovery works better and friendly. I must admit I copied the test from async_case as example which was the reason and I just learned about TestCase instantiation while writing this example :) Your suggestion is better and changed it to test discovery.

asvetlov

Perfect!

Doc/library/unittest.rst

asvetlov

there are two extra lines in example that should be dropped

bedevere-bot · 2019-09-11T10:34:01Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

asvetlov

Thank you very much!
Done well

tirkarthi · 2019-09-11T10:35:59Z

Ah sorry, I removed the connection example and overlooked the setup and teardown which is not used. Thanks.

tirkarthi · 2019-09-11T10:45:44Z

Thank you very much Andrew for all the guidance :)

miss-islington · 2019-09-11T11:02:14Z

@tirkarthi: Status check is done, and it's a success ✅ .

miss-islington · 2019-09-11T11:02:17Z

Thanks @tirkarthi for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@asvetlov

…nGH-15878) * Document `unittest.IsolatedAsyncioTestCase` API * Add a simple example with respect to order of evaluation of setup and teardown calls. https://bugs.python.org/issue32972 Automerge-Triggered-By: @asvetlov (cherry picked from commit 6a9fd66) Co-authored-by: Xtreak <tir.karthi@gmail.com>

bedevere-bot · 2019-09-11T11:02:27Z

GH-15918 is a backport of this pull request to the 3.8 branch.

@asvetlov

) (GH-15918) * Document `unittest.IsolatedAsyncioTestCase` API * Add a simple example with respect to order of evaluation of setup and teardown calls. https://bugs.python.org/issue32972 Automerge-Triggered-By: @asvetlov (cherry picked from commit 6a9fd66) Co-authored-by: Xtreak <tir.karthi@gmail.com>

@asvetlov

…nGH-15878) * Document `unittest.IsolatedAsyncioTestCase` API * Add a simple example with respect to order of evaluation of setup and teardown calls. https://bugs.python.org/issue32972 Automerge-Triggered-By: @asvetlov

@asvetlov

…nGH-15878) * Document `unittest.IsolatedAsyncioTestCase` API * Add a simple example with respect to order of evaluation of setup and teardown calls. https://bugs.python.org/issue32972 Automerge-Triggered-By: @asvetlov

tirkarthi added 3 commits September 10, 2019 16:39

Initial pass of async_case docs with an example.

fd7b1b5

Fix indentation and NEWS entry.

2fc2ba0

Fix indentation.

7cf96fb

the-knights-who-say-ni added the CLA signed label Sep 10, 2019

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Sep 10, 2019

tirkarthi changed the title ~~bpo32972: Document IsolatedAsyncioTestCase of unittest.async_case module~~ bpo-32972: Document IsolatedAsyncioTestCase of unittest.async_case module Sep 10, 2019

asvetlov changed the title ~~bpo-32972: Document IsolatedAsyncioTestCase of unittest.async_case module~~ bpo-32972: Document IsolatedAsyncioTestCase of unittest.async_case module Sep 10, 2019

asvetlov added the skip news label Sep 10, 2019

asvetlov closed this Sep 10, 2019

asvetlov reopened this Sep 10, 2019

asvetlov approved these changes Sep 10, 2019

View reviewed changes

Doc/library/unittest.rst Outdated Show resolved Hide resolved

Doc/library/unittest.rst Outdated Show resolved Hide resolved

Misc/NEWS.d/3.8.0b1.rst Outdated Show resolved Hide resolved

bedevere-bot added awaiting merge and removed awaiting review labels Sep 10, 2019

asvetlov requested changes Sep 10, 2019

View reviewed changes

bedevere-bot removed the awaiting merge label Sep 10, 2019

bedevere-bot added the awaiting changes label Sep 10, 2019

Fix import path and add an example to whatsnew document.

866ce96

asvetlov reviewed Sep 11, 2019

View reviewed changes

Doc/whatsnew/3.8.rst Outdated Show resolved Hide resolved

Doc/library/unittest.rst Outdated Show resolved Hide resolved

Doc/library/unittest.rst Show resolved Hide resolved

Doc/library/unittest.rst Outdated Show resolved Hide resolved

Doc/library/unittest.rst Outdated Show resolved Hide resolved

Make example use test discovery. Remove sync connection example.

0b42ec2

asvetlov approved these changes Sep 11, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Sep 11, 2019

asvetlov reviewed Sep 11, 2019

View reviewed changes

Doc/library/unittest.rst Outdated Show resolved Hide resolved

asvetlov reviewed Sep 11, 2019

View reviewed changes

Doc/library/unittest.rst Outdated Show resolved Hide resolved

asvetlov requested changes Sep 11, 2019

View reviewed changes

bedevere-bot removed the awaiting merge label Sep 11, 2019

bedevere-bot added the awaiting changes label Sep 11, 2019

Drop sync connection examples.

ecd8db8

asvetlov approved these changes Sep 11, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Sep 11, 2019

asvetlov added 🤖 automerge labels Sep 11, 2019

tirkarthi changed the title ~~bpo-32972: Document IsolatedAsyncioTestCase of unittest.async_case module~~ bpo-32972: Document IsolatedAsyncioTestCase of unittest module Sep 11, 2019

miss-islington merged commit 6a9fd66 into python:master Sep 11, 2019

bedevere-bot removed the awaiting merge label Sep 11, 2019

bedevere-bot removed the needs backport to 3.8 label Sep 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-32972: Document IsolatedAsyncioTestCase of unittest module #15878

bpo-32972: Document IsolatedAsyncioTestCase of unittest module #15878

tirkarthi commented Sep 10, 2019 •

edited

Loading

asvetlov left a comment

asvetlov left a comment

bedevere-bot commented Sep 10, 2019

tirkarthi commented Sep 11, 2019

asvetlov commented Sep 11, 2019

tirkarthi commented Sep 11, 2019

asvetlov left a comment

tirkarthi commented Sep 11, 2019

asvetlov left a comment

asvetlov left a comment

bedevere-bot commented Sep 11, 2019

asvetlov left a comment

tirkarthi commented Sep 11, 2019

tirkarthi commented Sep 11, 2019

miss-islington commented Sep 11, 2019

miss-islington commented Sep 11, 2019

bedevere-bot commented Sep 11, 2019

bpo-32972: Document IsolatedAsyncioTestCase of unittest module #15878

bpo-32972: Document IsolatedAsyncioTestCase of unittest module #15878

Conversation

tirkarthi commented Sep 10, 2019 • edited Loading

asvetlov left a comment

Choose a reason for hiding this comment

asvetlov left a comment

Choose a reason for hiding this comment

bedevere-bot commented Sep 10, 2019

tirkarthi commented Sep 11, 2019

asvetlov commented Sep 11, 2019

tirkarthi commented Sep 11, 2019

asvetlov left a comment

Choose a reason for hiding this comment

tirkarthi commented Sep 11, 2019

asvetlov left a comment

Choose a reason for hiding this comment

asvetlov left a comment

Choose a reason for hiding this comment

bedevere-bot commented Sep 11, 2019

asvetlov left a comment

Choose a reason for hiding this comment

tirkarthi commented Sep 11, 2019

tirkarthi commented Sep 11, 2019

miss-islington commented Sep 11, 2019

miss-islington commented Sep 11, 2019

bedevere-bot commented Sep 11, 2019

tirkarthi commented Sep 10, 2019 •

edited

Loading