Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change typing of the secure argument on StreamResponse.set_cookie #4238

Merged
merged 3 commits into from
Oct 26, 2019

Conversation

paulefoe
Copy link
Member

@paulefoe paulefoe commented Oct 19, 2019

What do these changes do?

This change fixes the contradiction between docs and annotation in code

Are there changes in behavior for the user?

No

Related issue number

This commit fixes #4204

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."

@codecov-io
Copy link

codecov-io commented Oct 19, 2019

Codecov Report

Merging #4238 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4238   +/-   ##
=======================================
  Coverage   97.55%   97.55%           
=======================================
  Files          43       43           
  Lines        8841     8841           
  Branches     1383     1383           
=======================================
  Hits         8625     8625           
  Misses         93       93           
  Partials      123      123
Impacted Files Coverage Δ
aiohttp/web_response.py 97.69% <ø> (ø) ⬆️

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 3cf4104...723f40d. Read the comment docs.

Copy link
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.

Please update ./docs/web_reference.rst as well

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 19, 2019
@paulefoe
Copy link
Member Author

paulefoe commented Oct 20, 2019

@asvetlov I think docs are correct already, aren't they? It was only the typings that were wrong.

https://docs.aiohttp.org/en/stable/web_reference.html#aiohttp.web.BaseRequest.secure

@asvetlov
Copy link
Member

There is also https://docs.aiohttp.org/en/stable/web_reference.html#aiohttp.web.StreamResponse.set_cookie where types for parameters are outdated for secure and httponly

@paulefoe
Copy link
Member Author

I updated httponly param. About secure everything seems correct tho, or am I missing something?

@asvetlov asvetlov merged commit e4573f8 into aio-libs:master Oct 26, 2019
@asvetlov
Copy link
Member

Thanks!

asvetlov pushed a commit that referenced this pull request Oct 26, 2019
…ie (#4238)

(cherry picked from commit e4573f8)

Co-authored-by: Pavel Filatov <triksrimer@gmail.com>
asvetlov added a commit that referenced this pull request Oct 26, 2019
…ie (#4238) (#4273)

(cherry picked from commit e4573f8)

Co-authored-by: Pavel Filatov <triksrimer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contradiction between documentation and annotation of the secure parameter of set_cookie()
3 participants