Deploying to gh-pages from @ fac9fba 🚀

litestar-org · Mar 29, 2024 · ea8dc52 · ea8dc52
1 parent 46859f9
commit ea8dc52
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 41 deletions.
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/usage/configuration.html b/latest/usage/configuration.html
@@ -1021,8 +1021,7 @@ <h2>Defining Default Factories<a class="headerlink" href="#defining-default-fact
     <span class="n">assets</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_dynamic_factory_generation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -1074,8 +1073,7 @@ <h2>Defining Default Factories<a class="headerlink" href="#defining-default-fact
     <span class="n">name</span> <span class="o">=</span> <span class="n">Use</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="o">.</span><span class="n">__random__</span><span class="o">.</span><span class="n">choice</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;Roxy&quot;</span><span class="p">,</span> <span class="s2">&quot;Spammy&quot;</span><span class="p">,</span> <span class="s2">&quot;Moshe&quot;</span><span class="p">])</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_default_pet_factory</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/latest/usage/declaring_factories.html b/latest/usage/declaring_factories.html
@@ -827,8 +827,7 @@ <h1>Declaring Factories<a class="headerlink" href="#declaring-factories" title="
     <span class="n">weight</span><span class="p">:</span> <span class="nb">float</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">TypedDictFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">TypedDictFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_is_person</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -856,8 +855,7 @@ <h1>Declaring Factories<a class="headerlink" href="#declaring-factories" title="
     <span class="n">weight</span><span class="p">:</span> <span class="nb">float</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">ModelFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">ModelFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_is_person</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -889,8 +887,7 @@ <h1>Declaring Factories<a class="headerlink" href="#declaring-factories" title="
     <span class="n">weight</span><span class="p">:</span> <span class="nb">float</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_is_person</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -928,8 +925,7 @@ <h1>Declaring Factories<a class="headerlink" href="#declaring-factories" title="
     <span class="n">_assets</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">AttrsFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">AttrsFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_person_factory</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -984,8 +980,7 @@ <h2>Imperative Factory Creation<a class="headerlink" href="#imperative-factory-c
     <span class="n">assets</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]]</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_dynamic_factory_generation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/latest/usage/fixtures.html b/latest/usage/fixtures.html
@@ -788,8 +788,7 @@ <h1>Pytest fixtures<a class="headerlink" href="#pytest-fixtures" title="Permalin
 
 
 <span class="nd">@register_fixture</span>
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_person_factory</span><span class="p">(</span><span class="n">person_factory</span><span class="p">:</span> <span class="n">PersonFactory</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -822,8 +821,7 @@ <h1>Pytest fixtures<a class="headerlink" href="#pytest-fixtures" title="Permalin
     <span class="n">birthday</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">datetime</span><span class="p">,</span> <span class="n">date</span><span class="p">]</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="n">person_factory_fixture</span> <span class="o">=</span> <span class="n">register_fixture</span><span class="p">(</span><span class="n">PersonFactory</span><span class="p">)</span>
@@ -861,8 +859,7 @@ <h1>Pytest fixtures<a class="headerlink" href="#pytest-fixtures" title="Permalin
     <span class="n">birthday</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">datetime</span><span class="p">,</span> <span class="n">date</span><span class="p">]</span>
 
 
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="n">person_factory_fixture</span> <span class="o">=</span> <span class="n">register_fixture</span><span class="p">(</span><span class="n">PersonFactory</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;aliased_person_factory&quot;</span><span class="p">)</span>
@@ -906,8 +903,7 @@ <h2>The <code class="docutils literal notranslate"><span class="pre">Fixture</sp
 
 
 <span class="nd">@register_fixture</span>
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">ClassRoomFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">ClassRoom</span><span class="p">]):</span>

diff --git a/latest/usage/handling_custom_types.html b/latest/usage/handling_custom_types.html
@@ -868,8 +868,7 @@ <h2>Creating Custom Base Factories<a class="headerlink" href="#creating-custom-b
 
 
 <span class="c1"># we use our CustomDataclassFactory as a base for the PersonFactory</span>
-<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">CustomDataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">PersonFactory</span><span class="p">(</span><span class="n">CustomDataclassFactory</span><span class="p">[</span><span class="n">Person</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_custom_dataclass_base_factory</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/latest/usage/library_factories/sqlalchemy_factory.html b/latest/usage/library_factories/sqlalchemy_factory.html
@@ -775,8 +775,7 @@ <h1>SQLAlchemyFactory<a class="headerlink" href="#sqlalchemyfactory" title="Perm
 <span class="kn">from</span> <span class="nn">polyfactory.factories.sqlalchemy_factory</span> <span class="kn">import</span> <span class="n">SQLAlchemyFactory</span>
 
 
-<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
@@ -786,8 +785,7 @@ <h1>SQLAlchemyFactory<a class="headerlink" href="#sqlalchemyfactory" title="Perm
     <span class="n">name</span><span class="p">:</span> <span class="n">Mapped</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
 
 
-<span class="k">class</span> <span class="nc">AuthorFactory</span><span class="p">(</span><span class="n">SQLAlchemyFactory</span><span class="p">[</span><span class="n">Author</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">AuthorFactory</span><span class="p">(</span><span class="n">SQLAlchemyFactory</span><span class="p">[</span><span class="n">Author</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_sqla_factory</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -813,8 +811,7 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 <span class="kn">from</span> <span class="nn">polyfactory.factories.sqlalchemy_factory</span> <span class="kn">import</span> <span class="n">SQLAlchemyFactory</span>
 
 
-<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
@@ -833,8 +830,7 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
     <span class="n">author_id</span><span class="p">:</span> <span class="n">Mapped</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="n">mapped_column</span><span class="p">(</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Author</span><span class="o">.</span><span class="n">id</span><span class="p">))</span>
 
 
-<span class="k">class</span> <span class="nc">AuthorFactory</span><span class="p">(</span><span class="n">SQLAlchemyFactory</span><span class="p">[</span><span class="n">Author</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">AuthorFactory</span><span class="p">(</span><span class="n">SQLAlchemyFactory</span><span class="p">[</span><span class="n">Author</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">AuthorFactoryWithRelationship</span><span class="p">(</span><span class="n">SQLAlchemyFactory</span><span class="p">[</span><span class="n">Author</span><span class="p">]):</span>
@@ -871,8 +867,7 @@ <h2>Persistence<a class="headerlink" href="#persistence" title="Permalink to thi
 <span class="kn">from</span> <span class="nn">polyfactory.factories.sqlalchemy_factory</span> <span class="kn">import</span> <span class="n">SQLAlchemyFactory</span>
 
 
-<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
@@ -924,8 +919,7 @@ <h2>Adding global overrides<a class="headerlink" href="#adding-global-overrides"
 <span class="kn">from</span> <span class="nn">polyfactory.factories.sqlalchemy_factory</span> <span class="kn">import</span> <span class="n">SQLAlchemyFactory</span><span class="p">,</span> <span class="n">T</span>
 
 
-<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">Base</span><span class="p">(</span><span class="n">DeclarativeBase</span><span class="p">):</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>

diff --git a/latest/usage/model_coverage.html b/latest/usage/model_coverage.html
@@ -792,8 +792,7 @@ <h1>Model coverage generation<a class="headerlink" href="#model-coverage-generat
     <span class="n">vehicle</span><span class="p">:</span> <span class="n">Car</span> <span class="o">|</span> <span class="n">Boat</span>
 
 
-<span class="k">class</span> <span class="nc">ProfileFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Profile</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">ProfileFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">Profile</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_profile_coverage</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
@@ -848,8 +847,7 @@ <h2>Notes on collection types<a class="headerlink" href="#notes-on-collection-ty
     <span class="n">members</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Profile</span><span class="p">]</span>
 
 
-<span class="k">class</span> <span class="nc">SocialGroupFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">SocialGroup</span><span class="p">]):</span>
-    <span class="o">...</span>
+<span class="k">class</span> <span class="nc">SocialGroupFactory</span><span class="p">(</span><span class="n">DataclassFactory</span><span class="p">[</span><span class="n">SocialGroup</span><span class="p">]):</span> <span class="o">...</span>
 
 
 <span class="k">def</span> <span class="nf">test_social_group_coverage</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>