Merge pull request #679 from bsipocz/keyring_login_add_retype_password

Add retype_password parameter for keyring using login()s

Author: keflavich

astroquery/alma/__init__.py

@@ -10,15 +10,19 @@ class Conf(_config.ConfigNamespace):
     Configuration parameters for `astroquery.alma`.
     """
 
-    timeout = _config.ConfigItem(60, "Timeout in seconds")
+    timeout = _config.ConfigItem(60, "Timeout in seconds.")
 
     archive_url = _config.ConfigItem(
         ['http://almascience.org',
          'http://almascience.eso.org',
          'http://almascience.nrao.edu',
          'http://almascience.nao.ac.jp',
          'http://beta.cadc-ccda.hia-iha.nrc-cnrc.gc.ca'],
-        'The ALMA Archive mirror to use')
+        'The ALMA Archive mirror to use.')
+
+    username = _config.ConfigItem(
+        "",
+        'Optional default username for ALMA archive.')
 
 conf = Conf()
 

astroquery/alma/core.py

@@ -24,7 +24,7 @@
 import astropy.io.votable as votable
 
 from ..exceptions import (RemoteServiceError, TableParseError,
-                          InvalidQueryError)
+                          InvalidQueryError, LoginError)
 from ..utils import commons, system_tools
 from ..utils.process_asyncs import async_to_sync
 from ..query import QueryWithLogin
@@ -38,6 +38,7 @@ class AlmaClass(QueryWithLogin):
 
     TIMEOUT = conf.timeout
     archive_url = conf.archive_url
+    USERNAME = conf.username
 
     def __init__(self):
         super(AlmaClass, self).__init__()
@@ -394,7 +395,31 @@ def _parse_result(self, response, verbose=False):
         table = first_table.to_table(use_names_over_ids=True)
         return table
 
-    def _login(self, username, store_password=False):
+    def _login(self, username=None, store_password=False,
+               reenter_password=False):
+        """
+        Login to the ALMA Science Portal.
+
+        Parameters
+        ----------
+        username : str, optional
+            Username to the ALMA Science Portal. If not given, it should be
+            specified in the config file.
+        store_password : bool, optional
+            Stores the password securely in your keyring. Default is False.
+        reenter_password : bool, optional
+            Asks for the password even if it is already stored in the
+            keyring. This is the way to overwrite an already stored passwork
+            on the keyring. Default is False.
+        """
+
+        if username is None:
+            if self.USERNAME == "":
+                raise LoginError("If you do not pass a username to login(), "
+                                 "you should configure a default one!")
+            else:
+                username = self.USERNAME
+
         # Check if already logged in
         loginpage = self._request("GET", "https://asa.alma.cl/cas/login",
                                   cache=False)
@@ -404,8 +429,12 @@ def _login(self, username, store_password=False):
             return True
 
         # Get password from keyring or prompt
-        password_from_keyring = keyring.get_password("astroquery:asa.alma.cl",
-                                                     username)
+        if reenter_password is False:
+            password_from_keyring = keyring.get_password(
+                "astroquery:asa.alma.cl", username)
+        else:
+            password_from_keyring = None
+
         if password_from_keyring is None:
             if system_tools.in_ipynb():
                 log.warn("You may be using an ipython notebook:"

astroquery/cosmosim/__init__.py

@@ -21,13 +21,16 @@ class Conf(_config.ConfigNamespace):
 
     query_url = _config.ConfigItem(
         ['http://www.cosmosim.org/uws/query'],
-        'CosmoSim UWS query URL')
+        'CosmoSim UWS query URL.')
     schema_url = _config.ConfigItem(
         ['http://www.cosmosim.org/query/account/databases/json'],
-        'CosmoSim json query URL for generating database schema')
+        'CosmoSim json query URL for generating database schema.')
     timeout = _config.ConfigItem(
         60.0,
-        'Timeout for CosmoSim query')
+        'Timeout for CosmoSim query.')
+    username = _config.ConfigItem(
+        "",
+        'Optional default username for CosmoSim database.')
 
 conf = Conf()
 

astroquery/cosmosim/core.py

@@ -23,6 +23,7 @@
 # Astroquery imports
 from ..query import QueryWithLogin
 from . import conf
+from ..exceptions import LoginError
 
 conf.max_lines = -1
 conf.max_width = -1
@@ -35,11 +36,34 @@ class CosmoSimClass(QueryWithLogin):
     QUERY_URL = conf.query_url
     SCHEMA_URL = conf.schema_url
     TIMEOUT = conf.timeout
+    USERNAME = conf.username
 
     def __init__(self):
         super(CosmoSimClass, self).__init__()
 
-    def _login(self, username, password=None, store_password=False):
+    def _login(self, username=None, password=None, store_password=False,
+               reenter_password=False):
+        """
+        Login to the CosmoSim database.
+
+        Parameters
+        ----------
+        username : str, optional
+            Username to the CosmoSim database. If not given, it should be
+            specified in the config file.
+        store_password : bool, optional
+            Stores the password securely in your keyring. Default is False.
+        reenter_password : bool, optional
+            Asks for the password even if it is already stored in the
+            keyring. This is the way to overwrite an already stored passwork
+            on the keyring. Default is False.
+        """
+        if username is None:
+            if self.USERNAME == "":
+                raise LoginError("If you do not pass a username to login(), "
+                                 "you should configure a default one!")
+            else:
+                username = self.USERNAME
 
         # login after logging out (interactive)
         if not hasattr(self, 'session'):
@@ -55,9 +79,13 @@ def _login(self, username, password=None, store_password=False):
         self.username = username
 
         # Get password from keyring or prompt
-        password_from_keyring = keyring.get_password(
-            "astroquery:www.cosmosim.org", self.username)
-        if not password_from_keyring:
+        if reenter_password is False:
+            password_from_keyring = keyring.get_password(
+                "astroquery:www.cosmosim.org", self.username)
+        else:
+            password_from_keyring = None
+
+        if password_from_keyring is None:
             logging.warning("No password was found in the keychain for the "
                             "provided username.")
             if password:

astroquery/eso/core.py

@@ -171,7 +171,7 @@ def _activate_form(self, response, form_index=0, inputs={}, cache=True,
         return response
 
     def _login(self, username=None, store_password=False,
-               retype_password=False):
+               reenter_password=False):
         """
         Login to the ESO User Portal.
 
@@ -182,7 +182,7 @@ def _login(self, username=None, store_password=False,
             specified in the config file.
         store_password : bool, optional
             Stores the password securely in your keyring. Default is False.
-        retype_password : bool, optional
+        reenter_password : bool, optional
             Asks for the password even if it is already stored in the
             keyring. This is the way to overwrite an already stored passwork
             on the keyring. Default is False.
@@ -195,7 +195,7 @@ def _login(self, username=None, store_password=False,
                 username = self.USERNAME
 
         # Get password from keyring or prompt
-        if retype_password is False:
+        if reenter_password is False:
             password_from_keyring = keyring.get_password(
                 "astroquery:www.eso.org", username)
         else:
@@ -318,7 +318,7 @@ def query_surveys(self, surveys='', cache=True,
                 query_dict["max_rows_returned"] = self.ROW_LIMIT
             else:
                 query_dict["max_rows_returned"] = 10000
-    
+
             survey_response = self._activate_form(survey_form, form_index=0,
                                                   inputs=query_dict, cache=cache)