Typed interactions with the GitHub API v3
name and message when generate_release_notes is true @heitorpolidoro (#2868)WorkflowJob @xvega (#2921)created and check_suite_id filter for Repository Workflow runs @treee111 (#2891)add_to_collaborators @jodelasur (#2905).swp fils to .gitignore @boomanaiden154 (#2903)CONTRIBUTING.md @wakamex (#2900)pyproject.toml @treee111 (#2894)The github.Comparison.Comparison instance returned by Repository.compare provides a commits property that used to return a list[github.Commit.Commit], which has now been changed to PaginatedList[github.Commit.Commit]. This breaks user code that assumes a list:
commits = repo.compare("v0.6", "v0.7").commits
no_of_commits = len(commits) # will raise a TypeError
This will raise a TypeError: object of type 'PaginatedList' has no len(), as the returned PaginatedList
does not support the len() method. Use the totalCount property instead:
commits = repo.compare("v0.6", "v0.7").commits
no_of_commits = commits.totalCount
Repository.compare().commits return paginated list by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2882
include_all_branches to create_repo_from_template of AuthenticatedUser and Organization by @janssonoskar in https://github.com/PyGithub/PyGithub/pull/2871
Organization.create_repo by @tekumara in https://github.com/PyGithub/PyGithub/pull/2700
Repository collaborator permissions by @flying-sheep in https://github.com/PyGithub/PyGithub/pull/1996
PullRequestReview.dismiss by @ColasGael in https://github.com/PyGithub/PyGithub/pull/2854
request_cve on RepositoryAdvisories by @JLLeitschuh in https://github.com/PyGithub/PyGithub/pull/2855
GithubObject.last_modified_datetime to have last_modified as a datetime by @chouetz in https://github.com/PyGithub/PyGithub/pull/2772
internal as valid Repository visibility value by @AndrewJDawes in https://github.com/PyGithub/PyGithub/pull/2806
Repository by @trim21 in https://github.com/PyGithub/PyGithub/pull/2798
Full Changelog: https://github.com/PyGithub/PyGithub/compare/v2.1.1...v2.2.0
This release introduces a default throttling mechanism to mitigate secondary rate limit errors and comply with Github's best practices: https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits
The default throttling of 1 second between writes and 0.25 second between any requests can be configured
for github.Github and github.GithubIntegration:
g = github.Github(seconds_between_requests=0.25, seconds_between_writes=1)
Set these parameters to None to disable throttling and restore earlier behavior.
This release introduces a default retry mechanism to retry retry-able 403 responses (primary and secondary rate limit errors only) and any 5xx response.
Class github.GithubRetry implements this behavior, and can be configured via the retry argument of github.Github and github.GithubIntegration.
Retry behavior is configured similar to urllib3.Retry: https://urllib3.readthedocs.io/en/stable/reference/urllib3.util.html
g = github.Github(retry=github.GithubRetry())
Set this parameter to None to disable retry mechanism and restore earlier behaviour.
Any timestamps returned by this library are datetime with timezone information, usually UTC.
Before this release, timestamps used to be naive datetime instances without timezone.
Comparing (other than ==) these timestamps with naive datetime instances used to work but will now break.
Add a timezone information to your datetime instances before comparison:
if g.get_repo("PyGithub/PyGithub").created_at < datetime(2012, 2, 26, tzinfo=timezone.utc):
...
A Netrc file (e.g. ~/.netrc) does not override PyGithub authentication, anymore.
If you require authentication through Netrc, then this is a breaking change.
Use a github.Auth.NetrcAuth instance to use Netrc credentials:
>>> auth = Auth.NetrcAuth()
>>> g = Github(auth=auth)
>>> g.get_user().login
'login'
Merged overloaded create_pull methods
def create_pull(self, issue, base, head)
def create_pull(self, title, body, base, head, maintainer_can_modify=NotSet, draft=False)
into
def create_pull(self, base, head, *, title=NotSet, body=NotSet, maintainer_can_modify=NotSet, draft=NotSet, issue=NotSet)
Please update your usage of Repository.create_pull accordingly.
Branch.edit_* functions return objects (#2748) (8dee53a8)license attribute to Repository (#2721) (26d353e7)Repository (#2742) (65cfeb1b)is_alphanumeric attribute to Autolink and Repository.create_autolink (#2630) (b6a28a26)requests fallback to netrc, provide github.Auth.Netrc (#2739) (ac36f6a9)AppInstallationAuth.__integration (#2695) (8bf542ae)Secret and Variable classes (#2623) (bcca758d)required_linear_history attribute to BranchProtection (#2643) (7a80fad9)GithubException, don't log it (#2611) (de80ff4b)message property to GithubException (#2591) (f087cad3)Workflow.get_runs() (#2346) (766df993)github.Rate.used field (#2531) (c4c2e527)Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a)required_conversation_resolution assertion (#2715) (54f22267)responseHeaders to int (#2697) (adbfce92)subject_type in creating pull request review comment (#2642) (4933459e)GithubRetry.py (#2610) (950a6949)Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a).pyi type stubs back to .py sources (#2636)add_attribute.py to latest conding style (#2631) (e735972e)flake8 with ruff (#2617) (42c3b47c)disallow_untyped_defs (#2609) (294c0cc9)check_untyped_defs (#2607) (8816889a)typing_extensions for TypedDict (#2592) (5fcb0c7d)flake8 as last (#2595) (11bb6bd7)This release introduces a default throttling mechanism to mitigate secondary rate limit errors and comply with Github's best practices: https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits
The default throttling of 1 second between writes and 0.25 second between any requests can be configured for github.Github and github.GithubIntegration:
g = github.Github(seconds_between_requests=0.25, seconds_between_writes=1)
Set these parameters to None to disable throttling and restore earlier behavior.
This release introduces a default retry mechanism to retry retry-able 403 responses (primary and secondary rate limit errors only) and any 5xx response.
Class github.GithubRetry implements this behavior, and can be configured via the retry argument of github.Github and github.GithubIntegration. Retry behavior is configured similar to urllib3.Retry: https://urllib3.readthedocs.io/en/stable/reference/urllib3.util.html
g = github.Github(retry=github.GithubRetry())
Set this parameter to None to disable retry mechanism and restore earlier behaviour.
Any timestamps returned by this library are datetime with timezone information, usually UTC. Before this release, timestamps used to be naive datetime instances without timezone. Comparing (other than ==) these timestamps with naive datetime instances used to work but will now break. Add a timezone information to your datetime instances before comparison:
if g.get_repo("PyGithub/PyGithub").created_at < datetime(2012, 2, 26, tzinfo=timezone.utc):
...
Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a)Artifact type stub back to source (#2553)This release introduces new way of authentication. All authentication-related arguments github.Github(login_or_token=…, password=…, jwt=…, app_auth=…) and github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…) are replaced by a single auth=… argument. Module github.Auth provides classes for all supported ways of authentication: Login, Token, AppAuth, AppAuthToken, AppInstallationAuth, AppUserAuth. Old arguments are deprecated but continue to work. They are scheduled for removal for version 2.0 release.
This project has decided to move all typing information from .pyi files into the respective .py source files. This will happen gradually over time.
position argument in github.PullRequest.create_review_comment(position=…) has been renamed to line.
This breaks user code that calls create_review_comment with keyword argument position. Call with line=… instead.
Calling this method with positional arguments is not breaking.jwt_expiry, jwt_issued_at and jwt_algorithm arguments in github.GithubIntegration() have changed their position.
User code calling github.GithubIntegration(…) with these arguments as positional arguments breaks.
Please use keyword arguments: github.GithubIntegration(…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…).since argument in github.PullRequest.get_review_comments(…) has changed position.User code callinggithub.PullRequest.get_review_comments(…)with this argument as positional argument breaks. Please use keyword argument:github.PullRequest.get_review_comments(since=…)`.github.Github(login_or_token=…) is deprecated, use github.Github(auth=github.Auth.Login(…)) or github.Github(auth=github.Auth.Token(…)) instead.github.Github(password=…) is deprecated, use github.Github(auth=github.Auth.Login(…)) instead.github.Github(jwt=…) is deprecated, use github.Github(auth=github.AppAuth(…)) or github.Github(auth=github.AppAuthToken(…)) instead.github.Github(app_auth=…) is deprecated, use github.Github(auth=github.Auth.AppInstallationAuth(…)) instead.github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…) is deprecated, use github.GithubIntegration(auth=github.Auth.AppAuth(…)) instead.github.GithubIntegration.create_jwt is deprecated, use github.Github(auth=github.Auth.AppAuth), github.Auth.AppAuth.token or github.Auth.AppAuth.create_jwt(expiration) instead.AppAuthentication is deprecated, use github.Auth.AppInstallationAuth instead.github.Github.get_app() without providing argument slug is deprecated, use github.GithubIntegration(auth=github.Auth.AppAuth(…)).get_app().Installation.get_repos (#2547) (64075120)AppUserAuth for Github App user tokens (#2546) (f291a368)MainClass.get_app return completed GithubApp when slug is given (#2543) (84912a67)name filter to Repository.get_artifacts() (#2459) (9f52e948)name, display_title and path attributes to WorkflowRun (#2397) (10816389)create_fork arguments (#2493) (b94a83cb)ref to Deployment (#2489) (e8075c41)check_suite_id integer to Workflow.get_runs (#2466) (a4854519)generate_release_notes parameter to create_git_release and create_git_tag_and_release (#2417) (49b3ae16)artifact_id argument to Repository.get_artifact() (#2458) (4fa0a5f3)GithubCredentials.py to CONTRIBUTING.md (#2482) (297317ba)