Skip to content

Commit d005f8d

Browse files
committed
deploy: f158a23
1 parent b1efcc7 commit d005f8d

File tree

7 files changed

+35
-34
lines changed

7 files changed

+35
-34
lines changed

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 74de8eaab55ac97875c670351b88906e
3+
config: 283ddcf70e4f3dc8e720faf528cde2e7
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/environment.pickle

883 Bytes
Binary file not shown.
513 Bytes
Binary file not shown.
513 Bytes
Binary file not shown.

_modules/qiskit_serverless/core/decorators.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -775,6 +775,7 @@ <h1>Source code for qiskit_serverless.core.decorators</h1><div class="highlight"
775775
<span class="k">def</span><span class="w"> </span><span class="nf">decorator_trace</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">FunctionType</span><span class="p">):</span>
776776
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The decorator that python call&quot;&quot;&quot;</span>
777777

778+
<span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
778779
<span class="k">def</span><span class="w"> </span><span class="nf">wrapper</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
779780
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The wrapper&quot;&quot;&quot;</span>
780781
<span class="n">tracer</span> <span class="o">=</span> <span class="n">trace</span><span class="o">.</span><span class="n">get_tracer</span><span class="p">(</span><span class="s2">&quot;client.tracer&quot;</span><span class="p">)</span>
@@ -783,7 +784,7 @@ <h1>Source code for qiskit_serverless.core.decorators</h1><div class="highlight"
783784
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">traced_function</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span>
784785
<span class="k">else</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
785786
<span class="p">)</span>
786-
<span class="k">with</span> <span class="n">tracer</span><span class="o">.</span><span class="n">start_as_current_span</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">traced_feature</span><span class="si">}</span><span class="s2">.$</span><span class="si">{</span><span class="n">function_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">):</span>
787+
<span class="k">with</span> <span class="n">tracer</span><span class="o">.</span><span class="n">start_as_current_span</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">traced_feature</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">function_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">):</span>
787788
<span class="n">result</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
788789
<span class="k">return</span> <span class="n">result</span>
789790

stubs/qiskit_serverless.core.IBMServerlessClient.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -406,11 +406,11 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
406406
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_dict</span></code>(dictionary)</p></td>
407407
<td><p>Converts dict to object.</p></td>
408408
</tr>
409-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">function</span></code>(**kwargs)</p></td>
410-
<td><p>The wrapper</p></td>
409+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">function</span></code>(title[, provider])</p></td>
410+
<td><p>Returns program based on parameters.</p></td>
411411
</tr>
412412
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">functions</span></code>(**kwargs)</p></td>
413-
<td><p>The wrapper</p></td>
413+
<td><p>Returns list of available functions.</p></td>
414414
</tr>
415415
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code>(title[, provider])</p></td>
416416
<td><p>Returns program based on parameters.</p></td>
@@ -421,17 +421,17 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
421421
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_jobs</span></code>(**kwargs)</p></td>
422422
<td><p>Return list of jobs.</p></td>
423423
</tr>
424-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">job</span></code>(**kwargs)</p></td>
425-
<td><p>The wrapper</p></td>
424+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">job</span></code>(job_id)</p></td>
425+
<td><p>Returns job by job id.</p></td>
426426
</tr>
427427
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">jobs</span></code>(**kwargs)</p></td>
428-
<td><p>The wrapper</p></td>
428+
<td><p>Return list of jobs.</p></td>
429429
</tr>
430430
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>(**kwargs)</p></td>
431431
<td><p>Returns list of available programs.</p></td>
432432
</tr>
433-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">logs</span></code>(**kwargs)</p></td>
434-
<td><p>The wrapper</p></td>
433+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">logs</span></code>(job_id)</p></td>
434+
<td><p>Return logs.</p></td>
435435
</tr>
436436
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_file_delete</span></code>(file, function)</p></td>
437437
<td><p>Deletes a file available to the provider for the specific Qiskit Function.</p></td>
@@ -445,23 +445,23 @@ <h1>qiskit_serverless.core.IBMServerlessClient<a class="headerlink" href="#qiski
445445
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_files</span></code>(function)</p></td>
446446
<td><p>Returns the list of files available for the provider in the Qiskit Function folder.</p></td>
447447
</tr>
448-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_jobs</span></code>(**kwargs)</p></td>
449-
<td><p>The wrapper</p></td>
448+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_jobs</span></code>(function, **kwargs)</p></td>
449+
<td><p>List of jobs created in this provider and function.</p></td>
450450
</tr>
451-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span></code>(**kwargs)</p></td>
452-
<td><p>The wrapper</p></td>
451+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span></code>(job_id)</p></td>
452+
<td><p>Return results.</p></td>
453453
</tr>
454454
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">run</span></code>(program[, arguments, config, provider])</p></td>
455455
<td><p>Run a function and return its job.</p></td>
456456
</tr>
457457
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">save_account</span></code>([token, name, overwrite, ...])</p></td>
458458
<td><p>Save the account to disk for future use.</p></td>
459459
</tr>
460-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code>(**kwargs)</p></td>
461-
<td><p>The wrapper</p></td>
460+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code>(job_id)</p></td>
461+
<td><p>Check status.</p></td>
462462
</tr>
463-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">stop</span></code>(**kwargs)</p></td>
464-
<td><p>The wrapper</p></td>
463+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">stop</span></code>(job_id[, service])</p></td>
464+
<td><p>Stops job/program.</p></td>
465465
</tr>
466466
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_dict</span></code>()</p></td>
467467
<td><p>Converts class to dict.</p></td>

stubs/qiskit_serverless.core.ServerlessClient.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -381,11 +381,11 @@ <h1>qiskit_serverless.core.ServerlessClient<a class="headerlink" href="#qiskit-s
381381
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_dict</span></code>(dictionary)</p></td>
382382
<td><p>Converts dict to object.</p></td>
383383
</tr>
384-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">function</span></code>(**kwargs)</p></td>
385-
<td><p>The wrapper</p></td>
384+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">function</span></code>(title[, provider])</p></td>
385+
<td><p>Returns program based on parameters.</p></td>
386386
</tr>
387387
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">functions</span></code>(**kwargs)</p></td>
388-
<td><p>The wrapper</p></td>
388+
<td><p>Returns list of available functions.</p></td>
389389
</tr>
390390
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code>(title[, provider])</p></td>
391391
<td><p>Returns program based on parameters.</p></td>
@@ -396,17 +396,17 @@ <h1>qiskit_serverless.core.ServerlessClient<a class="headerlink" href="#qiskit-s
396396
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_jobs</span></code>(**kwargs)</p></td>
397397
<td><p>Return list of jobs.</p></td>
398398
</tr>
399-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">job</span></code>(**kwargs)</p></td>
400-
<td><p>The wrapper</p></td>
399+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">job</span></code>(job_id)</p></td>
400+
<td><p>Returns job by job id.</p></td>
401401
</tr>
402402
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">jobs</span></code>(**kwargs)</p></td>
403-
<td><p>The wrapper</p></td>
403+
<td><p>Return list of jobs.</p></td>
404404
</tr>
405405
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>(**kwargs)</p></td>
406406
<td><p>Returns list of available programs.</p></td>
407407
</tr>
408-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">logs</span></code>(**kwargs)</p></td>
409-
<td><p>The wrapper</p></td>
408+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">logs</span></code>(job_id)</p></td>
409+
<td><p>Return logs.</p></td>
410410
</tr>
411411
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_file_delete</span></code>(file, function)</p></td>
412412
<td><p>Deletes a file available to the provider for the specific Qiskit Function.</p></td>
@@ -420,20 +420,20 @@ <h1>qiskit_serverless.core.ServerlessClient<a class="headerlink" href="#qiskit-s
420420
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_files</span></code>(function)</p></td>
421421
<td><p>Returns the list of files available for the provider in the Qiskit Function folder.</p></td>
422422
</tr>
423-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_jobs</span></code>(**kwargs)</p></td>
424-
<td><p>The wrapper</p></td>
423+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">provider_jobs</span></code>(function, **kwargs)</p></td>
424+
<td><p>List of jobs created in this provider and function.</p></td>
425425
</tr>
426-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span></code>(**kwargs)</p></td>
427-
<td><p>The wrapper</p></td>
426+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span></code>(job_id)</p></td>
427+
<td><p>Return results.</p></td>
428428
</tr>
429429
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">run</span></code>(program[, arguments, config, provider])</p></td>
430430
<td><p>Run a function and return its job.</p></td>
431431
</tr>
432-
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code>(**kwargs)</p></td>
433-
<td><p>The wrapper</p></td>
432+
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">status</span></code>(job_id)</p></td>
433+
<td><p>Check status.</p></td>
434434
</tr>
435-
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">stop</span></code>(**kwargs)</p></td>
436-
<td><p>The wrapper</p></td>
435+
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">stop</span></code>(job_id[, service])</p></td>
436+
<td><p>Stops job/program.</p></td>
437437
</tr>
438438
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_dict</span></code>()</p></td>
439439
<td><p>Converts class to dict.</p></td>

0 commit comments

Comments
 (0)