Skip to content

Add documentation on surfacing error codes (#231) #572

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

Open
DaveKavya wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation on surfacing error codes (#231) #572

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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,23 @@ Long term:

- The client currently inputs and outputs JSON dictionaries. Adding models would unlock features such as typing and validation.
- Add supporting functions to elevate customer experience (i.e. adding a funtion that surfaces IP address for a Droplet)

- Add supporting functions to elevate customer experience (i.e. adding a funtion that surfaces IP address for a Droplet)

### 🧩 Handling Error Codes

When using `pydo`, some API responses may include specific error codes.
To make debugging easier, you can catch and print these codes from exceptions.

**Example:**
```python
from pydo import Client
import os

client = Client(token=os.getenv("DIGITALOCEAN_TOKEN"))

try:
client.droplets.list()
except Exception as e:
print("Error code:", getattr(e, "code", "Unknown"))
print("Error message:", e)