anvil_consortium_manager.forms module

Forms classes for the anvil_consortium_manager app.

class anvil_consortium_manager.forms.AccountImportForm(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)

Bases: ModelForm

Form to import an Account from AnVIL.

class Meta

Bases: object

fields = ('email', 'is_service_account', 'note')

model: alias of Account

base_fields = {'email': <django.forms.fields.EmailField object>, 'is_service_account': <django.forms.fields.BooleanField object>, 'note': <django.forms.fields.CharField object>}

clean_email()

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.AccountUpdateForm(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)

Bases: ModelForm

Form to update an Account.

class Meta

Bases: object

fields = ('note',)

model: alias of Account

base_fields = {'note': <django.forms.fields.CharField object>}

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.BillingProjectImportForm(billing_project_choices=[], *args, **kwargs)

Bases: ModelForm

Form to import a BillingProject from AnVIL

class Meta

Bases: object

fields = ('name', 'note')

model: alias of BillingProject

base_fields = {'name': <django.forms.fields.ChoiceField object>, 'note': <django.forms.fields.CharField object>}

clean_name()

declared_fields = {'name': <django.forms.fields.ChoiceField object>}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.BillingProjectUpdateForm(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)

Bases: ModelForm

Form to update a billing project.

class Meta

Bases: object

fields = ('note',)

model: alias of BillingProject

base_fields = {'note': <django.forms.fields.CharField object>}

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.Bootstrap5MediaFormMixin

Bases: object

Form Mixin defined to set required Media for select2-bootstrap-5-theme.

class Media

Bases: object

css = {'screen': ('https://cdnjs.cloudflare.com/ajax/libs/select2-bootstrap-5-theme/1.3.0/select2-bootstrap-5-theme.min.css',)}

class anvil_consortium_manager.forms.DefaultWorkspaceDataForm(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)

Bases: ModelForm

Default (empty) form for the workspace data object.

class Meta

Bases: object

fields = ('workspace',)

model: alias of DefaultWorkspaceData

base_fields = {'workspace': <django.forms.models.ModelChoiceField object>}

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.FilterForm(*args, **kwargs)

Bases: Form

Custom form to pass to Filters defined in filters.py.

This form displays the fields except radio buttons with floating fields in a single row.

base_fields = {}

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.GroupAccountMembershipForm(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)

Bases: Bootstrap5MediaFormMixin, ModelForm

Form for the GroupAccountMembership model.

class Meta

Bases: object

fields = ('group', 'account', 'role')

help_texts = {'account': 'Select the account to add to this group.', 'group': 'Select the group to add this accoun to. Only groups that are managed by the app are shown.', 'role': 'Select the role that the account should have in the group.\n Admin can see group membership, add or remove members, and delete the group.'}

model: alias of GroupAccountMembership

base_fields = {'account': <django.forms.models.ModelChoiceField object>, 'group': <django.forms.models.ModelChoiceField object>, 'role': <django.forms.fields.TypedChoiceField object>}

declared_fields = {'account': <django.forms.models.ModelChoiceField object>, 'group': <django.forms.models.ModelChoiceField object>}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.GroupGroupMembershipForm(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)

Bases: Bootstrap5MediaFormMixin, ModelForm

Form for the GroupGroupMembership model.

class Meta

Bases: object

fields = ('parent_group', 'child_group', 'role')

help_texts = {'child_group': 'This group will be a member of the parent group.', 'role': 'Select the role that the child group should have in the parent group.\n Admin can see group membership, add or remove members, and delete the group.'}

model: alias of GroupGroupMembership

widgets = {'child_group': <dal_select2.widgets.ModelSelect2 object>}

base_fields = {'child_group': <django.forms.models.ModelChoiceField object>, 'parent_group': <django.forms.models.ModelChoiceField object>, 'role': <django.forms.fields.TypedChoiceField object>}

declared_fields = {'parent_group': <django.forms.models.ModelChoiceField object>}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.ManagedGroupCreateForm(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)

Bases: ModelForm

Form to create a ManagedGroup on AnVIL.

class Meta

Bases: object

fields = ('name', 'note')

help_texts = {'name': 'Name of the group to create on AnVIL.'}

model: alias of ManagedGroup

base_fields = {'name': <django.forms.fields.SlugField object>, 'note': <django.forms.fields.CharField object>}

clean_name()

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.ManagedGroupUpdateForm(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)

Bases: ModelForm

Form to update information about a ManagedGroup.

class Meta

Bases: object

fields = ('note', 'is_managed_by_app')

model: alias of ManagedGroup

base_fields = {'is_managed_by_app': <django.forms.fields.BooleanField object>, 'note': <django.forms.fields.CharField object>}

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.UserEmailEntryForm(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, field_order=None, use_required_attribute=None, renderer=None, bound_field_class=None)

Bases: Form

Form for user to enter their email attempting to link their AnVIL account.

base_fields = {'email': <django.forms.fields.EmailField object>}

clean_email()

Custom validation.

Do not allow service accounts.

declared_fields = {'email': <django.forms.fields.EmailField object>}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.WorkspaceCloneFormMixin(workspace_to_clone, *args, **kwargs)

Bases: object

Form mixing to perform cleaning when cloning a workspace.

clean()

class anvil_consortium_manager.forms.WorkspaceForm(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)

Bases: Bootstrap5MediaFormMixin, ModelForm

Form to create a new workspace on AnVIL.

class Meta

Bases: object

fields = ('billing_project', 'name', 'authorization_domains', 'note')

model: alias of Workspace

widgets = {'authorization_domains': <dal_select2.widgets.ModelSelect2Multiple object>, 'billing_project': <dal_select2.widgets.ModelSelect2 object>}

base_fields = {'authorization_domains': <django.forms.models.ModelMultipleChoiceField object>, 'billing_project': <django.forms.models.ModelChoiceField object>, 'name': <django.forms.fields.SlugField object>, 'note': <django.forms.fields.CharField object>}

clean(): Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.

clean_billing_project()

declared_fields = {}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.WorkspaceGroupSharingForm(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)

Bases: Bootstrap5MediaFormMixin, ModelForm

Form for the WorkspaceGroupSharing model.

class Meta

Bases: object

fields = ('workspace', 'group', 'access', 'can_compute')

model: alias of WorkspaceGroupSharing

widgets = {'group': <dal_select2.widgets.ModelSelect2 object>, 'workspace': <dal_select2.widgets.ModelSelect2 object>}

base_fields = {'access': <django.forms.fields.TypedChoiceField object>, 'can_compute': <django.forms.fields.BooleanField object>, 'group': <django.forms.models.ModelChoiceField object>, 'workspace': <django.forms.models.ModelChoiceField object>}

declared_fields = {'workspace': <django.forms.models.ModelChoiceField object>}

property media: Return all media required to render the widgets on this form.

class anvil_consortium_manager.forms.WorkspaceImportForm(workspace_choices=[], *args, **kwargs)

Bases: Form

Form to import a workspace from AnVIL – new version.

base_fields = {'note': <django.forms.fields.CharField object>, 'workspace': <django.forms.fields.ChoiceField object>}

declared_fields = {'note': <django.forms.fields.CharField object>, 'workspace': <django.forms.fields.ChoiceField object>}

property media: Return all media required to render the widgets on this form.

title = 'Import a workspace'

class anvil_consortium_manager.forms.WorkspaceRequesterPaysForm(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)

Bases: ModelForm

Form to update the is_requester_pays field for a workspace.

class Meta

Bases: object

fields = ('is_requester_pays',)

help_texts = {'is_requester_pays': 'If you change this box, the workspace\'s "requester pays" setting will be updated on AnVIL when you save your changes.'}

model: alias of Workspace

widgets = {'is_requester_pays': <django.forms.widgets.CheckboxInput object>}

base_fields = {'is_requester_pays': <django.forms.fields.BooleanField object>}

declared_fields = {}

property media: Return all media required to render the widgets on this form.