Skip to content

Improved doc string for jp_fetch to include how to provide query parameters in GET and json data in POST #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
minrk merged 5 commits into from
Apr 10, 2025
Merged

Improved doc string for jp_fetch to include how to provide query parameters in GET and json data in POST #83

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fdc074
Improved doc string
0Hughman0 Sep 4, 2024
71b8ede
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 16, 2024
90d8438
made argument order more consistent in POST
0Hughman0 Sep 16, 2024
35c78f9
Merge branch 'doc-improvements' of https://github.com/0Hughman0/pytes…
0Hughman0 Sep 16, 2024
ab722ce
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions pytest_jupyter/jupyter_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,25 @@ def jp_fetch(jp_serverapp, http_server_client, jp_auth_header, jp_base_url):
async def my_test(jp_fetch):
response = await jp_fetch("api", "spec.yaml")
...

With query parameters:

.. code-block:: python

async def my_test(jp_fetch):
response = await jp_fetch("api", "spec.yaml", params={"parameter": "value"})
...

A POST request with data:

.. code-block:: python

async def my_test(jp_fetch):
response = await jp_fetch(
"api", "spec.yaml", method="POST", body=json.dumps({"parameter": "value"})
)
...

"""

def client_fetch(*parts, headers=None, params=None, **kwargs):
Expand Down