python-django-polymorphic-doc 2.0.2-1 / usr / share / doc / python-django-polymorphic-doc / html / api / polymorphic.formsets.html

This file is indexed.

/usr/share/doc/python-django-polymorphic-doc/html/api/polymorphic.formsets.html is in python-django-polymorphic-doc 2.0.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>polymorphic.formsets &mdash; django-polymorphic 2.0.2 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="django-polymorphic 2.0.2 documentation" href="../index.html"/>
        <link rel="up" title="API Documentation" href="index.html"/>
        <link rel="next" title="polymorphic.managers" href="polymorphic.managers.html"/>
        <link rel="prev" title="polymorphic.contrib.guardian" href="polymorphic.contrib.guardian.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../index.html" class="icon icon-home"> django-polymorphic
          

          
          </a>

          
            
            
              <div class="version">
                2.0.2
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../admin.html">Django admin integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../performance.html">Performance Considerations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../third-party.html">Third-party applications support</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../formsets.html">Formsets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../migrating.html">Migrating existing models to polymorphic</a></li>
<li class="toctree-l1"><a class="reference internal" href="../managers.html">Custom Managers, Querysets &amp; Manager Inheritance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../advanced.html">Advanced features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">API Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="polymorphic.admin.html">polymorphic.admin</a></li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.contrib.extra_views.html">polymorphic.contrib.extra_views</a></li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.contrib.guardian.html">polymorphic.contrib.guardian</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">polymorphic.formsets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#model-formsets">Model formsets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#inline-formsets">Inline formsets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#generic-formsets">Generic formsets</a></li>
<li class="toctree-l3"><a class="reference internal" href="#low-level-features">Low-level features</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.managers.html">polymorphic.managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.models.html">polymorphic.models</a></li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.templatetags.html">polymorphic.templatetags.polymorphic_admin_tags</a></li>
<li class="toctree-l2"><a class="reference internal" href="polymorphic.utils.html">polymorphic.utils</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">django-polymorphic</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">API Documentation</a> &raquo;</li>
        
      <li>polymorphic.formsets</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/api/polymorphic.formsets.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-polymorphic.formsets">
<span id="polymorphic-formsets"></span><h1>polymorphic.formsets<a class="headerlink" href="#module-polymorphic.formsets" title="Permalink to this headline"></a></h1>
<p>This allows creating formsets where each row can be a different form type.
The logic of the formsets work similar to the standard Django formsets;
there are factory methods to construct the classes with the proper form settings.</p>
<p>The “parent” formset hosts the entire model and their child model.
For every child type, there is an <a class="reference internal" href="#polymorphic.formsets.PolymorphicFormSetChild" title="polymorphic.formsets.PolymorphicFormSetChild"><code class="xref py py-class docutils literal"><span class="pre">PolymorphicFormSetChild</span></code></a> instance
that describes how to display and construct the child.
It’s parameters are very similar to the parent’s factory method.</p>
<div class="section" id="model-formsets">
<h2>Model formsets<a class="headerlink" href="#model-formsets" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polymorphic.formsets.polymorphic_modelformset_factory">
<code class="descclassname">polymorphic.formsets.</code><code class="descname">polymorphic_modelformset_factory</code><span class="sig-paren">(</span><em>model</em>, <em>formset_children</em>, <em>formset=&lt;class 'polymorphic.formsets.models.BasePolymorphicModelFormSet'&gt;</em>, <em>form=&lt;class 'django.forms.models.ModelForm'&gt;</em>, <em>fields=None</em>, <em>exclude=None</em>, <em>extra=1</em>, <em>can_order=False</em>, <em>can_delete=True</em>, <em>max_num=None</em>, <em>formfield_callback=None</em>, <em>widgets=None</em>, <em>validate_max=False</em>, <em>localized_fields=None</em>, <em>labels=None</em>, <em>help_texts=None</em>, <em>error_messages=None</em>, <em>min_num=None</em>, <em>validate_min=False</em>, <em>field_classes=None</em>, <em>child_form_kwargs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.polymorphic_modelformset_factory" title="Permalink to this definition"></a></dt>
<dd><p>Construct the class for an polymorphic model formset.</p>
<p>All arguments are identical to :func:’~django.forms.models.modelformset_factory’,
with the exception of the ‘’formset_children’’ argument.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>formset_children</strong> (<em>Iterable</em><em>[</em><a class="reference internal" href="#polymorphic.formsets.PolymorphicFormSetChild" title="polymorphic.formsets.PolymorphicFormSetChild"><em>PolymorphicFormSetChild</em></a><em>]</em>) – A list of all child :class:’PolymorphicFormSetChild’ objects
that tell the inline how to render the child model types.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">type</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="polymorphic.formsets.PolymorphicFormSetChild">
<em class="property">class </em><code class="descclassname">polymorphic.formsets.</code><code class="descname">PolymorphicFormSetChild</code><span class="sig-paren">(</span><em>model</em>, <em>form=&lt;class 'django.forms.models.ModelForm'&gt;</em>, <em>fields=None</em>, <em>exclude=None</em>, <em>formfield_callback=None</em>, <em>widgets=None</em>, <em>localized_fields=None</em>, <em>labels=None</em>, <em>help_texts=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.PolymorphicFormSetChild" title="Permalink to this definition"></a></dt>
<dd><p>Metadata to define the inline of a polymorphic child.
Provide this information in the :func:’polymorphic_inlineformset_factory’ construction.</p>
</dd></dl>

</div>
<div class="section" id="inline-formsets">
<h2>Inline formsets<a class="headerlink" href="#inline-formsets" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polymorphic.formsets.polymorphic_inlineformset_factory">
<code class="descclassname">polymorphic.formsets.</code><code class="descname">polymorphic_inlineformset_factory</code><span class="sig-paren">(</span><em>parent_model</em>, <em>model</em>, <em>formset_children</em>, <em>formset=&lt;class 'polymorphic.formsets.models.BasePolymorphicInlineFormSet'&gt;</em>, <em>fk_name=None</em>, <em>form=&lt;class 'django.forms.models.ModelForm'&gt;</em>, <em>fields=None</em>, <em>exclude=None</em>, <em>extra=1</em>, <em>can_order=False</em>, <em>can_delete=True</em>, <em>max_num=None</em>, <em>formfield_callback=None</em>, <em>widgets=None</em>, <em>validate_max=False</em>, <em>localized_fields=None</em>, <em>labels=None</em>, <em>help_texts=None</em>, <em>error_messages=None</em>, <em>min_num=None</em>, <em>validate_min=False</em>, <em>field_classes=None</em>, <em>child_form_kwargs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.polymorphic_inlineformset_factory" title="Permalink to this definition"></a></dt>
<dd><p>Construct the class for an inline polymorphic formset.</p>
<p>All arguments are identical to :func:’~django.forms.models.inlineformset_factory’,
with the exception of the ‘’formset_children’’ argument.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>formset_children</strong> (<em>Iterable</em><em>[</em><a class="reference internal" href="#polymorphic.formsets.PolymorphicFormSetChild" title="polymorphic.formsets.PolymorphicFormSetChild"><em>PolymorphicFormSetChild</em></a><em>]</em>) – A list of all child :class:’PolymorphicFormSetChild’ objects
that tell the inline how to render the child model types.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">type</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="generic-formsets">
<h2>Generic formsets<a class="headerlink" href="#generic-formsets" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polymorphic.formsets.generic_polymorphic_inlineformset_factory">
<code class="descclassname">polymorphic.formsets.</code><code class="descname">generic_polymorphic_inlineformset_factory</code><span class="sig-paren">(</span><em>model</em>, <em>formset_children</em>, <em>form=&lt;class 'django.forms.models.ModelForm'&gt;</em>, <em>formset=&lt;class 'polymorphic.formsets.generic.BaseGenericPolymorphicInlineFormSet'&gt;</em>, <em>ct_field='content_type'</em>, <em>fk_field='object_id'</em>, <em>fields=None</em>, <em>exclude=None</em>, <em>extra=1</em>, <em>can_order=False</em>, <em>can_delete=True</em>, <em>max_num=None</em>, <em>formfield_callback=None</em>, <em>validate_max=False</em>, <em>for_concrete_model=True</em>, <em>min_num=None</em>, <em>validate_min=False</em>, <em>child_form_kwargs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.generic_polymorphic_inlineformset_factory" title="Permalink to this definition"></a></dt>
<dd><p>Construct the class for a generic inline polymorphic formset.</p>
<p>All arguments are identical to <code class="xref py py-func docutils literal"><span class="pre">generic_inlineformset_factory()</span></code>,
with the exception of the <code class="docutils literal"><span class="pre">formset_children</span></code> argument.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>formset_children</strong> (<em>Iterable</em><em>[</em><a class="reference internal" href="#polymorphic.formsets.PolymorphicFormSetChild" title="polymorphic.formsets.PolymorphicFormSetChild"><em>PolymorphicFormSetChild</em></a><em>]</em>) – A list of all child <a class="reference internal" href="#polymorphic.formsets.PolymorphicFormSetChild" title="polymorphic.formsets.PolymorphicFormSetChild"><code class="xref py py-class docutils literal"><span class="pre">PolymorphicFormSetChild</span></code></a> objects
that tell the inline how to render the child model types.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">type</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="low-level-features">
<h2>Low-level features<a class="headerlink" href="#low-level-features" title="Permalink to this headline"></a></h2>
<p>The internal machinery can be used to extend the formset classes. This includes:</p>
<dl class="function">
<dt id="polymorphic.formsets.polymorphic_child_forms_factory">
<code class="descclassname">polymorphic.formsets.</code><code class="descname">polymorphic_child_forms_factory</code><span class="sig-paren">(</span><em>formset_children</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.polymorphic_child_forms_factory" title="Permalink to this definition"></a></dt>
<dd><p>Construct the forms for the formset children.
This is mostly used internally, and rarely needs to be used by external projects.
When using the factory methods (:func:’polymorphic_inlineformset_factory’),
this feature is called already for you.</p>
</dd></dl>

<dl class="class">
<dt id="polymorphic.formsets.BasePolymorphicModelFormSet">
<em class="property">class </em><code class="descclassname">polymorphic.formsets.</code><code class="descname">BasePolymorphicModelFormSet</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.BasePolymorphicModelFormSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">django.forms.models.BaseModelFormSet</span></code></p>
<p>A formset that can produce different forms depending on the object type.</p>
<p>Note that the ‘add’ feature is therefore more complex,
as all variations need ot be exposed somewhere.</p>
<p>When switching existing formsets to the polymorphic formset,
note that the ID field will no longer be named ‘’model_ptr’‘,
but just appear as ‘’id’‘.</p>
</dd></dl>

<dl class="class">
<dt id="polymorphic.formsets.BasePolymorphicInlineFormSet">
<em class="property">class </em><code class="descclassname">polymorphic.formsets.</code><code class="descname">BasePolymorphicInlineFormSet</code><span class="sig-paren">(</span><em>data=None</em>, <em>files=None</em>, <em>instance=None</em>, <em>save_as_new=False</em>, <em>prefix=None</em>, <em>queryset=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.BasePolymorphicInlineFormSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">django.forms.models.BaseInlineFormSet</span></code>, <code class="xref py py-class docutils literal"><span class="pre">polymorphic.formsets.models.BasePolymorphicModelFormSet</span></code></p>
<p>Polymorphic formset variation for inline formsets</p>
</dd></dl>

<dl class="class">
<dt id="polymorphic.formsets.BaseGenericPolymorphicInlineFormSet">
<em class="property">class </em><code class="descclassname">polymorphic.formsets.</code><code class="descname">BaseGenericPolymorphicInlineFormSet</code><span class="sig-paren">(</span><em>data=None</em>, <em>files=None</em>, <em>instance=None</em>, <em>save_as_new=None</em>, <em>prefix=None</em>, <em>queryset=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#polymorphic.formsets.BaseGenericPolymorphicInlineFormSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">django.contrib.contenttypes.forms.BaseGenericInlineFormSet</span></code>, <code class="xref py py-class docutils literal"><span class="pre">polymorphic.formsets.models.BasePolymorphicModelFormSet</span></code></p>
<p>Polymorphic formset variation for inline generic formsets</p>
</dd></dl>

</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="polymorphic.managers.html" class="btn btn-neutral float-right" title="polymorphic.managers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="polymorphic.contrib.guardian.html" class="btn btn-neutral" title="polymorphic.contrib.guardian" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Bert Constantin, Chris Glass, Diederik van der Boor.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'2.0.2',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.