django_sorcery.forms module

Helper functions for creating Form classes from SQLAlchemy models.

class django_sorcery.forms.BaseModelForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None, session=None)

Bases: django.forms.models.BaseModelForm

Base ModelForm for sqlalchemy models.

is_valid(rollback=True)

Return True if the form has no errors, or False otherwise.

Will also rollback the session transaction.

model_to_dict()

Returns a dict containing the data in instance suitable for passing as forms initial keyword argument.

save(flush=True, **kwargs)

Makes form’s self.instance model persistent and flushes the session.

save_instance(instance=None, cleaned_data=None)

Updates form’s instance with cleaned data.

update_attribute(instance, name, field, value)

Provides hooks for updating form instance’s attribute for a field with value.

class django_sorcery.forms.ModelForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None, session=None)

Bases: django_sorcery.forms.BaseModelForm

ModelForm base class for sqlalchemy models.

base_fields = {}

declared_fields = {}

media

class django_sorcery.forms.ModelFormMetaclass

Bases: django.forms.forms.DeclarativeFieldsMetaclass

ModelForm metaclass for sqlalchemy models.

class django_sorcery.forms.SQLAModelFormOptions(options=None)

Bases: django.forms.models.ModelFormOptions

Model form options for sqlalchemy.

django_sorcery.forms.apply_limit_choices_to_form_field(formfield)

Apply limit_choices_to to the formfield’s query if needed.

django_sorcery.forms.fields_for_model(model, session, fields=None, exclude=None, widgets=None, formfield_callback=None, localized_fields=None, labels=None, help_texts=None, error_messages=None, field_classes=None, apply_limit_choices_to=True, **kwargs)

Returns a dictionary containing form fields for a given model.

django_sorcery.forms.model_to_dict(instance, fields=None, exclude=None)

Return a dict containing the data in instance suitable for passing as a Form’s initial keyword argument.

fields is an optional list of field names. If provided, return only the named.

exclude is an optional list of field names. If provided, exclude the named from the returned dict, even if they are listed in the fields argument.

django_sorcery.forms.modelform_factory(model, form=<class 'django_sorcery.forms.ModelForm'>, formfield_callback=None, **kwargs)

Return a ModelForm class containing form fields for the given model.