◐ Shell
reader mode source ↗
Skip to content

bpo-34831: Asyncio tutorial#9748

Closed
cjrh wants to merge 31 commits into
python:mainfrom
cjrh:bpo-34831-asyncio-tutorial
Closed

bpo-34831: Asyncio tutorial#9748
cjrh wants to merge 31 commits into
python:mainfrom
cjrh:bpo-34831-asyncio-tutorial

Conversation

@cjrh

@cjrh cjrh commented Oct 7, 2018

Copy link
Copy Markdown
Contributor

@cjrh cjrh requested review from 1st1 and asvetlov as code owners October 7, 2018 10:25
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Oct 7, 2018
@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from 9089420 to a7a9f25 Compare October 7, 2018 10:57
@1st1

1st1 commented Oct 7, 2018

Copy link
Copy Markdown
Member

cc @ambv -- Łukasz, would be great if you could take a look at this too and share some of your thoughts/experience.

@1st1

1st1 commented Oct 7, 2018

Copy link
Copy Markdown
Member

also @elprans please take a look.

@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from a7a9f25 to 4b47460 Compare October 12, 2018 14:34

@willingc willingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thanks @cjrh. A few comments so far.

@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from 9f21e81 to 30d158d Compare October 21, 2018 04:15
@tirkarthi

Copy link
Copy Markdown
Member

Docs failure could be due to recent logging related changes to fix Sphinx deprecation warnings in ee171a2

@tirkarthi

Copy link
Copy Markdown
Member

Upstream issue : https://bugs.python.org/issue35036
PR : #10024

Running make suspicious with the fix locally for reference :

(venv) ➜  Doc git:(0e82bc95f2) ✗ make suspicious
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
PATH=./venv/bin:$PATH sphinx-build -b suspicious -d build/doctrees -D latex_elements.papersize=  . build/suspicious
Running Sphinx v1.8.1
loading pickled environment... done
loading ignore rules... done, 343 rules loaded
building [mo]: targets for 0 po files that are out of date
building [suspicious]: targets for 484 source files that are out of date
updating environment: [] 0 added, 11 changed, 0 removed
reading sources... [100%] whatsnew/changelog
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 30%] library/asyncio-tutorial/case-study-chat-server
/Users/karthikeyansingaravelan/stuff/python/cpython/Doc/venv/lib/python3.7/site-packages/sphinx/application.py:388: RemovedInSphinx20Warning: app.warning() is now deprecated. Use sphinx.util.logging instead.
  RemovedInSphinx20Warning)
writing output... [100%] whatsnew/index
WARNING: [library/asyncio-tutorial/case-study-chat-server:49] ":TODO" found in " (ref:TODO) to create a TCP server very"
build finished with problems, 1 warning.
make[1]: *** [build] Error 1
Suspicious check complete; look for any errors in the above output or in build/suspicious/suspicious.csv.  If all issues are false positives, append that file to tools/susp-ignored.csv.
make: *** [suspicious] Error 1

@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from a6668dd to 7c95086 Compare November 4, 2018 05:52
@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from 7c95086 to 8c2f3ff Compare June 15, 2019 03:30
@willingc

Copy link
Copy Markdown
Contributor

Hi @cjrh, Thanks for updating the PR. I will do my best to review it this week. Hope all is well in your world. ☀️

@1st1

1st1 commented Jun 16, 2019

Copy link
Copy Markdown
Member

Yeah, it's a huge improvement; I'll also try to find time to review this before 3.8 final.

@JulienPalard

Copy link
Copy Markdown
Member

The unreadable build failure is due to Sphinx deprecating a function, I'm currently fixing it, but in the meantime here's the error you have to fix (or add to Doc/tools/susp-ignored.csv):

WARNING: [distutils/examples:267] "`" found in "This is the description of the ``foobar`` package."
WARNING: [library/asyncio-tutorial/running-async-functions:131] "`" found in "    task1 = func1()  // In Python: `task1 = create_task(func1())`"
WARNING: [library/asyncio-tutorial/running-async-functions:131] "`" found in "    task2 = func2()  // In Python: `task2 = create_task(func2())`"
WARNING: Found 1/355 unused rules:
distutils/examples,,`,This is the description of the ``foobar`` package.

@JulienPalard

Copy link
Copy Markdown
Member

@cjrh You can now rebase on top of master, since e1786b5 the suspicious.py script is fixed.

@cjrh

cjrh commented Sep 10, 2019

Copy link
Copy Markdown
Contributor Author

Thanks for the update, I'll rebase that soon.

14 hidden items Load more…
@cjrh cjrh force-pushed the bpo-34831-asyncio-tutorial branch from 576ef44 to 26cc634 Compare September 11, 2019 12:45
@1st1

1st1 commented Sep 12, 2019

Copy link
Copy Markdown
Member

This is huge, thank you, @cjrh!

I'm a bit busy at the sprints right now, I'll review this soon.

@asvetlov asvetlov left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Very impressive.
Please use a new stream API instead of legacy reader/writer.

5 hidden conversations Load more…
@bedevere-bot

Copy link
Copy Markdown

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

Copy link
Copy Markdown
Contributor

I suggest splitting this combo PR into smaller sections.
For example, async_functions.rst is finished and almost ready for merging after a little polishing.
It makes a value in itself, we can process it fast.

@cjrh cjrh mannequin mentioned this pull request Apr 17, 2022
@kumaraditya303

Copy link
Copy Markdown
Contributor

I am closing this as this will be split into smaller PRs as discussed in the issue. Thanks for the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.