o em@sddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZmZeGd d d ZGd d d ZGd ddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZGd!d"d"eZGd#d$d$eZGd%d&d&eZ Gd'd(d(Z!Gd)d*d*eZ"Gd+d,d,e"Z#d-S).) dataclass)List)Template)render_to_string)conditional_escape) SafeString)slugify) TEMPLATE_PACKflatatt render_fieldc@s"eZdZUeeed<eed<dS)Pointer positionsnameN)__name__ __module__ __qualname__rint__annotations__strrrT/var/www/html/humari/django-venv/lib/python3.10/site-packages/crispy_forms/layout.pyr s  r c@seZdZddZdS)TemplateNameMixincCs"d|jvr |j|}|S|j}|S)Nz%s)template)self template_packrrrrget_template_names  z#TemplateNameMixin.get_template_nameN)rrrrrrrrrs rc@s\eZdZddZddZddZddZd d Zdd d Zd dddddZ e fddZ d S) LayoutObjectcCs |j|SNfieldsrslicerrr __getitem__ zLayoutObject.__getitem__cCs||j|<dSrr)rr!valuerrr __setitem__!zLayoutObject.__setitem__cCs |j|=dSrrr rrr __delitem__$s zLayoutObject.__delitem__cCs t|jSr)lenr)rrrr__len__'r#zLayoutObject.__len__cCs.d|jvrt|j|rt|j|St||S)z This allows us to access self.fields list methods like append or insert, without having to declare them one by one r)__dict__hasattrrgetattrobject__getattribute__)rrrrr __getattr__*s  zLayoutObject.__getattr__NcCs|jtdddS)a  Returns a list of Pointers. First parameter is the location of the field, second one the name of the field. Example:: [ Pointer([0,1,2], 'field_name1'), Pointer([0,3], 'field_name2'), ] NT)indexgreedy)get_layout_objectsr)rr0rrrget_field_names5s zLayoutObject.get_field_namesrFr0 max_levelr1c Gsg}|durt|ts|g}n|durg}t|dko |dtk}t|jD]F\}}t||rL|r=|t||g|n|t||g|jj t |drlt||ksY|rl||g||d} ||j |i| }q&|S)a Returns a list of Pointers pointing to layout objects of any type matching `LayoutClasses`:: [ Pointer([0,1,2], 'div']), Pointer([0,3], 'field_name'), ] :param max_level: An integer that indicates max level depth to reach when traversing a layout. :param greedy: Boolean that indicates whether to be greedy. If set, max_level is skipped. Nrr3r4) isinstancelistr(r enumeraterappendr __class__rlowerr+r2) rr0r5r1 LayoutClassespointers str_classi layout_object new_kwargsrrrr2As  zLayoutObject.get_layout_objectsc s$tdfdd|jDS)Nc3s(|]}t|fdiVqdS)rN)r ).0fieldcontextformkwargsrrr is&z3LayoutObject.get_rendered_fields..)rjoinrrrHrGrrIrrFrget_rendered_fieldsgsz LayoutObject.get_rendered_fieldsr) rrrr"r%r'r)r/r3r2r rMrrrrrs  &rc@$eZdZdZddZefddZdS)Layouta Form Layout. It is conformed by Layout objects: `Fieldset`, `Row`, `Column`, `MultiField`, `HTML`, `ButtonHolder`, `Button`, `Hidden`, `Reset`, `Submit` and fields. Form fields have to be strings. Layout objects `Fieldset`, `Row`, `Column`, `MultiField` and `ButtonHolder` can hold other Layout objects within. Though `ButtonHolder` should only hold `HTML` and BaseInput inherited classes: `Button`, `Hidden`, `Reset` and `Submit`. Example:: helper.layout = Layout( Fieldset('Company data', 'is_company' ), Fieldset(_('Contact details'), 'email', Row('password1', 'password2'), 'first_name', 'last_name', HTML(''), 'company' ), ButtonHolder( Submit('Save', 'Save', css_class='button white'), ), ) cGst||_dSr)r8r)rrrrr__init__r&zLayout.__init__cKs|j|||fi|Sr)rMrLrrrrendersz Layout.renderNrrr__doc__rPr rQrrrrrOmsrOc@2eZdZdZdZddddddZefddZdS) ButtonHolderag Layout object. It wraps fields in a
This is where you should put Layout objects that render to form buttons Attributes ---------- template: str The default template which this Layout Object will be rendered with. Parameters ---------- *fields : HTML or BaseInput The layout objects to render within the ``ButtonHolder``. It should only hold `HTML` and `BaseInput` inherited objects. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. Examples -------- An example using ``ButtonHolder`` in your layout:: ButtonHolder( HTML(Information Saved), Submit('Save', 'Save') ) z%s/layout/buttonholder.htmlNcss_id css_classrcGs&t||_||_||_|p|j|_dSr)r8rrWrXr)rrWrXrrrrrrPs zButtonHolder.__init__cKs>|j|||fi|}||}|||dt||S)N) buttonholder fields_output)rMrupdaterflatten)rrHrGrrIhtmlrrrrrQs zButtonHolder.renderrrrrSrrPr rQrrrrrUs %rUc@s6eZdZdZdZdZddddddZefdd ZdS) BaseInputa A base class to reduce the amount of code in the Input classes. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_classes: str CSS classes to be applied to the ````. Parameters ---------- name : str The name attribute of the button. value : str The value attribute of the button. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to `flatatt` and converted into key="value", pairs. These attributes are added to the ````. z%s/layout/baseinput.htmlrCNrVcKsl||_||_|r ||_nt|j}|jd||_i|_|r)|jd|7_|p-|j|_t||_ dS)Nz-id- ) rr$idr input_typeattrs field_classesrr flat_attrs)rrr$rWrXrrIslugrrrrPs  zBaseInput.__init__cKs<tt|j||_||}|d|it||S)z Renders an `` if container is used as a Layout object. Input button value can be a variable in context. input)rrr$rQrr[rr\)rrHrGrrIrrrrrQs zBaseInput.render) rrrrSrrdrPr rQrrrrr_s r_c@eZdZdZdZdZdS)Submita Used to create a Submit button descriptor for the {% crispy %} template tag. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_classes: str CSS classes to be applied to the ````. input_type: str The ``type`` attribute of the ````. Parameters ---------- name : str The name attribute of the button. value : str The value attribute of the button. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to `flatatt` and converted into key="value", pairs. These attributes are added to the ````. Examples -------- Note: ``form`` arg to ``render()`` is not required for ``BaseInput`` inherited objects. >>> submit = Submit('Search the Site', 'search this site') >>> submit.render("", "", Context()) '' >>> submit = Submit('Search the Site', 'search this site', css_id="custom-id", css_class="custom class", my_attr=True, data="my-data") >>> submit.render("", "", Context()) '' Usually you will not call the render method on the object directly. Instead add it to your ``Layout`` manually or use the `add_input` method:: class ExampleForm(forms.Form): [...] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.helper = FormHelper() self.helper.add_input(Submit('submit', 'Submit')) submitzbtn btn-primaryNrrrrSrbrdrrrrri;ric@rh)Buttonai Used to create a button descriptor for the {% crispy %} template tag. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_classes: str CSS classes to be applied to the ````. input_type: str The ``type`` attribute of the ````. Parameters ---------- name : str The name attribute of the button. value : str The value attribute of the button. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to `flatatt` and converted into key="value", pairs. These attributes are added to the ````. Examples -------- Note: ``form`` arg to ``render()`` is not required for ``BaseInput`` inherited objects. >>> button = Button('Button 1', 'Press Me!') >>> button.render("", "", Context()) '' >>> button = Button('Button 1', 'Press Me!', css_id="custom-id", css_class="custom class", my_attr=True, data="my-data") >>> button.render("", "", Context()) '' Usually you will not call the render method on the object directly. Instead add it to your ``Layout`` manually or use the `add_input` method:: class ExampleForm(forms.Form): [...] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.helper = FormHelper() self.helper.add_input(Button('Button 1', 'Press Me!')) buttonbtnNrkrrrrrmGrlrmc@seZdZdZdZdZdS)Hiddena Used to create a Hidden input descriptor for the {% crispy %} template tag. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_classes: str CSS classes to be applied to the ````. input_type: str The ``type`` attribute of the ````. Parameters ---------- name : str The name attribute of the button. value : str The value attribute of the button. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to `flatatt` and converted into key="value", pairs. These attributes are added to the ````. Examples -------- Note: ``form`` arg to ``render()`` is not required for ``BaseInput`` inherited objects. >>> hidden = Hidden("hidden", "hide-me") >>> hidden.render("", "", Context()) '' Usually you will not call the render method on the object directly. Instead add it to your ``Layout`` manually or use the `add_input` method:: class ExampleForm(forms.Form): [...] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.helper = FormHelper() self.helper.add_input(Hidden("hidden", "hide-me")) hiddenNrkrrrrrps4rpc@rh)Reseta Used to create a reset button descriptor for the {% crispy %} template tag. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_classes: str CSS classes to be applied to the ````. input_type: str The ``type`` attribute of the ````. Parameters ---------- name : str The name attribute of the button. value : str The value attribute of the button. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to `flatatt` and converted into key="value", pairs. These attributes are added to the ````. Examples -------- Note: ``form`` arg to ``render()`` is not required for ``BaseInput`` inherited objects. >>> reset = Reset('Reset This Form', 'Revert Me!') >>> reset.render("", "", Context()) '' >>> reset = Reset('Reset This Form', 'Revert Me!', css_id="custom-id", css_class="custom class", my_attr=True, data="my-data") >>> reset.render("", "", Context()) '' Usually you will not call the render method on the object directly. Instead add it to your ``Layout`` manually manually or use the `add_input` method:: class ExampleForm(forms.Form): [...] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.helper = FormHelper() self.helper.add_input(Reset('Reset This Form', 'Revert Me!')) resetzbtn btn-inverseNrkrrrrrrrlrrc@rT) Fieldseta A layout object which wraps fields in a ``
`` Parameters ---------- legend : str The content of the fieldset's ````. This text is context aware, to bring this to life see the examples section. *fields : str | LayoutObject | HTML Any number of fields as positional arguments to be rendered within the ``
`` css_class : str, optional Additional CSS classes to be applied to the ````. By default None. css_id : str, optional A custom DOM id for the layout object. If not provided the name argument is slugified and turned into the id for the submit button. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to ``flatatt`` and converted into key="value", pairs. These attributes are added to the ``
``. Examples -------- The Fieldset Layout object is added to your ``Layout`` for example:: Fieldset("Text for the legend", "form_field_1", "form_field_2", css_id="my-fieldset-id", css_class="my-fieldset-class", data="my-data" ) The above layout will be rendered as:: '''
Text for the legend # form fields render here
''' The first parameter is the text for the fieldset legend. This text is context aware, so you can do things like:: Fieldset("Data for {{ user.username }}", 'form_field_1', 'form_field_2' ) z%s/layout/fieldset.htmlN)rXrWrcOs6t||_||_||_||_|p|j|_t||_dSr)r8rlegendrXrWrr re)rrurXrWrrrIrrrrP:s  zFieldset.__init__cKsV|j|||fi|}|jrtt|j|}ntd}||}t||||dS)NrC)fieldsetrur)rMrurrrQrrr)rrHrGrrIrrurrrrrQBs  zFieldset.renderr^rrrrrts 7rtc@s<eZdZdZdZdZdddddddddZefdd ZdS) MultiFielda MultiField container for Bootstrap3. Renders to a MultiField
. Attributes ---------- template: str The default template which this Layout Object will be rendered with. field_template: str The template which fields will be rendered with. Parameters ---------- label: str The label for the multifield. *fields: str The fields to be rendered within the multifield. label_class: str, optional CSS classes to be added to the multifield label. By default None. help_text: str, optional Help text will be available in the context of the multifield template. This is unused in the bootstrap3 template provided. By default None. css_class : str, optional Additional CSS classes to be applied to the ````. By default None. css_id : str, optional A DOM id for the layout object which will be added to the wrapping ``
`` if provided. By default None. template : str, optional Overrides the default template, if provided. By default None. field_template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to ``flatatt`` and converted into key="value", pairs. These attributes are added to the wrapping ``
``. z%s/layout/multifield.htmlz%s/multifield.htmlN) label_class help_textrXrWrfield_templatec OsVt||_||_|p d|_|pd|_||_||_|p|j|_|p"|j|_t | |_ dS)N blockLabel ctrlHolder) r8r label_htmlrxrXrWryrrzr re) rlabelrxryrXrWrrzrrIrrrrPys     zMultiField.__init__c Ks|drdd|DD]}||jvr|jd7_q |j|}|j|||f||j|d|}||}|||dt|| S)Nform_show_errorscss|]}|jVqdSr)r)rDpointerrrrrJsz$MultiField.render..z error)r labelclassrA) multifieldrZ) r3errorsrXrzrMrxrr[rr\) rrHrGrrIrErzrZrrrrrQs(   zMultiField.render) rrrrSrrzrPr rQrrrrrwNs' rwc@s6eZdZdZdZdZddddddZefddZdS) Diva Layout object. It wraps fields in a ``
``. Attributes ---------- template : str The default template which this Layout Object will be rendered with. css_class : str, optional CSS classes to be applied to the ``
``. By default None. Parameters ---------- *fields : str, LayoutObject Any number of fields as positional arguments to be rendered within the ``
``. css_id : str, optional A DOM id for the layout object which will be added to the ``
`` if provided. By default None. css_class : str, optional Additional CSS classes to be applied in addition to those declared by the class itself. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to ``flatatt`` and converted into key="value", pairs. These attributes are added to the ``
``. Examples -------- In your ``Layout`` you can:: Div( 'form_field_1', 'form_field_2', css_id='div-example', css_class='divs', ) It is also possible to nest Layout Objects within a Div:: Div( Div( Field('form_field', css_class='field-class'), css_class='div-class', ), Div('form_field_2', css_class='div-class'), ) z%s/layout/div.htmlNrVcOsTt||_|jr|r|jd|7_n|r||_||_|p!|j|_t||_dS)Nr`)r8rrXrWrr re)rrWrXrrrIrrrrPs   z Div.__init__cKs0|j|||fi|}||}t|||dS)N)divr)rMrr)rrHrGrrIrrrrrrQs z Div.render) rrrrSrrXrPr rQrrrrrs 3 rc@eZdZdZdZdS)Rowa Layout object. It wraps fields in a ``
`` and the template adds the appropriate class to render the contents in a row. e.g. ``form-row`` when using the Bootstrap4 template pack. Attributes ---------- template : str The default template which this Layout Object will be rendered with. css_class : str, optional CSS classes to be applied to the ``
``. By default None. Parameters ---------- *fields : str, LayoutObject Any number of fields as positional arguments to be rendered within the ``
``. css_id : str, optional A DOM id for the layout object which will be added to the ``
`` if provided. By default None. css_class : str, optional Additional CSS classes to be applied in addition to those declared by the class itself. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to ``flatatt`` and converted into key="value", pairs. These attributes are added to the ``
``. Examples -------- In your ``Layout`` you can:: Row('form_field_1', 'form_field_2', css_id='row-example') It is also possible to nest Layout Objects within a Row:: Row( Div( Field('form_field', css_class='field-class'), css_class='div-class', ), Div('form_field_2', css_class='div-class'), ) z%s/layout/row.htmlNrrrrSrrrrrrs0rc@r)Columna Layout object. It wraps fields in a ``
`` and the template adds the appropriate class to render the contents in a column. e.g. ``col-md`` when using the Bootstrap4 template pack. Attributes ---------- template : str The default template which this Layout Object will be rendered with. css_class : str, optional CSS classes to be applied to the ``
``. By default None. Parameters ---------- *fields : str, LayoutObject Any number of fields as positional arguments to be rendered within the ``
``. css_id : str, optional A DOM id for the layout object which will be added to the ``
`` if provided. By default None. css_class : str, optional Additional CSS classes to be applied in addition to those declared by the class itself. If using the Bootstrap4 template pack the default ``col-md`` is removed if this string contins another ``col-`` class. By default None. template : str, optional Overrides the default template, if provided. By default None. **kwargs : dict, optional Additional attributes are passed to ``flatatt`` and converted into key="value", pairs. These attributes are added to the ``
``. Examples -------- In your ``Layout`` you can:: Column('form_field_1', 'form_field_2', css_id='col-example') It is also possible to nest Layout Objects within a Row:: Div( Column( Field('form_field', css_class='field-class'), css_class='col-sm, ), Column('form_field_2', css_class='col-sm'), ) z%s/layout/column.htmlNrrrrrr%s2rc@rN)HTMLa# Layout object. It can contain pure HTML and it has access to the whole context of the page where the form is being rendered. Examples:: HTML("{% if saved %}Data saved{% endif %}") HTML('') cCs ||_dSr)r])rr]rrrrPfr#z HTML.__init__cKstt|j|Sr)rrr]rQrLrrrrQisz HTML.renderNrRrrrrr[s rc@s8eZdZdZdZiZddddddZedfddZdS) Fielda A Layout object, usually containing one field name, where you can add attributes to it easily. Attributes ---------- template : str The default template which this Layout Object will be rendered with. attrs : dict Attributes to be applied to the field. These are converted into html attributes. e.g. ``data_id: 'test'`` in the attrs dict will become ``data-id='test'`` on the field's ````. Parameters ---------- *fields : str Usually a single field, but can be any number of fields, to be rendered with the same attributes applied. css_class : str, optional CSS classes to be applied to the field. These are added to any classes included in the ``attrs`` dict. By default ``None``. wrapper_class: str, optional CSS classes to be used when rendering the Field. This class is usually applied to the ``
`` which wraps the Field's ``