Implement BaseRequest.get_extra_info() #4196
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`BaseRequest.get_extra_info()` provides a shortcut for accessing extra information from the underlying protocols' transport
Codecov Report
@@ Coverage Diff @@
## master #4196 +/- ##
==========================================
- Coverage 97.57% 97.53% -0.05%
==========================================
Files 43 43
Lines 8825 8837 +12
Branches 1381 1383 +2
==========================================
+ Hits 8611 8619 +8
- Misses 92 94 +2
- Partials 122 124 +2
Continue to review full report at Codecov.
|
psf-chronographer
bot
added
the
bot:chronographer:provided
rbialon
changed the title
rbialon
commented
Oct 17, 2019
| @@ -673,6 +673,18 @@ def body_exists(self) -> bool: | |||
| self._post = MultiDictProxy(out) | |||
| return self._post | |||
|
|
|||
| def get_extra_info(self, name: str, default: Any = None) -> Any: | |||
There was a problem hiding this comment.
I just saw that I defined the name parameter for get_extra_info to be a string both in the documentation and type hinting.
This is true, but it could also be any other valid dictionary key. Should I reconsider this?
There was a problem hiding this comment.
No, in asyncio the key is a string by convention.
rbialon
commented
Oct 17, 2019
| Reads extra information from the protocol's transport. | ||
| If no value associated with ``name`` is found, ``default`` is returned. | ||
|
|
||
| :param str name: The key to look up in the transport extra information. |
There was a problem hiding this comment.
It's defined as a string here, too.
asvetlov
reviewed
Oct 18, 2019
Add versionadded to get_extra_info() documentation
asvetlov
approved these changes
Oct 18, 2019
|
Thanks! |
asvetlov
pushed a commit
that referenced
this pull request
Oct 18, 2019
* Add get_extra_info for BaseRequest `BaseRequest.get_extra_info()` provides a shortcut for accessing extra information from the underlying protocols' transport * Add get_extra_info default value test * Add return type annotation to BaseRequest.get_extra_info() * Remove async from BaseRequest.get_extra_info() * Rewrite get_extra_info test, cover all branches * Add news entry to CHANGES for #4189 * Add Raphael Bialon to CONTRIBUTORS.txt * Add documentation for BaseRequest.get_extra_info() * Update web_reference.rst Add versionadded to get_extra_info() documentation (cherry picked from commit fbc9cf6) Co-authored-by: Raphael Bialon <[email protected]>
asvetlov
added a commit
that referenced
this pull request
Oct 18, 2019
Add versionadded to get_extra_info() documentation (cherry picked from commit fbc9cf6) Co-authored-by: Raphael Bialon <[email protected]>
|
Thanks, I'll take a look at it :-) |
|
Already done by #4240 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
This PR introduces the
get_extra_info()function onBaseRequestas suggested in #4189 .It provides the same functionality as the current
request.transport.get_extra_info()but is directly associated withrequest.Are there changes in behavior for the user?
Users are encouraged to favor
request.get_extra_info()instead ofrequest.transport.get_extra_info(), asrequest.transportis about to be deprecated.Related issue number
#4189
Checklist
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange it to the pr id after creating the pr.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.