Skip to content

feat(api): update examples #22

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
merged 1 commit into from
Feb 12, 2025
Merged

feat(api): update examples #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 25 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ client = Gitpod(
bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted
)

runner = client.runners.create()
print(runner.access_token)
response = client.identity.get_authenticated_identity()
print(response.organization_id)
```

While you can provide a `bearer_token` keyword argument,
Expand All @@ -55,8 +55,8 @@ client = AsyncGitpod(


async def main() -> None:
runner = await client.runners.create()
print(runner.access_token)
response = await client.identity.get_authenticated_identity()
print(response.organization_id)


asyncio.run(main())
Expand Down Expand Up @@ -84,12 +84,12 @@ from gitpod import Gitpod

client = Gitpod()

all_services = []
all_environments = []
# Automatically fetches more pages as needed.
for service in client.environments.automations.services.list():
# Do something with service here
all_services.append(service)
print(all_services)
for environment in client.environments.list():
# Do something with environment here
all_environments.append(environment)
print(all_environments)
```

Or, asynchronously:
Expand All @@ -102,11 +102,11 @@ client = AsyncGitpod()


async def main() -> None:
all_services = []
all_environments = []
# Iterate through items across all pages, issuing requests as needed.
async for service in client.environments.automations.services.list():
all_services.append(service)
print(all_services)
async for environment in client.environments.list():
all_environments.append(environment)
print(all_environments)


asyncio.run(main())
Expand All @@ -115,23 +115,23 @@ asyncio.run(main())
Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:

```python
first_page = await client.environments.automations.services.list()
first_page = await client.environments.list()
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = await first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.services)}")
print(f"number of items we just fetched: {len(next_page.environments)}")

# Remove `await` for non-async usage.
```

Or just work directly with the returned data:

```python
first_page = await client.environments.automations.services.list()
first_page = await client.environments.list()

print(f"next page cursor: {first_page.pagination.next_token}") # => "next page cursor: ..."
for service in first_page.services:
print(service.id)
for environment in first_page.environments:
print(environment.id)

# Remove `await` for non-async usage.
```
Expand All @@ -152,7 +152,7 @@ from gitpod import Gitpod
client = Gitpod()

try:
client.runners.create()
client.identity.get_authenticated_identity()
except gitpod.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
Expand Down Expand Up @@ -195,7 +195,7 @@ client = Gitpod(
)

# Or, configure per-request:
client.with_options(max_retries=5).runners.create()
client.with_options(max_retries=5).identity.get_authenticated_identity()
```

### Timeouts
Expand All @@ -218,7 +218,7 @@ client = Gitpod(
)

# Override per-request:
client.with_options(timeout=5.0).runners.create()
client.with_options(timeout=5.0).identity.get_authenticated_identity()
```

On timeout, an `APITimeoutError` is thrown.
Expand Down Expand Up @@ -259,11 +259,11 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
from gitpod import Gitpod

client = Gitpod()
response = client.runners.with_raw_response.create()
response = client.identity.with_raw_response.get_authenticated_identity()
print(response.headers.get('X-My-Header'))

runner = response.parse() # get the object that `runners.create()` would have returned
print(runner.access_token)
identity = response.parse() # get the object that `identity.get_authenticated_identity()` would have returned
print(identity.organization_id)
```

These methods return an [`APIResponse`](https://github.com/gitpod-io/gitpod-sdk-python/tree/main/src/gitpod/_response.py) object.
Expand All @@ -277,7 +277,7 @@ The above interface eagerly reads the full response body when you make the reque
To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.

```python
with client.runners.with_streaming_response.create() as response:
with client.identity.with_streaming_response.get_authenticated_identity() as response:
print(response.headers.get("X-My-Header"))

for line in response.iter_lines():
Expand Down
48 changes: 28 additions & 20 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -735,13 +735,13 @@ def test_parse_retry_after_header(self, remaining_retries: int, retry_after: str
@mock.patch("gitpod._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
@pytest.mark.respx(base_url=base_url)
def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(
side_effect=httpx.TimeoutException("Test timeout error")
)

with pytest.raises(APITimeoutError):
self.client.post(
"/gitpod.v1.RunnerService/CreateRunner",
"/gitpod.v1.IdentityService/GetAuthenticatedIdentity",
body=cast(object, dict()),
cast_to=httpx.Response,
options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
Expand All @@ -752,11 +752,11 @@ def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> No
@mock.patch("gitpod._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
@pytest.mark.respx(base_url=base_url)
def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(return_value=httpx.Response(500))
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(return_value=httpx.Response(500))

with pytest.raises(APIStatusError):
self.client.post(
"/gitpod.v1.RunnerService/CreateRunner",
"/gitpod.v1.IdentityService/GetAuthenticatedIdentity",
body=cast(object, dict()),
cast_to=httpx.Response,
options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
Expand Down Expand Up @@ -788,9 +788,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = client.runners.with_raw_response.create()
response = client.identity.with_raw_response.get_authenticated_identity()

assert response.retries_taken == failures_before_success
assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
Expand All @@ -812,9 +812,11 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = client.runners.with_raw_response.create(extra_headers={"x-stainless-retry-count": Omit()})
response = client.identity.with_raw_response.get_authenticated_identity(
extra_headers={"x-stainless-retry-count": Omit()}
)

assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0

Expand All @@ -835,9 +837,11 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = client.runners.with_raw_response.create(extra_headers={"x-stainless-retry-count": "42"})
response = client.identity.with_raw_response.get_authenticated_identity(
extra_headers={"x-stainless-retry-count": "42"}
)

assert response.http_request.headers.get("x-stainless-retry-count") == "42"

Expand Down Expand Up @@ -1531,13 +1535,13 @@ async def test_parse_retry_after_header(self, remaining_retries: int, retry_afte
@mock.patch("gitpod._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
@pytest.mark.respx(base_url=base_url)
async def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(
side_effect=httpx.TimeoutException("Test timeout error")
)

with pytest.raises(APITimeoutError):
await self.client.post(
"/gitpod.v1.RunnerService/CreateRunner",
"/gitpod.v1.IdentityService/GetAuthenticatedIdentity",
body=cast(object, dict()),
cast_to=httpx.Response,
options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
Expand All @@ -1548,11 +1552,11 @@ async def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter)
@mock.patch("gitpod._base_client.BaseClient._calculate_retry_timeout", _low_retry_timeout)
@pytest.mark.respx(base_url=base_url)
async def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> None:
respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(return_value=httpx.Response(500))
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(return_value=httpx.Response(500))

with pytest.raises(APIStatusError):
await self.client.post(
"/gitpod.v1.RunnerService/CreateRunner",
"/gitpod.v1.IdentityService/GetAuthenticatedIdentity",
body=cast(object, dict()),
cast_to=httpx.Response,
options={"headers": {RAW_RESPONSE_HEADER: "stream"}},
Expand Down Expand Up @@ -1585,9 +1589,9 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = await client.runners.with_raw_response.create()
response = await client.identity.with_raw_response.get_authenticated_identity()

assert response.retries_taken == failures_before_success
assert int(response.http_request.headers.get("x-stainless-retry-count")) == failures_before_success
Expand All @@ -1610,9 +1614,11 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = await client.runners.with_raw_response.create(extra_headers={"x-stainless-retry-count": Omit()})
response = await client.identity.with_raw_response.get_authenticated_identity(
extra_headers={"x-stainless-retry-count": Omit()}
)

assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0

Expand All @@ -1634,9 +1640,11 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
return httpx.Response(500)
return httpx.Response(200)

respx_mock.post("/gitpod.v1.RunnerService/CreateRunner").mock(side_effect=retry_handler)
respx_mock.post("/gitpod.v1.IdentityService/GetAuthenticatedIdentity").mock(side_effect=retry_handler)

response = await client.runners.with_raw_response.create(extra_headers={"x-stainless-retry-count": "42"})
response = await client.identity.with_raw_response.get_authenticated_identity(
extra_headers={"x-stainless-retry-count": "42"}
)

assert response.http_request.headers.get("x-stainless-retry-count") == "42"

Expand Down