pydoc/2.38.0/apache_beam.dataframe.frame_base.html - beam-site - Git at Google



 <!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>apache_beam.dataframe.frame_base module &mdash; Apache Beam 2.38.0 documentation</title>


   <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.dataframe.frames module" href="apache_beam.dataframe.frames.html" />
     <link rel="prev" title="apache_beam.dataframe.expressions module" href="apache_beam.dataframe.expressions.html" />
 </head>

 <body class="wy-body-for-nav">


   <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"> Apache Beam


           </a>


               <div class="version">
                 2.38.0
               </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="apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.dataframe.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.convert.html">apache_beam.dataframe.convert module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.doctests.html">apache_beam.dataframe.doctests module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.expressions.html">apache_beam.dataframe.expressions module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.dataframe.frame_base module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.frames.html">apache_beam.dataframe.frames module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.io.html">apache_beam.dataframe.io module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.pandas_top_level_functions.html">apache_beam.dataframe.pandas_top_level_functions module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.partitionings.html">apache_beam.dataframe.partitionings module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.schemas.html">apache_beam.dataframe.schemas module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.transforms.html">apache_beam.dataframe.transforms module</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>


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

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Apache Beam</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><a href="apache_beam.dataframe.html">apache_beam.dataframe package</a> &raquo;</li>

       <li>apache_beam.dataframe.frame_base module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.dataframe.frame_base.rst.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="module-apache_beam.dataframe.frame_base">
 <span id="apache-beam-dataframe-frame-base-module"></span><h1>apache_beam.dataframe.frame_base module<a class="headerlink" href="#module-apache_beam.dataframe.frame_base" title="Permalink to this headline">¶</a></h1>
 <dl class="class">
 <dt id="apache_beam.dataframe.frame_base.DeferredBase">
 <em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">DeferredBase</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <dl class="classmethod">
 <dt id="apache_beam.dataframe.frame_base.DeferredBase.wrap">
 <em class="property">classmethod </em><code class="descname">wrap</code><span class="sig-paren">(</span><em>expr</em>, <em>split_tuples=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase.wrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase.wrap" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase">
 <em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">UnusableUnpickledDeferredBase</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#UnusableUnpickledDeferredBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Placeholder object used to break the transitive pickling chain in case a
 DeferredBase accidentially gets pickled (e.g. as part of globals).</p>
 <p>Trying to use this object after unpickling is a bug and will result in an
 error.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.dataframe.frame_base.DeferredFrame">
 <em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">DeferredFrame</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredFrame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredFrame" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.frame_base.DeferredBase" title="apache_beam.dataframe.frame_base.DeferredBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.frame_base.DeferredBase</span></code></a></p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.name_and_func">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">name_and_func</code><span class="sig-paren">(</span><em>method: Union[str, Callable]</em><span class="sig-paren">)</span> &#x2192; Tuple[str, Callable]<a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#name_and_func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.name_and_func" title="Permalink to this definition">¶</a></dt>
 <dd><p>For the given method name or method, return the method name and the method
 itself.</p>
 <p>For internal use only. No backwards compatibility guarantees.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.wont_implement_method">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">wont_implement_method</code><span class="sig-paren">(</span><em>base_type</em>, <em>name</em>, <em>reason=None</em>, <em>explanation=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#wont_implement_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.wont_implement_method" title="Permalink to this definition">¶</a></dt>
 <dd><p>Generate a stub method that raises WontImplementError.</p>
 <p>Note either reason or explanation must be specified. If both are specified,
 explanation is ignored.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>base_type</strong> – The pandas type of the method that this is trying to replicate.</li>
 <li><strong>name</strong> – The name of the method that this is aiming to replicate.</li>
 <li><strong>reason</strong> – If specified, use data from the corresponding entry in
 <code class="docutils literal notranslate"><span class="pre">_WONT_IMPLEMENT_REASONS</span></code> to generate a helpful exception message
 and docstring for the method.</li>
 <li><strong>explanation</strong> – If specified, use this string as an explanation for why
 this operation is not supported when generating an exception message
 and docstring.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.not_implemented_method">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">not_implemented_method</code><span class="sig-paren">(</span><em>op</em>, <em>jira='BEAM-9547'</em>, <em>base_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#not_implemented_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.not_implemented_method" title="Permalink to this definition">¶</a></dt>
 <dd><p>Generate a stub method for <code class="docutils literal notranslate"><span class="pre">op</span></code> that simply raises a NotImplementedError.</p>
 <p>For internal use only. No backwards compatibility guarantees.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.maybe_inplace">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">maybe_inplace</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#maybe_inplace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.maybe_inplace" title="Permalink to this definition">¶</a></dt>
 <dd><p>Handles the inplace= kwarg available in many pandas operations.</p>
 <p>This decorator produces a new function handles the inplace kwarg. When
 <cite>inplace=False</cite>, the new function simply yields the result of <cite>func</cite>
 directly.</p>
 <p>When <cite>inplace=True</cite>, the output of <cite>func</cite> is used to replace this instances
 expression. The result is that any operations applied to this instance after
 the inplace operation will refernce the updated expression.</p>
 <p>For internal use only. No backwards compatibility guarantees.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.args_to_kwargs">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">args_to_kwargs</code><span class="sig-paren">(</span><em>base_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#args_to_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.args_to_kwargs" title="Permalink to this definition">¶</a></dt>
 <dd><p>Convert all args to kwargs before calling the decorated function.</p>
 <p>When applied to a function, this decorator creates a new function
 that always calls the wrapped function with <em>only</em> keyword arguments. It
 inspects the argspec for the identically-named method on <cite>base_type</cite> to
 determine the name to use for arguments that are converted to keyword
 arguments.</p>
 <p>For internal use only. No backwards compatibility guarantees.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.with_docs_from">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">with_docs_from</code><span class="sig-paren">(</span><em>base_type</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#with_docs_from"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.with_docs_from" title="Permalink to this definition">¶</a></dt>
 <dd><p>Decorator that updates the documentation from the wrapped function to
 duplicate the documentation from the identically-named method in <cite>base_type</cite>.</p>
 <p>Any docstring on the original function will be included in the new function
 under a “Differences from pandas” heading.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.dataframe.frame_base.populate_defaults">
 <code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">populate_defaults</code><span class="sig-paren">(</span><em>base_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#populate_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.populate_defaults" title="Permalink to this definition">¶</a></dt>
 <dd><p>Populate default values for keyword arguments in decorated function.</p>
 <p>When applied to a function, this decorator creates a new function
 with default values for all keyword arguments, based on the default values
 for the identically-named method on <cite>base_type</cite>.</p>
 <p>For internal use only. No backwards compatibility guarantees.</p>
 </dd></dl>

 <dl class="exception">
 <dt id="apache_beam.dataframe.frame_base.WontImplementError">
 <em class="property">exception </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">WontImplementError</code><span class="sig-paren">(</span><em>msg</em>, <em>reason=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#WontImplementError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.WontImplementError" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotImplementedError</span></code></a></p>
 <p>An subclass of NotImplementedError to raise indicating that implementing
 the given method is not planned.</p>
 <p>Raising this error will also prevent this doctests from being validated
 when run with the beam dataframe validation doctest runner.</p>
 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.dataframe.frames.html" class="btn btn-neutral float-right" title="apache_beam.dataframe.frames module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.dataframe.expressions.html" class="btn btn-neutral float-left" title="apache_beam.dataframe.expressions module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </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>apache_beam.dataframe.frame_base module — Apache Beam 2.38.0 documentation</title>








	<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


	<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
	<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

	<script type="text/javascript" src="_static/js/theme.js"></script>




	<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="apache_beam.dataframe.frames module" href="apache_beam.dataframe.frames.html" />
	<link rel="prev" title="apache_beam.dataframe.expressions module" href="apache_beam.dataframe.expressions.html" />
	</head>

	<body class="wy-body-for-nav">


	<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"> Apache Beam



	</a>




	<div class="version">
	2.38.0
	</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="apache_beam.coders.html">apache_beam.coders package</a></li>
	<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a><ul class="current">
	<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.dataframe.html#submodules">Submodules</a><ul class="current">
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.convert.html">apache_beam.dataframe.convert module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.doctests.html">apache_beam.dataframe.doctests module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.expressions.html">apache_beam.dataframe.expressions module</a></li>
	<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.dataframe.frame_base module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.frames.html">apache_beam.dataframe.frames module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.io.html">apache_beam.dataframe.io module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.pandas_top_level_functions.html">apache_beam.dataframe.pandas_top_level_functions module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.partitionings.html">apache_beam.dataframe.partitionings module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.schemas.html">apache_beam.dataframe.schemas module</a></li>
	<li class="toctree-l3"><a class="reference internal" href="apache_beam.dataframe.transforms.html">apache_beam.dataframe.transforms module</a></li>
	</ul>
	</li>
	</ul>
	</li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
	</ul>
	<ul>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
	</ul>



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

	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


	<nav class="wy-nav-top" aria-label="top navigation">

	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
	<a href="index.html">Apache Beam</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> »</li>

	<li><a href="apache_beam.dataframe.html">apache_beam.dataframe package</a> »</li>

	<li>apache_beam.dataframe.frame_base module</li>


	<li class="wy-breadcrumbs-aside">


	<a href="_sources/apache_beam.dataframe.frame_base.rst.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="module-apache_beam.dataframe.frame_base">
	<span id="apache-beam-dataframe-frame-base-module"></span><h1>apache_beam.dataframe.frame_base module<a class="headerlink" href="#module-apache_beam.dataframe.frame_base" title="Permalink to this headline">¶</a></h1>
	<dl class="class">
	<dt id="apache_beam.dataframe.frame_base.DeferredBase">
	<em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">DeferredBase</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
	<dl class="classmethod">
	<dt id="apache_beam.dataframe.frame_base.DeferredBase.wrap">
	<em class="property">classmethod </em><code class="descname">wrap</code><span class="sig-paren">(</span><em>expr</em>, <em>split_tuples=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase.wrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase.wrap" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase">
	<em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">UnusableUnpickledDeferredBase</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#UnusableUnpickledDeferredBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
	<p>Placeholder object used to break the transitive pickling chain in case a
	DeferredBase accidentially gets pickled (e.g. as part of globals).</p>
	<p>Trying to use this object after unpickling is a bug and will result in an
	error.</p>
	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.dataframe.frame_base.DeferredFrame">
	<em class="property">class </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">DeferredFrame</code><span class="sig-paren">(</span><em>expr</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredFrame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredFrame" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference internal" href="#apache_beam.dataframe.frame_base.DeferredBase" title="apache_beam.dataframe.frame_base.DeferredBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.dataframe.frame_base.DeferredBase</span></code></a></p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.name_and_func">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">name_and_func</code><span class="sig-paren">(</span><em>method: Union[str, Callable]</em><span class="sig-paren">)</span> → Tuple[str, Callable]<a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#name_and_func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.name_and_func" title="Permalink to this definition">¶</a></dt>
	<dd><p>For the given method name or method, return the method name and the method
	itself.</p>
	<p>For internal use only. No backwards compatibility guarantees.</p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.wont_implement_method">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">wont_implement_method</code><span class="sig-paren">(</span><em>base_type</em>, <em>name</em>, <em>reason=None</em>, <em>explanation=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#wont_implement_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.wont_implement_method" title="Permalink to this definition">¶</a></dt>
	<dd><p>Generate a stub method that raises WontImplementError.</p>
	<p>Note either reason or explanation must be specified. If both are specified,
	explanation is ignored.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>base_type</strong> – The pandas type of the method that this is trying to replicate.</li>
	<li><strong>name</strong> – The name of the method that this is aiming to replicate.</li>
	<li><strong>reason</strong> – If specified, use data from the corresponding entry in
	<code class="docutils literal notranslate"><span class="pre">_WONT_IMPLEMENT_REASONS</span></code> to generate a helpful exception message
	and docstring for the method.</li>
	<li><strong>explanation</strong> – If specified, use this string as an explanation for why
	this operation is not supported when generating an exception message
	and docstring.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.not_implemented_method">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">not_implemented_method</code><span class="sig-paren">(</span><em>op</em>, <em>jira='BEAM-9547'</em>, <em>base_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#not_implemented_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.not_implemented_method" title="Permalink to this definition">¶</a></dt>
	<dd><p>Generate a stub method for <code class="docutils literal notranslate"><span class="pre">op</span></code> that simply raises a NotImplementedError.</p>
	<p>For internal use only. No backwards compatibility guarantees.</p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.maybe_inplace">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">maybe_inplace</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#maybe_inplace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.maybe_inplace" title="Permalink to this definition">¶</a></dt>
	<dd><p>Handles the inplace= kwarg available in many pandas operations.</p>
	<p>This decorator produces a new function handles the inplace kwarg. When
	<cite>inplace=False</cite>, the new function simply yields the result of <cite>func</cite>
	directly.</p>
	<p>When <cite>inplace=True</cite>, the output of <cite>func</cite> is used to replace this instances
	expression. The result is that any operations applied to this instance after
	the inplace operation will refernce the updated expression.</p>
	<p>For internal use only. No backwards compatibility guarantees.</p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.args_to_kwargs">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">args_to_kwargs</code><span class="sig-paren">(</span><em>base_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#args_to_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.args_to_kwargs" title="Permalink to this definition">¶</a></dt>
	<dd><p>Convert all args to kwargs before calling the decorated function.</p>
	<p>When applied to a function, this decorator creates a new function
	that always calls the wrapped function with <em>only</em> keyword arguments. It
	inspects the argspec for the identically-named method on <cite>base_type</cite> to
	determine the name to use for arguments that are converted to keyword
	arguments.</p>
	<p>For internal use only. No backwards compatibility guarantees.</p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.with_docs_from">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">with_docs_from</code><span class="sig-paren">(</span><em>base_type</em>, <em>name=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#with_docs_from"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.with_docs_from" title="Permalink to this definition">¶</a></dt>
	<dd><p>Decorator that updates the documentation from the wrapped function to
	duplicate the documentation from the identically-named method in <cite>base_type</cite>.</p>
	<p>Any docstring on the original function will be included in the new function
	under a “Differences from pandas” heading.</p>
	</dd></dl>

	<dl class="function">
	<dt id="apache_beam.dataframe.frame_base.populate_defaults">
	<code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">populate_defaults</code><span class="sig-paren">(</span><em>base_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#populate_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.populate_defaults" title="Permalink to this definition">¶</a></dt>
	<dd><p>Populate default values for keyword arguments in decorated function.</p>
	<p>When applied to a function, this decorator creates a new function
	with default values for all keyword arguments, based on the default values
	for the identically-named method on <cite>base_type</cite>.</p>
	<p>For internal use only. No backwards compatibility guarantees.</p>
	</dd></dl>

	<dl class="exception">
	<dt id="apache_beam.dataframe.frame_base.WontImplementError">
	<em class="property">exception </em><code class="descclassname">apache_beam.dataframe.frame_base.</code><code class="descname">WontImplementError</code><span class="sig-paren">(</span><em>msg</em>, <em>reason=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#WontImplementError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.WontImplementError" title="Permalink to this definition">¶</a></dt>
	<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">NotImplementedError</span></code></a></p>
	<p>An subclass of NotImplementedError to raise indicating that implementing
	the given method is not planned.</p>
	<p>Raising this error will also prevent this doctests from being validated
	when run with the beam dataframe validation doctest runner.</p>
	</dd></dl>

	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="apache_beam.dataframe.frames.html" class="btn btn-neutral float-right" title="apache_beam.dataframe.frames module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="apache_beam.dataframe.expressions.html" class="btn btn-neutral float-left" title="apache_beam.dataframe.expressions module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

	</div>


	<hr/>

	<div role="contentinfo">
	<p>
	© Copyright

	</p>
	</div>
	Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>






	</body>
	</html>