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

Added properties of default ClientSession params to ClientSession class #4240

Merged
merged 3 commits into from
Oct 20, 2019

Conversation

paulefoe
Copy link
Member

@paulefoe paulefoe commented Oct 19, 2019

What do these changes do?

Added properties of default ClientSession params to ClientSession class so it is available for introspection now

Are there changes in behavior for the user?

Users can now see which default parameters were initialized with ClientSession

Related issue number

This commit fixes #3882

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

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

codecov-io commented Oct 19, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4240   +/-   ##
=======================================
  Coverage   97.55%   97.55%           
=======================================
  Files          43       43           
  Lines        8841     8841           
  Branches     1383     1383           
=======================================
  Hits         8625     8625           
  Misses         93       93           
  Partials      123      123

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...1dfd243. 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.

The code is correct.
Please document added public attributes in ./docs/client_reference.rst.
Please use .. versionadded:: 3.7 tag

@@ -918,6 +919,60 @@ def timeout(self) -> Union[object, ClientTimeout]:
"""Timeout for the session."""
return self._timeout

@property
def default_headers(self) -> 'CIMultiDict[str]':
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
def default_headers(self) -> 'CIMultiDict[str]':
def headers(self) -> 'CIMultiDict[str]':

Let's keep property names in sync with constructor parameters

…default_headers property to headers so that it matches the constructor of the ClientSession
@asvetlov asvetlov merged commit 5f291b0 into aio-libs:master Oct 20, 2019
@asvetlov
Copy link
Member

Thanks!

asvetlov pushed a commit that referenced this pull request Oct 20, 2019
…on class (#4240)

(cherry picked from commit 5f291b0)

Co-authored-by: Pavel Filatov <triksrimer@gmail.com>
asvetlov added a commit that referenced this pull request Oct 20, 2019
…on class (#4240) (#4242)

* [3.6] Added properties of default ClientSession params to ClientSession class (#4240)
(cherry picked from commit 5f291b0)

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.

Expose ClientSession defaults such as headers and auth for introspection
3 participants