<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Pyro - Python Remote Objects - 4.21 — Pyro 4.21 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '4.21',
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>
<link rel="top" title="Pyro 4.21 documentation" href="#" />
<link rel="next" title="Intro and Example" href="intro.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="intro.html" title="Intro and Example"
accesskey="N">next</a> |</li>
<li><a href="#">Pyro 4.21 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="pyro-python-remote-objects-version">
<h1>Pyro - Python Remote Objects - 4.21<a class="headerlink" href="#pyro-python-remote-objects-version" title="Permalink to this headline">¶</a></h1>
<img alt="PYRO logo" class="align-center" src="_images/pyro-large.png" />
<div class="section" id="what-is-pyro">
<h2>What is Pyro?<a class="headerlink" href="#what-is-pyro" title="Permalink to this headline">¶</a></h2>
<p>It is a library that enables you to build applications in which
objects can talk to each other over the network, with minimal programming effort.
You can just use normal Python method calls to call objects on other machines.
Pyro is written in <strong>100% pure Python</strong> and therefore runs on many platforms and Python versions,
<strong>including Python 3.x</strong>.</p>
<p>Pyro is copyright © Irmen de Jong (<a class="reference external" href="mailto:irmen%40razorvine.net">irmen<span>@</span>razorvine<span>.</span>net</a> | <a class="reference external" href="http://www.razorvine.net">http://www.razorvine.net</a>). Please read <a class="reference internal" href="license.html"><em>Software License and Disclaimer</em></a>.</p>
<p>Join the <a class="reference external" href="http://lists.sourceforge.net/lists/listinfo/pyro-core">Pyro mailing list</a> for questions and discussion.
Pyro can be found on Pypi as <a class="reference external" href="http://pypi.python.org/pypi/Pyro4/">Pyro4</a>. Source on Github: <a class="reference external" href="https://github.com/irmen/Pyro4">https://github.com/irmen/Pyro4</a></p>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Intro and Example</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#about-pyro-feature-overview">About Pyro: feature overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-can-you-use-it-for">What can you use it for?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#simple-example">Simple Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#performance">Performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing Pyro</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#obtaining-and-installing-pyro">Obtaining and installing Pyro</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#stuff-you-get-in-the-distribution-archive">Stuff you get in the distribution archive</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#warm-up">Warm-up</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#pyro-concepts-and-tools">Pyro concepts and tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#building-a-warehouse">Building a Warehouse</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#building-a-stock-market-simulator">Building a Stock market simulator</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#running-it-on-different-machines">Running it on different machines</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#other-means-of-creating-connections">Other means of creating connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#ok-what-s-next">Ok, what’s next?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commandline.html">Command line tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#name-server">Name server</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#name-server-control">Name server control</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#test-echo-server">Test echo server</a></li>
<li class="toctree-l2"><a class="reference internal" href="commandline.html#configuration-check">Configuration check</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="clientcode.html">Clients: Calling remote objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#object-discovery">Object discovery</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#calling-methods">Calling methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#serialization">Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#proxies-connections-threads-and-cleaning-up">Proxies, connections, threads and cleaning up</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#oneway-calls">Oneway calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#batched-calls">Batched calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#asynchronous-future-remote-calls-call-chains">Asynchronous (‘future’) remote calls & call chains</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#pyro-callbacks">Pyro Callbacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="clientcode.html#miscellaneous-features">Miscellaneous features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="servercode.html">Servers: publishing objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="servercode.html#pyro-daemon-publishing-pyro-objects">Pyro Daemon: publishing Pyro objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="servercode.html#autoproxying">Autoproxying</a></li>
<li class="toctree-l2"><a class="reference internal" href="servercode.html#server-types-and-object-concurrency-model">Server types and Object concurrency model</a></li>
<li class="toctree-l2"><a class="reference internal" href="servercode.html#serialization">Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="servercode.html#other-features">Other features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nameserver.html">Name Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#starting-the-name-server">Starting the Name Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#configuration-items">Configuration items</a></li>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#name-server-control-tool">Name server control tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#locating-the-name-server-and-using-it-in-your-code">Locating the Name Server and using it in your code</a></li>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#the-magical-pyroname-protocol-type">The ‘magical’ PYRONAME protocol type</a></li>
<li class="toctree-l2"><a class="reference internal" href="nameserver.html#resolving-object-names">Resolving object names</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="security.html#pickle-as-serialization-format-optional">Pickle as serialization format (optional)</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#network-interface-binding">Network interface binding</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#running-pyro-servers-with-different-credentials-user-id">Running Pyro servers with different credentials/user id</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#protocol-encryption">Protocol encryption</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#dotted-names-object-traversal">Dotted names (object traversal)</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#environment-variables-overriding-config-items">Environment variables overriding config items</a></li>
<li class="toctree-l2"><a class="reference internal" href="security.html#preventing-arbitrary-connections-hmac-signature">Preventing arbitrary connections: HMAC signature</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors and remote tracebacks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="errors.html#pyro-errors">Pyro errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html#remote-errors">Remote errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="errors.html#detailed-traceback-information">Detailed traceback information</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="flame.html">Flame: Foreign Location Automatic Module Exposer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="flame.html#enabling-flame">Enabling Flame</a></li>
<li class="toctree-l2"><a class="reference internal" href="flame.html#command-line-server">Command line server</a></li>
<li class="toctree-l2"><a class="reference internal" href="flame.html#flame-object-and-examples">Flame object and examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tipstricks.html">Tips & Tricks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#best-practices">Best practices</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#logging">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#multiple-network-interfaces">Multiple network interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#same-major-python-version-required">Same major Python version required</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#wire-protocol-version">Wire protocol version</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#asynchronous-future-normal-function-calls">Asynchronous (‘future’) normal function calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#dns-setup">DNS setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#pyro-behind-a-nat-router-firewall">Pyro behind a NAT router/firewall</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#binary-data-transfer">Binary data transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#msg-waitall-socket-option">MSG_WAITALL socket option</a></li>
<li class="toctree-l2"><a class="reference internal" href="tipstricks.html#ipv6-support">IPV6 support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuring Pyro</a><ul>
<li class="toctree-l2"><a class="reference internal" href="config.html#resetting-the-config-to-default-values">Resetting the config to default values</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#inspecting-current-config">Inspecting current config</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#overview-of-config-items">Overview of Config Items</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading from Pyro 3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="upgrading.html#should-i-choose-pyro4">Should I choose Pyro4?</a></li>
<li class="toctree-l2"><a class="reference internal" href="upgrading.html#differences">Differences</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Pyro4 library API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/main.html"><tt class="docutils literal"><span class="pre">Pyro4</span></tt> — Main API package</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/core.html"><tt class="docutils literal"><span class="pre">Pyro4.core</span></tt> — core Pyro logic</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/naming.html"><tt class="docutils literal"><span class="pre">Pyro4.naming</span></tt> — Pyro name server</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/util.html"><tt class="docutils literal"><span class="pre">Pyro4.util</span></tt> — Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/util.html#module-Pyro4.socketutil"><tt class="docutils literal"><span class="pre">Pyro4.socketutil</span></tt> — Socket related utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/util.html#module-Pyro4.threadutil"><tt class="docutils literal"><span class="pre">Pyro4.threadutil</span></tt> — wrapper module for <tt class="docutils literal"><span class="pre">threading</span></tt></a></li>
<li class="toctree-l2"><a class="reference internal" href="api/constants.html"><tt class="docutils literal"><span class="pre">Pyro4.constants</span></tt> — Constant value definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/config.html"><tt class="docutils literal"><span class="pre">Pyro4.config</span></tt> — Configuration items</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/errors.html"><tt class="docutils literal"><span class="pre">Pyro4.errors</span></tt> — Exception classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/echoserver.html"><tt class="docutils literal"><span class="pre">Pyro4.test.echoserver</span></tt> — Built-in echo server for testing purposes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/flame.html"><tt class="docutils literal"><span class="pre">Pyro4.utils.flame</span></tt> — Foreign Location Automatic Module Exposer</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/futures.html"><tt class="docutils literal"><span class="pre">Pyro4.futures</span></tt> — asynchronous calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/socketserver.html">Socket server API contract</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="alternative.html">Running on alternative Python implementations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="alternative.html#jython">Jython</a></li>
<li class="toctree-l2"><a class="reference internal" href="alternative.html#ironpython">IronPython</a></li>
<li class="toctree-l2"><a class="reference internal" href="alternative.html#pypy">Pypy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyrolite.html">Pyrolite - client library for Java and .NET</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Software License and Disclaimer</a></li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
<div class="figure align-center">
<a class="reference external image-reference" href="http://wiki.teamfortress.com/wiki/Pyro"><img alt="PYYYRRRROOOO" src="_images/tf_pyrotaunt.png" /></a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/pyro.png" alt="Logo"/>
</a></p>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Pyro - Python Remote Objects - 4.21</a><ul>
<li><a class="reference internal" href="#what-is-pyro">What is Pyro?</a></li>
<li><a class="reference internal" href="#contents">Contents</a><ul>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="intro.html"
title="next chapter">Intro and Example</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="intro.html" title="Intro and Example"
>next</a> |</li>
<li><a href="#">Pyro 4.21 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Irmen de Jong.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
