Note

This is a public alpha release, and therefore features and functionality may change and the software and documentation may contain technical bugs or other issues. If you discover any issues please consider registering a GitHub issue.

datasources.forms module

class datasources.forms.DataSourceForm(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)

Bases: django.forms.models.ModelForm

Form class for creating / updating DataSource.

class Meta

Bases: object

exclude = ['auth_method', 'owner', 'users']

model

alias of datasources.models.DataSource

base_fields = {'_connector_string': <django.forms.fields.CharField object at 0x7fe79c5258d0>, 'api_key': <django.forms.fields.CharField object at 0x7fe79c525b38>, 'description': <django.forms.fields.CharField object at 0x7fe79c566048>, 'encrypted_docs_url': <django.forms.fields.URLField object at 0x7fe79c525cf8>, 'is_encrypted': <django.forms.fields.BooleanField object at 0x7fe79c525c50>, 'licence': <django.forms.models.ModelChoiceField object at 0x7fe79c525fd0>, 'name': <django.forms.fields.CharField object at 0x7fe79d0aa048>, 'plugin_name': <django.forms.fields.ChoiceField object at 0x7fe79d0e9ac8>, 'prov_exempt': <django.forms.fields.BooleanField object at 0x7fe79c525e80>, 'public_permission_level': <django.forms.fields.TypedChoiceField object at 0x7fe79c525dd8>, 'url': <django.forms.fields.CharField object at 0x7fe79c525780>}

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_encrypted_docs_url()

Make sure that ‘is_encrypted’ and ‘encrypted_docs_url’ are always present as a pair.

declared_fields = {'plugin_name': <django.forms.fields.ChoiceField object at 0x7fe79d0e9ac8>}

media

class datasources.forms.LicenceForm(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)

Bases: django.forms.models.ModelForm

class Meta

Bases: object

exclude = ['owner']

model

alias of datasources.models.Licence

base_fields = {'name': <django.forms.fields.CharField object at 0x7fe79c539cc0>, 'short_name': <django.forms.fields.CharField object at 0x7fe79c539dd8>, 'url': <django.forms.fields.CharField object at 0x7fe79c544128>, 'version': <django.forms.fields.CharField object at 0x7fe79c539f60>}

declared_fields = {}

media

class datasources.forms.MetadataFieldForm(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)

Bases: django.forms.models.ModelForm

class Meta

Bases: object

fields = ['field', 'value']

model

alias of datasources.models.MetadataItem

base_fields = {'field': <django.forms.models.ModelChoiceField object at 0x7fe79c539a58>, 'value': <django.forms.fields.CharField object at 0x7fe79c539908>}

declared_fields = {}

media

class datasources.forms.PermissionGrantForm(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)

Bases: django.forms.models.ModelForm

class Meta

Bases: object

fields = ['granted', 'push_granted']

model

alias of datasources.models.UserPermissionLink

base_fields = {'granted': <django.forms.fields.TypedChoiceField object at 0x7fe79c539630>, 'push_granted': <django.forms.fields.BooleanField object at 0x7fe79c5396a0>}

declared_fields = {}

media

class datasources.forms.PermissionRequestForm(*args, **kwargs)

Bases: django.forms.models.ModelForm

class Meta

Bases: object

fields = ['user', 'requested', 'push_requested', 'reason']

help_texts = {'push_requested': 'Do you also require permission to push data?', 'user': 'You may request permission for yourself or on behalf of any applications for which you are responsible.'}

model

alias of datasources.models.UserPermissionLink

widgets = {'reason': <class 'django.forms.widgets.Textarea'>}

base_fields = {'push_requested': <django.forms.fields.BooleanField object at 0x7fe79c539320>, 'reason': <django.forms.fields.CharField object at 0x7fe79c5393c8>, 'requested': <django.forms.fields.TypedChoiceField object at 0x7fe79c539240>, 'user': <django.forms.models.ModelChoiceField object at 0x7fe79d0e9a90>}

declared_fields = {}

media

save(commit=True)

Save this permission request.

Because (user, datasource) are unique, if the user is changed we need to get the corresponding record.