Submissions App

Submission statuses are described in Common statuses

submissions.forms

submissions.forms module contents

submissions.helpers

submissions.helpers module contents

Created on Thu Jun 27 11:52:37 2019

@author: Paolo Cozzi <cozzi@ibba.cnr.it>

class submissions.helpers.AnimalResource

Bases: import_export.resources.ModelResource

class Meta

Bases: object

export_order = ('id', 'name', 'biosample_id', 'material', 'status', 'last_changed', 'last_submitted')

fields = ('id', 'name', 'biosample_id', 'material', 'status', 'last_changed', 'last_submitted')

model

alias of uid.models.Animal

dehydrate_status(animal)

Convert a numeric status field into the displayed column

fields = {'biosample_id': <import_export.fields.Field: biosample_id>, 'id': <import_export.fields.Field: id>, 'last_changed': <import_export.fields.Field: last_changed>, 'last_submitted': <import_export.fields.Field: last_submitted>, 'material': <import_export.fields.Field: material>, 'name': <import_export.fields.Field: name>, 'status': <import_export.fields.Field: status>}

class submissions.helpers.SampleResource

Bases: import_export.resources.ModelResource

class Meta

Bases: object

export_order = ('id', 'name', 'biosample_id', 'material', 'status', 'last_changed', 'last_submitted')

fields = ('id', 'name', 'biosample_id', 'material', 'status', 'last_changed', 'last_submitted')

model

alias of uid.models.Sample

dehydrate_status(sample)

Convert a numeric status field into the displayed column

fields = {'biosample_id': <import_export.fields.Field: biosample_id>, 'id': <import_export.fields.Field: id>, 'last_changed': <import_export.fields.Field: last_changed>, 'last_submitted': <import_export.fields.Field: last_submitted>, 'material': <import_export.fields.Field: material>, 'name': <import_export.fields.Field: name>, 'status': <import_export.fields.Field: status>}

submissions.helpers.is_target_in_message(target, messages)

This function will return true if target in message

Parameters

target (str) – target to search

submissions.helpers.send_message(submission_obj, validation_message=None)

Update submission.status and submission message using django channels

Parameters

• submission_obj (uid.models.Submission) – an UID submission object

• validation_message (dict) – set validation message

submissions.tasks

submissions.tasks module contents

Created on Tue Jul 9 16:10:06 2019

@author: Paolo Cozzi <cozzi@ibba.cnr.it>

class submissions.tasks.BatchUpdateMixin

Bases: submissions.tasks.SubmissionTaskMixin

Mixin to do batch update of fields to fix validation

batch_update(submission_id, ids, attribute)

item_cls = None

class submissions.tasks.ImportGenericTaskMixin

Bases: submissions.tasks.SubmissionTaskMixin, common.tasks.NotifyAdminTaskMixin

A mixing used to import datasource into UID

action = None

run(submission_id)

a function to upload data into UID

class submissions.tasks.SubmissionTaskMixin

Bases: object

A mixin to extend Task to support UID Submission objects

action = None

get_uid_submission(submission_id)

Get a UID Submission instance from an id

Parameters

submission_id (int) – the submission id

Returns

a UID submission instance

Return type

Submission

mail_to_owner(submission_obj, subject, body)

max_body_size = 5000

on_failure(exc, task_id, args, kwargs, einfo)

Override the default on_failure method

send_message(submission_obj, construct_message=False)

Update submission.status and submission message using django channels

Parameters

• submission_obj (uid.models.Submission) – an UID submission object

• construct_message (bool) – construct validation message or not

update_submission_status(submission_obj, status, message, construct_message=False)

Mark submission with status, then send message

Parameters

• submission_obj (uid.models.Submission) – an UID submission object

• status (int) – a common.constants.STATUSES value

• message (str) – the message to send

• construct_message (bool) – construct validation message or not

submissions.views

submissions.views module contents