refactor: make auth function private

Author: dshemetov

epidatpy/_auth.py

@@ -1,10 +1,9 @@
 import os
 import warnings
-from typing import Optional
 
 
-def get_api_key() -> Optional[str]:
-    key = os.environ.get("DELPHI_EPIDATA_KEY", None)
+def _get_api_key() -> str:
+    key = os.environ.get("DELPHI_EPIDATA_KEY", "")
 
     if not key:
         warnings.warn(

epidatpy/request.py

@@ -14,7 +14,7 @@
 from requests.auth import HTTPBasicAuth
 from tenacity import retry, stop_after_attempt
 
-from ._auth import get_api_key
+from ._auth import _get_api_key
 from ._constants import BASE_URL, HTTP_HEADERS
 from ._covidcast import CovidcastDataSources, define_covidcast_fields
 from ._endpoints import AEpiDataEndpoints
@@ -41,7 +41,7 @@ def _request_with_retry(
     stream: bool = False,
 ) -> Response:
     """Make request with a retry if an exception is thrown."""
-    basic_auth = HTTPBasicAuth("epidata", get_api_key())
+    basic_auth = HTTPBasicAuth("epidata", _get_api_key())
 
     def call_impl(s: Session) -> Response:
         res = s.get(url, params=params, headers=HTTP_HEADERS, stream=stream, auth=basic_auth)

tests/test_auth.py

@@ -1,12 +1,12 @@
-from pytest import warns, MonkeyPatch
+from pytest import MonkeyPatch, warns
 
-from epidatpy import get_api_key
+from epidatpy._auth import _get_api_key
 
 
 def test_get_api_key(monkeypatch: MonkeyPatch) -> None:
     with monkeypatch.context() as m:
         m.setenv("DELPHI_EPIDATA_KEY", "test")
-        assert get_api_key() == "test"
+        assert _get_api_key() == "test"
         m.delenv("DELPHI_EPIDATA_KEY")
         with warns(UserWarning):
-            assert get_api_key() is None
+            assert _get_api_key() == ""