contents.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Py4J Documentation &mdash; Py4J</title>
  7. <link rel="stylesheet" href="_static/py4jdoc.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: './',
  12. VERSION: '0.8.1',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: 'true'
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <link rel="author" title="About these documents" href="about.html" />
  22. <link rel="top" title="Py4J" href="index.html" />
  23. <link rel="next" title="1. Installing Py4J" href="install.html" />
  24. <script type="text/javascript">
  25. var _gaq = _gaq || [];
  26. _gaq.push(['_setAccount', 'UA-18626179-1']);
  27. _gaq.push(['_trackPageview']);
  28. (function() {
  29. var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  30. ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  31. var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  32. })();
  33. </script>
  34. </head>
  35. <body>
  36. <div class="page">
  37. <div class="banner">Py4J - A Bridge between Python and Java</div>
  38. <div class="related">
  39. <h3>Navigation</h3>
  40. <ul>
  41. <li class="right" style="margin-right: 5px">
  42. <a href="genindex.html" title="General Index"
  43. accesskey="I">index</a></li>
  44. <li class="right" >
  45. <a href="py-modindex.html" title="Python Module Index"
  46. >modules</a> |</li>
  47. <li class="right" >
  48. <a href="install.html" title="1. Installing Py4J"
  49. accesskey="N">next</a> |</li>
  50. <li><a href="index.html">Home</a> |</li>
  51. <li><a href="download.html">Download</a> |</li>
  52. <li><a href="#">Doc</a> |</li>
  53. <li><a href="https://blog.py4j.org">Blog</a> |</li>
  54. <li><a href="https://github.com/bartdag/py4j">github</a> |</li>
  55. <li><a href="about.html">About</a> &raquo;</li>
  56. </ul>
  57. </div>
  58. <div class="sphinxsidebar">
  59. <div class="sphinxsidebarwrapper">
  60. <h4>Next topic</h4>
  61. <p class="topless"><a href="install.html"
  62. title="next chapter">1. Installing Py4J</a></p>
  63. <h3>This Page</h3>
  64. <ul class="this-page-menu">
  65. <li><a href="_sources/contents.txt"
  66. rel="nofollow">Show Source</a></li>
  67. </ul>
  68. <div id="searchbox" style="display: none">
  69. <h3>Quick search</h3>
  70. <form class="search" action="search.html" method="get">
  71. <input type="text" name="q" size="18" />
  72. <input type="submit" value="Go" />
  73. <input type="hidden" name="check_keywords" value="yes" />
  74. <input type="hidden" name="area" value="default" />
  75. </form>
  76. <p class="searchtip" style="font-size: 90%">
  77. Enter search terms or a module, class or function name.
  78. </p>
  79. </div>
  80. <script type="text/javascript">$('#searchbox').show(0);</script>
  81. </div>
  82. </div>
  83. <div class="document">
  84. <div class="documentwrapper">
  85. <div class="bodywrapper">
  86. <div class="body">
  87. <div class="section" id="py4j-documentation">
  88. <h1>Py4J Documentation<a class="headerlink" href="#py4j-documentation" title="Permalink to this headline">¶</a></h1>
  89. <div class="toctree-wrapper compound">
  90. <ul>
  91. <li class="toctree-l1"><a class="reference internal" href="install.html">1. Installing Py4J</a><ul>
  92. <li class="toctree-l2"><a class="reference internal" href="install.html#installing-python-2-6-or-3-4">1.1. Installing Python 2.6+ or 3.4</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="install.html#installing-java-6">1.2. Installing Java 6+</a></li>
  94. <li class="toctree-l2"><a class="reference internal" href="install.html#id1">1.3. Installing Py4J</a></li>
  95. </ul>
  96. </li>
  97. <li class="toctree-l1"><a class="reference internal" href="getting_started.html">2. Getting Started with Py4J</a><ul>
  98. <li class="toctree-l2"><a class="reference internal" href="getting_started.html#writing-the-java-program">2.1. Writing the Java Program</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="getting_started.html#writing-the-python-program">2.2. Writing the Python Program</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="getting_started.html#collections-help-and-constructors">2.3. Collections, Help, and Constructors</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="getting_started.html#where-to-go-from-here">2.4. Where to go from here</a></li>
  102. </ul>
  103. </li>
  104. <li class="toctree-l1"><a class="reference internal" href="advanced_topics.html">3. Advanced Topics</a><ul>
  105. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#accessing-java-collections-and-arrays-from-python">3.1. Accessing Java collections and arrays from Python</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#byte-array-byte">3.2. Byte array (byte[])</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#implementing-java-interfaces-from-python-callback">3.3. Implementing Java interfaces from Python (callback)</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#converting-python-collections-to-java-collections">3.4. Converting Python collections to Java Collections</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#py4j-exceptions">3.5. Py4J Exceptions</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#importing-packages-with-jvm-views">3.6. Importing packages with JVM Views</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#using-py4j-with-eclipse">3.7. Using Py4J with Eclipse</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#py4j-memory-model">3.8. Py4J Memory model</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="advanced_topics.html#py4j-threading-and-connection-model">3.9. Py4J Threading and connection model</a></li>
  114. </ul>
  115. </li>
  116. <li class="toctree-l1"><a class="reference internal" href="py4j_python.html">4. Py4J Python API</a><ul>
  117. <li class="toctree-l2"><a class="reference internal" href="py4j_java_gateway.html">4.1. <code class="docutils literal"><span class="pre">py4j.java_gateway</span></code> &#8212; Py4J Main API</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="py4j_java_protocol.html">4.2. <code class="docutils literal"><span class="pre">py4j.protocol</span></code> &#8212; Py4J Protocol</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="py4j_java_collections.html">4.3. <code class="docutils literal"><span class="pre">py4j.java_collections</span></code> &#8212; Py4J Collections API</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="py4j_finalizer.html">4.4. <code class="docutils literal"><span class="pre">py4j.finalizer</span></code> &#8212; Py4J Finalizer API</a></li>
  121. </ul>
  122. </li>
  123. <li class="toctree-l1"><a class="reference internal" href="py4j_java.html">5. Py4J Java API</a></li>
  124. <li class="toctree-l1"><a class="reference internal" href="faq.html">6. Frequently Asked Questions</a><ul>
  125. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-turn-logging-on-off">6.1. How to turn logging on/off?</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-call-a-constructor">6.2. How to call a constructor?</a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-call-a-static-method">6.3. How to call a static method?</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-access-a-field">6.4. How to access a field?</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-import-a-class">6.5. How to import a class?</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-create-an-array">6.6. How to create an array?</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="faq.html#what-ports-are-used-by-py4j">6.7. What ports are used by Py4J?</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="faq.html#is-py4j-thread-safe">6.8. Is Py4J thread-safe?</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-can-i-use-py4j-with-eclipse">6.9. How can I use Py4J with Eclipse?</a></li>
  134. <li class="toctree-l2"><a class="reference internal" href="faq.html#can-i-use-py4j-with-python-3">6.10. Can I use Py4J with Python 3?</a></li>
  135. <li class="toctree-l2"><a class="reference internal" href="faq.html#are-there-any-security-concerns-with-py4j">6.11. Are there any security concerns with Py4J?</a></li>
  136. <li class="toctree-l2"><a class="reference internal" href="faq.html#i-found-a-bug-how-do-i-report-it">6.12. I found a bug, how do I report it?</a></li>
  137. <li class="toctree-l2"><a class="reference internal" href="faq.html#how-can-i-contribute">6.13. How can I contribute?</a></li>
  138. </ul>
  139. </li>
  140. <li class="toctree-l1"><a class="reference internal" href="contributing.html">7. Contributing to Py4J</a><ul>
  141. <li class="toctree-l2"><a class="reference internal" href="contributing.html#python-coding-conventions">7.1. Python Coding Conventions</a></li>
  142. <li class="toctree-l2"><a class="reference internal" href="contributing.html#java-coding-conventions">7.2. Java Coding Conventions</a></li>
  143. <li class="toctree-l2"><a class="reference internal" href="contributing.html#testing-python-code">7.3. Testing Python Code</a></li>
  144. <li class="toctree-l2"><a class="reference internal" href="contributing.html#testing-java-code">7.4. Testing Java Code</a></li>
  145. <li class="toctree-l2"><a class="reference internal" href="contributing.html#license-and-copyrights">7.5. License and Copyrights</a></li>
  146. </ul>
  147. </li>
  148. <li class="toctree-l1"><a class="reference internal" href="changelog.html">8. Changelog</a><ul>
  149. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-9">8.1. Py4J 0.9</a></li>
  150. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-8-2-1">8.2. Py4J 0.8.2.1</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-8-2">8.3. Py4J 0.8.2</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-8-1">8.4. Py4J 0.8.1</a></li>
  153. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-8">8.5. Py4J 0.8</a></li>
  154. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-7">8.6. Py4J 0.7</a></li>
  155. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-6">8.7. Py4J 0.6</a></li>
  156. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-5">8.8. Py4J 0.5</a></li>
  157. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-4">8.9. Py4J 0.4</a></li>
  158. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-3">8.10. Py4J 0.3</a></li>
  159. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-2">8.11. Py4J 0.2</a></li>
  160. <li class="toctree-l2"><a class="reference internal" href="changelog.html#py4j-0-1">8.12. Py4J 0.1</a></li>
  161. </ul>
  162. </li>
  163. </ul>
  164. </div>
  165. </div>
  166. </div>
  167. <div class="helpbar">
  168. <h3>Questions/Feedback?</h3>
  169. <ul>
  170. <li>Try the <a href="faq.html">FAQ</a> -- It answers many questions.</li>
  171. <li>Search for information in the <a href="https://groups.google.com/a/py4j.org/forum/#!forum/py4j">archives of the py4j-users mailing list</a>, or <a href="https://groups.google.com/a/py4j.org/forum/#!forum/py4j/join">post a question</a>.</li>
  172. <li>If you notice errors with this documentation, <a href="https://github.com/bartdag/py4j/issues">open a ticket</a> and let us know. Please, only open a ticket for feedback or improvements on the docs. To get help, use the links above!</li>
  173. </ul>
  174. </div>
  175. </div>
  176. </div>
  177. <div class="clearer"></div>
  178. </div>
  179. <div class="related">
  180. <h3>Navigation</h3>
  181. <ul>
  182. <li class="right" style="margin-right: 5px">
  183. <a href="genindex.html" title="General Index"
  184. >index</a></li>
  185. <li class="right" >
  186. <a href="py-modindex.html" title="Python Module Index"
  187. >modules</a> |</li>
  188. <li class="right" >
  189. <a href="install.html" title="1. Installing Py4J"
  190. >next</a> |</li>
  191. <li><a href="index.html">Home</a> |</li>
  192. <li><a href="download.html">Download</a> |</li>
  193. <li><a href="#">Doc</a> |</li>
  194. <li><a href="https://blog.py4j.org">Blog</a> |</li>
  195. <li><a href="https://github.com/bartdag/py4j">github</a> |</li>
  196. <li><a href="about.html">About</a> &raquo;</li>
  197. </ul>
  198. </div>
  199. <div class="footer">
  200. &copy; Copyright 2009-2013, Barthélémy Dagenais.
  201. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.1.
  202. </div>
  203. </div>
  204. </body>
  205. </html>