Add trace option for better API call debugging (#432)

* Add `trace=True` option for debugging

Author: justinpolygon

polygon/rest/__init__.py

@@ -17,7 +17,6 @@
 from typing import Optional, Any
 import os
 
-
 BASE = "https://api.polygon.io"
 ENV_KEY = "POLYGON_API_KEY"
 
@@ -46,6 +45,7 @@ def __init__(
         retries: int = 3,
         base: str = BASE,
         verbose: bool = False,
+        trace: bool = False,
         custom_json: Optional[Any] = None,
     ):
         super().__init__(
@@ -56,6 +56,7 @@ def __init__(
             retries=retries,
             base=base,
             verbose=verbose,
+            trace=trace,
             custom_json=custom_json,
         )
         self.vx = VXClient(
@@ -66,5 +67,6 @@ def __init__(
             retries=retries,
             base=base,
             verbose=verbose,
+            trace=trace,
             custom_json=custom_json,
         )

polygon/rest/base.py

@@ -9,6 +9,7 @@
 from .models.request import RequestOptionBuilder
 from ..logging import get_logger
 import logging
+from urllib.parse import urlencode
 from ..exceptions import AuthError, BadResponse, NoResultsError
 
 logger = get_logger("RESTClient")
@@ -29,6 +30,7 @@ def __init__(
         retries: int,
         base: str,
         verbose: bool,
+        trace: bool,
         custom_json: Optional[Any] = None,
     ):
         if api_key is None:
@@ -58,6 +60,7 @@ def __init__(
         self.retries = retries
         if verbose:
             logger.setLevel(logging.DEBUG)
+        self.trace = trace
         if custom_json:
             self.json = custom_json
         else:
@@ -77,14 +80,32 @@ def _get(
     ) -> Any:
         option = options if options is not None else RequestOptionBuilder()
 
+        headers = self._concat_headers(option.headers)
+
+        if self.trace:
+            full_url = f"{self.BASE}{path}"
+            if params:
+                full_url += f"?{urlencode(params)}"
+            print_headers = headers.copy()
+            if "Authorization" in print_headers:
+                print_headers["Authorization"] = print_headers["Authorization"].replace(
+                    self.API_KEY, "REDACTED"
+                )
+            print(f"Request URL: {full_url}")
+            print(f"Request Headers: {print_headers}")
+
         resp = self.client.request(
             "GET",
             self.BASE + path,
             fields=params,
             retries=self.retries,
-            headers=self._concat_headers(option.headers),
+            headers=headers,
         )
 
+        if self.trace:
+            resp_headers_dict = dict(resp.headers.items())
+            print(f"Response Headers: {resp_headers_dict}")
+
         if resp.status != 200:
             raise BadResponse(resp.data.decode("utf-8"))