formatting

planet/auth.py

@@ -131,7 +131,8 @@ def from_key(key: str) -> AuthType:
 
     @staticmethod
     def from_file(
-        filename: typing.Optional[typing.Union[str, pathlib.Path]] = None) -> AuthType:
+        filename: typing.Optional[typing.Union[str, pathlib.Path]] = None
+    ) -> AuthType:
         """Create authentication from secret file.
 
         The default secret file is named `.planet.json` and is stored in the user
@@ -153,17 +154,19 @@ def from_file(
             filename: Alternate path for the planet secret file.
 
         """
-        warnings.warn("Auth.from_file() will be deprecated.",  PendingDeprecationWarning)
+        warnings.warn("Auth.from_file() will be deprecated.", PendingDeprecationWarning)
         plauth_config = {
             **_ProductionEnv.LEGACY_AUTH_AUTHORITY,
             "client_type": planet_auth.PlanetLegacyAuthClientConfig.meta().get("client_type"),
         }
-        pl_authlib_context = planet_auth.Auth.initialize_from_config_dict(client_config=plauth_config,
-                                                                token_file=filename or SECRET_FILE_PATH)
-        #planet_auth_utils.PlanetAuthFactory.initialize_auth_client_context(
+        pl_authlib_context = planet_auth.Auth.initialize_from_config_dict(
+            client_config=plauth_config,
+            token_file=filename or SECRET_FILE_PATH
+        )
+        # planet_auth_utils.PlanetAuthFactory.initialize_auth_client_context(
         #    auth_profile_opt=_BuiltinConfigurationProvider.BUILTIN_PROFILE_NAME_LEGACY,
         #    token_file_opt=filename or SECRET_FILE_PATH
-        #)
+        # )
         return _PLAuthLibAuth(plauth=pl_authlib_context)
 
     @staticmethod
@@ -224,6 +227,7 @@ def store(self, filename: typing.Optional[typing.Union[str, pathlib.Path]] = Non
     def value(self):
         raise DeprecationWarning("Auth.value has been deprecated.")
 
+
 class APIKeyAuthException(PlanetError):
     """exceptions thrown by APIKeyAuth"""
     pass

planet/auth_builtins.py

@@ -18,13 +18,14 @@
 # Needs to be set at runtime (not necessarily at import time) for dependency injection to planet_auth_util
 os.environ["PL_AUTH_BUILTIN_CONFIG_PROVIDER"] = "planet.auth_builtins._BuiltinConfigurationProvider"
 
+
 class _ProductionEnv:
-    PRIMARY_PUBLIC_OAUTH_AUTHORITY_AUTH0 = {
+    OAUTH_AUTHORITY_USER = {
         "_comment": "OIDC/OAuth server used by Planet Public API endpoints",
         "auth_server": "https://login.planet.com/",
         "audiences": ["https://api.planet.com/"]
     }
-    PRIMARY_PUBLIC_OAUTH_AUTHORITY_SENTINELHUB = {
+    OAUTH_AUTHORITY_M2M = {
         "_comment": "OIDC/OAuth server used by Planet Public API endpoints",
         "auth_server": "https://services.sentinel-hub.com/auth/realms/main",
         "audiences": ["https://api.planet.com/"]
@@ -33,26 +34,29 @@ class _ProductionEnv:
         "_comment": "Planet legacy JWT auth server used by Planet Public API endpoints",
         "legacy_auth_endpoint": "https://api.planet.com/v0/auth/login"
     }
-    PRIMARY_PUBLIC_OAUTH_AUTHORITIES = [
-        PRIMARY_PUBLIC_OAUTH_AUTHORITY_AUTH0,
-        PRIMARY_PUBLIC_OAUTH_AUTHORITY_SENTINELHUB,
+    PUBLIC_OAUTH_AUTHORITIES = [
+        OAUTH_AUTHORITY_USER,
+        OAUTH_AUTHORITY_M2M,
     ]
 
+
 _SDK_CLIENT_ID_PROD = "49lHVBYlXCdfIYqE1B9zeXt0iFHSXees"
 
+
 _OIDC_AUTH_CLIENT_CONFIG__SDK_PROD = {
     # The well known OIDC client that is the Planet Python CLI.
     # Developers should register their own clients so that users may
     # manage grants for different applications.  Registering applications
     # also allows for application specific URLs or auth flow selection.
-    **_ProductionEnv.PRIMARY_PUBLIC_OAUTH_AUTHORITY_AUTH0,
+    **_ProductionEnv.OAUTH_AUTHORITY_USER,
     "client_type": "oidc_device_code",
     "client_id": _SDK_CLIENT_ID_PROD,
     "scopes": ["planet", "offline_access", "openid", "profile", "email"],
 }
 
+
 _OIDC_AUTH_CLIENT_CONFIG__M2M_PROD = {
-    **_ProductionEnv.PRIMARY_PUBLIC_OAUTH_AUTHORITY_SENTINELHUB,
+    **_ProductionEnv.OAUTH_AUTHORITY_M2M,
     "client_type": "oidc_client_credentials_secret",
     "scopes": [],
     # "client_id": "__MUST_BE_USER_SUPPLIED__",
@@ -77,53 +81,42 @@ class _BuiltinConfigurationProvider(BuiltinConfigurationProviderInterface):
     library that pertain to the Planet Lab's cloud service.
     """
 
-    # fmt: off
-    ##
-    ## OAuth production environment profiles
-    ##
     # Real
-    #   Using the client ID as a profile name is tricky...
+    #   Using the client ID as a profile name might be nice, but is tricky...
     #   We normalize directory paths to lower case. The auth implementation uses
     #   mixed case ID strings.  The odds of case normalized IDs colliding is low,
     #   but there is a bit of an off smell.
-    # BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID     = _SDK_CLIENT_ID_PROD
-    BUILTIN_PROFILE_NAME_PLANET_USER          = "planet-user"
-    BUILTIN_PROFILE_NAME_PLANET_M2M           = "planet-m2m"
-    # Aliases
-    # BUILTIN_PROFILE_ALIAS_PLANET_USER          = "planet-user"
+    # BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID = _SDK_CLIENT_ID_PROD
+    BUILTIN_PROFILE_NAME_PLANET_USER = "planet-user"
+    BUILTIN_PROFILE_NAME_PLANET_M2M = "planet-m2m"
+    BUILTIN_PROFILE_NAME_LEGACY = "legacy"
 
-    ##
-    ## Profiles that use Planet's old (pre-OAuth) based auth protocol
-    ##
-    BUILTIN_PROFILE_NAME_LEGACY               = "legacy"
+    # Aliases
+    # BUILTIN_PROFILE_ALIAS_PLANET_USER = "planet-user"
 
     _builtin_profile_auth_client_configs = {
-        ## OAuth Client Configs
-        # BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID     : _OIDC_AUTH_CLIENT_CONFIG__SDK_PROD,
-        BUILTIN_PROFILE_NAME_PLANET_USER          : _OIDC_AUTH_CLIENT_CONFIG__SDK_PROD,
-        BUILTIN_PROFILE_NAME_PLANET_M2M           : _OIDC_AUTH_CLIENT_CONFIG__M2M_PROD,
-
-        # Planet Legacy Protocols
-        BUILTIN_PROFILE_NAME_LEGACY            : _LEGACY_AUTH_CLIENT_CONFIG__PROD,
-
-        # Misc
-        # BUILTIN_PROFILE_NAME_NONE              : _NOOP_AUTH_CLIENT_CONFIG,
+        # BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID: _OIDC_AUTH_CLIENT_CONFIG__SDK_PROD,
+        BUILTIN_PROFILE_NAME_PLANET_USER: _OIDC_AUTH_CLIENT_CONFIG__SDK_PROD,
+        BUILTIN_PROFILE_NAME_PLANET_M2M: _OIDC_AUTH_CLIENT_CONFIG__M2M_PROD,
+        BUILTIN_PROFILE_NAME_LEGACY: _LEGACY_AUTH_CLIENT_CONFIG__PROD,
+        # BUILTIN_PROFILE_NAME_NONE: _NOOP_AUTH_CLIENT_CONFIG,
     }
 
     _builtin_profile_aliases = {
-        # BUILTIN_PROFILE_ALIAS_PLANET_USER : BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID,
+        # BUILTIN_PROFILE_ALIAS_PLANET_USER: BUILTIN_PROFILE_NAME_SDKCLI_CLIENT_ID,
     }
+
     _builtin_profile_default_by_client_type = {
-        "oidc_device_code"               : BUILTIN_PROFILE_NAME_PLANET_USER,
-        "oidc_auth_code"                 : BUILTIN_PROFILE_NAME_PLANET_USER,
-        "oidc_client_credentials_secret" : BUILTIN_PROFILE_NAME_PLANET_M2M,
-        "planet_legacy"                  : BUILTIN_PROFILE_NAME_LEGACY,
+        "oidc_device_code": BUILTIN_PROFILE_NAME_PLANET_USER,
+        "oidc_auth_code": BUILTIN_PROFILE_NAME_PLANET_USER,
+        "oidc_client_credentials_secret": BUILTIN_PROFILE_NAME_PLANET_M2M,
+        "planet_legacy": BUILTIN_PROFILE_NAME_LEGACY,
     }
+
     _builtin_trust_realms: Dict[str, Optional[List[dict]]] = {
-        "PRODUCTION": _ProductionEnv.PRIMARY_PUBLIC_OAUTH_AUTHORITIES,
+        "PRODUCTION": _ProductionEnv.PUBLIC_OAUTH_AUTHORITIES,
         "CUSTOM": None,
     }
-    # fmt: on
 
     def builtin_client_authclient_config_dicts(self) -> Dict[str, dict]:
         return self._builtin_profile_auth_client_configs

planet/cli/auth.py

@@ -19,7 +19,6 @@
 import planet_auth
 import planet_auth_utils
 
-import planet
 from .cmds import translate_exceptions
 from ..auth_builtins import _BuiltinConfigurationProvider
 
@@ -45,16 +44,14 @@ def auth(ctx):
     # just storing the API key, and nominally stores legacy API keys in a
     # different location(s).  This planet SDK historically only stored an
     # API key in this file.
-    if (ctx.invoked_subcommand == "init"
-        or ctx.invoked_subcommand == "value"
-        or ctx.invoked_subcommand == "store"
-    ):
+    if (ctx.invoked_subcommand == "init" or ctx.invoked_subcommand == "value" or ctx.invoked_subcommand == "store"):
         # click.echo("Overriding Auth Profile with legacy auth profile.")
         ctx.obj["AUTH"] = planet_auth_utils.PlanetAuthFactory.initialize_auth_client_context(
             auth_profile_opt=_BuiltinConfigurationProvider.BUILTIN_PROFILE_NAME_LEGACY,
             token_file_opt=planet_auth_utils.PlanetAuthUserConfig.default_user_config_file()
         )
 
+
 @auth.command(name="store", deprecated=True)  # type: ignore
 @translate_exceptions
 @click.argument('key')
@@ -63,7 +60,7 @@ def store(key):
     if click.confirm('This overrides the stored value. Continue?'):
         # See above.  A bit of hackery around the token_file to maintain old interface.
         token_file = planet_auth.FileBackedJsonObject(file_path=planet_auth_utils.PlanetAuthUserConfig.default_user_config_file())
-        try :
+        try:
             token_file.load()
             conf_data = token_file.data()
         except FileNotFoundError:
@@ -83,12 +80,10 @@ def store(key):
 auth.add_command(name="profile-show", cmd=planet_auth_utils.cmd_profile_show)
 auth.add_command(name="profile-set", cmd=planet_auth_utils.cmd_profile_set)
 
-planet_auth_utils.cmd_pllegacy_login.name="init"
+planet_auth_utils.cmd_pllegacy_login.name = "init"
 planet_auth_utils.cmd_pllegacy_login.deprecated = True
 auth.add_command(name="init", cmd=planet_auth_utils.cmd_pllegacy_login)
 
 planet_auth_utils.cmd_pllegacy_print_api_key.name = "value"
 planet_auth_utils.cmd_pllegacy_print_api_key.deprecated = True
 auth.add_command(name="value", cmd=planet_auth_utils.cmd_pllegacy_print_api_key)
-
-# TODO: what do we want to expose to Planet SDK and CLI users around auth profiles?

planet/cli/cli.py

@@ -93,12 +93,13 @@ def _configure_logging(verbosity):
         level=log_level,
         format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
+
 # Hide the embedded util from help.  It has many options and use cases that
 # may not be directly the most relevant or user-friendly for the specific
 # case of working against Planet Platform Services.
 # The interface we want to support for the SDK CLI is a specialized
 # subset defined by auth.py.
-planet_auth_utils.cmd_plauth_embedded.hidden=True
+planet_auth_utils.cmd_plauth_embedded.hidden = True
 main.add_command(cmd=planet_auth_utils.cmd_plauth_embedded, name="plauth")  # type: ignore
 
 main.add_command(auth.auth)  # type: ignore

tests/unit/test_auth.py

@@ -12,7 +12,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-import json
 import logging
 
 import pytest
@@ -66,6 +65,7 @@ def test_Auth_from_file_doesnotexist(secret_path):
     with pytest.raises(FileNotFoundError):
         _ = test_auth._plauth.request_authenticator().credential().legacy_api_key()
 
+
 def test_Auth_from_file_wrongformat(secret_path):
     with open(secret_path, 'w') as fp:
         fp.write('{"notkey": "testvar_wrong_format"}')
@@ -74,7 +74,6 @@ def test_Auth_from_file_wrongformat(secret_path):
         _ = test_auth._plauth.request_authenticator().credential().legacy_api_key()
 
 
-
 def test_Auth_from_file_alternate(tmp_path):
     secret_path = str(tmp_path / '.test')
     with open(secret_path, 'w') as fp:
@@ -120,16 +119,14 @@ def test_Auth_from_env_alternate_doesnotexist(monkeypatch):
 
 
 def test_Auth_from_login(monkeypatch):
-    auth_data = 'authdata'
-
     # auth.AuthClient has been completely removed
     # in the conversion to planet_auth
     # def login(*args, **kwargs):
     #     return {'api_key': auth_data}
     #
     # monkeypatch.setattr(auth.AuthClient, 'login', login)
     with pytest.raises(DeprecationWarning):
-        test_auth = auth.Auth.from_login('email', 'pw')
+        _ = auth.Auth.from_login('email', 'pw')
 
 
 def test_auth_value_deprecated():