sparclclient 1.2.2b7__py2.py3-none-any.whl → 1.2.2b9__py2.py3-none-any.whl

sparcl/__init__.py

@@ -31,4 +31,4 @@ __all__ = ["client", "align_records"]
 # __version__ = "1.2.1b3"
 # __version__ = "1.2.1"
 # FIRST uncommented value will be used! (so only leave one uncommented)
-__version__ = "1.2.2b7"
+__version__ = "1.2.2b9"

sparcl/client.py

@@ -250,17 +250,19 @@ class SparclClient:  # was SparclApi()
             email (:obj:`str`): User login email.
 
             password (:obj:`str`, optional): User SSO password.
-                If not given, the output will
-                prompt the user to enter in their SSO password.
+                If not given, the output will prompt the user
+                to enter in their SSO password.
 
         Returns:
             None.
 
         Example:
-            >>> client = SparclClient()
-            >>> client.login('test_user@noirlab.edu', 'test123')
+            >>>
+            >> client = SparclClient()
+            >> client.login('test_user@noirlab.edu', 'testpw')
             Logged in successfully with email='test_user@noirlab.edu'
         """
+
         if email is None:  # "logout"
             old_email = self.session.auth[0] if self.session.auth else None
             self.session.auth = None
@@ -308,9 +310,9 @@ class SparclClient:  # was SparclApi()
         Example:
             >>> client = SparclClient()
             >>> client.logout()
-            Logged-out successfully.
-            Previously logged-in with email test_user@noirlab.edu.
+            Logged-out successfully.  Previously logged-in with email None.
         """
+
         return self.login(None)
 
     @property
@@ -322,8 +324,8 @@ class SparclClient:  # was SparclApi()
         auth_status = response.json()
         #! print(f"DBG authorized: {auth_status=}")
 
-        username = auth_status.get('Loggedin_User')
-        all_private_drs = set(auth_status.get("All_Private_Datasets"))
+        username = auth_status.get("Loggedin_User")
+        #! all_private_drs = set(auth_status.get("All_Private_Datasets"))
         all_public_drs = set(auth_status.get("All_Public_Datasets"))
         auth_drs = set(auth_status.get("Authorized_Private_Datasets"))
         res = dict(
@@ -446,7 +448,8 @@ class SparclClient:  # was SparclApi()
         Example:
             >>> client = SparclClient()
             >>> sorted(client.get_available_fields())
-            ['data_release', 'datasetgroup', 'dateobs', 'dateobs_center', 'dec', 'dirpath', 'exptime', 'extra_files', 'filename', 'filesize', 'flux', 'instrument', 'ivar', 'mask', 'model', 'ra', 'redshift', 'redshift_err', 'redshift_warning', 'site', 'sparcl_id', 'specid', 'specprimary', 'spectype', 'survey', 'targetid', 'telescope', 'updated', 'wave_sigma', 'wavelength', 'wavemax', 'wavemin']
+            ['data_release', 'datasetgroup', 'dateobs', 'dateobs_center', 'dec', 'exptime', 'extra_files', 'file', 'flux', 'instrument', 'ivar', 'mask', 'model', 'ra', 'redshift', 'redshift_err', 'redshift_warning', 'site', 'sparcl_id', 'specid', 'specprimary', 'spectype', 'survey', 'targetid', 'telescope', 'updated', 'wave_sigma', 'wavelength', 'wavemax', 'wavemin']
+
         """  # noqa: E501
 
         drs = self.fields.all_drs if dataset_list is None else dataset_list
@@ -465,7 +468,7 @@ class SparclClient:  # was SparclApi()
         Example:
             >>> client = SparclClient()
             >>> client.version
-            9.0
+            11.0
         """
 
         if self.apiversion is None:
@@ -655,8 +658,9 @@ class SparclClient:  # was SparclApi()
             are NOT stored in the SPARCL database.
 
         Example:
-            >>> client = SparclClient(url=_PAT)
-            >>> specids = ['7972592460248666112', '3663710814482833408']
+            >>> client = SparclClient(url=_DEV)
+            >>> found = client.find(outfields=['specid'], limit=2)
+            >>> specids = [f.specid for f in found.records]
             >>> client.missing_specids(specids + ['bad_id'])
             ['bad_id']
         """
@@ -743,7 +747,7 @@ class SparclClient:  # was SparclApi()
 
         Example:
             >>> client = SparclClient()
-            >>> ids = ['00000f0b-07db-4234-892a-6e347db79c89',]
+            >>> ids = client.find(limit=1).ids
             >>> inc = ['sparcl_id', 'flux', 'wavelength', 'model']
             >>> ret = client.retrieve(uuid_list=ids, include=inc)
             >>> type(ret.records[0].wavelength)
@@ -766,6 +770,7 @@ class SparclClient:  # was SparclApi()
         format = "pkl"  # 'json',
         chunk = 500
 
+        orig_dataset_list = dataset_list
         if dataset_list is None:
             dataset_list = self.fields.all_drs
         assert isinstance(
@@ -807,8 +812,13 @@ class SparclClient:  # was SparclApi()
             #! "chunk_len": chunk,
             "format": format,
             #! "1thread": "yes",  # @@@ 7.3.2023
-            "dataset_list": ",".join(dataset_list),
+            #!"dataset_list": ",".join(dataset_list),
         }
+        # Do not put dataset_list in server call if it wasn't in client call.
+        # Else will interfer with defaulting behavior of AUTH (DLS-504).
+        if orig_dataset_list is not None:
+            uparams["dataset_list"] = ",".join(dataset_list)
+
         qstr = urlencode(uparams)
 
         #!url = f'{self.apiurl}/retrieve/?{qstr}'

sparcl/exceptions.py

@@ -21,6 +21,8 @@ def genSparclException(response, verbose=False):
         return UnknownField(status.get("errorMessage"))
     elif status.get("errorCode") == "BADCONST":
         return BadSearchConstraint(status.get("errorMessage"))
+    elif status.get("errorCode") == "NODRACCESS":
+        return AccessNotAllowed(status.get("errorMessage"))
     else:
         return UnknownServerError(
             f"{status.get('errorMessage')} "
@@ -34,7 +36,7 @@ class BaseSparclException(Exception):
 
     error_code = "UNKNOWN"
     error_message = "<NA>"
-    traceback = None
+    traceback = True
 
     def get_subclass_name(self):
         return self.__class__.__name__
@@ -140,4 +142,8 @@ class NoIDs(BaseSparclException):
     error_code = "NOIDS"
 
 
+class AccessNotAllowed(BaseSparclException):
+    error_code = "DSDENIED"
+
+
 # error_code values should be no bigger than 8 characters 12345678

sparcl/gather_2d.py

@@ -195,7 +195,7 @@ def align_records(records, fields=["flux", "wavelength"], precision=7):
         >>> got = client.retrieve(found.ids, include=specflds)
         >>> ar_dict, grid = align_records(got.records, fields=specflds)
         >>> ar_dict['model'].shape
-        (21, 4666)
+        (21, 4669)
 
     """
     # Report Garbage In