Skip to content

Simplify the hello world example, explain request lifecycle#4329

Merged
asvetlov merged 5 commits intoaio-libs:masterfrom
ksamuel:master
Nov 12, 2019
Merged

Simplify the hello world example, explain request lifecycle#4329
asvetlov merged 5 commits intoaio-libs:masterfrom
ksamuel:master

Conversation

@ksamuel
Copy link
Copy Markdown
Contributor

@ksamuel ksamuel commented Nov 8, 2019 •
edited by webknjaz
Loading

What do these changes do?

Simplify the hello world example in the README and doc index

Add a new page to the doc (http_request_lifecycle) to explain why aiohttp's client API requires several steps for performing a request. Compare it with the "requests" library. Gives some information about the use of the ClientSession object.

Are there changes in behavior for the user?

No

Related issue number

Close #4272

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@ksamuel
Simplify client hello world, explain verbosity
1ff22a1 
Simplify the hello world example in the README and doc index

Add a new page to the doc (http_request_lifecycle) to explain why aiohttp's client API requires several steps for performing a request. Compare it with the "requests" library. Gives some information about the use of the ClientSession object.
@ksamuel
Properly name news fragment with issue number
03427f7
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Nov 8, 2019
webknjaz
webknjaz reviewed Nov 9, 2019
View reviewed changes
README.rst Outdated
Content-type: text/html; charset=utf-8
Body: <!doctype html> ...

Comming from `requests<https://requests.readthedocs.io/>`_ ? Read :ref:`why we need so many lines <http://aiohttp.readthedocs.io/en/latest/aiohttp-request-lifecycle>`.
Copy link
Copy Markdown
Member

@webknjaz webknjaz Nov 9, 2019

Choose a reason for hiding this comment

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

This makes the CI fail.

webknjaz
webknjaz reviewed Nov 9, 2019
View reviewed changes
CONTRIBUTORS.txt Outdated
Ilya Chichak
Ingmar Steen
Ivan Larin
Kevin Samuel
Copy link
Copy Markdown
Member

@webknjaz webknjaz Nov 9, 2019

Choose a reason for hiding this comment

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

"K" goes after "J" in the alphabet.

@codecov-io
Copy link
Copy Markdown

codecov-io commented Nov 9, 2019 •
edited
Loading

Codecov Report

Merging #4329 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4329      +/-   ##
==========================================
- Coverage   97.55%   97.51%   -0.04%     
==========================================
  Files          43       43              
  Lines        8862     8859       -3     
  Branches     1389     1389              
==========================================
- Hits         8645     8639       -6     
- Misses         93       96       +3     
  Partials      124      124
Impacted Files Coverage Δ
aiohttp/web_protocol.py 91.81% <0%> (-0.88%) ⬇️
aiohttp/helpers.py 96.12% <0%> (-0.03%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0bd628...11eaf4a. Read the comment docs.

@ksamuel
Copy link
Copy Markdown
Contributor Author

ksamuel commented Nov 9, 2019

I see that the coverage went down, but I didn't touched the code or unit tests.

Maybe I'm doing the PR on the wrong branch?

asvetlov
asvetlov requested changes Nov 9, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

Awesome!
I very appreciate the PR, it elaborates the idea of the client session pretty well.

One minor thing: please use double backticks for inline code examples.
aiohttp follows CPython style guide for documentation, it contains a rule for code formatting.

@asvetlov
Copy link
Copy Markdown
Member

asvetlov commented Nov 12, 2019

Coverage jittering for aiohttp worries me too.
Maybe this is because we report the coverage for both master and 3.7 branches?
I don't know.

@asvetlov asvetlov merged commit 17bed45 into aio-libs:master Nov 12, 2019
@asvetlov
Copy link
Copy Markdown
Member

asvetlov commented Nov 12, 2019

Thanks!

asvetlov pushed a commit that referenced this pull request Nov 12, 2019
@ksamuel @asvetlov
[3.7] Simplify the hello world example, explain request lifecycle (#4329
eff7b72 
)

(cherry picked from commit 17bed45)

Co-authored-by: ksamuel <[email protected]>
asvetlov added a commit that referenced this pull request Nov 12, 2019
@asvetlov @ksamuel
[3.7] Simplify the hello world example, explain request lifecycle (#4329
7dfeac1 
) (#4335)

(cherry picked from commit 17bed45)

Co-authored-by: ksamuel <[email protected]>
asvetlov pushed a commit that referenced this pull request Oct 16, 2020
@ksamuel @asvetlov
Simplify the hello world example, explain request lifecycle (#4329)
d9e2ad4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@webknjaz webknjaz webknjaz left review comments

@asvetlov asvetlov asvetlov approved these changes

Assignees

No one assigned

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve client "hello world" in README

4 participants

@ksamuel @codecov-io @asvetlov @webknjaz