Add extra_headers option to get methods #192

basnijholt · 2023-04-12T18:37:42Z

This allows to do for example:

async def get_stargazers_with_dates(full_repo_name):
    headers = {"Accept": "application/vnd.github.v3.star+json"}
    async with httpx.AsyncClient() as client:
        gh = gidgethub.httpx.GitHubAPI(client, "basnijholt", oauth_token=token)
        repo_owner, repo_name = full_repo_name.split("/")
        stats_contributors = await gh.getitem(
            f"/repos/{repo_owner}/{repo_name}/stargazers", extra_headers=headers
        )
        return stats_contributors

await get_stargazers_with_dates("basnijholt/adaptive-lighting")

Some more extra headers folks might want to use:

https://github.com/PyGithub/PyGithub/blob/300c5015d41236eb410b9cbe895258294e3500af/github/Consts.py#L58-L133

Closes #193

This allows to do for example: ```python async def get_stargazers_with_dates(full_repo_name): headers = {"Accept": "application/vnd.github.v3.star+json"} async with httpx.AsyncClient() as client: gh = gidgethub.httpx.GitHubAPI(client, "basnijholt", oauth_token=token) repo_owner, repo_name = full_repo_name.split("/") stats_contributors = await gh.getitem( f"/repos/{repo_owner}/{repo_name}/stargazers", extra_headers=headers ) return stats_contributors await get_stargazers_with_dates("basnijholt/adaptive-lighting") ```

brettcannon · 2023-04-12T20:57:07Z

Would you mind opening a corresponding issue so we can discuss the API proposal there?

brettcannon · 2023-04-12T20:57:51Z

And without doing a review, I noticed there are no tests.

basnijholt · 2023-04-13T05:47:09Z

I have opened #193 and I added some tests.

tests/test_abc.py

codecov-commenter · 2023-04-27T00:12:57Z

Codecov Report

Merging #192 (06bdcdd) into main (901f057) will not change coverage.
The diff coverage is 100.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff            @@
##              main      #192   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9         9           
  Lines          469       471    +2     
  Branches        86        87    +1     
=========================================
+ Hits           469       471    +2

Impacted Files	Coverage Δ
gidgethub/abc.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

basnijholt · 2023-04-27T00:33:30Z

I believe the CI failure is unrelated to these changes.

Mariatta · 2023-04-27T00:37:07Z

Unrelated but still needs to be fixed before merging this PR. Perhaps we just need to bump the sphinx dependency. It can be done as a separate PR.

basnijholt · 2023-04-27T02:10:19Z

I think I have fixed the Sphinx issue in 4cd6ead.

Mariatta · 2023-04-27T15:31:07Z

Thank you! Can you also update the changelog

Mariatta · 2023-04-27T15:31:40Z

and documentation to document the new extra_headers parameter

Mariatta · 2023-05-04T19:05:08Z

Can you update the branch and resolve the conflict?

basnijholt · 2023-05-05T03:38:11Z

@Mariatta, I have

fixed the conflicts
added documentation
updated the changelog

Thanks for reviewing!

basnijholt · 2023-05-06T19:10:02Z

We’re now running into urllib3/urllib3#2168 in the docs build.

Mariatta

The readthedocs is still failing.

.readthedocs.yaml

basnijholt · 2023-05-11T19:01:50Z

The docs build successfully now 🎉

https://gidgethub--192.org.readthedocs.build/en/192/abc.html

Mariatta

Thanks!

brettcannon

I personally would like to set {} as the default value since it isn't modified, but I also know using a mutable default value makes people uncomfortable, so I'm fine with None as a default.

brettcannon · 2023-05-26T22:33:42Z

Thanks!

Bumps [gidgethub](https://github.com/brettcannon/gidgethub) from 5.0.1 to 5.3.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/brettcannon/gidgethub/releases">gidgethub's releases</a>.</em></p> <blockquote> <h2>5.3.0</h2> <ul> <li> <p>Add support passing <code>extra_headers</code> when making requests [PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/192">#192</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/192">brettcannon/gidgethub#192</a>)</p> </li> <li> <p>Add a getstatus() method for APIs that do not return content. [PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/194">#194</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/194">brettcannon/gidgethub#194</a>)</p> </li> </ul> <h2>5.2.1</h2> <ul> <li> <p>Fix cgi and importlib_resources deprecations. [PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/185">#185</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/185">brettcannon/gidgethub#185</a>)</p> </li> <li> <p>Add support for Python 3.11 and drop EOL Python 3.6 [PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/184">#184</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/184">brettcannon/gidgethub#184</a>)</p> </li> </ul> <h2>5.2.0</h2> <ul> <li>Make the minimum version of PyJWT be v2.4.0.</li> </ul> <h2>5.1.0</h2> <ul> <li> <p>Use <code>X-Hub-Signature-256</code> header for webhook validation when available. ([PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/160">#160</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/160">brettcannon/gidgethub#160</a>)).</p> </li> <li> <p>The documentation is now built using Sphinx v>= 4.0.0. ([Issue <a href="https://redirect.github.com/brettcannon/gidgethub/issues/143">#143</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/issues/143">brettcannon/gidgethub#143</a>))</p> </li> <li> <p><code>gidgethub.abc.GitHubAPI.getiter</code> now accepts <code>iterable_key</code> parameter in order to support the Checks API. ([Issue <a href="https://redirect.github.com/brettcannon/gidgethub/issues/164">#164</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/issues/164">brettcannon/gidgethub#164</a>))</p> </li> <li> <p>Accept HTTP 202 ACCEPTED as successful. ([PR <a href="https://redirect.github.com/brettcannon/gidgethub/issues/174">#174</a>](<a href="https://redirect.github.com/brettcannon/gidgethub/pull/174">brettcannon/gidgethub#174</a>))</p> </li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/gidgethub/gidgethub/blob/main/docs/changelog.rst">gidgethub's changelog</a>.</em></p> <blockquote> <h2>5.3.0</h2> <ul> <li> <p>Add support passing <code>extra_headers</code> when making requests (<code>PR [#192](gidgethub/gidgethub#192) <https://github.com/brettcannon/gidgethub/pull/192></code>_)</p> </li> <li> <p>Add a getstatus() method for APIs that do not return content. (<code>PR [#194](gidgethub/gidgethub#194) <https://github.com/brettcannon/gidgethub/pull/194></code>_)</p> </li> </ul> <h2>5.2.1</h2> <ul> <li> <p>Fix cgi and importlib_resources deprecations. (<code>PR [#185](gidgethub/gidgethub#185) <https://github.com/brettcannon/gidgethub/pull/185></code>_)</p> </li> <li> <p>Add support for Python 3.11 and drop EOL Python 3.6 (<code>PR [#184](gidgethub/gidgethub#184) <https://github.com/brettcannon/gidgethub/pull/184></code>_)</p> </li> </ul> <h2>5.2.0</h2> <ul> <li>Make the minimum version of PyJWT be v2.4.0.</li> </ul> <h2>5.1.0</h2> <ul> <li> <p>Use <code>X-Hub-Signature-256</code> header for webhook validation when available. (<code>PR [#160](gidgethub/gidgethub#160) <https://github.com/brettcannon/gidgethub/pull/160></code>_).</p> </li> <li> <p>The documentation is now built using Sphinx v>= 4.0.0. (<code>Issue [#143](gidgethub/gidgethub#143) <https://github.com/brettcannon/gidgethub/issues/143></code>_)</p> </li> <li> <p>:meth:<code>gidgethub.abc.GitHubAPI.getiter</code> now accepts <code>iterable_key</code> parameter in order to support the Checks API. (<code>Issue [#164](gidgethub/gidgethub#164) <https://github.com/brettcannon/gidgethub/issues/164></code>_)</p> </li> <li> <p>Accept HTTP 202 ACCEPTED as successful. (<code>PR [#174](gidgethub/gidgethub#174) <https://github.com/brettcannon/gidgethub/pull/174></code>_)</p> </li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/gidgethub/gidgethub/commit/dbcdf4bd32de86288495dbbd8c1682399ba53ad1"><code>dbcdf4b</code></a> Fix the rst markup on the Changelog. (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/197">#197</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/b9fe3c69030e0960d4ba2dcc1efb921e240c7504"><code>b9fe3c6</code></a> Add <code>extra_headers</code> option to <code>get</code> methods (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/192">#192</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/901f0578c00919cdb8c0b120b6d9d9f35eda620e"><code>901f057</code></a> Add a getstatus() method to gidgethub.abc (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/194">#194</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/20e861254150b16bfd2fbe26b012cb6736430faf"><code>20e8612</code></a> Update the intersphinx mapping to 1.0-style (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/195">#195</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/e1f7baed601914139fc5179fcb8faea210bbf543"><code>e1f7bae</code></a> Fix lint issues (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/191">#191</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/b3ae8d16426355f660a2fc2aadeb4d8e61478add"><code>b3ae8d1</code></a> Replace use of <code>requests</code> in examples with <code>httpx</code> (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/190">#190</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/4fe3c04d7c550a5b33fbf00e154810042f7d3edb"><code>4fe3c04</code></a> Release 5.2.1 (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/186">#186</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/89ade8859539212e0663e91f0777ad8a39ecf323"><code>89ade88</code></a> Fix cgi and importlib_resources deprecations (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/185">#185</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/64888cbe83e3f11af3c6f25294adff26dc2f557a"><code>64888cb</code></a> Add support for Python 3.11 and drop EOL Python 3.6 (<a href="https://redirect.github.com/brettcannon/gidgethub/issues/184">#184</a>)</li> <li><a href="https://github.com/gidgethub/gidgethub/commit/8c60e56029b7e10b7be9879e64dfbf97bbeda2b8"><code>8c60e56</code></a> Add variable mapping to fix 'Session tests-3.10-dev skipped: Python interpret...</li> <li>Additional commits viewable in <a href="https://github.com/brettcannon/gidgethub/compare/5.0.1...v5.3.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=gidgethub&package-manager=pip&previous-version=5.0.1&new-version=5.3.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

basnijholt mentioned this pull request Apr 13, 2023

Add extra_headers option to HTTP methods in GitHubAPI #193

Closed

Add tests

428f502

basnijholt commented Apr 13, 2023

View reviewed changes

tests/test_abc.py Show resolved Hide resolved

Fix intersphinx_mapping format

4cd6ead

offbyone mentioned this pull request Apr 27, 2023

Update the intersphinx mapping to 1.0-style #195

Merged

Merge branch 'main' into extra_headers

0e1e6b2

basnijholt added 3 commits May 4, 2023 20:28

Add extra_headers to changelog

f3e77df

Merge remote-tracking branch 'upstream/main' into extra_headers

fd1e2c5

Add extra_headers to docs

a34aef6

Use Python 3.11 for .readthedocs.yaml

06bdcdd

Mariatta requested changes May 7, 2023

View reviewed changes

.readthedocs.yaml Outdated Show resolved Hide resolved

basnijholt added 2 commits May 11, 2023 12:00

Update .readthedocs.yaml

d59f3bf

Remove double comma in abc.rst

c50234b

Mariatta approved these changes May 11, 2023

View reviewed changes

brettcannon approved these changes May 26, 2023

View reviewed changes

brettcannon merged commit b9fe3c6 into gidgethub:main May 26, 2023

webknjaz mentioned this pull request Jun 16, 2023

: TypeError: RawGitHubAPI._make_request() got an unexpected keyword argument 'extra_headers' sanitizers/octomachinery#53

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add extra_headers option to get methods #192

Add extra_headers option to get methods #192

basnijholt commented Apr 12, 2023 •

edited by Mariatta

Loading

brettcannon commented Apr 12, 2023

brettcannon commented Apr 12, 2023

basnijholt commented Apr 13, 2023

codecov-commenter commented Apr 27, 2023 •

edited

Loading

basnijholt commented Apr 27, 2023

Mariatta commented Apr 27, 2023

basnijholt commented Apr 27, 2023 •

edited

Loading

Mariatta commented Apr 27, 2023

Mariatta commented Apr 27, 2023

Mariatta commented May 4, 2023

basnijholt commented May 5, 2023

basnijholt commented May 6, 2023 •

edited

Loading

Mariatta left a comment

basnijholt commented May 11, 2023

Mariatta left a comment

brettcannon left a comment

brettcannon commented May 26, 2023

Add extra_headers option to get methods #192

Add extra_headers option to get methods #192

Conversation

basnijholt commented Apr 12, 2023 • edited by Mariatta Loading

brettcannon commented Apr 12, 2023

brettcannon commented Apr 12, 2023

basnijholt commented Apr 13, 2023

codecov-commenter commented Apr 27, 2023 • edited Loading

Codecov Report

basnijholt commented Apr 27, 2023

Mariatta commented Apr 27, 2023

basnijholt commented Apr 27, 2023 • edited Loading

Mariatta commented Apr 27, 2023

Mariatta commented Apr 27, 2023

Mariatta commented May 4, 2023

basnijholt commented May 5, 2023

basnijholt commented May 6, 2023 • edited Loading

Mariatta left a comment

Choose a reason for hiding this comment

basnijholt commented May 11, 2023

Mariatta left a comment

Choose a reason for hiding this comment

brettcannon left a comment

Choose a reason for hiding this comment

brettcannon commented May 26, 2023

basnijholt commented Apr 12, 2023 •

edited by Mariatta

Loading

codecov-commenter commented Apr 27, 2023 •

edited

Loading

basnijholt commented Apr 27, 2023 •

edited

Loading

basnijholt commented May 6, 2023 •

edited

Loading