Document that requests.session() is depreciated

Adds a docstring note that `requests.session()` is depreciated. Users should
use `requests.Session()` in versions released after Requests v1.0.
This commit is contained in:
Steven M. Vascellaro
2018-06-13 12:43:05 -04:00
parent 883caaf145
commit 1c13c5e6f3
+6 -1
View File
@@ -735,7 +735,12 @@ def session():
"""
Returns a :class:`Session` for context-management.
.. deprecated:: 1.0.0
This method has been deprecated since version 1.0.0 and is only kept for
backwards compatibility. New code should use :class:`~requests.sessions.Session`
to create a session. This may be removed at a future date.
:rtype: Session
"""
return Session()