Skip to content

Commit f10f02b

Browse files
author
Brohammad
committed
Deploying to gh-pages from @ litestar-org/litestar@505365a 🚀
1 parent 3b62dbe commit f10f02b

11 files changed

Lines changed: 98 additions & 98 deletions

File tree

4908/_modules/litestar/handlers/base.html

Lines changed: 84 additions & 82 deletions
Large diffs are not rendered by default.

4908/_sources/usage/openapi/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ can prevent the schema or documentation UI from being served correctly. Requests
4747

4848
The schema is also available programmatically via :attr:`~litestar.app.Litestar.openapi_schema`.
4949

50-
These endpoints are particularly useful for importing the schema into third party tools, such as Postman.
5150

5251
.. toctree::
5352

4908/reference/background_tasks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@
602602
<dd class="field-odd"><ul class="simple">
603603
<li><p><span class="target" id="litestar.background_tasks.BackgroundTasks.params.tasks"></span><strong>tasks</strong><a class="paramlink headerlink reference internal" href="#litestar.background_tasks.BackgroundTasks.params.tasks"></a> – An iterable of <a class="reference internal" href="#litestar.background_tasks.BackgroundTask" title="litestar.background_tasks.BackgroundTask"><code class="xref py py-class docutils literal notranslate"><span class="pre">BackgroundTask</span></code></a> instances.</p></li>
604604
<li><p><span class="target" id="litestar.background_tasks.BackgroundTasks.params.run_in_task_group"></span><strong>run_in_task_group</strong><a class="paramlink headerlink reference internal" href="#litestar.background_tasks.BackgroundTasks.params.run_in_task_group"></a> – If you set this value to <code class="docutils literal notranslate"><span class="pre">True</span></code> than the tasks will run concurrently, using
605-
a <a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.abc.TaskGroup" title="(in AnyIO v4.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskGroup</span></code></a>. Note: This will not preserve execution order.</p></li>
605+
a <a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.abc.TaskGroup" title="(in AnyIO v4.14.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskGroup</span></code></a>. Note: This will not preserve execution order.</p></li>
606606
</ul>
607607
</dd>
608608
</dl>

4908/reference/di.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@
554554
<span class="sig-prename descclassname"><span class="pre">litestar.di.</span></span><span class="sig-name descname"><span class="pre">NamedDependency</span></span><a class="headerlink" href="#litestar.di.NamedDependency" title="Link to this definition"></a></dt>
555555
<dd><p>Mark a parameter for name-based dependency injection.</p>
556556
<p>The name of the function parameter will be used as the name for the dependency to inject.</p>
557-
<p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">Annotated</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code>, &lt;litestar.di.Dependency object at 0x7f80cd4d3770&gt;]</p>
557+
<p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">Annotated</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code>, &lt;litestar.di.Dependency object at 0x7f2885b2fe60&gt;]</p>
558558
</dd></dl>
559559

560560
<dl class="py class">

4908/reference/params.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1119,7 +1119,7 @@
11191119
<dt class="sig sig-object py" id="litestar.params.SkipValidation">
11201120
<span class="sig-prename descclassname"><span class="pre">litestar.params.</span></span><span class="sig-name descname"><span class="pre">SkipValidation</span></span><a class="headerlink" href="#litestar.params.SkipValidation" title="Link to this definition"></a></dt>
11211121
<dd><p>Exclude ‘T’ from validation, effectively treating it as ‘Any’</p>
1122-
<p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">Annotated</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code>, &lt;litestar.params.SkipValidationMarker object at 0x7f80cd74dd30&gt;]</p>
1122+
<p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">Annotated</span></code>[<code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code>, &lt;litestar.params.SkipValidationMarker object at 0x7f2885919c70&gt;]</p>
11231123
</dd></dl>
11241124

11251125
<dl class="py class">

4908/reference/testing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,7 @@
741741
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
742742
<dl class="py method">
743743
<dt class="sig sig-object py" id="litestar.testing.AsyncWebSocketTestSession.__init__">
744-
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="types.html#litestar.types.ASGIApp" title="litestar.types.ASGIApp"><span class="pre">ASGIApp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="types.html#litestar.types.WebSocketScope" title="litestar.types.WebSocketScope"><span class="pre">WebSocketScope</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">connect_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.abc.TaskGroup" title="(in AnyIO v4.14.1)"><span class="pre">anyio.abc.TaskGroup</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../_modules/litestar/testing/websocket_test_session.html#AsyncWebSocketTestSession.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#litestar.testing.AsyncWebSocketTestSession.__init__" title="Link to this definition"></a></dt>
744+
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">app</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="types.html#litestar.types.ASGIApp" title="litestar.types.ASGIApp"><span class="pre">ASGIApp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">scope</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="types.html#litestar.types.WebSocketScope" title="litestar.types.WebSocketScope"><span class="pre">WebSocketScope</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">connect_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><span class="pre">float</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.abc.TaskGroup" title="(in AnyIO v4.14.2)"><span class="pre">anyio.abc.TaskGroup</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span></span><a class="reference internal" href="../_modules/litestar/testing/websocket_test_session.html#AsyncWebSocketTestSession.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#litestar.testing.AsyncWebSocketTestSession.__init__" title="Link to this definition"></a></dt>
745745
<dd></dd></dl>
746746

747747
<dl class="py method">

4908/release-notes/whats-new-2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,7 +1160,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Link to this heading">¶</a></
11601160
<div class="admonition">
11611161
<p class="admonition-title">Run it</p>
11621162
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;userName&quot;:&quot;Litestar User&quot;,&quot;password&quot;:&quot;xyz&quot;,&quot;created_at&quot;:&quot;2023-04-24T00:00:00Z&quot;}&#39;</span>
1163-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;bfbee238-4f59-4eba-997b-4c5c60fc363b&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
1163+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;47b65817-b551-4c49-9870-7ed28efd6311&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
11641164
</span></pre></div>
11651165
</div>
11661166
</div>
@@ -1277,7 +1277,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Link to this heading">¶</a></
12771277
<div class="admonition">
12781278
<p class="admonition-title">Run it</p>
12791279
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;name&quot;:&quot;Litestar User&quot;,&quot;password&quot;:&quot;xyz&quot;,&quot;created_at&quot;:&quot;2023-04-24T00:00:00Z&quot;}&#39;</span>
1280-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;3666feaf-951d-4232-91c7-2bfcb8b2510c&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
1280+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;fc7fc9b4-d6c1-488a-aed0-24196448a10c&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
12811281
</span></pre></div>
12821282
</div>
12831283
</div>

4908/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

4908/topics/sync-vs-async.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ <h3>Limitations<a class="headerlink" href="#limitations" title="Link to this hea
655655
non-blocking way, it does not speed up its execution. Computationally intensive tasks
656656
that are performed regularly should be offloaded into a different process, to make use
657657
of multiple CPU cores.</p>
658-
<p>This can for example be achieve by using <a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.to_process.run_sync" title="(in AnyIO v4.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">anyio.to_process.run_sync()</span></code></a>.</p>
658+
<p>This can for example be achieve by using <a class="reference external" href="https://anyio.readthedocs.io/en/stable/api.html#anyio.to_process.run_sync" title="(in AnyIO v4.14.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">anyio.to_process.run_sync()</span></code></a>.</p>
659659
</section>
660660
</section>
661661
<section id="warnings-about-the-mode-of-execution">

0 commit comments

Comments
 (0)