Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / pydoc / 2.47.0 / _modules / apache_beam / options / pipeline_options_validator.html
blob: b87a91655bc115984d3c32bc3b805daa25d6b51b [file] [log] [blame]
<!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.options.pipeline_options_validator &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.options.pipeline_options_validator</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.options.pipeline_options_validator</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;Pipeline options validator.</span>
<span class="sd">For internal use only; no backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">apache_beam.internal</span> <span class="kn">import</span> <span class="n">pickler</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">DebugOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">GoogleCloudOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">PortableOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">SetupOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">StandardOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">TestOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">TypeOptions</span>
<span class="kn">from</span> <span class="nn">apache_beam.options.pipeline_options</span> <span class="kn">import</span> <span class="n">WorkerOptions</span>
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="PipelineOptionsValidator"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator">[docs]</a><span class="k">class</span> <span class="nc">PipelineOptionsValidator</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates PipelineOptions.</span>
<span class="sd"> Goes through a list of known PipelineOption subclassess and calls::</span>
<span class="sd"> validate(validator)</span>
<span class="sd"> if one is implemented. Aggregates a list of validation errors from all and</span>
<span class="sd"> returns an aggregated list.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Validator will call validate on these subclasses of PipelineOptions</span>
<span class="n">OPTIONS</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">DebugOptions</span><span class="p">,</span>
<span class="n">GoogleCloudOptions</span><span class="p">,</span>
<span class="n">PortableOptions</span><span class="p">,</span>
<span class="n">SetupOptions</span><span class="p">,</span>
<span class="n">StandardOptions</span><span class="p">,</span>
<span class="n">TestOptions</span><span class="p">,</span>
<span class="n">TypeOptions</span><span class="p">,</span>
<span class="n">WorkerOptions</span>
<span class="p">]</span>
<span class="c1"># Mutually exclusive options for different types of portable environments.</span>
<span class="n">REQUIRED_ENVIRONMENT_OPTIONS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;DOCKER&#39;</span><span class="p">:</span> <span class="p">[],</span>
<span class="s1">&#39;PROCESS&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;process_command&#39;</span><span class="p">],</span>
<span class="s1">&#39;EXTERNAL&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;external_service_address&#39;</span><span class="p">],</span>
<span class="s1">&#39;LOOPBACK&#39;</span><span class="p">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="n">OPTIONAL_ENVIRONMENT_OPTIONS</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;DOCKER&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;docker_container_image&#39;</span><span class="p">],</span>
<span class="s1">&#39;PROCESS&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;process_variables&#39;</span><span class="p">],</span>
<span class="s1">&#39;EXTERNAL&#39;</span><span class="p">:</span> <span class="p">[],</span>
<span class="s1">&#39;LOOPBACK&#39;</span><span class="p">:</span> <span class="p">[]</span>
<span class="p">}</span>
<span class="c1"># Possible validation errors.</span>
<span class="n">ERR_MISSING_OPTION</span> <span class="o">=</span> <span class="s1">&#39;Missing required option: </span><span class="si">%s</span><span class="s1">.&#39;</span>
<span class="n">ERR_MISSING_GCS_PATH</span> <span class="o">=</span> <span class="s1">&#39;Missing GCS path option: </span><span class="si">%s</span><span class="s1">.&#39;</span>
<span class="n">ERR_INVALID_GCS_PATH</span> <span class="o">=</span> <span class="s1">&#39;Invalid GCS path (</span><span class="si">%s</span><span class="s1">), given for the option: </span><span class="si">%s</span><span class="s1">.&#39;</span>
<span class="n">ERR_INVALID_GCS_BUCKET</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid GCS bucket (</span><span class="si">%s</span><span class="s1">), given for the option: </span><span class="si">%s</span><span class="s1">. See &#39;</span>
<span class="s1">&#39;https://developers.google.com/storage/docs/bucketnaming &#39;</span>
<span class="s1">&#39;for more details.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_GCS_OBJECT</span> <span class="o">=</span> <span class="s1">&#39;Invalid GCS object (</span><span class="si">%s</span><span class="s1">), given for the option: </span><span class="si">%s</span><span class="s1">.&#39;</span>
<span class="n">ERR_INVALID_JOB_NAME</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid job_name (</span><span class="si">%s</span><span class="s1">); the name must consist of only the characters &#39;</span>
<span class="s1">&#39;[-a-z0-9], starting with a letter and ending with a letter or number&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_PROJECT_NUMBER</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid Project ID (</span><span class="si">%s</span><span class="s1">). Please make sure you specified the Project ID, &#39;</span>
<span class="s1">&#39;not project number.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_PROJECT_ID</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid Project ID (</span><span class="si">%s</span><span class="s1">). Please make sure you specified the Project ID, &#39;</span>
<span class="s1">&#39;not project description.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_NOT_POSITIVE</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid value (</span><span class="si">%s</span><span class="s1">) for option: </span><span class="si">%s</span><span class="s1">. Value needs &#39;</span>
<span class="s1">&#39;to be positive.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_TEST_MATCHER_TYPE</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid value (</span><span class="si">%s</span><span class="s1">) for option: </span><span class="si">%s</span><span class="s1">. Please extend your matcher object &#39;</span>
<span class="s1">&#39;from hamcrest.core.base_matcher.BaseMatcher.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_TEST_MATCHER_UNPICKLABLE</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid value (</span><span class="si">%s</span><span class="s1">) for option: </span><span class="si">%s</span><span class="s1">. Please make sure the test matcher &#39;</span>
<span class="s1">&#39;is unpicklable.&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_TRANSFORM_NAME_MAPPING</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Invalid transform name mapping format. Please make sure the mapping is &#39;</span>
<span class="s1">&#39;string key-value pairs. Invalid pair: (</span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">)&#39;</span><span class="p">)</span>
<span class="n">ERR_INVALID_ENVIRONMENT</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Option </span><span class="si">%s</span><span class="s1"> is not compatible with environment type </span><span class="si">%s</span><span class="s1">.&#39;</span><span class="p">)</span>
<span class="n">ERR_ENVIRONMENT_CONFIG</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Option environment_config is incompatible with option(s) </span><span class="si">%s</span><span class="s1">.&#39;</span><span class="p">)</span>
<span class="n">ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;Option </span><span class="si">%s</span><span class="s1"> is required for environment type </span><span class="si">%s</span><span class="s1">.&#39;</span><span class="p">)</span>
<span class="n">ERR_NUM_WORKERS_TOO_HIGH</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;num_workers (</span><span class="si">%s</span><span class="s1">) cannot exceed max_num_workers (</span><span class="si">%s</span><span class="s1">)&#39;</span><span class="p">)</span>
<span class="n">ERR_REPEATABLE_OPTIONS_NOT_SET_AS_LIST</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">&#39;(</span><span class="si">%s</span><span class="s1">) is a string. Programmatically set PipelineOptions like (</span><span class="si">%s</span><span class="s1">) &#39;</span>
<span class="s1">&#39;options need to be specified as a list.&#39;</span><span class="p">)</span>
<span class="c1"># GCS path specific patterns.</span>
<span class="n">GCS_URI</span> <span class="o">=</span> <span class="s1">&#39;(?P&lt;SCHEME&gt;[^:]+)://(?P&lt;BUCKET&gt;[^/]+)(/(?P&lt;OBJECT&gt;.*))?&#39;</span>
<span class="n">GCS_BUCKET</span> <span class="o">=</span> <span class="s1">&#39;^[a-z0-9][-_a-z0-9.]+[a-z0-9]$&#39;</span>
<span class="n">GCS_SCHEME</span> <span class="o">=</span> <span class="s1">&#39;gs&#39;</span>
<span class="c1"># GoogleCloudOptions specific patterns.</span>
<span class="n">JOB_PATTERN</span> <span class="o">=</span> <span class="s1">&#39;[a-z]([-a-z0-9]*[a-z0-9])?&#39;</span>
<span class="n">PROJECT_ID_PATTERN</span> <span class="o">=</span> <span class="s1">&#39;[a-z][-a-z0-9:.]+[a-z0-9]&#39;</span>
<span class="n">PROJECT_NUMBER_PATTERN</span> <span class="o">=</span> <span class="s1">&#39;[0-9]*&#39;</span>
<span class="n">ENDPOINT_PATTERN</span> <span class="o">=</span> <span class="sa">r</span><span class="s1">&#39;https://[\S]*googleapis\.com[/]?&#39;</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">options</span><span class="p">,</span> <span class="n">runner</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="n">options</span>
<span class="bp">self</span><span class="o">.</span><span class="n">runner</span> <span class="o">=</span> <span class="n">runner</span>
<div class="viewcode-block" id="PipelineOptionsValidator.validate"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate">[docs]</a> <span class="k">def</span> <span class="nf">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Calls validate on subclassess and returns a list of errors.</span>
<span class="sd"> validate will call validate method on subclasses, accumulate the returned</span>
<span class="sd"> list of errors, and returns the aggregate list.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Aggregate list of errors after all calling all possible validate methods.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="bp">cls</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">OPTIONS</span><span class="p">:</span>
<span class="k">if</span> <span class="s1">&#39;validate&#39;</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__dict__</span> <span class="ow">and</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">[</span><span class="s1">&#39;validate&#39;</span><span class="p">]):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.is_service_runner"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_service_runner">[docs]</a> <span class="k">def</span> <span class="nf">is_service_runner</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;True if pipeline will execute on the Google Cloud Dataflow service.&quot;&quot;&quot;</span>
<span class="n">is_service_runner</span> <span class="o">=</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">runner</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;DataflowRunner&#39;</span><span class="p">,</span> <span class="s1">&#39;TestDataflowRunner&#39;</span><span class="p">])</span>
<span class="n">dataflow_endpoint</span> <span class="o">=</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">GoogleCloudOptions</span><span class="p">)</span><span class="o">.</span><span class="n">dataflow_endpoint</span><span class="p">)</span>
<span class="n">is_service_endpoint</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">dataflow_endpoint</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ENDPOINT_PATTERN</span><span class="p">,</span> <span class="n">dataflow_endpoint</span><span class="p">))</span>
<span class="k">return</span> <span class="n">is_service_runner</span> <span class="ow">and</span> <span class="n">is_service_endpoint</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.is_full_string_match"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_full_string_match">[docs]</a> <span class="k">def</span> <span class="nf">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">string</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns True if the pattern matches the whole string.&quot;&quot;&quot;</span>
<span class="n">pattern</span> <span class="o">=</span> <span class="s1">&#39;^</span><span class="si">%s</span><span class="s1">$&#39;</span> <span class="o">%</span> <span class="n">pattern</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">string</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span></div>
<span class="k">def</span> <span class="nf">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[</span><span class="n">err</span> <span class="o">%</span> <span class="n">args</span><span class="p">]</span>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_gcs_path"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_gcs_path">[docs]</a> <span class="k">def</span> <span class="nf">validate_gcs_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates a GCS path against gs://bucket/object URI format.&quot;&quot;&quot;</span>
<span class="n">arg</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">arg</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_MISSING_GCS_PATH</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">GCS_URI</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">DOTALL</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_GCS_PATH</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="n">scheme</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;SCHEME&#39;</span><span class="p">)</span>
<span class="n">bucket</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;BUCKET&#39;</span><span class="p">)</span>
<span class="n">gcs_object</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">&#39;OBJECT&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="p">((</span><span class="n">scheme</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">scheme</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">GCS_SCHEME</span><span class="p">)</span> <span class="ow">or</span>
<span class="p">(</span><span class="n">bucket</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">)):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_GCS_PATH</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">GCS_BUCKET</span><span class="p">,</span> <span class="n">bucket</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_GCS_BUCKET</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">gcs_object</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="ow">in</span> <span class="n">gcs_object</span> <span class="ow">or</span> <span class="s1">&#39;</span><span class="se">\r</span><span class="s1">&#39;</span> <span class="ow">in</span> <span class="n">gcs_object</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_GCS_OBJECT</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[]</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_cloud_options"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_cloud_options">[docs]</a> <span class="k">def</span> <span class="nf">validate_cloud_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates job_name and project arguments.&quot;&quot;&quot;</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="p">(</span><span class="n">view</span><span class="o">.</span><span class="n">job_name</span> <span class="ow">and</span>
<span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">JOB_PATTERN</span><span class="p">,</span> <span class="n">view</span><span class="o">.</span><span class="n">job_name</span><span class="p">)):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_JOB_NAME</span><span class="p">,</span> <span class="n">view</span><span class="o">.</span><span class="n">job_name</span><span class="p">))</span>
<span class="n">project</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">project</span>
<span class="k">if</span> <span class="n">project</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_MISSING_OPTION</span><span class="p">,</span> <span class="s1">&#39;project&#39;</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PROJECT_NUMBER_PATTERN</span><span class="p">,</span> <span class="n">project</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_PROJECT_NUMBER</span><span class="p">,</span> <span class="n">project</span><span class="p">))</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_full_string_match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">PROJECT_ID_PATTERN</span><span class="p">,</span> <span class="n">project</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_PROJECT_ID</span><span class="p">,</span> <span class="n">project</span><span class="p">))</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">update</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">view</span><span class="o">.</span><span class="n">job_name</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;Existing job name must be provided when updating a pipeline.&#39;</span><span class="p">))</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">transform_name_mapping</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">view</span><span class="o">.</span><span class="n">update</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">StandardOptions</span><span class="p">)</span><span class="o">.</span><span class="n">streaming</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;Transform name mapping option is only useful when &#39;</span>
<span class="s1">&#39;--update and --streaming is specified&#39;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">view</span><span class="o">.</span><span class="n">transform_name_mapping</span><span class="o">.</span><span class="n">items</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">key</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_TRANSFORM_NAME_MAPPING</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">region</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_service_runner</span><span class="p">():</span>
<span class="n">default_region</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="o">.</span><span class="n">get_default_gcp_region</span><span class="p">()</span>
<span class="k">if</span> <span class="n">default_region</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_MISSING_OPTION</span><span class="p">,</span> <span class="s1">&#39;region&#39;</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">view</span><span class="o">.</span><span class="n">region</span> <span class="o">=</span> <span class="n">default_region</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_sdk_container_image_options"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_sdk_container_image_options">[docs]</a> <span class="k">def</span> <span class="nf">validate_sdk_container_image_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">sdk_container_image</span> <span class="ow">and</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_harness_container_image</span><span class="p">:</span>
<span class="c1"># To be fully backwards-compatible, these options will be set to the same</span>
<span class="c1"># value. Check that the values are different.</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">sdk_container_image</span> <span class="o">!=</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_harness_container_image</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;Cannot use legacy flag --worker_harness_container_image along &#39;</span>
<span class="s1">&#39;with view.sdk_container_image&#39;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_harness_container_image</span><span class="p">:</span>
<span class="c1"># Warn about legacy flag and set new flag to value of old flag.</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s1">&#39;Setting sdk_container_image to value of legacy flag &#39;</span>
<span class="s1">&#39;worker_harness_container_image.&#39;</span><span class="p">)</span>
<span class="n">view</span><span class="o">.</span><span class="n">sdk_container_image</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_harness_container_image</span>
<span class="k">elif</span> <span class="n">view</span><span class="o">.</span><span class="n">sdk_container_image</span><span class="p">:</span>
<span class="c1"># Set legacy option to value of new option.</span>
<span class="n">view</span><span class="o">.</span><span class="n">worker_harness_container_image</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">sdk_container_image</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_container_prebuilding_options"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_container_prebuilding_options">[docs]</a> <span class="k">def</span> <span class="nf">validate_container_prebuilding_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">custom_image</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">WorkerOptions</span><span class="p">)</span><span class="o">.</span><span class="n">sdk_container_image</span>
<span class="k">if</span> <span class="p">(</span><span class="n">view</span><span class="o">.</span><span class="n">prebuild_sdk_container_base_image</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="n">custom_image</span> <span class="o">!=</span> <span class="n">view</span><span class="o">.</span><span class="n">prebuild_sdk_container_base_image</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;Don</span><span class="se">\&#39;</span><span class="s1">t use the deprecated option &#39;</span>
<span class="s1">&#39;--prebuild_sdk_container_base_image. Use --sdk_container_image &#39;</span>
<span class="s1">&#39;instead.&#39;</span><span class="p">))</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_num_workers"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_num_workers">[docs]</a> <span class="k">def</span> <span class="nf">validate_num_workers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates that Dataflow worker number is valid.&quot;&quot;&quot;</span>
<span class="n">errors</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">validate_optional_argument_positive</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="s1">&#39;num_workers&#39;</span><span class="p">)</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">validate_optional_argument_positive</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="s1">&#39;max_num_workers&#39;</span><span class="p">))</span>
<span class="n">num_workers</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">num_workers</span>
<span class="n">max_num_workers</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">max_num_workers</span>
<span class="k">if</span> <span class="p">(</span><span class="n">num_workers</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">max_num_workers</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span>
<span class="n">num_workers</span> <span class="o">&gt;</span> <span class="n">max_num_workers</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_NUM_WORKERS_TOO_HIGH</span><span class="p">,</span> <span class="n">num_workers</span><span class="p">,</span> <span class="n">max_num_workers</span><span class="p">))</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_worker_region_zone"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_worker_region_zone">[docs]</a> <span class="k">def</span> <span class="nf">validate_worker_region_zone</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates Dataflow worker region and zone arguments are consistent.&quot;&quot;&quot;</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">zone</span> <span class="ow">and</span> <span class="p">(</span><span class="n">view</span><span class="o">.</span><span class="n">worker_region</span> <span class="ow">or</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_zone</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;Cannot use deprecated flag --zone along with worker_region or &#39;</span>
<span class="s1">&#39;worker_zone.&#39;</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">DebugOptions</span><span class="p">)</span><span class="o">.</span><span class="n">lookup_experiment</span><span class="p">(</span><span class="s1">&#39;worker_region&#39;</span><span class="p">)</span>\
<span class="ow">and</span> <span class="p">(</span><span class="n">view</span><span class="o">.</span><span class="n">worker_region</span> <span class="ow">or</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_zone</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;Cannot use deprecated experiment worker_region along with &#39;</span>
<span class="s1">&#39;worker_region or worker_zone.&#39;</span><span class="p">))</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_region</span> <span class="ow">and</span> <span class="n">view</span><span class="o">.</span><span class="n">worker_zone</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="s1">&#39;worker_region and worker_zone are mutually exclusive.&#39;</span><span class="p">))</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">zone</span><span class="p">:</span>
<span class="n">_LOGGER</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="s1">&#39;Option --zone is deprecated. Please use --worker_zone instead.&#39;</span><span class="p">)</span>
<span class="n">view</span><span class="o">.</span><span class="n">worker_zone</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">zone</span>
<span class="n">view</span><span class="o">.</span><span class="n">zone</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_optional_argument_positive"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_optional_argument_positive">[docs]</a> <span class="k">def</span> <span class="nf">validate_optional_argument_positive</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates that an optional argument (if set) has a positive value.&quot;&quot;&quot;</span>
<span class="n">arg</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">arg</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_NOT_POSITIVE</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[]</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_test_matcher"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_test_matcher">[docs]</a> <span class="k">def</span> <span class="nf">validate_test_matcher</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates that on_success_matcher argument if set.</span>
<span class="sd"> Validates that on_success_matcher is unpicklable and is instance</span>
<span class="sd"> of `hamcrest.core.base_matcher.BaseMatcher`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># This is a test only method and requires hamcrest</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="n">pickled_matcher</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="n">on_success_matcher</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">matcher</span> <span class="o">=</span> <span class="n">pickler</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">pickled_matcher</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">matcher</span><span class="p">,</span> <span class="n">BaseMatcher</span><span class="p">):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_TEST_MATCHER_TYPE</span><span class="p">,</span> <span class="n">matcher</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_TEST_MATCHER_UNPICKLABLE</span><span class="p">,</span>
<span class="n">pickled_matcher</span><span class="p">,</span>
<span class="n">arg_name</span><span class="p">))</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_environment_options"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_environment_options">[docs]</a> <span class="k">def</span> <span class="nf">validate_environment_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates portable environment options.&quot;&quot;&quot;</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">actual_environment_type</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">view</span><span class="o">.</span><span class="n">environment_type</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">environment_type</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">for</span> <span class="n">environment_type</span><span class="p">,</span> <span class="n">required</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">REQUIRED_ENVIRONMENT_OPTIONS</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">found_required_options</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">opt</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">required</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">lookup_environment_option</span><span class="p">(</span><span class="n">opt</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">]</span>
<span class="n">found_optional_options</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">opt</span> <span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">OPTIONAL_ENVIRONMENT_OPTIONS</span><span class="p">[</span><span class="n">environment_type</span><span class="p">]</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">lookup_environment_option</span><span class="p">(</span><span class="n">opt</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">]</span>
<span class="n">found_options</span> <span class="o">=</span> <span class="n">found_required_options</span> <span class="o">+</span> <span class="n">found_optional_options</span>
<span class="k">if</span> <span class="n">environment_type</span> <span class="o">==</span> <span class="n">actual_environment_type</span><span class="p">:</span>
<span class="k">if</span> <span class="n">view</span><span class="o">.</span><span class="n">environment_config</span><span class="p">:</span>
<span class="k">if</span> <span class="n">found_options</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_ENVIRONMENT_CONFIG</span><span class="p">,</span> <span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">found_options</span><span class="p">)))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">missing_options</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">required</span><span class="p">)</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span>
<span class="nb">set</span><span class="p">(</span><span class="n">found_required_options</span><span class="p">))</span>
<span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">missing_options</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION</span><span class="p">,</span>
<span class="n">opt</span><span class="p">,</span>
<span class="n">environment_type</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Environment options classes are mutually exclusive.</span>
<span class="k">for</span> <span class="n">opt</span> <span class="ow">in</span> <span class="n">found_options</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_ENVIRONMENT</span><span class="p">,</span> <span class="n">opt</span><span class="p">,</span> <span class="n">actual_environment_type</span><span class="p">))</span>
<span class="k">if</span> <span class="n">actual_environment_type</span> <span class="o">==</span> <span class="s1">&#39;LOOPBACK&#39;</span> <span class="ow">and</span> <span class="n">view</span><span class="o">.</span><span class="n">environment_config</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_INVALID_ENVIRONMENT</span><span class="p">,</span> <span class="s1">&#39;environment_config&#39;</span><span class="p">,</span> <span class="s1">&#39;LOOPBACK&#39;</span><span class="p">))</span>
<span class="k">return</span> <span class="n">errors</span></div>
<div class="viewcode-block" id="PipelineOptionsValidator.validate_repeatable_argument_passed_as_list"><a class="viewcode-back" href="../../../apache_beam.options.pipeline_options_validator.html#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_repeatable_argument_passed_as_list">[docs]</a> <span class="k">def</span> <span class="nf">validate_repeatable_argument_passed_as_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates that repeatable PipelineOptions like dataflow_service_options</span>
<span class="sd"> or experiments are specified as a list when set programmatically. This</span>
<span class="sd"> way, users do not inadvertently specify it as a string, mirroring the way</span>
<span class="sd"> they are set via the command lineRepeatable options, which are as passed a</span>
<span class="sd"> list.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">arg</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">,</span> <span class="kc">None</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">arg</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_error</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ERR_REPEATABLE_OPTIONS_NOT_SET_AS_LIST</span><span class="p">,</span> <span class="n">arg</span><span class="p">,</span> <span class="n">arg_name</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[]</span></div></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>