sparclclient 1.2.5b1__py2.py3-none-any.whl → 1.2.6__py2.py3-none-any.whl

sparcl/__init__.py

@@ -34,4 +34,5 @@ __all__ = ["client", "align_records"]
 #__version__ = "1.2.2"
 #__version__ = "1.2.3"
 #__version__ = "1.2.4"
-__version__ = "1.2.5b1"
+#__version__ = "1.2.5"
+__version__ = "1.2.6"

sparcl/client.py

@@ -159,6 +159,9 @@ class SparclClient:  # was SparclApi()
             wait for server to send a response. Generally time to
             wait for first byte. Defaults to 5400.
 
+        announcement (:obj:`bool`, optional): SPARCL announcements.
+            Defaults to True.
+
     Example:
         >>> client = SparclClient()
 
@@ -179,6 +182,7 @@ class SparclClient:  # was SparclApi()
         show_curl=False,
         connect_timeout=1.1,  # seconds
         read_timeout=90 * 60,  # seconds
+        announcement=True,
     ):
         """Create client instance."""
         session = requests.Session()
@@ -193,9 +197,8 @@ 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
@@ -203,10 +206,18 @@ class SparclClient:  # was SparclApi()
         # (connect timeout, read timeout) in seconds
         self.timeout = (self.c_timeout, self.r_timeout)
         # @@@ read timeout should be a function of the POST payload size
+        self.announcement = announcement
 
         if verbose:
             print(f"apiurl={self.apiurl}")
 
+        if announcement:
+            ann = f"{self.apiurl}/announcement/"
+            annres = requests.get(ann, timeout=self.timeout)
+            annstr = annres.json()['announcement']
+            if annstr:
+                print(f"announcement={annstr}")
+
         # Get API Version
         try:
             endpoint = f"{self.apiurl}/version/"
@@ -249,18 +260,19 @@ class SparclClient:  # was SparclApi()
             f" client_hash={ut.githash()},"
             f" verbose={self.verbose},"
             f" connect_timeout={self.c_timeout},"
-            f" read_timeout={self.r_timeout})"
+            f" read_timeout={self.r_timeout},"
+            f" announcement={self.announcement})"
         )
 
     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
@@ -274,8 +286,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
 
@@ -322,8 +334,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
@@ -331,8 +343,8 @@ 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
 
@@ -343,10 +355,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.
@@ -398,10 +412,10 @@ class SparclClient:  # was SparclApi()
         parameter of client.retrieve().
 
         Args:
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to get the default fields. Defaults to None, which
-                will return the intersection of default fields in all
-                data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of
+                data sets from which to get the default fields. Defaults
+                to None, which will return the intersection of default
+                fields in all data sets hosted on the SPARCL database.
 
         Returns:
             List of fields tagged as 'default' from DATASET_LIST.
@@ -415,9 +429,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)
@@ -429,10 +443,10 @@ class SparclClient:  # was SparclApi()
         of client.retrieve().
 
         Args:
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to get all fields. Defaults to None, which
-                will return the intersection of all fields in all
-                data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to get all fields. Defaults to None, which
+                will return the intersection of all fields in all data sets
+                hosted on the SPARCL database.
 
         Returns:
             List of fields tagged as 'all' from DATASET_LIST.
@@ -458,16 +472,15 @@ 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
@@ -487,10 +500,10 @@ class SparclClient:  # was SparclApi()
         client.retreive().
 
         Args:
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to get available fields. Defaults to None, which
-                will return the intersection of all available fields in
-                all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to get available fields. Defaults to None,
+                which will return the intersection of all available fields
+                in all data sets hosted on the SPARCL database.
 
         Returns:
             Set of fields available from data sets in DATASET_LIST.
@@ -543,10 +556,10 @@ class SparclClient:  # was SparclApi()
         """Find records in the SPARCL database.
 
         Args:
-            outfields (:obj:`list`, optional): List of fields to return.
-                Only CORE fields may be passed to this parameter.
-                Defaults to None, which will return only the sparcl_id
-                and _dr fields.
+            outfields (:obj:`list` of :obj:`str`, optional): List of
+                fields to return. Only CORE fields may be passed to
+                this parameter. Defaults to None, which will return
+                only the sparcl_id and _dr fields.
 
             constraints (:obj:`dict`, optional): Key-Value pairs of
                 constraints to place on the record selection. The Key
@@ -591,12 +604,10 @@ 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()  # noqa: E501
             }
         uparams = dict(
             limit=limit,
@@ -622,7 +633,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)
@@ -637,11 +648,11 @@ class SparclClient:  # was SparclApi()
         NOT stored in the SPARCL database.
 
         Args:
-            uuid_list (:obj:`list`): List of sparcl_ids.
+            uuid_list (:obj:`list` of :obj:`str`): List of sparcl_ids.
 
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to find missing sparcl_ids. Defaults to None, meaning
-                all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to find missing sparcl_ids. Defaults to None,
+                meaning all data sets hosted on the SPARCL database.
 
             countOnly (:obj:`bool`, optional): Set to True to return only
                 a count of the missing sparcl_ids from the uuid_list.
@@ -656,16 +667,16 @@ class SparclClient:  # was SparclApi()
 
         Example:
             >>> client = SparclClient()
-            >>> ids = ['ddbb57ee-8e90-4a0d-823b-0f5d97028076',]
-            >>> client.missing(ids)
+            >>> sparcl_ids = ['ddbb57ee-8e90-4a0d-823b-0f5d97028076',]
+            >>> client.missing(uuid_list=sparcl_ids)
             ['ddbb57ee-8e90-4a0d-823b-0f5d97028076']
         """
 
         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))
@@ -692,11 +703,11 @@ class SparclClient:  # was SparclApi()
         NOT stored in the SPARCL database.
 
         Args:
-            specid_list (:obj:`list`): List of specids.
+            specid_list (:obj:`list` of :obj:`int`): List of specids.
 
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to find missing specids. Defaults to None, meaning
-                all data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to find missing specids. Defaults to None,
+                meaning all data sets hosted on the SPARCL database.
 
             countOnly (:obj:`bool`, optional): Set to True to return only
                 a count of the missing specids from the specid_list.
@@ -711,16 +722,15 @@ class SparclClient:  # was SparclApi()
 
         Example:
             >>> client = SparclClient()
-            >>> found = client.find(outfields=['specid'], limit=2)
-            >>> specids = [f.specid for f in found.records]
-            >>> client.missing_specids(specids + ['bad_id'])
-            ['bad_id']
+            >>> specids = [398913623742323421, 6181239242670493696]
+            >>> client.missing_specids(specid_list=specids)
+            [398913623742323421]
         """
         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))
@@ -756,13 +766,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
@@ -780,15 +790,15 @@ class SparclClient:  # was SparclApi()
         sparcl_ids.
 
         Args:
-            uuid_list (:obj:`list`): List of sparcl_ids.
+            uuid_list (:obj:`list` of :obj:`str`): List of sparcl_ids.
 
-            include (:obj:`list`, optional): List of field names to include
-                in each record. Defaults to 'DEFAULT', which will return
-                the fields tagged as 'default'.
+            include (:obj:`list` of :obj:`str`, optional): List of field
+                names to include in each record. Defaults to 'DEFAULT',
+                which will return the fields tagged as 'default'.
 
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to retrieve spectra data. Defaults to None, meaning all
-                data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to retrieve spectra data. Defaults to None,
+                meaning all data sets hosted on the SPARCL database.
 
             limit (:obj:`int`, optional): Maximum number of records to
                 return. Defaults to 500. Maximum allowed is 24,000.
@@ -827,9 +837,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
 
@@ -920,7 +930,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":
@@ -944,26 +954,26 @@ 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"]}')
-        
-        # Format/consolodate the server messages to one message with the count of missing
-        # files
+            print(f"{meta['status']}")
+
+        # Format/consolodate the server messages to one message with
+        # the count of missing files
         if len(meta["status"].get("warnings", [])) > 0:
             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])
+            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)
@@ -983,15 +993,15 @@ class SparclClient:  # was SparclApi()
         specids.
 
         Args:
-            specid_list (:obj:`list`): List of specids.
+            specid_list (:obj:`list` of :obj:`int`): List of specids.
 
-            include (:obj:`list`, optional): List of field names to include
-                in each record. Defaults to 'DEFAULT', which will return
-                the fields tagged as 'default'.
+            include (:obj:`list` of :obj:`str`, optional): List of field
+                names to include in each record. Defaults to 'DEFAULT',
+                which will return the fields tagged as 'default'.
 
-            dataset_list (:obj:`list`, optional): List of data sets from
-                which to retrieve spectra data. Defaults to None, meaning all
-                data sets hosted on the SPARCL database.
+            dataset_list (:obj:`list` of :obj:`str`, optional): List of data
+                sets from which to retrieve spectra data. Defaults to None,
+                meaning all data sets hosted on the SPARCL database.
 
             limit (:obj:`int`, optional): Maximum number of records to
                 return. Defaults to 500. Maximum allowed is 24,000.
@@ -1016,9 +1026,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])}."
@@ -1026,8 +1036,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]
@@ -1036,6 +1048,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"specids 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.5b1.dist-info → sparclclient-1.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.5b1
+Version: 1.2.6
 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.5b1.dist-info → sparclclient-1.2.6.dist-info}/RECORD

@@ -1,6 +1,6 @@
 sparcl/Results.py,sha256=vnACjm8sp7MrsJ_5LTuKMuyRWqeBJxOxQM302cHmAlk,9159
-sparcl/__init__.py,sha256=hahu4a4UYZyFWVRvdhVioUHONvVyQDt1S3dMczOFNkg,1101
-sparcl/client.py,sha256=riepZHgMhxC328GX9vIGOWGMPfn-aIKGFziFYB12d8c,38669
+sparcl/__init__.py,sha256=ddW6kTTKyO62X2WfQ6s_ZDmyc5hIkRBh7C6SsM2KE1s,1122
+sparcl/client.py,sha256=a3uUD19yi_hHAkRtpk-A2gXQ_w1l1LktDFLCrUUAcV0,39876
 sparcl/conf.py,sha256=GFNDelaiVIAkjNjvFlG7HAlPpU39nqZmTPohQGmOcgI,928
 sparcl/exceptions.py,sha256=sznmOMGENHvxutSXlRVWqi87bR2Qiebka7LyR3mAII0,4244
 sparcl/fields.py,sha256=NZUBqDidpbXfeX5F4b306F323xZY2CRIx8eVv-HWTVU,5127
@@ -15,7 +15,7 @@ sparcl/benchmarks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU
 sparcl/benchmarks/benchmarks.py,sha256=OmlSdnAPLmcvGXsr-HzGyfAAcnoqlO0JQ4EIA7JGhZc,9424
 sparcl/benchmarks/sparcl_benchmarking.ipynb,sha256=gwof2hqM9Qb49qzRX-mky7WNqXZCMSB7ry8bX8dImxc,17559
 sparcl/notebooks/sparcl-examples.ipynb,sha256=gEwMKI1x7A1YsVeCsQn1QoMO0ZuIhMUAu3qedTiQ7hM,169268
-sparclclient-1.2.5b1.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
-sparclclient-1.2.5b1.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
-sparclclient-1.2.5b1.dist-info/METADATA,sha256=9lhlH82UUmM1h1FKAe6CJOKDV7CF84pYtBVDFCmRYqY,680
-sparclclient-1.2.5b1.dist-info/RECORD,,
+sparclclient-1.2.6.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
+sparclclient-1.2.6.dist-info/WHEEL,sha256=ssQ84EZ5gH1pCOujd3iW7HClo_O_aDaClUbX4B8bjKY,100
+sparclclient-1.2.6.dist-info/METADATA,sha256=Y8Rgexjy-KrLSpXugWfxnIHfMB6EhwEsWK1b1UyGisg,678
+sparclclient-1.2.6.dist-info/RECORD,,