output/tutorial/py.html - thrift-website - Git at Google

 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
     <meta content="en-us" http-equiv="Content-Language" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">

     <link href="/static/images/favicon.ico" rel="shortcut icon" />
     <link href="/static/css/style.css" rel="stylesheet" type="text/css" />
     <link href="/static/css/codehilite.css" rel="stylesheet" type="text/css" />
     <link href="/static/css/bootstrap.css" media="screen, projection" rel="stylesheet" type="text/css" />
     <link href="/static/css/thrift.css" media="screen, projection" rel="stylesheet" type="text/css" />

     <script src="/static/js/jquery.min.js"></script>
     <script src="/static/js/bootstrap-dropdown.js"></script>
     <script src="/static/js/bootstrap-tab.js"></script>
     <script src="/static/js/thrift.js"></script>

     <title>Apache Thrift - Python</title>
   </head>
   <body>
     <div class="navbar">
   <div class="navbar-inner">
     <div class="container">
       <a class="brand" href="/">Apache Thrift &trade;</a>
       <div class="nav-collapse">
         <ul class="nav pull-right">
           <li><a href="/download">Download</a></li>
           <li><a href="/docs">Documentation</a></li>
           <li><a href="/developers">Developers</a></li>
           <li><a href="/lib">Libraries</a></li>
           <li><a href="/tutorial">Tutorial</a></li>
           <li><a href="/test">Test Suite</a></li>
           <li><a href="/about">About</a></li>
           <li class="dropdown">
             <a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache <b class="caret"></b></a>
             <ul class="dropdown-menu">
               <li><a href="http://www.apache.org/" target="_blank">Apache Home</a></li>
               <li><a href="http://www.apache.org/licenses/" target="_blank">Apache License v2.0</a></li>
               <li><a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Donate</a></li>
               <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
               <li><a href="http://www.apache.org/security/" target="_blank">Security</a></li>
             </ul>
           </li>
         </ul>
       </div>
     </div>
   </div>
 </div>

     <div class="container">
       <h2>Python Tutorial</h2>

 <h3>Introduction</h3>

 <p>
 All Apache Thrift tutorials require that you have:

 <ol>
   <li>The Apache Thrift Compiler and Libraries, see <a href="/download">Download</a> and <a href="/docs/BuildingFromSource">Building from Source</a> for more details.</li>
   <li>Generated the <a href="https://github.com/apache/thrift/blob/master/tutorial/tutorial.thrift">tutorial.thrift</a> and <a href="https://github.com/apache/thrift/blob/master/tutorial/shared.thrift">shared.thrift</a> files:<br>
     <pre><code>thrift -r --gen py tutorial.thrift</code></pre>
   </li>
   <li>Followed all prerequisites listed below.</li>
 </ol>

 <h3 id="prerequisites">Prerequisites</h3>

 <h3 id="client">Client</h3>

 <div class="highlight"><pre class="codehilite"><code><span class="kn">import</span> <span class="nn">sys</span>
 <span class="kn">import</span> <span class="nn">glob</span>
 <span class="n">sys</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">append</span><span class="p">(</span><span class="s">'gen-py'</span><span class="p">)</span>
 <span class="n">sys</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">glob</span><span class="p">.</span><span class="n">glob</span><span class="p">(</span><span class="s">'../../lib/py/build/lib*'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>

 <span class="kn">from</span> <span class="nn">tutorial</span> <span class="kn">import</span> <span class="n">Calculator</span>
 <span class="kn">from</span> <span class="nn">tutorial.ttypes</span> <span class="kn">import</span> <span class="n">InvalidOperation</span><span class="p">,</span> <span class="n">Operation</span><span class="p">,</span> <span class="n">Work</span>

 <span class="kn">from</span> <span class="nn">thrift</span> <span class="kn">import</span> <span class="n">Thrift</span>
 <span class="kn">from</span> <span class="nn">thrift.transport</span> <span class="kn">import</span> <span class="n">TSocket</span>
 <span class="kn">from</span> <span class="nn">thrift.transport</span> <span class="kn">import</span> <span class="n">TTransport</span>
 <span class="kn">from</span> <span class="nn">thrift.protocol</span> <span class="kn">import</span> <span class="n">TBinaryProtocol</span>


 <span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
     <span class="c1"># Make socket
 </span>    <span class="n">transport</span> <span class="o">=</span> <span class="n">TSocket</span><span class="p">.</span><span class="n">TSocket</span><span class="p">(</span><span class="s">'localhost'</span><span class="p">,</span> <span class="mi">9090</span><span class="p">)</span>

     <span class="c1"># Buffering is critical. Raw sockets are very slow
 </span>    <span class="n">transport</span> <span class="o">=</span> <span class="n">TTransport</span><span class="p">.</span><span class="n">TBufferedTransport</span><span class="p">(</span><span class="n">transport</span><span class="p">)</span>

     <span class="c1"># Wrap in a protocol
 </span>    <span class="n">protocol</span> <span class="o">=</span> <span class="n">TBinaryProtocol</span><span class="p">.</span><span class="n">TBinaryProtocol</span><span class="p">(</span><span class="n">transport</span><span class="p">)</span>

     <span class="c1"># Create a client to use the protocol encoder
 </span>    <span class="n">client</span> <span class="o">=</span> <span class="n">Calculator</span><span class="p">.</span><span class="n">Client</span><span class="p">(</span><span class="n">protocol</span><span class="p">)</span>

     <span class="c1"># Connect!
 </span>    <span class="n">transport</span><span class="p">.</span><span class="nb">open</span><span class="p">()</span>

     <span class="n">client</span><span class="p">.</span><span class="n">ping</span><span class="p">()</span>
     <span class="k">print</span><span class="p">(</span><span class="s">'ping()'</span><span class="p">)</span>

     <span class="n">sum_</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
     <span class="k">print</span><span class="p">(</span><span class="s">'1+1=%d'</span> <span class="o">%</span> <span class="n">sum_</span><span class="p">)</span>

     <span class="n">work</span> <span class="o">=</span> <span class="n">Work</span><span class="p">()</span>

     <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">Operation</span><span class="p">.</span><span class="n">DIVIDE</span>
     <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">=</span> <span class="mi">1</span>
     <span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">=</span> <span class="mi">0</span>

     <span class="k">try</span><span class="p">:</span>
         <span class="n">quotient</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">calculate</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">work</span><span class="p">)</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'Whoa? You know how to divide by zero?'</span><span class="p">)</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'FYI the answer is %d'</span> <span class="o">%</span> <span class="n">quotient</span><span class="p">)</span>
     <span class="k">except</span> <span class="n">InvalidOperation</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'InvalidOperation: %r'</span> <span class="o">%</span> <span class="n">e</span><span class="p">)</span>

     <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">=</span> <span class="n">Operation</span><span class="p">.</span><span class="n">SUBTRACT</span>
     <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">=</span> <span class="mi">15</span>
     <span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">=</span> <span class="mi">10</span>

     <span class="n">diff</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">calculate</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">work</span><span class="p">)</span>
     <span class="k">print</span><span class="p">(</span><span class="s">'15-10=%d'</span> <span class="o">%</span> <span class="n">diff</span><span class="p">)</span>

     <span class="n">log</span> <span class="o">=</span> <span class="n">client</span><span class="p">.</span><span class="n">getStruct</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
     <span class="k">print</span><span class="p">(</span><span class="s">'Check log: %s'</span> <span class="o">%</span> <span class="n">log</span><span class="p">.</span><span class="n">value</span><span class="p">)</span>

     <span class="c1"># Close!
 </span>    <span class="n">transport</span><span class="p">.</span><span class="n">close</span><span class="p">()</span>

 </code></pre></div>
 <p class="snippet_footer">This snippet was generated by Apache Thrift's <strong>source tree docs</strong>:
 <a href="https://gitbox.apache.org/repos/asf?p=thrift.git;a=blob;hb=HEAD;f=tutorial/py/PythonClient.py">tutorial/py/PythonClient.py</a>
 </p>

 <h3 id="server">Server</h3>

 <div class="highlight"><pre class="codehilite"><code><span class="kn">import</span> <span class="nn">glob</span>
 <span class="kn">import</span> <span class="nn">sys</span>
 <span class="n">sys</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">append</span><span class="p">(</span><span class="s">'gen-py'</span><span class="p">)</span>
 <span class="n">sys</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">glob</span><span class="p">.</span><span class="n">glob</span><span class="p">(</span><span class="s">'../../lib/py/build/lib*'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>

 <span class="kn">from</span> <span class="nn">tutorial</span> <span class="kn">import</span> <span class="n">Calculator</span>
 <span class="kn">from</span> <span class="nn">tutorial.ttypes</span> <span class="kn">import</span> <span class="n">InvalidOperation</span><span class="p">,</span> <span class="n">Operation</span>

 <span class="kn">from</span> <span class="nn">shared.ttypes</span> <span class="kn">import</span> <span class="n">SharedStruct</span>

 <span class="kn">from</span> <span class="nn">thrift.transport</span> <span class="kn">import</span> <span class="n">TSocket</span>
 <span class="kn">from</span> <span class="nn">thrift.transport</span> <span class="kn">import</span> <span class="n">TTransport</span>
 <span class="kn">from</span> <span class="nn">thrift.protocol</span> <span class="kn">import</span> <span class="n">TBinaryProtocol</span>
 <span class="kn">from</span> <span class="nn">thrift.server</span> <span class="kn">import</span> <span class="n">TServer</span>


 <span class="k">class</span> <span class="nc">CalculatorHandler</span><span class="p">:</span>
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="bp">self</span><span class="p">.</span><span class="n">log</span> <span class="o">=</span> <span class="p">{}</span>

     <span class="k">def</span> <span class="nf">ping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'ping()'</span><span class="p">)</span>

     <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n1</span><span class="p">,</span> <span class="n">n2</span><span class="p">):</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'add(%d,%d)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">n1</span><span class="p">,</span> <span class="n">n2</span><span class="p">))</span>
         <span class="k">return</span> <span class="n">n1</span> <span class="o">+</span> <span class="n">n2</span>

     <span class="k">def</span> <span class="nf">calculate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logid</span><span class="p">,</span> <span class="n">work</span><span class="p">):</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'calculate(%d, %r)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">logid</span><span class="p">,</span> <span class="n">work</span><span class="p">))</span>

         <span class="k">if</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">==</span> <span class="n">Operation</span><span class="p">.</span><span class="n">ADD</span><span class="p">:</span>
             <span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">+</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span>
         <span class="k">elif</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">==</span> <span class="n">Operation</span><span class="p">.</span><span class="n">SUBTRACT</span><span class="p">:</span>
             <span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">-</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span>
         <span class="k">elif</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">==</span> <span class="n">Operation</span><span class="p">.</span><span class="n">MULTIPLY</span><span class="p">:</span>
             <span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">*</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span>
         <span class="k">elif</span> <span class="n">work</span><span class="p">.</span><span class="n">op</span> <span class="o">==</span> <span class="n">Operation</span><span class="p">.</span><span class="n">DIVIDE</span><span class="p">:</span>
             <span class="k">if</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
                 <span class="k">raise</span> <span class="n">InvalidOperation</span><span class="p">(</span><span class="n">work</span><span class="p">.</span><span class="n">op</span><span class="p">,</span> <span class="s">'Cannot divide by 0'</span><span class="p">)</span>
             <span class="n">val</span> <span class="o">=</span> <span class="n">work</span><span class="p">.</span><span class="n">num1</span> <span class="o">/</span> <span class="n">work</span><span class="p">.</span><span class="n">num2</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="k">raise</span> <span class="n">InvalidOperation</span><span class="p">(</span><span class="n">work</span><span class="p">.</span><span class="n">op</span><span class="p">,</span> <span class="s">'Invalid operation'</span><span class="p">)</span>

         <span class="n">log</span> <span class="o">=</span> <span class="n">SharedStruct</span><span class="p">()</span>
         <span class="n">log</span><span class="p">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">logid</span>
         <span class="n">log</span><span class="p">.</span><span class="n">value</span> <span class="o">=</span> <span class="s">'%d'</span> <span class="o">%</span> <span class="p">(</span><span class="n">val</span><span class="p">)</span>
         <span class="bp">self</span><span class="p">.</span><span class="n">log</span><span class="p">[</span><span class="n">logid</span><span class="p">]</span> <span class="o">=</span> <span class="n">log</span>

         <span class="k">return</span> <span class="n">val</span>

     <span class="k">def</span> <span class="nf">getStruct</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'getStruct(%d)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">))</span>
         <span class="k">return</span> <span class="bp">self</span><span class="p">.</span><span class="n">log</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>

     <span class="k">def</span> <span class="nf">zip</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">print</span><span class="p">(</span><span class="s">'zip()'</span><span class="p">)</span>


 <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span>
     <span class="n">handler</span> <span class="o">=</span> <span class="n">CalculatorHandler</span><span class="p">()</span>
     <span class="n">processor</span> <span class="o">=</span> <span class="n">Calculator</span><span class="p">.</span><span class="n">Processor</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
     <span class="n">transport</span> <span class="o">=</span> <span class="n">TSocket</span><span class="p">.</span><span class="n">TServerSocket</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">9090</span><span class="p">)</span>
     <span class="n">tfactory</span> <span class="o">=</span> <span class="n">TTransport</span><span class="p">.</span><span class="n">TBufferedTransportFactory</span><span class="p">()</span>
     <span class="n">pfactory</span> <span class="o">=</span> <span class="n">TBinaryProtocol</span><span class="p">.</span><span class="n">TBinaryProtocolFactory</span><span class="p">()</span>

     <span class="n">server</span> <span class="o">=</span> <span class="n">TServer</span><span class="p">.</span><span class="n">TSimpleServer</span><span class="p">(</span><span class="n">processor</span><span class="p">,</span> <span class="n">transport</span><span class="p">,</span> <span class="n">tfactory</span><span class="p">,</span> <span class="n">pfactory</span><span class="p">)</span>

     <span class="c1"># You could do one of these for a multithreaded server
 </span>    <span class="c1"># server = TServer.TThreadedServer(
 </span>    <span class="c1">#     processor, transport, tfactory, pfactory)
 </span>    <span class="c1"># server = TServer.TThreadPoolServer(
 </span>    <span class="c1">#     processor, transport, tfactory, pfactory)
 </span>
     <span class="k">print</span><span class="p">(</span><span class="s">'Starting the server...'</span><span class="p">)</span>
     <span class="n">server</span><span class="p">.</span><span class="n">serve</span><span class="p">()</span>
     <span class="k">print</span><span class="p">(</span><span class="s">'done.'</span><span class="p">)</span>
 </code></pre></div>
 <p class="snippet_footer">This snippet was generated by Apache Thrift's <strong>source tree docs</strong>:
 <a href="https://gitbox.apache.org/repos/asf?p=thrift.git;a=blob;hb=HEAD;f=tutorial/py/PythonServer.py">tutorial/py/PythonServer.py</a>
 </p>

 <h2 id="additional-information">Additional Information</h2>


     </div>
     <div class="container">
   <hr>
   <footer class="footer">
     <div class="row">
       <div class="span3">
         <h3>Links</h3>
         <ul class="unstyled">
           <li><a href="/download">Download</a></li>
           <li><a href="/developers">Developers</a></li>
           <li><a href="/tutorial">Tutorials</a></li>
         </ul>
         <ul class="unstyled">
           <li><a href="/sitemap">Sitemap</a></li>
         </ul>
       </div>
       <div class="span3">
         <h3>Get Involved</h3>
         <ul class="unstyled">
           <li><a href="/mailing">Mailing Lists</a></li>
           <li><a href="http://issues.apache.org/jira/browse/THRIFT">Issue Tracking</a></li>
           <li><a href="/docs/HowToContribute">How To Contribute</a></li>
         </ul>
       </div>
       <div class="span6">
         <a href="http://www.apache.org/"><img src="/static/images/feather.svg" onerror="this.src='/static/images/feather.png';this.onerror=null;" /></a>
         Copyright &copy; 2024 <a href="http://www.apache.org/">Apache Software Foundation</a>.
         Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>.
         Apache, Apache Thrift, and the Apache feather logo are trademarks of The Apache Software Foundation.
       </div>
     </div>
   </footer>
 </div>

   </body>
 </html>