Download Latest Version v2.9.0 source code.tar.gz (2.6 MB)
Email in envelope

Get an email when there's a new version of PyGitHub

Home / v2.9.0
Name Modified Size InfoDownloads / Week
Parent folder
README.md 2026-03-22 7.6 kB
0
v2.9.0 source code.tar.gz 2026-03-22 2.6 MB
0
v2.9.0 source code.zip 2026-03-22 4.0 MB
0
Totals: 3 Items   6.6 MB 0

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 https://github.com/PyGithub/PyGithub/pull/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:

:::python
# 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:

    :::python 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

Improvements

Bug Fixes

Maintenance

New Contributors

Full Changelog: https://github.com/PyGithub/PyGithub/compare/v2.8.0...v2.9.0

Source: README.md, updated 2026-03-22