mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-09-21 05:09:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed ccf02fa to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2025-05-11 13:00:41 +00:00
parent 7f8d53a0f5
commit de0b7dfc14
35 changed files with 159 additions and 167 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dev/reference/testing_api/index.html
View file

@ -50,7 +50,7 @@
<a id=__codelineno-3-6 name=__codelineno-3-6 href=#__codelineno-3-6></a><span class=nd>@djc_test</span>
<a id=__codelineno-3-7 name=__codelineno-3-7 href=#__codelineno-3-7></a><span class=k>def</span><span class=w> </span><span class=nf>test_my_component</span><span class=p>():</span>
<a id=__codelineno-3-8 name=__codelineno-3-8 href=#__codelineno-3-8></a> <span class=o>...</span>
</code></pre></div> <p><strong>Arguments:</strong></p> <ul> <li> <p><code>django_settings</code>: Django settings, a dictionary passed to Django's <a href=https://docs.djangoproject.com/en/5.1/topics/testing/tools/#django.test.override_settings><code>@override_settings</code></a>. The test runs within the context of these overridden settings.</p> <p>If <code>django_settings</code> contains django-components settings (<code>COMPONENTS</code> field), these are merged. Other Django settings are simply overridden.</p> </li> <li> <p><code>components_settings</code>: Instead of defining django-components settings under <code>django_settings["COMPONENTS"]</code>, you can simply set the Components settings here.</p> <p>These settings are merged with the django-components settings from <code>django_settings["COMPONENTS"]</code>.</p> <p>Fields in <code>components_settings</code> override fields in <code>django_settings["COMPONENTS"]</code>.</p> </li> <li> <p><code>parametrize</code>: Parametrize the test function with <a href=https://docs.pytest.org/en/stable/how-to/parametrize.html#pytest-mark-parametrize><code>pytest.mark.parametrize</code></a>. This requires <a href=https://docs.pytest.org/ >pytest</a> to be installed.</p> <p>The input is a tuple of:</p> <ul> <li><code>(param_names, param_values)</code> or</li> <li><code>(param_names, param_values, ids)</code></li> </ul> <p>Example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components.testing</span><span class=w> </span><span class=kn>import</span> <span class=n>djc_test</span>
</code></pre></div> <p><strong>Arguments:</strong></p> <ul> <li> <p><code>django_settings</code>: Django settings, a dictionary passed to Django's <a href=https://docs.djangoproject.com/en/5.2/topics/testing/tools/#django.test.override_settings><code>@override_settings</code></a>. The test runs within the context of these overridden settings.</p> <p>If <code>django_settings</code> contains django-components settings (<code>COMPONENTS</code> field), these are merged. Other Django settings are simply overridden.</p> </li> <li> <p><code>components_settings</code>: Instead of defining django-components settings under <code>django_settings["COMPONENTS"]</code>, you can simply set the Components settings here.</p> <p>These settings are merged with the django-components settings from <code>django_settings["COMPONENTS"]</code>.</p> <p>Fields in <code>components_settings</code> override fields in <code>django_settings["COMPONENTS"]</code>.</p> </li> <li> <p><code>parametrize</code>: Parametrize the test function with <a href=https://docs.pytest.org/en/stable/how-to/parametrize.html#pytest-mark-parametrize><code>pytest.mark.parametrize</code></a>. This requires <a href=https://docs.pytest.org/ >pytest</a> to be installed.</p> <p>The input is a tuple of:</p> <ul> <li><code>(param_names, param_values)</code> or</li> <li><code>(param_names, param_values, ids)</code></li> </ul> <p>Example:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=kn>from</span><span class=w> </span><span class=nn>django_components.testing</span><span class=w> </span><span class=kn>import</span> <span class=n>djc_test</span>
<a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a>
<a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a><span class=nd>@djc_test</span><span class=p>(</span>
<a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a> <span class=n>parametrize</span><span class=o>=</span><span class=p>(</span>