fix: don't override per_page in PaginatedList

Currently a default is set for `per_page` to 100, but later the manner of passing params to the functions was updated such that it is not the default but instead overrides `per_page`.
You would get a dict of `{"_kwargs": [("per_page": 1)], "per_page": 100}
which then converts to the following request
https://institution/api/v1/courses?per_page=1&per_page=100
since we define `per_page` later it will also be put in later when expanded with .items().

keeps the same behaviour as before except that _kwargs now must be list[tuple[str,Any]], this doesn't break anything internally, but can break other people's code.

Also made _kwargs keyword consistent for all PaginatedList calls, couldn't find any reason why they were different.

Author: superle3

README.md

@@ -123,7 +123,7 @@ Let’s look at how we can use the `PaginatedList` returned by our `get_courses(
 # Access the first element in our list.
 #
 # You'll notice the first call takes a moment, but the next N-1
-# elements (where N = the per_page argument supplied; the default is 10)
+# elements (where N = the per_page argument supplied; the default in canvasapi is 100)
 # will be instantly accessible.
 >>> print(courses[0])
 TST101 Test Course (1234567)

canvasapi/account.py

@@ -1168,7 +1168,7 @@ def get_grading_periods(self, **kwargs):
             "accounts/{}/grading_periods".format(self.id),
             {"account_id": self.id},
             _root="grading_periods",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_grading_standards(self, **kwargs):

canvasapi/blueprint.py

@@ -103,7 +103,7 @@ def get_unsynced_changes(self, **kwargs):
             "courses/{}/blueprint_templates/{}/unsynced_changes".format(
                 self.course_id, self.id
             ),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def list_blueprint_migrations(self, **kwargs):
@@ -126,7 +126,7 @@ def list_blueprint_migrations(self, **kwargs):
                 self.course_id, self.id
             ),
             {"course_id": self.course_id},
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def show_blueprint_migration(self, migration, **kwargs):
@@ -201,7 +201,7 @@ def get_details(self, **kwargs):
             "courses/{}/blueprint_templates/{}/migrations/{}/details".format(
                 self.course_id, self.template_id, self.id
             ),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_import_details(self, **kwargs):
@@ -224,7 +224,7 @@ def get_import_details(self, **kwargs):
             "courses/{}/blueprint_subscriptions/{}/migrations/{}/details".format(
                 self.course_id, self.subscription_id, self.id
             ),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
 
@@ -258,7 +258,7 @@ def list_blueprint_imports(self, **kwargs):
                 self.course_id, self.id
             ),
             {"course_id": self.id},
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def show_blueprint_import(self, migration, **kwargs):

canvasapi/canvas.py

@@ -820,7 +820,7 @@ def get_epub_exports(self, **kwargs):
             "GET",
             "epub_exports",
             _root="courses",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_file(self, file, **kwargs):

canvasapi/collaboration.py

@@ -22,7 +22,7 @@ def get_collaborators(self, **kwargs):
             "GET",
             "collaborations/{}/members".format(self.id),
             _root="collaborators",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
 

canvasapi/course.py

@@ -978,7 +978,7 @@ def get_collaborations(self, **kwargs):
             "GET",
             "courses/{}/collaborations".format(self.id),
             _root="collaborations",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_content_export(self, content_export, **kwargs):
@@ -1018,7 +1018,7 @@ def get_content_exports(self, **kwargs):
             self._requester,
             "GET",
             "courses/{}/content_exports".format(self.id),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_content_migration(self, content_migration, **kwargs):
@@ -1535,7 +1535,7 @@ def get_gradebook_history_details(self, date, **kwargs):
             self._requester,
             "GET",
             "courses/{}/gradebook_history/{}".format(self.id, date),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_grading_period(self, grading_period, **kwargs):
@@ -1579,7 +1579,7 @@ def get_grading_periods(self, **kwargs):
             "courses/{}/grading_periods".format(self.id),
             {"course_id": self.id},
             _root="grading_periods",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_grading_standards(self, **kwargs):
@@ -1719,7 +1719,7 @@ def get_lti_resource_links(self, **kwargs):
             self._requester,
             "GET",
             f"courses/{self.id}/lti_resource_links",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_migration_systems(self, **kwargs):
@@ -2279,7 +2279,7 @@ def get_submission_history(self, date, grader_id, assignment_id, **kwargs):
             "courses/{}/gradebook_history/{}/graders/{}/assignments/{}/submissions".format(
                 self.id, date, grader_id, assignment_id
             ),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_tabs(self, **kwargs):
@@ -2341,7 +2341,7 @@ def get_uncollated_submissions(self, **kwargs):
             self._requester,
             "GET",
             "courses/{}/gradebook_history/feed".format(self.id),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_user(self, user, user_id_type=None, **kwargs):
@@ -2511,7 +2511,7 @@ def list_blueprint_subscriptions(self, **kwargs):
             "GET",
             "courses/{}/blueprint_subscriptions".format(self.id),
             {"course_id": self.id},
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def preview_html(self, html, **kwargs):

canvasapi/group.py

@@ -309,7 +309,7 @@ def get_collaborations(self, **kwargs):
             "GET",
             "groups/{}/collaborations".format(self.id),
             _root="collaborations",
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_content_export(self, content_export, **kwargs):
@@ -353,7 +353,7 @@ def get_content_exports(self, **kwargs):
             self._requester,
             "GET",
             "groups/{}/content_exports".format(self.id),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_content_migration(self, content_migration, **kwargs):

canvasapi/paginated_list.py

@@ -31,6 +31,7 @@ def __init__(
         extra_attribs=None,
         _root=None,
         _url_override=None,
+        _kwargs=None,
         **kwargs,
     ):
         """
@@ -50,14 +51,24 @@ def __init__(
         Other URLs may be specified for third-party requests.
         :type _url_override: str
         :rtype: :class:`canvasapi.paginated_list.PaginatedList` of type content_class
+        :param _kwargs: A list of 2-tuples representing processed
+            keyword arguments to be sent to Canvas as params or data.
+        :type _kwargs: list[tuple[str, Any]]
         """
         self._elements = list()
 
         self._requester = requester
         self._content_class = content_class
         self._first_url = first_url
-        self._first_params = kwargs or {}
-        self._first_params["per_page"] = kwargs.get("per_page", 100)
+        _kwargs = _kwargs or []
+        for key, value in _kwargs:
+            if key == "per_page":
+                break
+        else:
+            # change kwargs such that if per_page is given as a keyword argument,
+            # we don't override it.
+            kwargs.setdefault("per_page", 100)
+        self._first_params = {"_kwargs": _kwargs, **kwargs}
         self._next_url = first_url
         self._next_params = self._first_params
         self._extra_attribs = extra_attribs or {}

canvasapi/user.py

@@ -371,7 +371,7 @@ def get_content_exports(self, **kwargs):
             self._requester,
             "GET",
             "users/{}/content_exports".format(self.id),
-            kwargs=combine_kwargs(**kwargs),
+            _kwargs=combine_kwargs(**kwargs),
         )
 
     def get_content_migration(self, content_migration, **kwargs):

docs/getting-started.rst

@@ -90,7 +90,7 @@ Let’s look at how we can use the :code:`PaginatedList` returned by our :code:`
     # Access the first element in our list.
     #
     # You'll notice the first call takes a moment, but the next N-1
-    # elements (where N = the per_page argument supplied; the default is 10)
+    # elements (where N = the per_page argument supplied; the default in canvasapi is 100)
     # will be instantly accessible.
     >>> print(courses[0])
     TST101 Test Course (1234567)