site/docs/3.2.2/api/python/_modules/pyspark/taskcontext.html - spark-website - Git at Google


 <!DOCTYPE html>

 <html>
   <head>
     <meta charset="utf-8" />
     <title>pyspark.taskcontext &#8212; PySpark 3.2.2 documentation</title>

   <link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">


   <link rel="stylesheet"
     href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
   <link rel="preload" as="font" type="font/woff2" crossorigin
     href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
   <link rel="preload" as="font" type="font/woff2" crossorigin
     href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">


   <link rel="stylesheet"
     href="../../_static/vendor/open-sans_all/1.44.1/index.css">
   <link rel="stylesheet"
     href="../../_static/vendor/lato_latin-ext/1.44.1/index.css">


     <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" />

   <link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js">

     <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
     <script src="../../_static/jquery.js"></script>
     <script src="../../_static/underscore.js"></script>
     <script src="../../_static/doctools.js"></script>
     <script src="../../_static/language_data.js"></script>
     <script src="../../_static/copybutton.js"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
     <link rel="search" title="Search" href="../../search.html" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="docsearch:language" content="en" />
   </head>
   <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">

     <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
 <div class="container-xl">

     <a class="navbar-brand" href="../../index.html">

       <img src="../../_static/spark-logo-reverse.png" class="logo" alt="logo" />

     </a>
     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
         <span class="navbar-toggler-icon"></span>
     </button>

     <div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
       <ul id="navbar-main-elements" class="navbar-nav mr-auto">


         <li class="nav-item ">
             <a class="nav-link" href="../../getting_started/index.html">Getting Started</a>
         </li>

         <li class="nav-item ">
             <a class="nav-link" href="../../user_guide/index.html">User Guide</a>
         </li>

         <li class="nav-item ">
             <a class="nav-link" href="../../reference/index.html">API Reference</a>
         </li>

         <li class="nav-item ">
             <a class="nav-link" href="../../development/index.html">Development</a>
         </li>

         <li class="nav-item ">
             <a class="nav-link" href="../../migration_guide/index.html">Migration Guide</a>
         </li>


       </ul>


       <ul class="navbar-nav">


       </ul>
     </div>
 </div>
     </nav>


     <div class="container-xl">
       <div class="row">

           <div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
   <i class="icon fas fa-search"></i>
   <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
 </form>
 <nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">

     <div class="bd-toc-item active">


     <ul class="nav bd-sidenav">


       </ul>

   </nav>
           </div>


           <div class="d-none d-xl-block col-xl-2 bd-toc">


 <nav id="bd-toc-nav">
     <ul class="nav section-nav flex-column">

     </ul>
 </nav>


           </div>


           <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">

               <div>

   <h1>Source code for pyspark.taskcontext</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>
 <span class="kn">from</span> <span class="nn">pyspark.java_gateway</span> <span class="kn">import</span> <span class="n">local_connect_and_auth</span>
 <span class="kn">from</span> <span class="nn">pyspark.serializers</span> <span class="kn">import</span> <span class="n">read_int</span><span class="p">,</span> <span class="n">write_int</span><span class="p">,</span> <span class="n">write_with_length</span><span class="p">,</span> <span class="n">UTF8Deserializer</span>


 <div class="viewcode-block" id="TaskContext"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.html#pyspark.TaskContext">[docs]</a><span class="k">class</span> <span class="nc">TaskContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Contextual information about a task which can be read or mutated during</span>
 <span class="sd">    execution. To access the TaskContext for a running task, use:</span>
 <span class="sd">    :meth:`TaskContext.get`.</span>
 <span class="sd">    &quot;&quot;&quot;</span>

     <span class="n">_taskContext</span> <span class="o">=</span> <span class="kc">None</span>

     <span class="n">_attemptNumber</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_partitionId</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_stageId</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_taskAttemptId</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_localProperties</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_resources</span> <span class="o">=</span> <span class="kc">None</span>

     <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Even if users construct TaskContext instead of using get, give them the singleton.&quot;&quot;&quot;</span>
         <span class="n">taskContext</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span>
         <span class="k">if</span> <span class="n">taskContext</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">return</span> <span class="n">taskContext</span>
         <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span> <span class="o">=</span> <span class="n">taskContext</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">taskContext</span>

     <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">_getOrCreate</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Internal function to get or create global TaskContext.&quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span> <span class="o">=</span> <span class="n">TaskContext</span><span class="p">()</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span>

     <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">_setTaskContext</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">taskContext</span><span class="p">):</span>
         <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span> <span class="o">=</span> <span class="n">taskContext</span>

 <div class="viewcode-block" id="TaskContext.get"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.get.html#pyspark.TaskContext.get">[docs]</a>    <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return the currently active TaskContext. This can be called inside of</span>
 <span class="sd">        user functions to access contextual information about running tasks.</span>

 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
 <span class="sd">        Must be called on the worker, not the driver. Returns None if not initialized.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span></div>

 <div class="viewcode-block" id="TaskContext.stageId"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.stageId.html#pyspark.TaskContext.stageId">[docs]</a>    <span class="k">def</span> <span class="nf">stageId</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;The ID of the stage that this task belong to.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stageId</span></div>

 <div class="viewcode-block" id="TaskContext.partitionId"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.partitionId.html#pyspark.TaskContext.partitionId">[docs]</a>    <span class="k">def</span> <span class="nf">partitionId</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        The ID of the RDD partition that is computed by this task.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_partitionId</span></div>

 <div class="viewcode-block" id="TaskContext.attemptNumber"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.attemptNumber.html#pyspark.TaskContext.attemptNumber">[docs]</a>    <span class="k">def</span> <span class="nf">attemptNumber</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;&quot;</span>
 <span class="sd">        How many times this task has been attempted.  The first task attempt will be assigned</span>
 <span class="sd">        attemptNumber = 0, and subsequent attempts will have increasing attempt numbers.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attemptNumber</span></div>

 <div class="viewcode-block" id="TaskContext.taskAttemptId"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.taskAttemptId.html#pyspark.TaskContext.taskAttemptId">[docs]</a>    <span class="k">def</span> <span class="nf">taskAttemptId</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        An ID that is unique to this task attempt (within the same SparkContext, no two task</span>
 <span class="sd">        attempts will share the same attempt ID).  This is roughly equivalent to Hadoop&#39;s</span>
 <span class="sd">        TaskAttemptID.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_taskAttemptId</span></div>

 <div class="viewcode-block" id="TaskContext.getLocalProperty"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.getLocalProperty.html#pyspark.TaskContext.getLocalProperty">[docs]</a>    <span class="k">def</span> <span class="nf">getLocalProperty</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="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get a local property set upstream in the driver, or None if it is missing.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_localProperties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span></div>

 <div class="viewcode-block" id="TaskContext.resources"><a class="viewcode-back" href="../../reference/api/pyspark.TaskContext.resources.html#pyspark.TaskContext.resources">[docs]</a>    <span class="k">def</span> <span class="nf">resources</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Resources allocated to the task. The key is the resource name and the value is information</span>
 <span class="sd">        about the resource.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_resources</span></div></div>


 <span class="n">BARRIER_FUNCTION</span> <span class="o">=</span> <span class="mi">1</span>
 <span class="n">ALL_GATHER_FUNCTION</span> <span class="o">=</span> <span class="mi">2</span>


 <span class="k">def</span> <span class="nf">_load_from_socket</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="n">auth_secret</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">all_gather_message</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Load data from a given socket, this is a blocking method thus only return when the socket</span>
 <span class="sd">    connection has been closed.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="p">(</span><span class="n">sockfile</span><span class="p">,</span> <span class="n">sock</span><span class="p">)</span> <span class="o">=</span> <span class="n">local_connect_and_auth</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="n">auth_secret</span><span class="p">)</span>

     <span class="c1"># The call may block forever, so no timeout</span>
     <span class="n">sock</span><span class="o">.</span><span class="n">settimeout</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>

     <span class="k">if</span> <span class="n">function</span> <span class="o">==</span> <span class="n">BARRIER_FUNCTION</span><span class="p">:</span>
         <span class="c1"># Make a barrier() function call.</span>
         <span class="n">write_int</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="n">sockfile</span><span class="p">)</span>
     <span class="k">elif</span> <span class="n">function</span> <span class="o">==</span> <span class="n">ALL_GATHER_FUNCTION</span><span class="p">:</span>
         <span class="c1"># Make a all_gather() function call.</span>
         <span class="n">write_int</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="n">sockfile</span><span class="p">)</span>
         <span class="n">write_with_length</span><span class="p">(</span><span class="n">all_gather_message</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">),</span> <span class="n">sockfile</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Unrecognized function type&quot;</span><span class="p">)</span>
     <span class="n">sockfile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>

     <span class="c1"># Collect result.</span>
     <span class="nb">len</span> <span class="o">=</span> <span class="n">read_int</span><span class="p">(</span><span class="n">sockfile</span><span class="p">)</span>
     <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">):</span>
         <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">UTF8Deserializer</span><span class="p">()</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">sockfile</span><span class="p">))</span>

     <span class="c1"># Release resources.</span>
     <span class="n">sockfile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
     <span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

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


 <div class="viewcode-block" id="BarrierTaskContext"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskContext.html#pyspark.BarrierTaskContext">[docs]</a><span class="k">class</span> <span class="nc">BarrierTaskContext</span><span class="p">(</span><span class="n">TaskContext</span><span class="p">):</span>

     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    A :class:`TaskContext` with extra contextual info and tooling for tasks in a barrier stage.</span>
 <span class="sd">    Use :func:`BarrierTaskContext.get` to obtain the barrier context for a running barrier task.</span>

 <span class="sd">    .. versionadded:: 2.4.0</span>

 <span class="sd">    Notes</span>
 <span class="sd">    -----</span>
 <span class="sd">    This API is experimental</span>
 <span class="sd">    &quot;&quot;&quot;</span>

     <span class="n">_port</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">_secret</span> <span class="o">=</span> <span class="kc">None</span>

     <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">_getOrCreate</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Internal function to get or create global BarrierTaskContext. We need to make sure</span>
 <span class="sd">        BarrierTaskContext is returned from here because it is needed in python worker reuse</span>
 <span class="sd">        scenario, see SPARK-25921 for more details.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span><span class="p">,</span> <span class="n">BarrierTaskContext</span><span class="p">):</span>
             <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span>

 <div class="viewcode-block" id="BarrierTaskContext.get"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskContext.get.html#pyspark.BarrierTaskContext.get">[docs]</a>    <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return the currently active :class:`BarrierTaskContext`.</span>
 <span class="sd">        This can be called inside of user functions to access contextual information about</span>
 <span class="sd">        running tasks.</span>

 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
 <span class="sd">        Must be called on the worker, not the driver. Returns None if not initialized.</span>
 <span class="sd">        An Exception will raise if it is not in a barrier stage.</span>

 <span class="sd">        This API is experimental</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span><span class="p">,</span> <span class="n">BarrierTaskContext</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;It is not in a barrier stage&#39;</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_taskContext</span></div>

     <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">_initialize</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">secret</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Initialize BarrierTaskContext, other methods within BarrierTaskContext can only be called</span>
 <span class="sd">        after BarrierTaskContext is initialized.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">cls</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">port</span>
         <span class="bp">cls</span><span class="o">.</span><span class="n">_secret</span> <span class="o">=</span> <span class="n">secret</span>

 <div class="viewcode-block" id="BarrierTaskContext.barrier"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskContext.barrier.html#pyspark.BarrierTaskContext.barrier">[docs]</a>    <span class="k">def</span> <span class="nf">barrier</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Sets a global barrier and waits until all tasks in this stage hit this barrier.</span>
 <span class="sd">        Similar to `MPI_Barrier` function in MPI, this function blocks until all tasks</span>
 <span class="sd">        in the same stage have reached this routine.</span>

 <span class="sd">        .. versionadded:: 2.4.0</span>

 <span class="sd">        .. warning:: In a barrier stage, each task much have the same number of `barrier()`</span>
 <span class="sd">            calls, in all possible code branches.</span>
 <span class="sd">            Otherwise, you may get the job hanging or a SparkException after timeout.</span>

 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
 <span class="sd">        This API is experimental</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secret</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Not supported to call barrier() before initialize &quot;</span> <span class="o">+</span>
                                <span class="s2">&quot;BarrierTaskContext.&quot;</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="n">_load_from_socket</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secret</span><span class="p">,</span> <span class="n">BARRIER_FUNCTION</span><span class="p">)</span></div>

 <div class="viewcode-block" id="BarrierTaskContext.allGather"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskContext.allGather.html#pyspark.BarrierTaskContext.allGather">[docs]</a>    <span class="k">def</span> <span class="nf">allGather</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        This function blocks until all tasks in the same stage have reached this routine.</span>
 <span class="sd">        Each task passes in a message and returns with a list of all the messages passed in</span>
 <span class="sd">        by each of those tasks.</span>

 <span class="sd">        .. versionadded:: 3.0.0</span>

 <span class="sd">        .. warning:: In a barrier stage, each task much have the same number of `allGather()`</span>
 <span class="sd">            calls, in all possible code branches.</span>
 <span class="sd">            Otherwise, you may get the job hanging or a SparkException after timeout.</span>

 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
 <span class="sd">        This API is experimental</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Argument `message` must be of type `str`&quot;</span><span class="p">)</span>
         <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secret</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Not supported to call barrier() before initialize &quot;</span> <span class="o">+</span>
                                <span class="s2">&quot;BarrierTaskContext.&quot;</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="k">return</span> <span class="n">_load_from_socket</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secret</span><span class="p">,</span> <span class="n">ALL_GATHER_FUNCTION</span><span class="p">,</span> <span class="n">message</span><span class="p">)</span></div>

 <div class="viewcode-block" id="BarrierTaskContext.getTaskInfos"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskContext.getTaskInfos.html#pyspark.BarrierTaskContext.getTaskInfos">[docs]</a>    <span class="k">def</span> <span class="nf">getTaskInfos</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Returns :class:`BarrierTaskInfo` for all tasks in this barrier stage,</span>
 <span class="sd">        ordered by partition ID.</span>

 <span class="sd">        .. versionadded:: 2.4.0</span>

 <span class="sd">        Notes</span>
 <span class="sd">        -----</span>
 <span class="sd">        This API is experimental</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secret</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Not supported to call getTaskInfos() before initialize &quot;</span> <span class="o">+</span>
                                <span class="s2">&quot;BarrierTaskContext.&quot;</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="n">addresses</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_localProperties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;addresses&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
             <span class="k">return</span> <span class="p">[</span><span class="n">BarrierTaskInfo</span><span class="p">(</span><span class="n">h</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="n">addresses</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;,&quot;</span><span class="p">)]</span></div></div>


 <div class="viewcode-block" id="BarrierTaskInfo"><a class="viewcode-back" href="../../reference/api/pyspark.BarrierTaskInfo.html#pyspark.BarrierTaskInfo">[docs]</a><span class="k">class</span> <span class="nc">BarrierTaskInfo</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Carries all task infos of a barrier task.</span>

 <span class="sd">    .. versionadded:: 2.4.0</span>

 <span class="sd">    Attributes</span>
 <span class="sd">    ----------</span>
 <span class="sd">    address : str</span>
 <span class="sd">        The IPv4 address (host:port) of the executor that the barrier task is running on</span>

 <span class="sd">    Notes</span>
 <span class="sd">    -----</span>
 <span class="sd">    This API is experimental</span>
 <span class="sd">    &quot;&quot;&quot;</span>

     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">address</span> <span class="o">=</span> <span class="n">address</span></div>
 </pre></div>

               </div>


               <div class='prev-next-bottom'>


               </div>

           </main>


       </div>
     </div>


   <script src="../../_static/js/index.3da636dd464baa7582d2.js"></script>


     <footer class="footer mt-5 mt-md-0">
   <div class="container">
     <p>
           &copy; Copyright .<br/>
         Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
     </p>
   </div>
 </footer>
   </body>
 </html>