Add example on handling errors from the API

Author: nlopes

examples/handling-error.py

@@ -0,0 +1,39 @@
+from datetime import date
+import os
+
+from duffel_api import Duffel
+from duffel_api.http_client import ApiError
+
+
+if __name__ == "__main__":
+    print("Duffel Flights API - Python Example on handling errors")
+
+    os.environ["DUFFEL_ACCESS_TOKEN"] = "some-invalid-token-to-trigger-an-error"
+
+    client = Duffel()
+    departure_date = date.today().replace(date.today().year + 1)
+    slices = [
+        {
+            "origin": "LHR",
+            "destination": "STN",
+            "departure_date": departure_date.strftime("%Y-%m-%d"),
+        },
+    ]
+    try:
+        offer_request = (
+            client.offer_requests.create()
+            .passengers(
+                [{"type": "adult"}, {"age": 1}, {"age": (date.today().year - 2003)}]
+            )
+            .slices(slices)
+            .execute()
+        )
+    except ApiError as exc:
+        # This is super useful when contacting Duffel support
+        print(f"Request ID: {exc.meta['request_id']}")
+        print(f"Status Code: {exc.meta['status']}")
+        print("Errors: ")
+        for error in exc.errors:
+            print(f" Title: {error['title']}")
+            print(f" Code: {error['code']}")
+            print(f" Message: {error['message']}")

tests/test_http_client.py

@@ -27,5 +27,6 @@ def test_http_client_error(requests_mock):
     client = HttpClient("some_token", "http://someaddress", "v1")
     with pytest.raises(
         ApiError, match="The airline responded with an unexpected error"
-    ):
+    ) as excinfo:
         client.do_get("/api/stuff")
+    assert excinfo.value.meta["request_id"] == "FmXeZifDA60QOlgAAODB"