Auth.write() -> Auth.store() to match CLI command

Author: jreiberkyle

planet/auth.py

@@ -134,9 +134,9 @@ def value(self):
     def to_dict(self) -> dict:
         pass
 
-    def write(self,
+    def store(self,
               filename: Optional[typing.Union[str, pathlib.Path]] = None):
-        '''Write authentication information.
+        '''Store authentication information in secret file.
 
         Parameters:
             filename: Alternate path for the planet secret file.

planet/cli/auth.py

@@ -50,7 +50,7 @@ def init(ctx, email, password):
     '''Obtain and store authentication information'''
     base_url = ctx.obj['BASE_URL']
     plauth = planet.Auth.from_login(email, password, base_url=base_url)
-    plauth.write()
+    plauth.store()
     click.echo('Initialized')
     if os.getenv(ENV_API_KEY):
         click.echo(f'Warning - Environment variable {ENV_API_KEY} already '
@@ -72,7 +72,7 @@ def store(key):
     '''Store authentication information'''
     plauth = planet.Auth.from_key(key)
     if click.confirm('This overrides the stored value. Continue?'):
-        plauth.write()
+        plauth.store()
         click.echo('Updated')
         if os.getenv(ENV_API_KEY):
             click.echo(f'Warning - Environment variable {ENV_API_KEY} already '

tests/unit/test_auth.py

@@ -118,23 +118,23 @@ def login(*args, **kwargs):
     assert test_auth.value == auth_data
 
 
-def test_Auth_write_doesnotexist(tmp_path):
+def test_Auth_store_doesnotexist(tmp_path):
     test_auth = auth.Auth.from_key('test')
     secret_path = str(tmp_path / '.test')
-    test_auth.write(secret_path)
+    test_auth.store(secret_path)
 
     with open(secret_path, 'r') as fp:
         assert json.loads(fp.read()) == {"key": "test"}
 
 
-def test_Auth_write_exists(tmp_path):
+def test_Auth_store_exists(tmp_path):
     secret_path = str(tmp_path / '.test')
 
     with open(secret_path, 'w') as fp:
         fp.write('{"existing": "exists"}')
 
     test_auth = auth.Auth.from_key('test')
-    test_auth.write(secret_path)
+    test_auth.store(secret_path)
 
     with open(secret_path, 'r') as fp:
         assert json.loads(fp.read()) == {"key": "test", "existing": "exists"}