sparclclient 1.2.3b8__tar.gz → 1.2.4b2__tar.gz

{sparclclient-1.2.3b8 → sparclclient-1.2.4b2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.3b8
+Version: 1.2.4b2
 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.3b8 → sparclclient-1.2.4b2}/sparcl/Results.py

@@ -10,7 +10,7 @@ from sparcl.utils import _AttrDict
 # from sparcl.gather_2d import bin_spectra_records
 import sparcl.exceptions as ex
 from warnings import warn
-
+import re
 
 class Results(UserList):
     def __init__(self, dict_list, client=None):
@@ -18,7 +18,7 @@ class Results(UserList):
         self.hdr = dict_list[0]
         self.recs = dict_list[1:]
         self.client = client
-        self.fields = client.fields
+        self.fields = client.fields if client else []
         self.to_science_fields()
 
         # HACK 12/14/2023 -sp- to fix UUID problem presumably
@@ -41,7 +41,25 @@ class Results(UserList):
     def info(self):
         """Info about this collection.
         e.g. Warnings, parameters used to get the collection, etc."""
-        return self.hdr
+        # Consolodate "Successfully found...." messages
+        cln_hdr = self.hdr.copy()
+        count = 0
+        success_msg = ""
+        info = []
+        for msg in cln_hdr['status']['info']:
+            if "Successfully" in msg:
+                matches = re.search('Successfully found ([0-9]*)', msg)
+                count += int(matches.groups()[0]) if len(matches.groups()) > 0 else 0  # noqa: E501
+                success_msg = msg
+            else:
+                info.append(msg)
+
+        if count > 0:
+            msg = re.sub(r'[0-9]+', str(count), success_msg, count=1)
+            info.append(msg)
+
+        cln_hdr['status']['info'] = info
+        return cln_hdr
 
     @property
     def count(self):

{sparclclient-1.2.3b8 → sparclclient-1.2.4b2}/sparcl/__init__.py

@@ -32,4 +32,5 @@ __all__ = ["client", "align_records"]
 # __version__ = "1.2.1"
 # FIRST uncommented value will be used! (so only leave one uncommented)
 #__version__ = "1.2.2"
-__version__ = "1.2.3b8"
+#__version__ = "1.2.3"
+__version__ = "1.2.4b2"

{sparclclient-1.2.3b8 → sparclclient-1.2.4b2}/sparcl/client.py

@@ -25,6 +25,7 @@ from warnings import warn
 import pickle
 import getpass
 import datetime
+import re
 
 #!from pathlib import Path
 import tempfile
@@ -223,7 +224,8 @@ class SparclClient:  # was SparclApi()
             msg = (
                 f"The SPARCL Client you are running expects an older "
                 f"version of the API services. "
-                f'Please upgrade to the latest "sparclclient".  '
+                f'Please upgrade to the latest "sparclclient" using  '
+                f'"pip install --upgrade sparclclient". '
                 f"The Client you are using expected version "
                 f"{SparclClient.KNOWN_GOOD_API_VERSION} but got "
                 f"{self.apiversion} from the SPARCL Server "
@@ -944,7 +946,19 @@ class SparclClient:  # was SparclApi()
             print(f'{meta["status"]}')
 
         if len(meta["status"].get("warnings", [])) > 0:
-            warn(f"{'; '.join(meta['status'].get('warnings'))}", stacklevel=2)
+            warnings = meta["status"].get("warnings")
+            if verbose:
+                print(f"There are {len(warnings)} warnings")
+            missingcount = 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)
+                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, limit, missingcount)   # noqa: E501
+            warn(warning_message, stacklevel=2)
 
         return Retrieved(results, client=self)
 

{sparclclient-1.2.3b8 → sparclclient-1.2.4b2}/tests/expected_pat.py

@@ -87,9 +87,11 @@ authorized_1 = {
     "Loggedin_As": "test_user_1@noirlab.edu",
     "Authorized_Datasets": {
         "BOSS-DR16",
+        "BOSS-DR17",
         "DESI-DR1",
         "DESI-EDR",
         "SDSS-DR16",
+        "SDSS-DR17",
         "SDSS-DR17-test",
     },
 }
@@ -107,20 +109,22 @@ authorized_3 = {
 # Private and Public
 pub_1 = ["BOSS-DR16"]
 pub_all = ["BOSS-DR16", "DESI-EDR", "SDSS-DR16"]
-priv = ["DESI-DR1", "SDSS-DR17-test"]
+priv = ["DESI-DR1", "SDSS-DR17-test", "BOSS-DR17", "SDSS-DR17"]
 all_all = pub_all + priv
 all_all.sort()
+privpub1 = [pub_all[0], priv[0]]
 unauth = "test_user_2@noirlab.edu"
 #
-auth_find_1 = auth_find_2 = all_all
+auth_find_1 = privpub1
+auth_find_2 = ['DESI-DR1', 'DESI-EDR']
 auth_find_3 = auth_retrieve_3 = (f"[DSDENIED] uname='{unauth}' is declined "
-                                 f"access to datasets={priv}; "
-                                 f"drs_requested={all_all} "
+                                 f"access to datasets={[priv[0]]}; "
+                                 f"drs_requested={privpub1} "
                                  f"my_auth={pub_all}")
 auth_find_4 = auth_find_6 = pub_all
 auth_find_5 = auth_retrieve_6 = ("[DSDENIED] uname='ANONYMOUS' is declined "
-                                 f"access to datasets={priv}; "
-                                 f"drs_requested={all_all} "
+                                 f"access to datasets={[priv[0]]}; "
+                                 f"drs_requested={privpub1} "
                                  f"my_auth={pub_all}")
-auth_retrieve_1 = auth_retrieve_2 = pub_1 + priv
+auth_retrieve_1 = auth_retrieve_2 = privpub1
 auth_retrieve_4 = auth_retrieve_5 = auth_retrieve_7 = auth_retrieve_8 = pub_1

{sparclclient-1.2.3b8 → sparclclient-1.2.4b2}/tests/tests_api.py

@@ -757,9 +757,10 @@ class AuthTest(unittest.TestCase):
 
         # Dataset lists
         cls.Pub = ["BOSS-DR16", "DESI-EDR", "SDSS-DR16"]
-        cls.Priv = ["DESI-DR1", "SDSS-DR17-test"]
+        cls.Priv = ["DESI-DR1", "SDSS-DR17-test", "BOSS-DR17", "SDSS-DR17"]
         cls.PrivPub = cls.Priv + cls.Pub
         cls.PrivPub.sort()
+        cls.PrivPub1 = [cls.Priv[0], cls.Pub[0]]
 
         # Sample list of sparcl_ids from each data set
         out = ["sparcl_id"]
@@ -773,7 +774,7 @@ class AuthTest(unittest.TestCase):
         cls.uuid_priv = (
             cls.client.find(
                 outfields=out,
-                constraints={"data_release": cls.Priv},
+                constraints={"data_release": [cls.Priv[0]]},
                 limit=2,
                 sort="sparcl_id",
             )
@@ -920,7 +921,7 @@ class AuthTest(unittest.TestCase):
             print(f"authorized_3: actual={actual}")
         self.assertEqual(actual, exp.authorized_3, msg="Actual to Expected")
 
-    def auth_find(self, user, drs, expvar, limit=21000):
+    def auth_find(self, user, drs, expvar, cons={}, limit=21000):
         expected = eval(expvar)  # e.g. 'ep.retrieve_N'
         #!print(f'{expvar}: {user=} {drs=} ')
         self.silent_login(user, usrpw)
@@ -928,7 +929,11 @@ class AuthTest(unittest.TestCase):
         out = self.outflds
         try:
             if drs is None:
-                found = self.client.find(outfields=out, limit=limit)
+                found = self.client.find(
+                    outfields=out,
+                    constraints=cons,
+                    limit=limit
+                )
             else:
                 found = self.client.find(
                     outfields=out,
@@ -982,7 +987,7 @@ class AuthTest(unittest.TestCase):
         """Test find method with authorized user; private data set specified.
         Should find Authorized Private DR"""
         exp = "exp.auth_find_1"
-        self.auth_find(self.auth_user, self.PrivPub, exp)
+        self.auth_find(self.auth_user, self.PrivPub1, exp)
 
     # | find | Auth | None | PASS |
     # @skip("Does not return Priv")  # @@@
@@ -990,13 +995,14 @@ class AuthTest(unittest.TestCase):
         """Test find method with authorized user; no data sets specified.
         Should find Authorized Private DR"""
         exp = "exp.auth_find_2"
-        self.auth_find(self.auth_user, None, exp)
+        constr = {'datasetgroup': ['DESI']}
+        self.auth_find(self.auth_user, None, exp, cons=constr)
 
     # | find | Unauth | Priv,Pub | FAIL |
     def test_auth_find_3(self):
         """Test find method with unauthorized user; private data set"""
         exp = "exp.auth_find_3"
-        self.auth_find(self.unauth_user, self.PrivPub, exp)
+        self.auth_find(self.unauth_user, self.PrivPub1, exp)
 
     # | find | Unauth | None | PASS |
     def test_auth_find_4(self):
@@ -1009,7 +1015,7 @@ class AuthTest(unittest.TestCase):
         """Test find method with anonymous user; private data set
         specified"""
         exp = "exp.auth_find_5"
-        self.auth_find(None, self.PrivPub, exp)
+        self.auth_find(None, self.PrivPub1, exp)
 
     # | find | Anon | None | PASS |
     def test_auth_find_6(self):
@@ -1022,7 +1028,7 @@ class AuthTest(unittest.TestCase):
     def test_auth_retrieve_1(self):
         """Retrieve method with authorized user; private data set specified"""
         exp = "exp.auth_retrieve_1"
-        self.auth_retrieve(self.auth_user, self.PrivPub, exp)
+        self.auth_retrieve(self.auth_user, self.PrivPub1, exp)
 
     # | retrieve | Auth | None | PASS |
     # @skip("Does not return Priv")  # @@@
@@ -1036,7 +1042,7 @@ class AuthTest(unittest.TestCase):
     def test_auth_retrieve_3(self):
         """Retrieve method with unauthorized user; private dataset specified"""
         exp = "exp.auth_retrieve_3"
-        self.auth_retrieve(self.unauth_user, self.PrivPub, exp)
+        self.auth_retrieve(self.unauth_user, self.PrivPub1, exp)
 
     # | retrieve | Unauth | None | PASS |
     # Should PASS since default (no data sets) means only
@@ -1059,7 +1065,7 @@ class AuthTest(unittest.TestCase):
         """Retrieve method with anonymous user; private data set specified"""
         self.silent_logout()
         exp = "exp.auth_retrieve_6"
-        self.auth_retrieve(None, self.PrivPub, exp)
+        self.auth_retrieve(None, self.PrivPub1, exp)
         #!# Replace exception name below once real one is created
 
     # | retrieve | Anon | None | PASS |