Method testWithFirstPage

tests/PaginatedList.py:398–443

(self)

    # more custom per page tests in CompletableGithubObjectWithPaginatedProperty

    def testWithFirstPage(self):
        # fetching the commit also fetches the fist page of files
        with self.captureRequests() as requests:
            repo = self.g.get_repo("PyGithub/PyGithub", lazy=True)
            commit = repo.get_commit("e359b83a04e8f34bedab0f2180169012d238a135", commit_files_per_page=3)
            # repo is lazy, so this commit is also lazy, here we test with an eager (fetched) commit
            commit.complete()
            files = commit.files
        self.assertListKeyEqual(
            requests,
            lambda r: r.url,
            ["/repos/PyGithub/PyGithub/commits/e359b83a04e8f34bedab0f2180169012d238a135?page=1&per_page=3"],
        )

        # consuming the first page of files should not fire a request
        with self.captureRequests() as requests:
            self.assertEqual(files[0].filename, "github/GeneratedReleaseNotes.py")
            self.assertEqual(files[1].filename, "github/Repository.py")
            self.assertEqual(files[2].filename, "pyproject.toml")
        self.assertEqual(len(requests), 0)

        # consuming items of the second page fetches the second page
        with self.captureRequests() as requests:
            self.assertEqual(files[3].filename, "tests/ReplayData/Repository.testGenerateReleaseNotes.txt")
        self.assertListKeyEqual(
            requests,
            lambda r: r.url,
            ["/repositories/3544490/commits/e359b83a04e8f34bedab0f2180169012d238a135?page=2&per_page=3"],
        )

        # consuming further items of the second page does not fire a request
        with self.captureRequests() as requests:
            self.assertEqual(
                files[4].filename, "tests/ReplayData/Repository.testGenerateReleaseNotesWithAllArguments.txt"
            )
            self.assertEqual(files[5].filename, "tests/Repository.py")
        self.assertEqual(len(requests), 0)

        # consuming items of the last page fetches the that page
        with self.captureRequests() as requests:
            self.assertEqual(files[6].filename, "tests/test_release_notes.yml")
        self.assertListKeyEqual(
            requests,
            lambda r: r.url,
            ["/repositories/3544490/commits/e359b83a04e8f34bedab0f2180169012d238a135?page=3&per_page=3"],
        )

    def testWithFirstSinglePage(self):
        # fetching the commit also fetches the fist page of files