This PR contains the following updates:

Package	Change	Age	Confidence
PyGithub	==2.8.1 → ==2.9.0
pygithub	==2.8.1 → ==2.9.0

Release Notes

v2.9.0

Compare Source

Notable changes

Lazy PyGithub objects

The notion of lazy objects has been added to some PyGithub classes in version 2.6.0. This release now makes all CompletableGithubObjects optionally lazy (if useful). See PyGithub/PyGithub#3403 for a complete list.

In lazy mode, getting a PyGithub object does not send a request to the GitHub API. Only accessing methods and properties sends the necessary requests to the GitHub API:

# Use lazy mode
g = Github(auth=auth, lazy=True)

# these method calls do not send requests to the GitHub API
user = g.get_user("PyGithub")    # get the user
repo = user.get_repo("PyGithub") # get the user's repo
pull = repo.get_pull(3403)       # get a known pull request
issue = pull.as_issue()          # turn the pull request into an issue

# these method and property calls send requests to Github API
issue.create_reaction("rocket")  # create a reaction
created = repo.created_at        # get property of lazy object repo

# once a lazy object has been fetched, all properties are available (no more requests)
licence = repo.license

All PyGithub classes that implement CompletableGithubObject support lazy mode (if useful). This is only useful for classes that have methods creating, changing, or getting objects.

By default, PyGithub objects are not lazy.

PyGithub objects with a paginated property

The GitHub API has the "feature" of paginated properties. Some objects returned by the API have a property that allows for pagination. Fetching subsequent pages of that property means fetching the entire object (with all other properties) and the specified page of the paginated property. Iterating over the paginated property means fetching all other properties multiple times. Fortunately, the allowed size of each page (per_page is usually 300, in contrast to the "usual" per_page maximum of 100).

Objects with paginated properties:

• Commit.files
• Comparison.commits
• EnterpriseConsumedLicenses.users

This PR makes iterating those paginated properties use the configured per_page setting.

It further allows to specify an individual per_page when either retrieving such objects, or fetching paginated properties.

See Classes with paginated properties for details.

Drop Python 3.8 support due to End-of-Life

Python 3.8 reached its end-of-life September 6, 2024. Support has been removed with this release.

Deprecations

• Method delete of Reaction is deprecated, use IssueComment.delete_reaction,
  PullRequestComment.delete_reaction, CommitComment.delete_reaction or Issue.delete_reaction instead.
• Method Issue.assignee and parameter Issue.edit(assignee=…) are deprecated,
  use Issue.assignees and Issue.edit(assignees=…) instead.
• Method Organization.edit_hook is deprecated, use Organization.get_hook(id).edit(…) instead.
  If you need to avoid Organization.get_hook(id) to fetch the Hook object from Github API,
  use a lazy Github instance:

Github(…, lazy=True).get_organization(…).get_hook(id).edit(…)

• Methods Team.add_to_members and Team.remove_from_members are deprecated,
  use Team.add_membership or Team.remove_membership instead.

New Features

• Consider per-page settings when iterating paginated properties by @​EnricoMi in PyGithub/PyGithub#3377
• Add Secret Scanning Alerts and Improve Code Scan Alerts by @​matt-davis27 in PyGithub/PyGithub#3307

Improvements

• More lazy objects by @​EnricoMi in PyGithub/PyGithub#3403
• Allow for enterprise base url prefixed with api. by @​EnricoMi in PyGithub/PyGithub#3419
• Add throw option to Workflow.create_dispatch to raise exceptions by @​dblanchette in PyGithub/PyGithub#2966
• Use GET url or _links.self as object url by @​EnricoMi in PyGithub/PyGithub#3421
• Add support for type parameter to get_issues by @​nrysk in PyGithub/PyGithub#3381
• Align implemented paths with OpenAPI spec by @​EnricoMi in PyGithub/PyGithub#3413
• Add suggested OpenAPI schemas by @​EnricoMi in PyGithub/PyGithub#3411
• Apply OpenAPI schemas by @​EnricoMi in PyGithub/PyGithub#3412

Bug Fixes

• Fix PaginatedList.totalCount returning 0 with GitHub deprecation notices by @​odedperezcodes in PyGithub/PyGithub#3382
• Use default type if known type is not supported by @​EnricoMi in PyGithub/PyGithub#3365

Maintenance

• Deprecate Reaction.delete by @​iarspider in PyGithub/PyGithub#3435
• Deprecate Issue.assignee by @​EnricoMi in PyGithub/PyGithub#3366
• Deprecate Orginization.edit_hook by @​EnricoMi in PyGithub/PyGithub#3404
• Deprecate Team.add_to_members and Team.remove_from_members by @​EnricoMi in PyGithub/PyGithub#3368
• Various minor OpenAPI fixes by @​EnricoMi in PyGithub/PyGithub#3375
• Update test key pair by @​EnricoMi in PyGithub/PyGithub#3453
• Pin CI lint Python version to 3.13 by @​EnricoMi in PyGithub/PyGithub#3406
• Improve error message on replay data mismatch by @​EnricoMi in PyGithub/PyGithub#3385 and PyGithub/PyGithub#3386
• Disable sleeps in tests by @​EnricoMi in PyGithub/PyGithub#3383
• Update autodoc defaults by @​Aidan-McNay in PyGithub/PyGithub#3369
• Add Python 3.14 to CI and tox by @​EnricoMi in PyGithub/PyGithub#3429
• Restrict PyPi release workflow permissions by @​JLLeitschuh in PyGithub/PyGithub#3418
• Fix OpenApi workflow by @​EnricoMi in PyGithub/PyGithub#3389
• Bump codecov/codecov-action from 3 to 5 by @​dependabot[bot] in PyGithub/PyGithub#3284
• Bump actions/setup-python from 5 to 6 by @​dependabot[bot] in PyGithub/PyGithub#3370
• Bump dawidd6/action-download-artifact from 3.0.0 to 3.1.4 by @​dependabot[bot] in PyGithub/PyGithub#3282
• Bump github/codeql-action from 3 to 4 by @​dependabot[bot] in PyGithub/PyGithub#3391
• Bump actions/upload-artifact from 4 to 5 by @​dependabot[bot] in PyGithub/PyGithub#3394
• Bump actions/download-artifact from 5 to 6 by @​dependabot[bot] in PyGithub/PyGithub#3393
• Drop Python 3.8 support due to EOL by @​hugovk in PyGithub/PyGithub#3191
• Merge changelog updates from v2.8 release branch by @​EnricoMi in PyGithub/PyGithub#3367

New Contributors

• @​odedperezcodes made their first contribution in PyGithub/PyGithub#3382
• @​Aidan-McNay made their first contribution in PyGithub/PyGithub#3369
• @​nrysk made their first contribution in PyGithub/PyGithub#3381
• @​matt-davis27 made their first contribution in PyGithub/PyGithub#3307

Full Changelog: PyGithub/PyGithub@v2.8.0...v2.9.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

• If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.