Add description for http_adapter and HttpAdapter as type hint

gouline · Dec 5, 2023 · ade8ecd · ade8ecd
1 parent 76f6a72
commit ade8ecd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/dbtmetabase/metabase.py b/dbtmetabase/metabase.py
@@ -16,7 +16,7 @@
 
 import requests
 import yaml
-from requests.adapters import BaseAdapter, HTTPAdapter, Retry
+from requests.adapters import HTTPAdapter, Retry
 
 from .logger.logging import logger
 from .models import exceptions
@@ -129,7 +129,7 @@ def __init__(
         exclude_sources: bool = False,
         http_extra_headers: Optional[dict] = None,
         http_timeout: int = 15,
-        http_adapter: Optional[BaseAdapter] = None,
+        http_adapter: Optional[HTTPAdapter] = None,
     ):
         """Constructor.
 
@@ -147,7 +147,7 @@ def __init__(
             sync_timeout (Optional[int], optional): Synchronization timeout (in secs). Defaults to None.
             http_extra_headers {dict} -- HTTP headers to be used by the Metabase client. (default: {None})
             exclude_sources {bool} -- Exclude exporting sources. (default: {False})
-            http_adapter: (Optional[BaseAdapter], optional) Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. Defaults to None.
+            http_adapter: (Optional[HTTPAdapter], optional) Provide custom HTTP adapter implementation for requests to use. Defaults to None.
         """
 
         self.base_url = f"{'http' if use_http else 'https'}://{host}"

diff --git a/dbtmetabase/models/interface.py b/dbtmetabase/models/interface.py
@@ -12,7 +12,7 @@
     NoMetabaseCredentialsSupplied,
 )
 from .metabase import MetabaseModel
-from requests.adapters import BaseAdapter
+from requests.adapters import HTTPAdapter
 
 
 class MetabaseInterface:
@@ -35,7 +35,7 @@ def __init__(
         exclude_sources: bool = False,
         http_extra_headers: Optional[dict] = None,
         http_timeout: int = 15,
-        http_adapter: Optional[BaseAdapter] = None,
+        http_adapter: Optional[HTTPAdapter] = None,
     ):
         """Constructor.
 
@@ -52,7 +52,7 @@ def __init__(
             sync_timeout (Optional[int], optional): Synchronization timeout (in secs). Defaults to None.
             exclude_sources (bool, optional): Exclude exporting sources. Defaults to False.
             http_extra_headers (Optional[dict], optional): HTTP headers to be used by the Metabase client. Defaults to None.
-            http_adapter: (Optional[BaseAdapter], optional) Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. Defaults to None.
+            http_adapter: (Optional[HTTPAdapter], optional) Provide custom HTTP adapter implementation for requests to use. Defaults to None.
         """
 
         # Metabase Client