sparclclient 1.2.6b12__tar.gz → 1.2.6b13__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sparclclient
-Version: 1.2.6b12
+Version: 1.2.6b13
 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.6b12 → sparclclient-1.2.6b13}/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.6b12"
+__version__ = "1.2.6b13"

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

@@ -197,7 +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
@@ -342,7 +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
 
@@ -410,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.
@@ -441,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.
@@ -477,7 +479,8 @@ class SparclClient:  # was SparclApi()
         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
@@ -497,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.
@@ -553,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
@@ -601,9 +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,
@@ -637,16 +641,18 @@ 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.
 
         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.
@@ -661,8 +667,8 @@ 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']
         """
 
@@ -697,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.
@@ -716,10 +722,9 @@ 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
@@ -785,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.
@@ -988,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.
@@ -1047,9 +1052,9 @@ class SparclClient:  # was SparclApi()
             usrcount = len(specid_list)
             dbcount = found.count
             warn = (
-                f"UserWarning: Some SPECIDs were not found. "
+                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"specids have no records available in the SPARCL database "
                 f"associated with DataSets {dr_list}."
             )
             print(warn)

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

@@ -287,7 +287,7 @@ class SparclClientTest(unittest.TestCase):
 
     def test_missing_specids_1(self):
         """Specids (not UUID) missing"""
-        badid = "NOT_SPEC_ID"
+        badid = 0
         specids = set([badid] + self.specid_list0[:1])
         missing = set(self.client.missing_specids(specids, verbose=False))
         if showact: