sparclclient 1.2.1__py2.py3-none-any.whl

sparcl/utils.py

@@ -0,0 +1,209 @@
+# Python library
+import datetime
+import time
+import socket
+import itertools
+import json
+import subprocess
+# External packages
+#   none
+# LOCAL packages
+#   none
+
+
+# data = {
+#     "a": "aval",
+#     "b": {
+#         "b1": {
+#             "b2b": "b2bval",
+#             "b2a": {
+#                 "b3a": "b3aval",
+#                 "b3b": "b3bval"
+#             }
+#         }
+#     }
+# }
+#
+# data1 = AttrDict(data)
+# print(data1.b.b1.b2a.b3b)  # -> b3bval
+class _AttrDict(dict):
+    """Dictionary subclass whose entries can be accessed by attributes
+    (as well as normally).
+    """
+
+    def __init__(self, *args, **kwargs):
+        def from_nested_dict(data):
+            """Construct nested AttrDicts from nested dictionaries."""
+            if not isinstance(data, dict):
+                return data
+            else:
+                return _AttrDict(
+                    {key: from_nested_dict(data[key]) for key in data}
+                )
+
+        super(_AttrDict, self).__init__(*args, **kwargs)
+        self.__dict__ = self
+
+        for key in self.keys():
+            self[key] = from_nested_dict(self[key])
+
+
+def tic():
+    """Start tracking elapsed time. Works in conjunction with toc().
+
+    Args:
+       None.
+    Returns:
+       Elapsed time.
+    """
+    tic.start = time.perf_counter()
+
+
+def toc():
+    """Return elapsed time since previous tic().
+
+    Args:
+       None.
+    Returns:
+       Elapsed time since previous tic().
+    """
+    elapsed_seconds = time.perf_counter() - tic.start
+    return elapsed_seconds  # fractional
+
+
+def here_now():
+    """Used to track info for benchmark. Probably OBE?
+
+    Args:
+       None.
+    Returns:
+       Time, date, and hostname.
+    """
+    hostname = socket.gethostname()
+    now = str(datetime.datetime.now())
+    return (hostname, now)
+
+
+def objform(obj):
+    """Nested structure of python object. Avoid spewing big lists.
+    See also: https://code.activestate.com/recipes/577504/
+
+    Args:
+       obj: Python object.
+    Returns:
+       Length if list, objforms of dict contents if dict, type if
+       anything else.
+    Example:
+       >>> res = client.sample_records(1)[0]
+       >>> objform(res)
+       <class 'sparcl.client.AttrDict'>
+    """
+    # dict((k,len(v)) for (k,v) in qs[0]['spzline'].items())
+    if obj is None:
+        return None
+    elif type(obj) is list:
+        if len(obj) > 999:
+            return f"CNT={len(obj)}"
+        elif len(obj) < 9:
+            return [objform(x) for x in obj]
+        else:
+            return [objform(x) for x in obj[:10]] + ["..."]
+    elif type(obj) is dict:
+        return dict((k, objform(v)) for (k, v) in obj.items())
+    else:
+        return str(type(obj))
+
+
+def dict2tree(obj, name=None, prefix=""):
+    """Return abstracted nested tree. Terminals contain TYPE.
+    As a special case, a list is given as a dict that represents a
+    compound type.  E.G. {'<list(3835)[0]>': float} means a list of
+    3835 elements where the first element is of type 'float'.  NB:
+    Only the type of the first element in a list is given.  If the
+    list has hetergeneous types, that fact is invisible in the
+    structure!!
+    """
+    nextpfx = "" if name is None else (prefix + name + ".")
+    showname = prefix if name is None else (prefix + name)
+    if isinstance(obj, dict):
+        children = dict()
+        for k, v in obj.items():
+            if isinstance(v, dict) or isinstance(v, list):
+                val = dict2tree(v, name=k, prefix=nextpfx)
+            else:
+                #!val = {k: type(v).__name__}
+                val = {nextpfx + k: type(v).__name__}
+            children.update(val)
+        tree = children if name is None else {showname: children}
+    elif isinstance(obj, list):
+        children = f"<list({len(obj)})[0]>:{type(obj[0]).__name__}"
+        tree = {showname: children}
+    else:
+        tree = {showname: type(obj).__name__}
+    return tree
+
+
+def invLUT(lut):
+    """Given dict[k]=v, Return dict[v]=k"""
+    return {v: k for k, v in lut.items()}
+
+
+def count_values(recs):
+    """Count number of non-None values in a list of dictionaries.
+    A key that exists with a value of None is treated the same as a
+    key that does not exist at all. i.e. It does not add to the count.
+
+    Args:
+       recs (:obj:`list`): ('records') List of dictionaries.
+
+    Returns:
+        A dictionary. Keys are the full list of keys available in any
+        of the recs.  Values are the count of occurances of non-None values
+        for that key.
+
+    >>> count_values([dict(a=None, b=3), dict(a=1, b=2), dict(a=None, b=2)])
+    {'a': 1, 'b': 3}
+    """
+    allkeys = set(list(itertools.chain(*recs)))
+    return {k: sum(x.get(k) is not None for x in recs) for k in allkeys}
+
+
+# In case I want to give CURL equivalents for client methods.
+#
+# Retrieve may return results as a pickle file since it usually contains
+# spectra vectors.  To handle pickle results, write curl output to out.pkl
+# and do something like:
+#   with open('out.pkl', 'rb') as f: res = pickle.load(f)
+def curl_retrieve_str(ids, server, svc="spectras", qstr=None):
+    #! ids = ['00000dd7-b1ff-48ed-b162-46d9d65f829c', 'BADID']
+    #!svc = 'spectras' if use_async else 'retrieve'
+    #! qstr = urlencode(uparams)
+    # server = "https://sparc1.datalab.noirlab.edu"
+    qqstr = "" if qstr is None else f"?{qstr}"
+    url = f"{server}/sparc/{svc}/{qqstr}"
+    curlpost1 = "curl -X 'POST' -H 'Content-Type: application/json' "
+    curlpost2 = f"-d '{json.dumps(ids)}' '{url}'"
+    curlpost3 = " | python3 -m json.tool"
+    return curlpost1 + curlpost2 + curlpost3
+
+
+# see: curl_retrieve_str
+def curl_find_str(sspec, server, qstr=None):
+    qqstr = "" if qstr is None else f"?{qstr}"
+    url = f"{server}/sparc/find/{qqstr}"
+    curlpost1 = "curl -X 'POST' -H 'Content-Type: application/json' "
+    curlpost2 = f"-d '{json.dumps(sspec)}' '{url}'"
+    curlpost3 = " | python3 -m json.tool"
+    return curlpost1 + curlpost2 + curlpost3
+
+def githash(verbose=False):
+    try:
+        #  "/usr/bin/git"
+        ret = subprocess.run(["git", "rev-parse", "HEAD"],\
+                             capture_output=True)
+        commit_hash = ret.stdout.decode().strip()
+    except Exception as err:
+        if verbose:
+            print(err)
+        commit_hash = "<NA>"
+    return commit_hash

sparclclient-1.2.1.dist-info/LICENSE

@@ -0,0 +1,31 @@
+Copyright 2022 Association of Universities for Research in
+Astronomy. Original code written by S. Pothier and A. Jacques.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+Redistributions of source code must retain the above copyright &
+attribution notice, this list of conditions, and the following
+disclaimer.
+
+Redistributions in binary form must reproduce the above copyright &
+attribution notice, this list of conditions, and the following
+disclaimer in the documentation and/or other materials provided with
+the distribution.
+
+Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+“AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sparclclient-1.2.1.dist-info/METADATA

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: sparclclient
+Version: 1.2.1
+Summary: A client for getting spectra and meta-data from NOIRLab.
+Author-email: "S. Pothier" <datalab-spectro@noirlab.edu>
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Bug Tracker, https://github.com/pypa/sparclclient/issues
+Project-URL: Documentation, https://sparclclient.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/pypa/sparclclient
+
+# sparclclient
+Python Client for SPARCL (SPectra Analysis and Retrievable Catalog Lab)
+

sparclclient-1.2.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+sparcl/Results.py,sha256=YFh7HmiAfjxQv1y55OHhXsJbpKBh7mn92zPJZ56gJxw,8477
+sparcl/__init__.py,sha256=SluDg17Gz9p8om9iydlLFewwIGJdYiR9VC2R-cXXdXU,934
+sparcl/client.py,sha256=Y8nNwdusP6ZnqE_fvWL1Nfjxlot0SHKHjQdw0hdCl2A,32324
+sparcl/conf.py,sha256=GFNDelaiVIAkjNjvFlG7HAlPpU39nqZmTPohQGmOcgI,928
+sparcl/exceptions.py,sha256=QfK3aTl1HTQmbhUCRfW9eo-rzEA1yUawKGtv_ca4nvY,3801
+sparcl/fields.py,sha256=Oef3KNmWqsqi8BPXuQA7EazLtwgfkqprbrPxev8sCio,5126
+sparcl/gather_2d.py,sha256=mTM9YhsGf2CMOQ-CE4-JcAs1PhA0mVKlciy9dKnp67o,8685
+sparcl/resample_spectra.py,sha256=Z_Lkoq4LapaIQp7tqZ88LayRLE8o9c832Icc0jSr5ok,1282
+sparcl/sparc.ini,sha256=q_wjo9DLnCYRxWFMl0CtMYp4DD1AXfEcK6BP6cmncwo,329
+sparcl/type_conversion.py,sha256=QmXNX9j_7QHnBu83f2ZBfREoql9wuo98ZbhQtSjRRWc,12965
+sparcl/unsupported.py,sha256=bfkkZa-PuqwN-Bqo3vCIrLupbWMDTCiTHPMNfXnqmMc,1848
+sparcl/utils.py,sha256=1u1e9mjOqdJTaywTQah1cnLIEuHEVj2lUJVOx8WpX3I,6287
+sparcl/benchmarks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sparcl/benchmarks/benchmarks.py,sha256=OmlSdnAPLmcvGXsr-HzGyfAAcnoqlO0JQ4EIA7JGhZc,9424
+sparcl/notebooks/sparcl-examples.ipynb,sha256=jdGaSw5KzYHXfPCthwjm0v2QFBcBeMf7-dvfGXwjZTA,257613
+sparclclient-1.2.1.dist-info/LICENSE,sha256=y10EluGMCzGs9X4oYCYyix3l6u-lawB_vlGR8qe442Q,1576
+sparclclient-1.2.1.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+sparclclient-1.2.1.dist-info/METADATA,sha256=1GUhe_YELEavKXmfpXS1BbT7HvXV_TedlSyoGT2eGHc,564
+sparclclient-1.2.1.dist-info/RECORD,,

sparclclient-1.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: flit 3.9.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any