############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Trim21 # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2025 Enrico Minack # # Copyright 2026 Enrico Minack # # # # This file is part of PyGithub. # # http://pygithub.readthedocs.io/ # # # # PyGithub is free software: you can redistribute it and/or modify it under # # the terms of the GNU Lesser General Public License as published by the Free # # Software Foundation, either version 3 of the License, or (at your option) # # any later version. # # # # PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY # # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # # details. # # # # You should have received a copy of the GNU Lesser General Public License # # along with PyGithub. If not, see . # # # ################################################################################ from __future__ import annotations from typing import TYPE_CHECKING, Any import github.Commit import github.File from github.GithubObject import Attribute, CompletableGithubObjectWithPaginatedProperty, NotSet from github.PaginatedList import PaginatedList if TYPE_CHECKING: from github.Commit import Commit class Comparison(CompletableGithubObjectWithPaginatedProperty): """ This class represents Comparisons. The reference can be found here https://docs.github.com/en/rest/commits/commits#compare-two-commits This class has a `paginated property `_. For details, see :meth:`Comparison.commits` or :meth:`Comparison.get_commits`. The OpenAPI schema can be found at - /components/schemas/commit-comparison """ def _initAttributes(self) -> None: super()._initAttributes() self._ahead_by: Attribute[int] = NotSet self._base_commit: Attribute[Commit] = NotSet self._behind_by: Attribute[int] = NotSet self._commits: Attribute[list[Commit]] = NotSet self._diff_url: Attribute[str] = NotSet self._files: Attribute[list[github.File.File]] = NotSet self._html_url: Attribute[str] = NotSet self._merge_base_commit: Attribute[Commit] = NotSet self._patch_url: Attribute[str] = NotSet self._permalink_url: Attribute[str] = NotSet self._status: Attribute[str] = NotSet self._total_commits: Attribute[int] = NotSet def __repr__(self) -> str: return self.get__repr__({"url": self._url.value}) @property def ahead_by(self) -> int: self._completeIfNotSet(self._ahead_by) return self._ahead_by.value @property def base_commit(self) -> Commit: self._completeIfNotSet(self._base_commit) return self._base_commit.value @property def behind_by(self) -> int: self._completeIfNotSet(self._behind_by) return self._behind_by.value @property def commits(self) -> PaginatedList[Commit]: """ This is a `paginated property `_. Iterating over this paginated list may fetch multiple pages. The size of these pages can be controlled via the ``…_per_page`` parameter of :meth:`github.Repository.Repository.compare`, :meth:`github.Comparison.Comparison.get_commits`, or :meth:`github.Github`. If no ``per_page`` is given, the default page size is 250. The maximum is 1000. At most 10000 commits can be retrieved. """ return PaginatedList( github.Commit.Commit, self._requester, self.url, self._pagination_parameters, list_item="commits", total_count_item="total_commits", firstData=self.raw_data if self.completed else None, firstHeaders=self.raw_headers if self.completed else None, ) @property def diff_url(self) -> str: self._completeIfNotSet(self._diff_url) return self._diff_url.value @property def files(self) -> list[github.File.File]: """ Only the first 300 changed files. """ self._completeIfNotSet(self._files) return self._files.value @property def html_url(self) -> str: self._completeIfNotSet(self._html_url) return self._html_url.value @property def merge_base_commit(self) -> Commit: self._completeIfNotSet(self._merge_base_commit) return self._merge_base_commit.value @property def patch_url(self) -> str: self._completeIfNotSet(self._patch_url) return self._patch_url.value @property def permalink_url(self) -> str: self._completeIfNotSet(self._permalink_url) return self._permalink_url.value @property def status(self) -> str: self._completeIfNotSet(self._status) return self._status.value @property def total_commits(self) -> int: self._completeIfNotSet(self._total_commits) return self._total_commits.value def get_commits(self, *, comparison_commits_per_page: int | None = None) -> PaginatedList[Commit]: """ :calls: `GET /repos/{owner}/{repo}/compare/{base...:head} `_ Identical to calling :meth:`github.Comparison.Comparison.commits`, except that this uses the given ``per_page`` value. For more details, see :meth:`github.Comparison.Comparison.commits`. :param comparison_commits_per_page: int Number of commits retrieved per page. Iterating over the commits will fetch pages of this size. The default page size is 250, the maximum is 1000. At most 10000 commits can be retrieved. """ return PaginatedList( github.Commit.Commit, self._requester, self.url, self._pagination_parameters_with(page=1, per_page=comparison_commits_per_page), headers=None, list_item="commits", ) def _useAttributes(self, attributes: dict[str, Any]) -> None: super()._useAttributes(attributes) if "ahead_by" in attributes: # pragma no branch self._ahead_by = self._makeIntAttribute(attributes["ahead_by"]) if "base_commit" in attributes: # pragma no branch self._base_commit = self._makeClassAttribute(github.Commit.Commit, attributes["base_commit"]) if "behind_by" in attributes: # pragma no branch self._behind_by = self._makeIntAttribute(attributes["behind_by"]) if "commits" in attributes: # pragma no branch self._commits = self._makeListOfClassesAttribute(github.Commit.Commit, attributes["commits"]) if "diff_url" in attributes: # pragma no branch self._diff_url = self._makeStringAttribute(attributes["diff_url"]) if "files" in attributes: # pragma no branch self._files = self._makeListOfClassesAttribute(github.File.File, attributes["files"]) if "html_url" in attributes: # pragma no branch self._html_url = self._makeStringAttribute(attributes["html_url"]) if "merge_base_commit" in attributes: # pragma no branch self._merge_base_commit = self._makeClassAttribute(github.Commit.Commit, attributes["merge_base_commit"]) if "patch_url" in attributes: # pragma no branch self._patch_url = self._makeStringAttribute(attributes["patch_url"]) if "permalink_url" in attributes: # pragma no branch self._permalink_url = self._makeStringAttribute(attributes["permalink_url"]) if "status" in attributes: # pragma no branch self._status = self._makeStringAttribute(attributes["status"]) if "total_commits" in attributes: # pragma no branch self._total_commits = self._makeIntAttribute(attributes["total_commits"])