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.

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

Jump to bottom

api: document "agent" parameter to request() #235

Merged
merged 2 commits into from
Feb 8, 2019
Merged

api: document "agent" parameter to request() #235

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
333b22e
api: document "agent" parameter to request()
ktdreyer Feb 6, 2019
c4829a8
Merge branch 'master' into doc-agent-param
twm Feb 8, 2019
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
6 changes: 6 additions & 0 deletions src/treq/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ def request(method, url, **kwargs):
:param bool unbuffered: Pass ``True`` to to disable response buffering. By
default treq buffers the entire response body in memory.

:param agent: Provide your own custom agent. Use this to override things
like ``connectTimeout`` or ``BrowserLikePolicyForHTTPS``. By
default, treq will create its own Agent with reasonable
defaults.
:type agent: twisted.web.iweb.IAgent

:rtype: Deferred that fires with an IResponse provider.

"""
Expand Down