Appendix - shreyasaha1997/edx-agea GitHub Wiki

Description of the various Fields

display_name

Purpose

It displays the name of the course at the top of the student view and studio view.

Scope

Scope.settings

question

Purpose

This is the problem statement given by the teacher.It is shown in student's view and it tells the student what to do.

Scope

Scope.settings

weight

Purpose

It defines the number of points each problem is worth.If the value is not set, the problem is worth the sum of the option point values.For example,if weight = 100, then the exam will be graded out of 100.

Scope

Scope.settings

points

Purpose

It is the maximum score that can be obtained by a student on a particular assignment.

Scope

Scope.settings

score

Purpose

It is the score given to the student.It is calculated by the autograder.

Scope

Scope.user_state

attempts

PurposeNo. of times the student uploads the answer file.

Scope

Scope.user_state

max_attempts

Purpose

No. of times the student is allowed to upload the answer file.If this field is not filled by the teacher,then the student can submit the answer file infinite nunber of times.

Scope

Scope.settings

raw_answer

Purpose

It refers to the answer excel file uploaded by the student.

Scope

Scope.user_state

raw_question

Purpose

It refers to the question excel file uploaded by the teacher.

Scope

Scope.settings

raw_solution

Purpose

It refers to the solution excel file uploaded by the teacher.

Scope

Scope.settings

Description of the Class Methods

get_submission(self)

It returns the class field raw_answer.

get_question(self)

It returns the class field raw_question.

get_solution(self)

It returns the class field raw_solution.

student_view(self, context=None)

It renders the content of cms.It stores student_state,id and max_file_size in context and passes it to the html file.It integrates the html,js and css files in a variable fragment and returns it.

studio_view(self, context=None)

It stores display_name,question,points,weight and max_attempts in edit_fields.It stores edit_fields in context along with studio_state,max_file_size and id and passes it to the html file.It integrates the html,js and css files in a variable fragment and returns it.

studio_state(self)

It returns the following to be used in studio_view:: 1.display_name 2.self.question 3.quploaded 4.suploaded 5.self.raw_question 6.suploaded 7.self.raw_solution 8.self.weight

student_state(self)

It returns the following to be used in studio_view:: 1.display_name 2.self.question 3.uploaded 4.raw_answer 5.raw_question 6.score 7.weight 8.attempts 9.max_attempts

Description of the Miscellaneous Methods

_get_sha1(file_descriptor)

It returns a hash value that is unique for every file.

_resource(path)

It is used to render the template.

load_resource(resource_path)

It is used to load the template.

render_template(template_path, context=None)

It is used to render the template.