Promote NIMS package version and update Sphinx generated files in _docs

Author: actions-user

docs/.doctrees/environment.pickle

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

docs/_modules/index.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -79,7 +79,9 @@ <h1>Source code for ni_measurementlink_service._internal.discovery_client</h1><d
 <span class="kn">import</span> <span class="nn">logging</span>
 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">pathlib</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
 <span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">time</span>
 <span class="kn">import</span> <span class="nn">typing</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 
@@ -101,6 +103,9 @@ <h1>Source code for ni_measurementlink_service._internal.discovery_client</h1><d
 
 <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>
 
+<span class="n">_START_SERVICE_TIMEOUT</span> <span class="o">=</span> <span class="mf">30.0</span>
+<span class="n">_START_SERVICE_POLLING_INTERVAL</span> <span class="o">=</span> <span class="mf">100e-3</span>
+
 
 <div class="viewcode-block" id="ServiceLocation"><a class="viewcode-back" href="../../../autoapi/ni_measurementlink_service/_internal/discovery_client/index.html#ni_measurementlink_service._internal.discovery_client.ServiceLocation">[docs]</a><span class="k">class</span> <span class="nc">ServiceLocation</span><span class="p">(</span><span class="n">typing</span><span class="o">.</span><span class="n">NamedTuple</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Represents the location of a service.&quot;&quot;&quot;</span>
@@ -279,12 +284,78 @@ <h1>Source code for ni_measurementlink_service._internal.discovery_client</h1><d
 
 <span class="k">def</span> <span class="nf">_get_discovery_service_address</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
     <span class="n">key_file_path</span> <span class="o">=</span> <span class="n">_get_key_file_path</span><span class="p">()</span>
+    <span class="n">_ensure_discovery_service_started</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">)</span>
     <span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Discovery service key file path: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">key_file_path</span><span class="p">)</span>
     <span class="k">with</span> <span class="n">_open_key_file</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">))</span> <span class="k">as</span> <span class="n">key_file</span><span class="p">:</span>
         <span class="n">key_json</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">key_file</span><span class="p">)</span>
         <span class="k">return</span> <span class="s2">&quot;localhost:&quot;</span> <span class="o">+</span> <span class="n">key_json</span><span class="p">[</span><span class="s2">&quot;InsecurePort&quot;</span><span class="p">]</span>
 
 
+<span class="k">def</span> <span class="nf">_ensure_discovery_service_started</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Check whether discovery service already running, if not start the discovery service.&quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="n">_service_already_running</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">):</span>
+        <span class="k">return</span>
+
+    <span class="n">exe_file_path</span> <span class="o">=</span> <span class="n">_get_discovery_service_location</span><span class="p">()</span>
+    <span class="n">_start_service</span><span class="p">(</span><span class="n">exe_file_path</span><span class="p">,</span> <span class="n">key_file_path</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span class="nf">_get_discovery_service_location</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">PurePath</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Gets the location of the discovery service process executable.&quot;&quot;&quot;</span>
+    <span class="n">registration_json_path</span> <span class="o">=</span> <span class="n">_get_registration_json_file_path</span><span class="p">()</span>
+    <span class="n">registration_json_obj</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">registration_json_path</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>
+    <span class="k">return</span> <span class="n">registration_json_path</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="n">registration_json_obj</span><span class="p">[</span><span class="s2">&quot;discovery&quot;</span><span class="p">][</span><span class="s2">&quot;path&quot;</span><span class="p">]</span>
+
+
+<span class="k">def</span> <span class="nf">_get_registration_json_file_path</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">:</span>
+    <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;win32&quot;</span><span class="p">:</span>
+        <span class="k">return</span> <span class="p">(</span>
+            <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;ProgramW6432&quot;</span><span class="p">])</span>
+            <span class="o">/</span> <span class="s2">&quot;National Instruments&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;Shared&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;MeasurementLink&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;MeasurementLinkServices.json&quot;</span>
+        <span class="p">)</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">&quot;Platform not supported&quot;</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span class="nf">_key_file_exists</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+    <span class="k">return</span> <span class="n">key_file_path</span><span class="o">.</span><span class="n">is_file</span><span class="p">()</span> <span class="ow">and</span> <span class="n">key_file_path</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span> <span class="o">&gt;</span> <span class="mi">0</span>
+
+
+<span class="k">def</span> <span class="nf">_start_service</span><span class="p">(</span><span class="n">exe_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">PurePath</span><span class="p">,</span> <span class="n">key_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Starts the service at the specified path and wait for the service to get up and running.&quot;&quot;&quot;</span>
+    <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="n">exe_file_path</span><span class="p">],</span> <span class="n">cwd</span><span class="o">=</span><span class="n">exe_file_path</span><span class="o">.</span><span class="n">parent</span><span class="p">)</span>
+    <span class="c1"># After the execution of process, check for key file existence in the path</span>
+    <span class="c1"># stop checking after 30 seconds have elapsed and throw error</span>
+    <span class="n">timeout_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">_START_SERVICE_TIMEOUT</span>
+    <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">with</span> <span class="n">_open_key_file</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">))</span> <span class="k">as</span> <span class="n">_</span><span class="p">:</span>
+                <span class="k">return</span>
+        <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
+            <span class="k">pass</span>
+        <span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">&gt;=</span> <span class="n">timeout_time</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">TimeoutError</span><span class="p">(</span><span class="s2">&quot;Timed out waiting for discovery service to start&quot;</span><span class="p">)</span>
+        <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">_START_SERVICE_POLLING_INTERVAL</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span class="nf">_service_already_running</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+    <span class="k">try</span><span class="p">:</span>
+        <span class="n">_delete_existing_key_file</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">)</span>
+    <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
+        <span class="k">return</span> <span class="kc">True</span>
+    <span class="k">return</span> <span class="kc">False</span>
+
+
+<span class="k">def</span> <span class="nf">_delete_existing_key_file</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+    <span class="k">if</span> <span class="n">_key_file_exists</span><span class="p">(</span><span class="n">key_file_path</span><span class="p">):</span>
+        <span class="k">with</span> <span class="n">key_file_path</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">_</span><span class="p">:</span>
+            <span class="k">pass</span>
+        <span class="n">key_file_path</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
+
+
 <span class="k">def</span> <span class="nf">_get_key_file_path</span><span class="p">(</span><span class="n">cluster_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">:</span>
     <span class="k">if</span> <span class="n">cluster_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
         <span class="k">return</span> <span class="n">_get_key_file_directory</span><span class="p">()</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;DiscoveryService_</span><span class="si">{</span><span class="n">cluster_id</span><span class="si">}</span><span class="s2">.json&quot;</span>

docs/_modules/ni_measurementlink_service/_internal/discovery_client.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -409,8 +409,8 @@ <h1>Source code for ni_measurementlink_service._internal.grpc_servicer</h1><div
 
         <span class="c1"># Measurement Parameters</span>
         <span class="n">measurement_signature</span> <span class="o">=</span> <span class="n">v2_measurement_service_pb2</span><span class="o">.</span><span class="n">MeasurementSignature</span><span class="p">(</span>
-            <span class="n">configuration_parameters_message_type</span><span class="o">=</span><span class="s2">&quot;ni.measurementlink.measurement.v1.MeasurementConfigurations&quot;</span><span class="p">,</span>
-            <span class="n">outputs_message_type</span><span class="o">=</span><span class="s2">&quot;ni.measurementlink.measurement.v1.MeasurementOutputs&quot;</span><span class="p">,</span>
+            <span class="n">configuration_parameters_message_type</span><span class="o">=</span><span class="s2">&quot;ni.measurementlink.measurement.v2.MeasurementConfigurations&quot;</span><span class="p">,</span>
+            <span class="n">outputs_message_type</span><span class="o">=</span><span class="s2">&quot;ni.measurementlink.measurement.v2.MeasurementOutputs&quot;</span><span class="p">,</span>
         <span class="p">)</span>
 
         <span class="c1"># Configurations</span>
@@ -435,6 +435,7 @@ <h1>Source code for ni_measurementlink_service._internal.grpc_servicer</h1><div
             <span class="n">output_parameter</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">output_metadata</span><span class="o">.</span><span class="n">display_name</span>
             <span class="n">output_parameter</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="n">output_metadata</span><span class="o">.</span><span class="n">type</span>
             <span class="n">output_parameter</span><span class="o">.</span><span class="n">repeated</span> <span class="o">=</span> <span class="n">output_metadata</span><span class="o">.</span><span class="n">repeated</span>
+            <span class="n">output_parameter</span><span class="o">.</span><span class="n">annotations</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">output_metadata</span><span class="o">.</span><span class="n">annotations</span><span class="p">)</span>
             <span class="n">measurement_signature</span><span class="o">.</span><span class="n">outputs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">output_parameter</span><span class="p">)</span>
 
         <span class="c1"># Sending back Response</span>

docs/_modules/ni_measurementlink_service/_internal/grpc_servicer.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

docs/_modules/ni_measurementlink_service/_internal/parameter/metadata.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

docs/_modules/ni_measurementlink_service/_internal/parameter/serialization_strategy.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">

docs/_modules/ni_measurementlink_service/_internal/parameter/serializer.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">

docs/_modules/ni_measurementlink_service/_internal/service_manager.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../../../../../search.html" method="get">

docs/_modules/ni_measurementlink_service/_internal/stubs/ni/measurementlink/discovery/v1/discovery_service_pb2_grpc.html

@@ -34,7 +34,7 @@
             ni_measurementlink_service
           </a>
               <div class="version">
-                1.1.0-dev2
+                1.1.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../../../../../search.html" method="get">