| |
| |
| <!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.testing.metric_result_matchers module — Apache Beam 2.68.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=2388e03a"></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.testing.pipeline_verifiers module" href="apache_beam.testing.pipeline_verifiers.html" /> |
| <link rel="prev" title="apache_beam.testing.extra_assertions module" href="apache_beam.testing.extra_assertions.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"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></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 current"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.testing.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.datatype_inference.html">apache_beam.testing.datatype_inference module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.extra_assertions.html">apache_beam.testing.extra_assertions module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.testing.metric_result_matchers module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher"><code class="docutils literal notranslate"><span class="pre">MetricResultMatcher</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher"><code class="docutils literal notranslate"><span class="pre">DistributionMatcher</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.testing.metric_result_matchers.verify_all"><code class="docutils literal notranslate"><span class="pre">verify_all()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.pipeline_verifiers.html">apache_beam.testing.pipeline_verifiers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.synthetic_pipeline.html">apache_beam.testing.synthetic_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_pipeline.html">apache_beam.testing.test_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_stream.html">apache_beam.testing.test_stream module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_stream_service.html">apache_beam.testing.test_stream_service module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.test_utils.html">apache_beam.testing.test_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.util.html">apache_beam.testing.util module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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.testing.html">apache_beam.testing package</a></li> |
| <li class="breadcrumb-item active">apache_beam.testing.metric_result_matchers module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.testing.metric_result_matchers.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.testing.metric_result_matchers"> |
| <span id="apache-beam-testing-metric-result-matchers-module"></span><h1>apache_beam.testing.metric_result_matchers module<a class="headerlink" href="#module-apache_beam.testing.metric_result_matchers" title="Link to this heading"></a></h1> |
| <p>MetricResult matchers for validating metrics in PipelineResults.</p> |
| <p>example usage:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">result</span> <span class="o">=</span> <span class="n">my_pipeline</span><span class="o">.</span><span class="n">run</span><span class="p">()</span> |
| <span class="n">all_metrics</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">metrics</span><span class="p">()</span><span class="o">.</span><span class="n">all_metrics</span><span class="p">()</span> |
| |
| <span class="n">matchers</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="n">MetricResultMatcher</span><span class="p">(</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="s1">'myNamespace'</span><span class="p">,</span> |
| <span class="n">name</span><span class="o">=</span><span class="s1">'myName'</span><span class="p">,</span> |
| <span class="n">step</span><span class="o">=</span><span class="s1">'myStep'</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="p">{</span> |
| <span class="s1">'pcollection'</span><span class="p">:</span> <span class="s1">'myCollection'</span><span class="p">,</span> |
| <span class="s1">'myCustomKey'</span><span class="p">:</span> <span class="s1">'myCustomValue'</span> |
| <span class="p">},</span> |
| <span class="n">attempted</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span> |
| <span class="n">committed</span><span class="o">=</span><span class="mi">42</span> |
| <span class="p">)</span> |
| <span class="p">]</span> |
| <span class="n">errors</span> <span class="o">=</span> <span class="n">metric_result_matchers</span><span class="o">.</span><span class="n">verify_all</span><span class="p">(</span><span class="n">all_metrics</span><span class="p">,</span> <span class="n">matchers</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">errors</span><span class="p">,</span> <span class="n">errors</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.MetricResultMatcher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.metric_result_matchers.</span></span><span class="sig-name descname"><span class="pre">MetricResultMatcher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</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">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">step</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">labels</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">attempted</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">committed</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">sum_value</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">count_value</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">min_value</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">max_value</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/testing/metric_result_matchers.html#MetricResultMatcher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core.html#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v2.1.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseMatcher</span></code></a></p> |
| <p>A PyHamcrest matcher that validates counter MetricResults.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_to"> |
| <span class="sig-name descname"><span class="pre">describe_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#MetricResultMatcher.describe_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_to" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_mismatch"> |
| <span class="sig-name descname"><span class="pre">describe_mismatch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metric_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mismatch_description</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#MetricResultMatcher.describe_mismatch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_mismatch" 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.testing.metric_result_matchers.DistributionMatcher"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.metric_result_matchers.</span></span><span class="sig-name descname"><span class="pre">DistributionMatcher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sum_value</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">count_value</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">min_value</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">max_value</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/testing/metric_result_matchers.html#DistributionMatcher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://pyhamcrest.readthedocs.io/en/stable/core.html#hamcrest.core.base_matcher.BaseMatcher" title="(in PyHamcrest v2.1.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseMatcher</span></code></a></p> |
| <p>A PyHamcrest matcher that validates counter distributions.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_to"> |
| <span class="sig-name descname"><span class="pre">describe_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#DistributionMatcher.describe_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_to" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_mismatch"> |
| <span class="sig-name descname"><span class="pre">describe_mismatch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">distribution_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mismatch_description</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#DistributionMatcher.describe_mismatch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_mismatch" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.metric_result_matchers.verify_all"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.metric_result_matchers.</span></span><span class="sig-name descname"><span class="pre">verify_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">all_metrics</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">matchers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/metric_result_matchers.html#verify_all"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.metric_result_matchers.verify_all" title="Link to this definition"></a></dt> |
| <dd><p>Verified that every matcher matches a metric result in all_metrics.</p> |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.testing.extra_assertions.html" class="btn btn-neutral float-left" title="apache_beam.testing.extra_assertions module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.testing.pipeline_verifiers.html" class="btn btn-neutral float-right" title="apache_beam.testing.pipeline_verifiers 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> |
