pydoc/2.47.0/_modules/apache_beam/testing/metric_result_matchers.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.testing.metric_result_matchers &mdash; Apache Beam 2.47.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" />
 </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.47.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>
 <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"><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="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="../../index.html">Module code</a> &raquo;</li>

       <li>apache_beam.testing.metric_result_matchers</li>


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

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.testing.metric_result_matchers</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="sd">&quot;&quot;&quot;MetricResult matchers for validating metrics in PipelineResults.</span>

 <span class="sd">example usage:</span>
 <span class="sd">::</span>

 <span class="sd">    result = my_pipeline.run()</span>
 <span class="sd">    all_metrics = result.metrics().all_metrics()</span>

 <span class="sd">    matchers = [</span>
 <span class="sd">      MetricResultMatcher(</span>
 <span class="sd">          namespace=&#39;myNamespace&#39;,</span>
 <span class="sd">          name=&#39;myName&#39;,</span>
 <span class="sd">          step=&#39;myStep&#39;,</span>
 <span class="sd">          labels={</span>
 <span class="sd">              &#39;pcollection&#39;: &#39;myCollection&#39;,</span>
 <span class="sd">              &#39;myCustomKey&#39;: &#39;myCustomValue&#39;</span>
 <span class="sd">          },</span>
 <span class="sd">          attempted=42,</span>
 <span class="sd">          committed=42</span>
 <span class="sd">      )</span>
 <span class="sd">    ]</span>
 <span class="sd">    errors = metric_result_matchers.verify_all(all_metrics, matchers)</span>
 <span class="sd">    self.assertFalse(errors, errors)</span>

 <span class="sd">&quot;&quot;&quot;</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">from</span> <span class="nn">hamcrest</span> <span class="kn">import</span> <span class="n">equal_to</span>
 <span class="kn">from</span> <span class="nn">hamcrest.core</span> <span class="kn">import</span> <span class="n">string_description</span>
 <span class="kn">from</span> <span class="nn">hamcrest.core.base_matcher</span> <span class="kn">import</span> <span class="n">BaseMatcher</span>
 <span class="kn">from</span> <span class="nn">hamcrest.core.matcher</span> <span class="kn">import</span> <span class="n">Matcher</span>

 <span class="kn">from</span> <span class="nn">apache_beam.metrics.cells</span> <span class="kn">import</span> <span class="n">DistributionResult</span>


 <span class="k">def</span> <span class="nf">_matcher_or_equal_to</span><span class="p">(</span><span class="n">value_or_matcher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;Pass-thru for matchers, and wraps value inputs in an equal_to matcher.&quot;&quot;&quot;</span>
   <span class="k">if</span> <span class="n">value_or_matcher</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
     <span class="k">return</span> <span class="kc">None</span>
   <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value_or_matcher</span><span class="p">,</span> <span class="n">Matcher</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">value_or_matcher</span>
   <span class="k">return</span> <span class="n">equal_to</span><span class="p">(</span><span class="n">value_or_matcher</span><span class="p">)</span>


 <div class="viewcode-block" id="MetricResultMatcher"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.MetricResultMatcher">[docs]</a><span class="k">class</span> <span class="nc">MetricResultMatcher</span><span class="p">(</span><span class="n">BaseMatcher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A PyHamcrest matcher that validates counter MetricResults.&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">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">step</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">attempted</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">committed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">sum_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">count_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">min_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
       <span class="n">max_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
   <span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">namespace</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">step</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">attempted</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">attempted</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">committed</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">committed</span><span class="p">)</span>
     <span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span> <span class="ow">or</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">label_matchers</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">labels</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">label_matchers</span><span class="p">[</span><span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">k</span><span class="p">)]</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_matches</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric_result</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span>
         <span class="n">metric_result</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">namespace</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metric_result</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">metric</span><span class="o">.</span><span class="n">name</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metric_result</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">step</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">attempted</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
         <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">attempted</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metric_result</span><span class="o">.</span><span class="n">attempted</span><span class="p">)):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">committed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
         <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">committed</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">metric_result</span><span class="o">.</span><span class="n">committed</span><span class="p">)):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">for</span> <span class="p">(</span><span class="n">k_matcher</span><span class="p">,</span> <span class="n">v_matcher</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">label_matchers</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">matched_keys</span> <span class="o">=</span> <span class="p">[</span>
           <span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">metric_result</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">labels</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
           <span class="k">if</span> <span class="n">k_matcher</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
       <span class="p">]</span>
       <span class="n">matched_key</span> <span class="o">=</span> <span class="n">matched_keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">matched_keys</span> <span class="k">else</span> <span class="kc">None</span>
       <span class="k">if</span> <span class="ow">not</span> <span class="n">matched_key</span><span class="p">:</span>
         <span class="k">return</span> <span class="kc">False</span>
       <span class="n">label_value</span> <span class="o">=</span> <span class="n">metric_result</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">labels</span><span class="p">[</span><span class="n">matched_key</span><span class="p">]</span>
       <span class="k">if</span> <span class="ow">not</span> <span class="n">v_matcher</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">label_value</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">False</span>
     <span class="k">return</span> <span class="kc">True</span>

 <div class="viewcode-block" id="MetricResultMatcher.describe_to"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_to">[docs]</a>  <span class="k">def</span> <span class="nf">describe_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">description</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; namespace: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; name: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; step: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">for</span> <span class="p">(</span><span class="n">k_matcher</span><span class="p">,</span> <span class="n">v_matcher</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">label_matchers</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; (label_key: &#39;</span><span class="p">)</span>
       <span class="n">k_matcher</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; label_value: &#39;</span><span class="p">)</span>
       <span class="n">v_matcher</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39;). &#39;</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">attempted</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; attempted: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">attempted</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">committed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; committed: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">committed</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span></div>

 <div class="viewcode-block" id="MetricResultMatcher.describe_mismatch"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.MetricResultMatcher.describe_mismatch">[docs]</a>  <span class="k">def</span> <span class="nf">describe_mismatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metric_result</span><span class="p">,</span> <span class="n">mismatch_description</span><span class="p">):</span>
     <span class="n">mismatch_description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s2">&quot;was&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">metric_result</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="DistributionMatcher"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.DistributionMatcher">[docs]</a><span class="k">class</span> <span class="nc">DistributionMatcher</span><span class="p">(</span><span class="n">BaseMatcher</span><span class="p">):</span>
 <span class="w">  </span><span class="sd">&quot;&quot;&quot;A PyHamcrest matcher that validates counter distributions.&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">sum_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">count_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">min_value</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">max_value</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">sum_value</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">sum_value</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">count_value</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">count_value</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">min_value</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">min_value</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">max_value</span> <span class="o">=</span> <span class="n">_matcher_or_equal_to</span><span class="p">(</span><span class="n">max_value</span><span class="p">)</span>

   <span class="k">def</span> <span class="nf">_matches</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">distribution_result</span><span class="p">):</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">distribution_result</span><span class="p">,</span> <span class="n">DistributionResult</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum_value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum_value</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">distribution_result</span><span class="o">.</span><span class="n">sum</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">count_value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">count_value</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span>
         <span class="n">distribution_result</span><span class="o">.</span><span class="n">count</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_value</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">distribution_result</span><span class="o">.</span><span class="n">min</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_value</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_value</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">distribution_result</span><span class="o">.</span><span class="n">max</span><span class="p">):</span>
       <span class="k">return</span> <span class="kc">False</span>
     <span class="k">return</span> <span class="kc">True</span>

 <div class="viewcode-block" id="DistributionMatcher.describe_to"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_to">[docs]</a>  <span class="k">def</span> <span class="nf">describe_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">description</span><span class="p">):</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum_value</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; sum_value: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">sum_value</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">count_value</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; count_value: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">count_value</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_value</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; min_value: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">min_value</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_value</span><span class="p">:</span>
       <span class="n">description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39; max_value: &#39;</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">max_value</span><span class="o">.</span><span class="n">describe_to</span><span class="p">(</span><span class="n">description</span><span class="p">)</span></div>

 <div class="viewcode-block" id="DistributionMatcher.describe_mismatch"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.DistributionMatcher.describe_mismatch">[docs]</a>  <span class="k">def</span> <span class="nf">describe_mismatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">distribution_result</span><span class="p">,</span> <span class="n">mismatch_description</span><span class="p">):</span>
     <span class="n">mismatch_description</span><span class="o">.</span><span class="n">append_text</span><span class="p">(</span><span class="s1">&#39;was&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">append_value</span><span class="p">(</span><span class="n">distribution_result</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="verify_all"><a class="viewcode-back" href="../../../apache_beam.testing.metric_result_matchers.html#apache_beam.testing.metric_result_matchers.verify_all">[docs]</a><span class="k">def</span> <span class="nf">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="w">  </span><span class="sd">&quot;&quot;&quot;Verified that every matcher matches a metric result in all_metrics.&quot;&quot;&quot;</span>
   <span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
   <span class="n">matched_metrics</span> <span class="o">=</span> <span class="p">[]</span>
   <span class="k">for</span> <span class="n">matcher</span> <span class="ow">in</span> <span class="n">matchers</span><span class="p">:</span>
     <span class="n">matched_metrics</span> <span class="o">=</span> <span class="p">[</span><span class="n">mr</span> <span class="k">for</span> <span class="n">mr</span> <span class="ow">in</span> <span class="n">all_metrics</span> <span class="k">if</span> <span class="n">matcher</span><span class="o">.</span><span class="n">matches</span><span class="p">(</span><span class="n">mr</span><span class="p">)]</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">matched_metrics</span><span class="p">:</span>
       <span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
           <span class="s1">&#39;Unable to match metrics for matcher </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span>
           <span class="p">(</span><span class="n">string_description</span><span class="o">.</span><span class="n">tostring</span><span class="p">(</span><span class="n">matcher</span><span class="p">)))</span>
   <span class="k">if</span> <span class="n">errors</span><span class="p">:</span>
     <span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
         <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">Actual MetricResults:</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">+</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">mr</span><span class="p">)</span>
                                                  <span class="k">for</span> <span class="n">mr</span> <span class="ow">in</span> <span class="n">all_metrics</span><span class="p">]))</span>
   <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <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>