onadata.apps.viewer.models package

Submodules

onadata.apps.viewer.models.column_rename module

class onadata.apps.viewer.models.column_rename.ColumnRename(id, xpath, column_name)

Bases: django.db.models.base.Model

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ColumnRename.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

classmethod ColumnRename.get_dict()
ColumnRename.objects = <django.db.models.manager.Manager object>

onadata.apps.viewer.models.data_dictionary module

class onadata.apps.viewer.models.data_dictionary.DataDictionary(id, xls, json, description, xml, user, require_auth, shared, shared_data, downloadable, allows_sms, encrypted, sms_id_string, id_string, title, date_created, date_modified, deleted_at, last_submission_time, has_start_time, uuid, bamboo_dataset, instances_with_geopoints, instances_with_osm, num_of_submissions, version, project, created_by, has_hxl_support, last_updated_at)

Bases: onadata.apps.logger.models.xform.XForm

exception DoesNotExist

Bases: onadata.apps.logger.models.xform.DoesNotExist

exception DataDictionary.MultipleObjectsReturned

Bases: onadata.apps.logger.models.xform.MultipleObjectsReturned

DataDictionary.file_name()
DataDictionary.metadata_set

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

DataDictionary.objects = <django.db.models.manager.Manager object>
DataDictionary.save(*args, **kwargs)
DataDictionary.tagged_items

Accessor to the related objects manager on the one-to-many relation created by GenericRelation.

In the example:

class Post(Model):
    comments = GenericRelation(Comment)

post.comments is a ReverseGenericManyToOneDescriptor instance.

onadata.apps.viewer.models.data_dictionary.save_project(sender, instance=None, created=False, **kwargs)
onadata.apps.viewer.models.data_dictionary.set_object_permissions(sender, instance=None, created=False, **kwargs)
onadata.apps.viewer.models.data_dictionary.sheet_to_csv(xls_content, sheet_name)

Writes a csv file of a specified sheet from a an excel file

Parameters:
  • xls_content – Excel file contents
  • sheet_name – the name of the excel sheet to generate the csv file
Returns:

a (StrionIO) csv file object
onadata.apps.viewer.models.data_dictionary.upload_to(instance, filename, username=None)

onadata.apps.viewer.models.export module

class onadata.apps.viewer.models.export.Export(*args, **kwargs)

Bases: django.db.models.base.Model

Class representing a data export from an XForm

CSV_EXPORT = 'csv'
CSV_ZIP_EXPORT = 'csv_zip'
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

Export.EXPORT_MIMES = {'xlsx': 'vnd.openxmlformats', 'csv_zip': 'zip', u'osm': u'osm', 'sav_zip': 'zip', 'zip': 'zip', 'kml': 'vnd.google-earth.kml+xml', 'csv': 'csv', 'xls': 'vnd.ms-excel', 'sav': 'sav'}
Export.EXPORT_OPTION_FIELDS = ['binary_select_multiples', 'dataview_pk', 'group_delimiter', 'include_images', 'include_labels', 'include_labels_only', 'include_hxl', 'query', 'remove_group_name', 'split_select_multiples', 'win_excel_utf8']
Export.EXPORT_TYPES = [('xls', 'Excel'), ('csv', 'CSV'), ('zip', 'ZIP'), ('kml', 'kml'), ('csv_zip', 'CSV ZIP'), ('sav_zip', 'SAV ZIP'), ('sav', 'SAV'), ('external', 'Excel'), (u'osm', u'osm'), ('gsheets', 'Google Sheets')]
Export.EXPORT_TYPE_DICT = {'kml': 'kml', 'zip': 'ZIP', 'gsheets': 'Google Sheets', 'csv_zip': 'CSV ZIP', u'osm': u'osm', 'sav_zip': 'SAV ZIP', 'csv': 'CSV', 'xls': 'Excel', 'sav': 'SAV', 'external': 'Excel'}
Export.EXTERNAL_EXPORT = 'external'
exception Export.ExportTypeError

Bases: exceptions.Exception

Export.FAILED = 2
Export.GOOGLE_SHEETS_EXPORT = 'gsheets'
Export.KML_EXPORT = 'kml'
Export.MAX_EXPORTS = 10
exception Export.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Export.OSM_EXPORT = u'osm'
Export.PENDING = 0
Export.SAV_EXPORT = 'sav'
Export.SAV_ZIP_EXPORT = 'sav_zip'
Export.SUCCESSFUL = 1
Export.XLS_EXPORT = 'xls'
Export.ZIP_EXPORT = 'zip'
classmethod Export.exports_outdated(xform, export_type, options={})
Export.filepath
Export.full_filepath
Export.get_export_type_display(*moreargs, **morekwargs)
Export.get_next_by_created_on(*moreargs, **morekwargs)
Export.get_previous_by_created_on(*moreargs, **morekwargs)
classmethod Export.is_filename_unique(xform, filename)
Export.is_pending
Export.is_successful
Export.objects = <django.db.models.manager.Manager object>
Export.save(*args, **kwargs)
Export.set_filename(filename)
Export.status
Export.xform

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

onadata.apps.viewer.models.export.export_delete_callback(sender, **kwargs)
onadata.apps.viewer.models.export.get_export_options_query_kwargs(options)

Get dict with options JSONField lookups for export options field

onadata.apps.viewer.models.export.md5hash(string)

onadata.apps.viewer.models.parsed_instance module

exception onadata.apps.viewer.models.parsed_instance.ParseError

Bases: exceptions.Exception

class onadata.apps.viewer.models.parsed_instance.ParsedInstance(id, instance, start_time, end_time, lat, lng)

Bases: django.db.models.base.Model

DEFAULT_BATCHSIZE = 1000
DEFAULT_LIMIT = 1000000
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception ParsedInstance.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ParsedInstance.STATUS = u'_status'
ParsedInstance.USERFORM_ID = u'_userform_id'
ParsedInstance.add_note(note)
classmethod ParsedInstance.dicts(xform)
ParsedInstance.get_notes()
ParsedInstance.instance

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

ParsedInstance.objects = <django.db.models.manager.Manager object>
ParsedInstance.remove_note(pk)
ParsedInstance.save(async=False, *args, **kwargs)
ParsedInstance.to_dict()
ParsedInstance.to_dict_for_mongo()
onadata.apps.viewer.models.parsed_instance.datetime_from_str(text)
onadata.apps.viewer.models.parsed_instance.dict_for_mongo(d)
onadata.apps.viewer.models.parsed_instance.get_etag_hash_from_query(queryset, sql=None, params=None)

Returns md5 hash from the date_modified field or

onadata.apps.viewer.models.parsed_instance.get_name_from_survey_element(element)
onadata.apps.viewer.models.parsed_instance.get_sql_with_params(xform, query=None, fields=None, sort=None, start=None, end=None, start_index=None, limit=None, count=None)
onadata.apps.viewer.models.parsed_instance.post_save_submission(sender, **kwargs)
onadata.apps.viewer.models.parsed_instance.query_data(xform, query=None, fields=None, sort=None, start=None, end=None, start_index=None, limit=None, count=None)

Module contents