| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.dataframe.frame_base module — Apache Beam 2.67.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=959b4fbe"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <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 role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> |
| <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><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.DeferredBase"><code class="docutils literal notranslate"><span class="pre">DeferredBase</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase"><code class="docutils literal notranslate"><span class="pre">UnusableUnpickledDeferredBase</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.DeferredFrame"><code class="docutils literal notranslate"><span class="pre">DeferredFrame</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.name_and_func"><code class="docutils literal notranslate"><span class="pre">name_and_func()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.wont_implement_method"><code class="docutils literal notranslate"><span class="pre">wont_implement_method()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.not_implemented_method"><code class="docutils literal notranslate"><span class="pre">not_implemented_method()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.maybe_inplace"><code class="docutils literal notranslate"><span class="pre">maybe_inplace()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.args_to_kwargs"><code class="docutils literal notranslate"><span class="pre">args_to_kwargs()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.with_docs_from"><code class="docutils literal notranslate"><span class="pre">with_docs_from()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.populate_defaults"><code class="docutils literal notranslate"><span class="pre">populate_defaults()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.dataframe.frame_base.WontImplementError"><code class="docutils literal notranslate"><span class="pre">WontImplementError</span></code></a></li> |
| </ul> |
| </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.testing.html">apache_beam.testing 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="breadcrumb-item active">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"> |
| |
| <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="Link to this heading"></a></h1> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.DeferredBase"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">DeferredBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.DeferredBase.wrap"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wrap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_tuples</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredBase.wrap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredBase.wrap" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">UnusableUnpickledDeferredBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#UnusableUnpickledDeferredBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.UnusableUnpickledDeferredBase" title="Link 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.13)"><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="py class"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.DeferredFrame"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">DeferredFrame</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#DeferredFrame"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.DeferredFrame" title="Link 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">DeferredBase</span></code></a></p> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.name_and_func"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">name_and_func</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.13)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#name_and_func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.name_and_func" title="Link 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="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.wont_implement_method"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">wont_implement_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">explanation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.wont_implement_method" title="Link 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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>base_type</strong> – The pandas type of the method that this is trying to replicate.</p></li> |
| <li><p><strong>name</strong> – The name of the method that this is aiming to replicate.</p></li> |
| <li><p><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.</p></li> |
| <li><p><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.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.not_implemented_method"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">not_implemented_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issue</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'20318'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.not_implemented_method" title="Link 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="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.maybe_inplace"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">maybe_inplace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#maybe_inplace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.maybe_inplace" title="Link 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="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.args_to_kwargs"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">args_to_kwargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.args_to_kwargs" title="Link 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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>base_type</strong> – The pandas type of the method that this is trying to replicate.</p></li> |
| <li><p><strong>removed_method</strong> – Whether this method has been removed in the running |
| Pandas version.</p></li> |
| <li><p><strong>removed_args</strong> – If not empty, which arguments have been dropped in the |
| running Pandas version.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.with_docs_from"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">with_docs_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.with_docs_from" title="Link 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> |
| <p>removed_method used in cases where a method has been removed in a later |
| version of Pandas.</p> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.populate_defaults"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">populate_defaults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">removed_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#populate_defaults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.populate_defaults" title="Link 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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>base_type</strong> – The pandas type of the method that this is trying to replicate.</p></li> |
| <li><p><strong>removed_method</strong> – Whether this method has been removed in the running |
| Pandas version.</p></li> |
| <li><p><strong>removed_args</strong> – If not empty, which arguments have been dropped in the |
| running Pandas version.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py exception"> |
| <dt class="sig sig-object py" id="apache_beam.dataframe.frame_base.WontImplementError"> |
| <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.dataframe.frame_base.</span></span><span class="sig-name descname"><span class="pre">WontImplementError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/dataframe/frame_base.html#WontImplementError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.dataframe.frame_base.WontImplementError" title="Link 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.13)"><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> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <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" aria-hidden="true"></span> Previous</a> |
| <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" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
