Assignment¶

Qualified name: tin.apps.assignments.models.Assignment

class Assignment(*args, **kwargs)[source]¶

Bases: Model

An assignment (or quiz) for a student.

If is_quiz is True, this model doubles as a quiz.

The manager for this model is AssignmentQuerySet.

Parameters:

id (BigAutoField) – Primary key: ID
name (CharField) – Name
description (CharField) – Description
markdown (BooleanField) – Markdown
language (CharField) – Language
filename (CharField) – Filename
points_possible (DecimalField) – Points possible
assigned (DateTimeField) – Assigned
due (DateTimeField) – Due
hidden (BooleanField) – Hidden
grader_file (FileField) – Grader file
enable_grader_timeout (BooleanField) – Enable grader timeout
grader_timeout (IntegerField) – Grader timeout
grader_has_network_access (BooleanField) – Grader has network access
has_network_access (BooleanField) – Has network access
submission_limit_count (PositiveIntegerField) – Submission limit count
submission_limit_interval (PositiveIntegerField) – Submission limit interval
submission_limit_cooldown (PositiveIntegerField) – Submission limit cooldown
last_action_output (CharField) – Last action output
is_quiz (BooleanField) – Is quiz
quiz_action (CharField) – Quiz action
quiz_autocomplete_enabled (BooleanField) – Quiz autocomplete enabled
quiz_description (CharField) – Quiz description
quiz_description_markdown (BooleanField) – Quiz description markdown

Relationship fields:

Parameters:

folder (ForeignKey to Folder) – Folder (related name: assignments)
course (ForeignKey to Course) – Course (related name: assignments)
venv (ForeignKey to Venv) – Venv (related name: assignments)

Reverse relationships:

Parameters:

submission_caps (Reverse ForeignKey from SubmissionCap) – All submission caps of this assignment (related name of assignment)
cooldown_periods (Reverse ForeignKey from CooldownPeriod) – All cooldown periods of this assignment (related name of assignment)
quiz (Reverse OneToOneField from Quiz) – The quiz of this assignment (related name of assignment)
log_messages (Reverse ForeignKey from QuizLogMessage) – All log messages of this assignment (related name of assignment)
moss_results (Reverse ForeignKey from MossResult) – All moss results of this assignment (related name of assignment)
submissions (Reverse ForeignKey from Submission) – All submissions of this assignment (related name of assignment)
final_submissions (Reverse ForeignKey from PublishedSubmission) – All final submissions of this assignment (related name of assignment)

Methods

`before_submission_cap`	Get the submission cap for an assignment before the due date.
`check_rate_limit`	Check if a student is submitting too quickly
`delete_file`	Delete a file by id
`find_student_override`	Find an `SubmissionCap` for a student.
`find_submission_cap`	Given a student, find the submission cap.
`get_absolute_url`
`get_file`
`get_language_display`	Shows the label of the `language`.
`get_next_by_assigned`	Finds next instance based on `assigned`.
`get_next_by_due`	Finds next instance based on `due`.
`get_previous_by_assigned`	Finds previous instance based on `assigned`.
`get_previous_by_due`	Finds previous instance based on `due`.
`get_quiz_action_display`	Shows the label of the `quiz_action`.
`list_files`	List all files in the assignments directory
`make_assignment_dir`	Creates the directory where the assignment grader scripts go.
`quiz_ended_for_student`	Check if the quiz has ended for a student
`quiz_issues_for_student`	Check if the student has exceeded the maximum amount of issues they can have with a quiz.
`quiz_locked_for_student`	Check if the quiz has been locked (e.g. due to leaving the tab).
`quiz_open_for_student`	Check if a quiz is open for a specific student
`save_file`	Save some text as a file
`save_grader_file`	Save the grader file to the correct location.
`submission_cap_after_due`	Get the submission cap after the due date.
`within_submission_limit`	Check if a student is within the submission limit for an assignment.

Attributes

`LANGUAGES`
`QUIZ_ACTIONS`
`assigned`	Type: `DateTimeField`
`cooldown_periods`	Type: Reverse `ForeignKey` from `CooldownPeriod`
`course`	Type: `ForeignKey` to `Course`
`course_id`	Internal field, use `course` instead.
`description`	Type: `CharField`
`due`	Type: `DateTimeField`
`enable_grader_timeout`	Type: `BooleanField`
`filename`	Type: `CharField`
`final_submissions`	Type: Reverse `ForeignKey` from `PublishedSubmission`
`folder`	Type: `ForeignKey` to `Folder`
`folder_id`	Internal field, use `folder` instead.
`grader_file`	Type: `FileField`
`grader_has_network_access`	Type: `BooleanField`
`grader_log_filename`
`grader_timeout`	Type: `IntegerField`
`has_network_access`	Type: `BooleanField`
`hidden`	Type: `BooleanField`
`id`	Type: `BigAutoField`
`is_quiz`	Type: `BooleanField`
`language`	Type: `CharField`
`last_action_output`	Type: `CharField`
`log_messages`	Type: Reverse `ForeignKey` from `QuizLogMessage`
`markdown`	Type: `BooleanField`
`moss_results`	Type: Reverse `ForeignKey` from `MossResult`
`name`	Type: `CharField`
`objects`
`points_possible`	Type: `DecimalField`
`quiz`	Type: Reverse `OneToOneField` from `Quiz`
`quiz_action`	Type: `CharField`
`quiz_autocomplete_enabled`	Type: `BooleanField`
`quiz_description`	Type: `CharField`
`quiz_description_markdown`	Type: `BooleanField`
`submission_caps`	Type: Reverse `ForeignKey` from `SubmissionCap`
`submission_limit_cooldown`	Type: `PositiveIntegerField`
`submission_limit_count`	Type: `PositiveIntegerField`
`submission_limit_interval`	Type: `PositiveIntegerField`
`submissions`	Type: Reverse `ForeignKey` from `Submission`
`venv`	Type: `ForeignKey` to `Venv`
`venv_fully_created`
`venv_id`	Internal field, use `venv` instead.

exception DoesNotExist¶: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶: Bases: MultipleObjectsReturned

before_submission_cap(student) → float[source]¶

Get the submission cap for an assignment before the due date.

Returns float("inf") if no cap is found.

check_rate_limit(student) → None[source]¶: Check if a student is submitting too quickly

delete_file(file_id: int) → None[source]¶: Delete a file by id

find_student_override(student) → SubmissionCap | None[source]¶

Find an SubmissionCap for a student.

Returns None if no override exists.

find_submission_cap(student) → float[source]¶

Given a student, find the submission cap.

This takes into account student overrides, and due dates.

list_files() → list[tuple[int, str, str, int, datetime]][source]¶

List all files in the assignments directory

Returns:

The index of the assignment
The name of the assignment submission
The full path to the assignment submission
The size of the submission
The time at which it was submitted

make_assignment_dir() → None[source]¶: Creates the directory where the assignment grader scripts go.

quiz_ended_for_student(student) → bool[source]¶: Check if the quiz has ended for a student

quiz_issues_for_student(student) → bool[source]¶: Check if the student has exceeded the maximum amount of issues they can have with a quiz.

quiz_locked_for_student(student) → bool[source]¶: Check if the quiz has been locked (e.g. due to leaving the tab)

quiz_open_for_student(student)[source]¶: Check if a quiz is open for a specific student

save_file(file_text: str | bytes, file_name: str) → None[source]¶: Save some text as a file

save_grader_file(grader_text: str) → None[source]¶: Save the grader file to the correct location.

Warning

Writing to files in directories not controlled by us without some form of sandboxing is a security risk. Most notably, users can use symbolic links to trick you into writing to another file, outside the directory. they control. This solution is very hacky, but we don’t have another good way of doing this.

submission_cap_after_due(student) → float[source]¶

Get the submission cap after the due date.

Returns float("inf") if no cap is found.

within_submission_limit(student) → bool[source]¶: Check if a student is within the submission limit for an assignment.