Skip to content

Commit 52c953c

Browse files
committed
Update docs
1 parent 34c2d96 commit 52c953c

File tree

1 file changed

+48
-8
lines changed

1 file changed

+48
-8
lines changed

docs/piston_rspy/index.html

+48-8
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,44 @@ <h3 id="returns">Returns:</h3>
6262
<li><code><a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></code>: The new client.</li>
6363
</ul></div>
6464
</dd>
65+
<dt id="piston_rspy.Client.with_url"><code class="name flex">
66+
<span>def <span class="ident">with_url</span></span>(<span>key: str, /) ‑> <a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></span>
67+
</code></dt>
68+
<dd>
69+
<div class="desc"><p>&ndash;</p>
70+
<p>Creates a new Client with a custom url.</p>
71+
<h3 id="args">Args:</h3>
72+
<ul>
73+
<li>url <code>str</code>:
74+
The url to use as the underlying piston backend.</li>
75+
</ul>
76+
<h3 id="returns">Returns:</h3>
77+
<ul>
78+
<li><code><a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></code>: The new client.</li>
79+
</ul></div>
80+
</dd>
81+
<dt id="piston_rspy.Client.with_url_and_key"><code class="name flex">
82+
<span>def <span class="ident">with_url_and_key</span></span>(<span>key: str, /) ‑> <a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></span>
83+
</code></dt>
84+
<dd>
85+
<div class="desc"><p>&ndash;</p>
86+
<p>Creates a new Client with a custom url and an api key.</p>
87+
<h3 id="args">Args:</h3>
88+
<ul>
89+
<li>
90+
<p>url <code>str</code>:
91+
The url to use as the underlying piston backend.</p>
92+
</li>
93+
<li>
94+
<p>key <code>str</code>:
95+
The api key to use.</p>
96+
</li>
97+
</ul>
98+
<h3 id="returns">Returns:</h3>
99+
<ul>
100+
<li><code><a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></code>: The new client.</li>
101+
</ul></div>
102+
</dd>
65103
</dl>
66104
<h3>Instance variables</h3>
67105
<dl>
@@ -97,7 +135,7 @@ <h3 id="raises">Raises:</h3>
97135
</ul></div>
98136
</dd>
99137
<dt id="piston_rspy.Client.fetch_runtimes"><code class="name flex">
100-
<span>def <span class="ident">fetch_runtimes</span></span>(<span>self) ‑> list</span>
138+
<span>def <span class="ident">fetch_runtimes</span></span>(<span>self) ‑> list[<a title="piston_rspy.Runtime" href="#piston_rspy.Runtime">Runtime</a>]</span>
101139
</code></dt>
102140
<dd>
103141
<div class="desc"><p>&ndash;</p>
@@ -112,7 +150,7 @@ <h3 id="raises">Raises:</h3>
112150
</ul></div>
113151
</dd>
114152
<dt id="piston_rspy.Client.get_headers"><code class="name flex">
115-
<span>def <span class="ident">get_headers</span></span>(<span>self) ‑> dict</span>
153+
<span>def <span class="ident">get_headers</span></span>(<span>self) ‑> dict[str, str]</span>
116154
</code></dt>
117155
<dd>
118156
<div class="desc"><p>&ndash;</p>
@@ -258,7 +296,7 @@ <h3 id="returns">Returns:</h3>
258296
</dd>
259297
<dt id="piston_rspy.Executor"><code class="flex name class">
260298
<span>class <span class="ident">Executor</span></span>
261-
<span>(</span><span>language: str = '', version: str = '*', files: list = [], stdin: str = '', args: list = [], compile_timeout: int = 10000, run_timeout: int = 3000, compile_memory_limit: int = -1, run_memory_limit: int = -1, /)</span>
299+
<span>(</span><span>language: str = '', version: str = '*', files: list[<a title="piston_rspy.File" href="#piston_rspy.File">File</a>] = [], stdin: str = '', args: list[str] = [], compile_timeout: int = 10000, run_timeout: int = 3000, compile_memory_limit: int = -1, run_memory_limit: int = -1, /)</span>
262300
</code></dt>
263301
<dd>
264302
<div class="desc"><p>&ndash;</p>
@@ -329,7 +367,7 @@ <h3 id="returns">Returns:</h3>
329367
</ul></div>
330368
</dd>
331369
<dt id="piston_rspy.Executor.add_args"><code class="name flex">
332-
<span>def <span class="ident">add_args</span></span>(<span>self, args: list, /) ‑> <a title="piston_rspy.Executor" href="#piston_rspy.Executor">Executor</a></span>
370+
<span>def <span class="ident">add_args</span></span>(<span>self, args: list[str], /) ‑> <a title="piston_rspy.Executor" href="#piston_rspy.Executor">Executor</a></span>
333371
</code></dt>
334372
<dd>
335373
<div class="desc"><p>&ndash;</p>
@@ -363,7 +401,7 @@ <h3 id="returns">Returns:</h3>
363401
</ul></div>
364402
</dd>
365403
<dt id="piston_rspy.Executor.add_files"><code class="name flex">
366-
<span>def <span class="ident">add_files</span></span>(<span>self, files: list, /) ‑> <a title="piston_rspy.Executor" href="#piston_rspy.Executor">Executor</a></span>
404+
<span>def <span class="ident">add_files</span></span>(<span>self, files: list[<a title="piston_rspy.File" href="#piston_rspy.File">File</a>], /) ‑> <a title="piston_rspy.Executor" href="#piston_rspy.Executor">Executor</a></span>
367405
</code></dt>
368406
<dd>
369407
<div class="desc"><p>&ndash;</p>
@@ -400,7 +438,7 @@ <h3 id="returns">Returns:</h3>
400438
<p>This method mutates the executor in place.</p></div>
401439
</dd>
402440
<dt id="piston_rspy.Executor.set_args"><code class="name flex">
403-
<span>def <span class="ident">set_args</span></span>(<span>self, args: list, /)</span>
441+
<span>def <span class="ident">set_args</span></span>(<span>self, args: list[str], /)</span>
404442
</code></dt>
405443
<dd>
406444
<div class="desc"><p>&ndash;</p>
@@ -446,7 +484,7 @@ <h3 id="returns">Returns:</h3>
446484
</ul></div>
447485
</dd>
448486
<dt id="piston_rspy.Executor.set_files"><code class="name flex">
449-
<span>def <span class="ident">set_files</span></span>(<span>self, files: list, /)</span>
487+
<span>def <span class="ident">set_files</span></span>(<span>self, files: list[<a title="piston_rspy.File" href="#piston_rspy.File">File</a>], /)</span>
450488
</code></dt>
451489
<dd>
452490
<div class="desc"><p>&ndash;</p>
@@ -628,7 +666,7 @@ <h3 id="returns">Returns:</h3>
628666
</dd>
629667
<dt id="piston_rspy.Runtime"><code class="flex name class">
630668
<span>class <span class="ident">Runtime</span></span>
631-
<span>(</span><span>language: str, version: str, aliases: list, /)</span>
669+
<span>(</span><span>language: str, version: str, aliases: list[str], /)</span>
632670
</code></dt>
633671
<dd>
634672
<div class="desc"><p>&ndash;</p>
@@ -693,6 +731,8 @@ <h4><code><a title="piston_rspy.Client" href="#piston_rspy.Client">Client</a></c
693731
<li><code><a title="piston_rspy.Client.headers" href="#piston_rspy.Client.headers">headers</a></code></li>
694732
<li><code><a title="piston_rspy.Client.url" href="#piston_rspy.Client.url">url</a></code></li>
695733
<li><code><a title="piston_rspy.Client.with_key" href="#piston_rspy.Client.with_key">with_key</a></code></li>
734+
<li><code><a title="piston_rspy.Client.with_url" href="#piston_rspy.Client.with_url">with_url</a></code></li>
735+
<li><code><a title="piston_rspy.Client.with_url_and_key" href="#piston_rspy.Client.with_url_and_key">with_url_and_key</a></code></li>
696736
</ul>
697737
</li>
698738
<li>

0 commit comments

Comments
 (0)