Skip to content

Document pickling custom transport adapters #7499

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.

Sign up for GitHub

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

Open
wayyoungboy wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

Document pickling custom transport adapters #7499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/user/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,10 +1024,22 @@ library to use SSLv3::
class Ssl3HttpAdapter(HTTPAdapter):
""""Transport adapter" that allows us to use SSLv3."""

__attrs__ = HTTPAdapter.__attrs__ + ["ssl_version"]

def __init__(self, ssl_version=ssl.PROTOCOL_SSLv3, **kwargs):
self.ssl_version = ssl_version
super().__init__(**kwargs)

def init_poolmanager(self, connections, maxsize, block=False):
self.poolmanager = PoolManager(
num_pools=connections, maxsize=maxsize,
block=block, ssl_version=ssl.PROTOCOL_SSLv3)
block=block, ssl_version=self.ssl_version)

If a custom Transport Adapter stores extra instance attributes, extend
``HTTPAdapter.__attrs__`` with those attribute names. Requests uses this list
when pickling adapters, which can happen when a :class:`Session
<requests.Session>` is copied or serialized. Without listing custom state in
``__attrs__``, unpickling the adapter may lose that state.

Example: Automatic Retries
^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down