binaryninja/commercial/api-docs/binaryninja.requests-module.html

368 lines
18 KiB
HTML

<!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 module &mdash; Binary Ninja API 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
<link rel="top" title="Binary Ninja API 1.1.0 documentation" href="index.html"/>
<link rel="next" title="binaryninja.requests.ConnectTimeout" href="binaryninja.requests.ConnectTimeout.html"/>
<link rel="prev" title="binaryninja.pyopenssl.makefile" href="binaryninja.pyopenssl.makefile.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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"> Binary Ninja API
</a>
<div class="version">
1.1
</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"><a class="reference internal" href="binaryninja.architecture-module.html">architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryninja-module.html">binaryninja</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.builtins-module.html">builtins</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pyopenssl-module.html">pyopenssl</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">requests</a><ul>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.ConnectTimeout.html">binaryninja.requests.ConnectTimeout</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.ConnectionError.html">binaryninja.requests.ConnectionError</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.DependencyWarning.html">binaryninja.requests.DependencyWarning</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.FileModeWarning.html">binaryninja.requests.FileModeWarning</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.HTTPError.html">binaryninja.requests.HTTPError</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.NullHandler.html">binaryninja.requests.NullHandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.PreparedRequest.html">binaryninja.requests.PreparedRequest</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.ReadTimeout.html">binaryninja.requests.ReadTimeout</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.Request.html">binaryninja.requests.Request</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.RequestException.html">binaryninja.requests.RequestException</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.RequestsDependencyWarning.html">binaryninja.requests.RequestsDependencyWarning</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.Response.html">binaryninja.requests.Response</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.Session.html">binaryninja.requests.Session</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.Timeout.html">binaryninja.requests.Timeout</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.TooManyRedirects.html">binaryninja.requests.TooManyRedirects</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.URLRequired.html">binaryninja.requests.URLRequired</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.check_compatibility.html">binaryninja.requests.check_compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.delete.html">binaryninja.requests.delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.get.html">binaryninja.requests.get</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.head.html">binaryninja.requests.head</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.options.html">binaryninja.requests.options</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.patch.html">binaryninja.requests.patch</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.post.html">binaryninja.requests.post</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.put.html">binaryninja.requests.put</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.request.html">binaryninja.requests.request</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.requests.session.html">binaryninja.requests.session</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.setting-module.html">setting</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Binary Ninja API</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> &raquo;</li>
<li>requests module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.requests-module.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-module">
<h1>requests module<a class="headerlink" href="#requests-module" title="Permalink to this headline"></a></h1>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.ConnectTimeout</span></code>(*args,&nbsp;...)</td>
<td>The request timed out while trying to connect to the remote server.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.ConnectionError</span></code>(*args,&nbsp;...)</td>
<td>A Connection error occurred.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.DependencyWarning</span></code></td>
<td>Warned when an attempt is made to import a module with missing optional dependencies.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.FileModeWarning</span></code></td>
<td>A file was opened in text mode, but Requests determined its binary length.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.HTTPError</span></code>(*args,&nbsp;**kwargs)</td>
<td>An HTTP error occurred.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.NullHandler</span></code>([level])</td>
<td>This handler does nothing.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.PreparedRequest</span></code>()</td>
<td>The fully mutable <code class="xref py py-class docutils literal"><span class="pre">PreparedRequest</span></code> object, containing the exact bytes that will be sent to the server.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.ReadTimeout</span></code>(*args,&nbsp;**kwargs)</td>
<td>The server did not send any data in the allotted amount of time.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.Request</span></code>([method,&nbsp;url,&nbsp;...])</td>
<td>A user-created <code class="xref py py-class docutils literal"><span class="pre">Request</span></code> object.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.RequestException</span></code>(*args,&nbsp;...)</td>
<td>There was an ambiguous exception that occurred while handling your request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.RequestsDependencyWarning</span></code></td>
<td>An imported dependency doesn&#8217;t match the expected version range.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.Response</span></code>()</td>
<td>The <code class="xref py py-class docutils literal"><span class="pre">Response</span></code> object, which contains a server&#8217;s response to an HTTP request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.Session</span></code>()</td>
<td>A Requests session.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.Timeout</span></code>(*args,&nbsp;**kwargs)</td>
<td>The request timed out.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.TooManyRedirects</span></code>(*args,&nbsp;...)</td>
<td>Too many redirects.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.URLRequired</span></code>(*args,&nbsp;**kwargs)</td>
<td>A valid URL is required to make a request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.check_compatibility</span></code>(...)</td>
<td></td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.delete</span></code>(url,&nbsp;**kwargs)</td>
<td>Sends a DELETE request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.get</span></code>(url[,&nbsp;params])</td>
<td>Sends a GET request.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.head</span></code>(url,&nbsp;**kwargs)</td>
<td>Sends a HEAD request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.options</span></code>(url,&nbsp;**kwargs)</td>
<td>Sends an OPTIONS request.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.patch</span></code>(url[,&nbsp;data])</td>
<td>Sends a PATCH request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.post</span></code>(url[,&nbsp;data,&nbsp;json])</td>
<td>Sends a POST request.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.put</span></code>(url[,&nbsp;data])</td>
<td>Sends a PUT request.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.request</span></code>(method,&nbsp;url,&nbsp;...)</td>
<td>Constructs and sends a <code class="xref py py-class docutils literal"><span class="pre">Request</span></code>.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.requests.session</span></code>()</td>
<td>Returns a <code class="xref py py-class docutils literal"><span class="pre">Session</span></code> for context-management.</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.requests.ConnectTimeout.html" class="btn btn-neutral float-right" title="binaryninja.requests.ConnectTimeout" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.pyopenssl.makefile.html" class="btn btn-neutral" title="binaryninja.pyopenssl.makefile" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, Vector 35 LLC.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>