sparclclient 1.2.6b10__tar.gz → 1.2.6b12__tar.gz

{sparclclient-1.2.6b10 → sparclclient-1.2.6b12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.6b10
+Version: 1.2.6b12
 Summary: A client for getting spectra and meta-data from NOIRLab.
 Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
 Description-Content-Type: text/markdown

{sparclclient-1.2.6b10 → sparclclient-1.2.6b12}/sparcl/__init__.py

@@ -35,4 +35,4 @@ __all__ = ["client", "align_records"]
 #__version__ = "1.2.3"
 #__version__ = "1.2.4"
 #__version__ = "1.2.5"
-__version__ = "1.2.6b10"
+__version__ = "1.2.6b12"

{sparclclient-1.2.6b10 → sparclclient-1.2.6b12}/sparcl/client.py

@@ -197,9 +197,7 @@ class SparclClient:  # was SparclApi()
         self.verbose = verbose
         self.show_curl = show_curl  # Show CURL equivalent of client method
         #!self.internal_names = internal_names
-        self.c_timeout = min(
-            MAX_CONNECT_TIMEOUT, float(connect_timeout)
-        )  # seconds
+        self.c_timeout = min(MAX_CONNECT_TIMEOUT, float(connect_timeout))  # seconds
         self.r_timeout = min(MAX_READ_TIMEOUT, float(read_timeout))  # seconds
 
         # require response within this num seconds
@@ -216,7 +214,7 @@ class SparclClient:  # was SparclApi()
             ann = f"{self.apiurl}/announcement/"
             annres = requests.get(ann, timeout=self.timeout)
             annstr = annres.json()['announcement']
-            if annstr is not None:
+            if annstr:
                 print(f"announcement={annstr}")
 
         # Get API Version
@@ -267,13 +265,13 @@ class SparclClient:  # was SparclApi()
 
     def token_expired(self, renew=False):
         """
-            POST http://localhost:8050/sparc/renew_token/
-            Content-Type: application/json
-            {
-              "refresh_token": "..."
-            }
+        POST http://localhost:8050/sparc/renew_token/
+        Content-Type: application/json
+        {
+          "refresh_token": "..."
+        }
 
-            Returns an 'access' token
+        Returns an 'access' token
         """
         now = datetime.datetime.now()
         expired = True
@@ -287,8 +285,8 @@ class SparclClient:  # was SparclApi()
             resp = requests.post(url, json={"refresh_token": self.renew_token})
             resp.raise_for_status()
             data = resp.json()
-            #@print(f"{data=}")
-            self.token = data['access']
+            # @print(f"{data=}")
+            self.token = data["access"]
             self.set_token_exp()
             expired = False
 
@@ -335,8 +333,8 @@ class SparclClient:  # was SparclApi()
         try:
             res.raise_for_status()
             #!print(f"DBG: {res.content=}")
-            self.token = res.json()['access']
-            self.renew_token = res.json()['refresh']
+            self.token = res.json()["access"]
+            self.renew_token = res.json()["refresh"]
             self.session.auth = (email, password)
         except Exception:
             self.session.auth = None
@@ -344,8 +342,7 @@ class SparclClient:  # was SparclApi()
             self.renew_token = None
             self.token_exp = None
             msg = (
-                "Could not login with given credentials."
-                ' Reverted to "Anonymous" user.'
+                'Could not login with given credentials. Reverted to "Anonymous" user.'
             )
             return msg
 
@@ -356,10 +353,12 @@ class SparclClient:  # was SparclApi()
     def set_token_exp(self):
         decoded = jwt.decode(
             self.token,
-            algorithms=['HS256',],
-            options={'verify_signature': False}
+            algorithms=[
+                "HS256",
+            ],
+            options={"verify_signature": False},
         )
-        self.token_exp = datetime.datetime.fromtimestamp(decoded['exp'])
+        self.token_exp = datetime.datetime.fromtimestamp(decoded["exp"])
 
     def logout(self):
         """Logout of the SPARCL service.
@@ -428,9 +427,9 @@ class SparclClient:  # was SparclApi()
         if dataset_list is None:
             dataset_list = self.fields.all_drs
 
-        assert isinstance(
-            dataset_list, (list, set)
-        ), f"DATASET_LIST must be a list. Found {dataset_list}"
+        assert isinstance(dataset_list, (list, set)), (
+            f"DATASET_LIST must be a list. Found {dataset_list}"
+        )
 
         common = set(self.fields.common(dataset_list))
         union = self.fields.default_retrieve_fields(dataset_list=dataset_list)
@@ -471,16 +470,14 @@ class SparclClient:  # was SparclApi()
             drs = self.fields.all_drs if dataset_list is None else dataset_list
             msg = (
                 f'Unknown fields "{",".join(unk)}" given '
-                f'for DataSets {",".join(drs)}. '
-                f'Allowed fields are: {",".join(all)}. '
+                f"for DataSets {','.join(drs)}. "
+                f"Allowed fields are: {','.join(all)}. "
             )
             raise ex.UnknownField(msg)
         return True
 
     def _common_internal(self, *, science_fields=None, dataset_list=None):
-        self._validate_science_fields(
-            science_fields, dataset_list=dataset_list
-        )
+        self._validate_science_fields(science_fields, dataset_list=dataset_list)
 
         if dataset_list is None:
             dataset_list = self.fields.all_drs
@@ -604,12 +601,9 @@ class SparclClient:  # was SparclApi()
         #!                               dataset_list=dataset_list) # DLS-401
         dr = list(dataset_list)[0]
         if len(constraints) > 0:
-            self._validate_science_fields(
-                constraints.keys(), dataset_list=dataset_list
-            )
+            self._validate_science_fields(constraints.keys(), dataset_list=dataset_list)
             constraints = {
-                self.fields._internal_name(k, dr): v
-                for k, v in constraints.items()
+                self.fields._internal_name(k, dr): v for k, v in constraints.items()
             }
         uparams = dict(
             limit=limit,
@@ -635,7 +629,7 @@ class SparclClient:  # was SparclApi()
 
         if res.status_code != 200:
             if verbose and ("traceback" in res.json()):
-                print(f'DBG: Server traceback=\n{res.json()["traceback"]}')
+                print(f"DBG: Server traceback=\n{res.json()['traceback']}")
             raise ex.genSparclException(res, verbose=self.verbose)
 
         found = Found(res.json(), client=self)
@@ -643,9 +637,7 @@ class SparclClient:  # was SparclApi()
             print(f"Record key counts: {ut.count_values(found.records)}")
         return found
 
-    def missing(
-        self, uuid_list, *, dataset_list=None, countOnly=False, verbose=False
-    ):
+    def missing(self, uuid_list, *, dataset_list=None, countOnly=False, verbose=False):
         """Return the subset of sparcl_ids in the given uuid_list that are
         NOT stored in the SPARCL database.
 
@@ -676,9 +668,9 @@ class SparclClient:  # was SparclApi()
 
         if dataset_list is None:
             dataset_list = self.fields.all_drs
-        assert isinstance(
-            dataset_list, (list, set)
-        ), f"DATASET_LIST must be a list. Found {dataset_list}"
+        assert isinstance(dataset_list, (list, set)), (
+            f"DATASET_LIST must be a list. Found {dataset_list}"
+        )
 
         verbose = verbose or self.verbose
         uparams = dict(dataset_list=",".join(dataset_list))
@@ -731,9 +723,9 @@ class SparclClient:  # was SparclApi()
         """
         if dataset_list is None:
             dataset_list = self.fields.all_drs
-        assert isinstance(
-            dataset_list, (list, set)
-        ), f"DATASET_LIST must be a list. Found {dataset_list}"
+        assert isinstance(dataset_list, (list, set)), (
+            f"DATASET_LIST must be a list. Found {dataset_list}"
+        )
 
         verbose = verbose or self.verbose
         uparams = dict(dataset_list=",".join(dataset_list))
@@ -769,13 +761,13 @@ class SparclClient:  # was SparclApi()
         unknown = inc_set.difference(avail_science)
         if len(unknown) > 0:
             msg = (
-                f'The INCLUDE list ({",".join(sorted(include_list))}) '
+                f"The INCLUDE list ({','.join(sorted(include_list))}) "
                 f"contains invalid data field names "
-                f'for Data Sets ({",".join(sorted(dataset_list))}). '
+                f"for Data Sets ({','.join(sorted(dataset_list))}). "
                 f"Unknown fields are: "
-                f'{", ".join(sorted(list(unknown)))}. '
+                f"{', '.join(sorted(list(unknown)))}. "
                 f"Available fields are: "
-                f'{", ".join(sorted(avail_science))}.'
+                f"{', '.join(sorted(avail_science))}."
             )
             raise ex.BadInclude(msg)
         return True
@@ -840,9 +832,9 @@ class SparclClient:  # was SparclApi()
         orig_dataset_list = dataset_list
         if dataset_list is None:
             dataset_list = self.fields.all_drs
-        assert isinstance(
-            dataset_list, (list, set)
-        ), f"DATASET_LIST must be a list. Found {dataset_list}"
+        assert isinstance(dataset_list, (list, set)), (
+            f"DATASET_LIST must be a list. Found {dataset_list}"
+        )
 
         verbose = self.verbose if verbose is None else verbose
 
@@ -933,7 +925,7 @@ class SparclClient:  # was SparclApi()
                 print(f"DBG: Server response=\n{res.text}")
             # @@@ FAILS on invalid JSON. Maybe not json at all !!!
             if verbose and ("traceback" in res.json()):
-                print(f'DBG: Server traceback=\n{res.json()["traceback"]}')
+                print(f"DBG: Server traceback=\n{res.json()['traceback']}")
             raise ex.genSparclException(res, verbose=verbose)
 
         if format == "json":
@@ -957,10 +949,10 @@ class SparclClient:  # was SparclApi()
             count = len(results) - 1
             print(
                 f"Got {count} spectra in "
-                f"{elapsed:.2f} seconds ({count/elapsed:.0f} "
+                f"{elapsed:.2f} seconds ({count / elapsed:.0f} "
                 "spectra/sec)"
             )
-            print(f'{meta["status"]}')
+            print(f"{meta['status']}")
 
         # Format/consolodate the server messages to one message with
         # the count of missing files
@@ -969,14 +961,14 @@ class SparclClient:  # was SparclApi()
             if verbose:
                 print(f"There are {len(warnings)} warnings")
             missingcount = 0
-            missing_message = re.sub(r' [0-9]+ ', ' %s ', warnings[0])
+            missing_message = re.sub(r" [0-9]+ ", " %s ", warnings[0])
             for i in warnings:
-                matches = re.match(r'.* ([0-9]+) out of the ([0-9]+).*', i)
+                matches = re.match(r".* ([0-9]+) out of the ([0-9]+).*", i)
                 if matches:
                     missingcount += int(matches.groups()[0])
 
             # using old style substitution to avoid issue with the {} in the message  # noqa: E501
-            warning_message = missing_message % (missingcount, req_num, missingcount)   # noqa: E501
+            warning_message = missing_message % (missingcount, req_num, missingcount)  # noqa: E501
             warn(warning_message, stacklevel=2)
 
         return Retrieved(results, client=self)
@@ -1029,9 +1021,9 @@ class SparclClient:  # was SparclApi()
             f'The "specid_list" parameter must be a python list. '
             f"You used a value of type {type(specid_list)}."
         )
-        assert (
-            len(specid_list) > 0
-        ), f'The "specid_list" parameter value must be a non-empty list'
+        assert len(specid_list) > 0, (
+            f'The "specid_list" parameter value must be a non-empty list'
+        )
         assert isinstance(specid_list[0], int), (
             f'The "specid_list" parameter must be a python list of INTEGERS. '
             f"You used an element value of type {type(specid_list[0])}."
@@ -1039,8 +1031,10 @@ class SparclClient:  # was SparclApi()
 
         if dataset_list is None:
             constraints = {"specid": specid_list}
+            dr_list = self.fields.all_drs
         else:
             constraints = {"specid": specid_list, "data_release": dataset_list}
+            dr_list = dataset_list
 
         # Science Field Name for uuid.
         dr = list(self.fields.all_drs)[0]
@@ -1049,6 +1043,16 @@ class SparclClient:  # was SparclApi()
         found = self.find([idfld], constraints=constraints, limit=limit)
         if verbose:
             print(f"Found {found.count} matches.")
+        if found.count < len(specid_list):
+            usrcount = len(specid_list)
+            dbcount = found.count
+            warn = (
+                f"UserWarning: Some SPECIDs were not found. "
+                f"{usrcount - dbcount} out of the {usrcount} requested "
+                f"uuids have no records available in the SPARCL database "
+                f"associated with DataSets {dr_list}."
+            )
+            print(warn)
         res = self.retrieve(
             found.ids,
             #! svc=svc,

{sparclclient-1.2.6b10 → sparclclient-1.2.6b12}/tests/tests_api.py

@@ -175,6 +175,7 @@ class SparclClientTest(unittest.TestCase):
             url=serverurl,
             verbose=clverb,
             show_curl=showcurl,
+            announcement=False,
         )
         cls.timing = dict()
         cls.doc = dict()
@@ -728,7 +729,7 @@ class AuthTest(unittest.TestCase):
             )
 
         cls.client = sparcl.client.SparclClient(
-            url=serverurl, verbose=clverb, show_curl=showcurl
+            url=serverurl, verbose=clverb, show_curl=showcurl,
         )
 
         global show_run_context