Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue/636 duplicate assignment #637

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Issue/636 duplicate assignment #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5e3c74d
fixing minor docstring errors in course.create_page
dsavransky Jun 18, 2020
d956264
Merge branch 'develop' into develop
Thetwam Jun 19, 2020
ed9a4bf
Merge remote-tracking branch 'upstream/develop' into develop
dsavransky Jul 27, 2020
dcff525
Merge branch 'ucfopen:develop' into develop
dsavransky Dec 23, 2021
167d488
Merge branch 'ucfopen:develop' into develop
dsavransky Oct 2, 2023
d8a7d90
adding duplicate assignment endpoint coverage and tests for #636
dsavransky Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions canvasapi/assignment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,23 @@ def delete(self, **kwargs):
)
return Assignment(self._requester, response.json())

def duplicate(self, **kwargs):
"""
Duplicate this assignment.

:calls: `POST /api/v1/courses/:course_id/assignments/:assignment_id/duplicate \
<https://canvas.instructure.com/doc/api/assignments.html#method.assignments_api.duplicate>`_

:rtype: :class:`canvasapi.assignment.Assignment`
"""

response = self._requester.request(
"POST",
"courses/{}/assignments/{}/duplicate".format(self.course_id, self.id),
_kwargs=combine_kwargs(**kwargs),
)
return Assignment(self._requester, response.json())

def edit(self, **kwargs):
"""
Modify this assignment.
Expand Down
11 changes: 11 additions & 0 deletions tests/fixtures/assignment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,17 @@
},
"status_code": 200
},
"duplicate_assignment": {
"method": "POST",
"endpoint": "courses/1/assignments/1/duplicate",
"data": {
"id": 1,
"course_id": 1,
"name": "Assignment 1 Copy",
"description": "Duplicate assignment"
},
"status_code": 200
},
"edit_assignment": {
"method": "PUT",
"endpoint": "courses/1/assignments/1",
Expand Down
9 changes: 9 additions & 0 deletions tests/test_assignment.py
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be overthinking it, but if the result_type key is passed, it will return a Quiz object rather than an Assignment. I'm not that type-safe when writing, but this could be a case where someone runs into issues. @Thetwam is it worth adding a test?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Yeah we'll want to handle that case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @bennettscience and @Thetwam. Happy to make changes, but I could use a little guidance. I've tested this out on my university's Canvas installation, and I can get two qualitatively different outputs if I pass the result_type="Quiz" kwarg. However, in each case, the duplicated assignment on Canvas is just an ordinary assignment - the only thing that's different are the keywords in the response json that's generated. Similarly, I can pass either of these outputs into an Assignment object or into a Quiz object, with no issues either way. I also get failures when trying to duplicate anything other than a regular assignment (e.g. a quiz or an external tool assignment).

So: what exactly do you want to happen here? Do you want Assignment.duplicate to check the format of the returned json and return a Quiz object in the case where result_type="Quiz", or should it still always return an Assignment object regardless of inputs? In the latter case, maybe I'd need to manually set the is_quiz_assignment attribute?

I'm struggling a bit, as I don't really understand the utility or intent of the result_type functionality in the original API, so any help would be greatly appreciated. Thanks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dsavransky Can you see if your instance has the newquizzes_on_quiz_page setting enabled? Re-reading the docs, that setting has to be enabled for the Quiz keyword to serialize it in a Quiz object:

When the root account has the feature ‘newquizzes_on_quiz_page` enabled and this argument is set to “Quiz” the response will be serialized into a quiz format(quizzes);

You shouldn't need to specify the is_quiz_assignment attribute because that's sent from Canvas. Maybe that's a better indicator?

I'm not sure what the intent was on Instructure's side other than to separate out New Quiz functions from Classic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have admin access to the Canvas instance I'm using for testing, so I'm not actually sure how to check that setting (open to suggestions). Here's what I observe: when I omit the result_type keyword, the JSON that's returned includes the is_quiz_assignment key. When I set result_type="Quiz", that key is not in the returned JSON. Instead, it includes: 'quiz_type': 'quizzes.next'.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bennettscience @Thetwam I'd like to eventually get this merged in if possible - could you please provide any guidance on your preferred solution here?

Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,15 @@ def test_delete_assignments(self, m):

self.assertIsInstance(deleted_assignment, Assignment)

# duplicate()
def test_duplicate_assignments(self, m):
register_uris({"assignment": ["duplicate_assignment"]}, m)

duplicated_assignment = self.assignment.duplicate()

self.assertIsInstance(duplicated_assignment, Assignment)
self.assertTrue(duplicated_assignment.name == f"{self.assignment.name} Copy")

# edit()
def test_edit_assignment(self, m):
register_uris({"assignment": ["edit_assignment"]}, m)
Expand Down
Loading