cdasws 1.8.10__py3-none-any.whl → 1.8.11__py3-none-any.whl

cdasws/__init__.py

@@ -102,7 +102,7 @@ try:
 except ImportError:
     try:
         import cdflib as cdf
-        import xarray as xr
+        import xarray as xr   # pylint: disable=ungrouped-imports
         CDF_XARRAY_AVAILABLE = True
         def cdf_to_xarray(filename, to_datetime=False, to_unixtime=False,
                           fillval_to_nan=False):
@@ -130,14 +130,21 @@ except ImportError:
             xarray.dataset
                 An XArray Dataset object.
             """
-            return cdf.cdf_to_xarray(filename, to_datetime=to_datetime,
+            return cdf.cdf_to_xarray(filename, to_datetime=to_datetime, # pylint: disable=no-member
                                      to_unixtime=to_unixtime,
                                      fillval_to_nan=fillval_to_nan)
     except ImportError:
         CDF_XARRAY_AVAILABLE = False
 
 
-__version__ = "1.8.10"
+try:
+    import requests_cache
+    CACHE_AVAILABLE = True
+except ImportError:
+    CACHE_AVAILABLE = False
+
+
+__version__ = "1.8.11"
 
 
 #
@@ -231,7 +238,8 @@ class CdasWs:
             proxy=None,
             ca_certs=None,
             disable_ssl_certificate_validation=False,
-            user_agent=None):
+            user_agent=None,
+            disable_cache=False):
         """
         Creates an object representing the CDAS web services.
 
@@ -259,6 +267,8 @@ class CdasWs:
             Flag indicating whether to validate the SSL certificate.
         user_agent
             A value that is appended to the HTTP User-Agent value.
+        disable_cache
+            Flag indicating whether to disable HTTP caching.
         """
 
         self.logger = logging.getLogger(type(self).__name__)
@@ -268,6 +278,7 @@ class CdasWs:
         self.logger.debug('ca_certs = %s', ca_certs)
         self.logger.debug('disable_ssl_certificate_validation = %s',
                           disable_ssl_certificate_validation)
+        self.logger.debug('disable_cache = %s', disable_cache)
 
         if endpoint is None:
             self._endpoint = 'https://cdaweb.gsfc.nasa.gov/WS/cdasr/1/dataviews/sp_phys/'
@@ -288,7 +299,12 @@ class CdasWs:
             'User-Agent' : self._user_agent,
             #'Accept-Encoding' : 'gzip'  # only beneficial for icdfml responses
         }
-        self._session = requests.Session()
+        if CACHE_AVAILABLE and disable_cache is not True:
+            self._session = requests_cache.CachedSession('cdasws_cache',
+                                                         cache_control=True)
+        else:
+            self._session = requests.Session()
+
         self._session.headers.update(self._request_headers)
         self._session.auth = NullAuth()
 
@@ -961,7 +977,8 @@ class CdasWs:
 
         url = 'https://doi.org/' + doi
         headers = {'Accept': 'text/x-bibliography; style=apa'}
-        response = requests.get(url, headers=headers)
+        response = requests.get(url, headers=headers,
+                                timeout=30)
 
         return response.text
 

cdasws/__main__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2024 United States Government as represented by
+# Copyright (c) 2018-2025 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -34,7 +34,7 @@
 Example Coordinate Data Analysis System (CDAS) web service client.
 Includes example calls to most of the web services.
 
-Copyright © 2018-2024 United States Government as represented by the
+Copyright © 2018-2025 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
@@ -42,6 +42,7 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 import sys
 import getopt
 import json
+import time
 import logging
 import logging.config
 from typing import List
@@ -56,7 +57,7 @@ from cdasws.datarepresentation import DataRepresentation
 logging.basicConfig()
 LOGGING_CONFIG_FILE = 'logging_config.json'
 try:
-    with open(LOGGING_CONFIG_FILE, 'r') as fd:
+    with open(LOGGING_CONFIG_FILE, 'r', encoding='utf-8') as fd:
         logging.config.dictConfig(json.load(fd))
 except BaseException as exc:    # pylint: disable=broad-except
     if not isinstance(exc, FileNotFoundError):
@@ -85,9 +86,10 @@ def print_usage(
     -------
     None
     """
-    print('USAGE: {name} [-e url][-d][-c cacerts][-h]'.format(name=name))
+    print(f'USAGE: {name} [-e url][-d][-c cacerts][-n][-h]')
     print('WHERE: url = CDAS web service endpoint URL')
     print('       -d disables TLS server certificate validation')
+    print('       -n disables the use of http caching')
     print('       cacerts = CA certificate filename')
 
 
@@ -108,13 +110,14 @@ def example(
             containing the CA certificates to use.<br>
         -d or --disable-cert-check to disable verification of the server's
             certificate
+        -n or --nocache disables the use of http caching
         -h or --help prints help information.
     """
 
     try:
-        opts = getopt.getopt(argv[1:], 'he:c:d',
+        opts = getopt.getopt(argv[1:], 'he:c:dn',
                              ['help', 'endpoint=', 'cacerts=',
-                              'disable-cert-check'])[0]
+                              'disable-cert-check', 'nocache'])[0]
     except getopt.GetoptError:
         print('ERROR: invalid option')
         print_usage(argv[0])
@@ -125,6 +128,7 @@ def example(
     endpoint = ENDPOINT
     ca_certs = None
     disable_ssl_certificate_validation = False
+    disable_cache = False
 
     for opt, arg in opts:
         if opt in ('-e', '--endpoint'):
@@ -134,6 +138,8 @@ def example(
         elif opt in ('-d', '--disable-cert-check'):
             disable_ssl_certificate_validation = True
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        elif opt in ('-n', '--nocache'):
+            disable_cache = True
         elif opt in ('-h', '--help'):
             print_usage(argv[0])
             sys.exit()
@@ -141,7 +147,8 @@ def example(
 
     cdas = CdasWs(endpoint=endpoint, ca_certs=ca_certs,
                   disable_ssl_certificate_validation=
-                  disable_ssl_certificate_validation, user_agent='Example')
+                  disable_ssl_certificate_validation, 
+                  disable_cache = disable_cache, user_agent='Example')
 
     print(cdas.get_observatory_groups(
         instrumentType='Magnetic Fields (Balloon)'))
@@ -163,14 +170,30 @@ def example(
 
     print('citation = ' + cdas.get_citation('10.48322/541v-1f57'))
 
-    mms_brst_inventory = cdas.get_inventory('MMS1_FPI_BRST_L2_DES-MOMS',
+    dataset = 'MMS1_FPI_BRST_L2_DES-MOMS'
+    t0 = time.perf_counter()
+    mms_brst_inventory = cdas.get_inventory(dataset,
                                             timeInterval=TimeInterval(
                                                 '2018-08-30T08:09:53Z',
                                                 '2018-08-30T08:52:00Z'))
-    print('MMS1_FPI_BRST_L2_DES-MOMS inventory:')
+    t1 = time.perf_counter()
+    print(f'{dataset} inventory took {t1 - t0}s')
+    print(f'{dataset} inventory:')
     for interval in mms_brst_inventory:
         print('    ' + str(interval))
 
+    t0 = time.perf_counter()
+    mms_brst_inventory = cdas.get_inventory(dataset,
+                                            timeInterval=TimeInterval(
+                                                '2018-08-30T08:09:53Z',
+                                                '2018-08-30T08:52:00Z'))
+    t1 = time.perf_counter()
+    print(f'second {dataset} inventory took {t1 - t0}s')
+    print(f'second {dataset} inventory:')
+    for interval in mms_brst_inventory:
+        print('    ' + str(interval))
+
+
     doi_inventory = cdas.get_inventory('10.21978/P8T923')
     print('10.21978/P8T923 inventory:')
     for interval in doi_inventory:

cdasws/timeinterval.py

@@ -35,7 +35,7 @@
 Package defining a class to represent the TimeInterval class from
 <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.<br>
 
-Copyright &copy; 2018-2024 United States Government as represented by the
+Copyright &copy; 2018-2025 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
@@ -252,13 +252,13 @@ class TimeInterval:
         """
         try:
             start_datetime = TimeInterval.get_datetime(start)
-        except ValueError:
-            raise ValueError('unrecognized start datetime value')
+        except ValueError as exc:
+            raise ValueError('unrecognized start datetime value') from exc
 
         try:
             end_datetime = TimeInterval.get_datetime(end)
-        except ValueError:
-            raise ValueError('unrecognized end datetime value')
+        except ValueError as exc:
+            raise ValueError('unrecognized end datetime value') from exc
 
         return start_datetime, end_datetime
 

{cdasws-1.8.10.dist-info → cdasws-1.8.11.dist-info}/METADATA

@@ -1,13 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.10
+Version: 1.8.11
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
 Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
 License: NOSA
 Keywords: heliophysics,coordinated data analysis,multi-mission,multi-instrument,space physics,spdf,cdaweb
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -20,13 +19,28 @@ Classifier: Programming Language :: Python
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
-Requires-Dist: python-dateutil (>=2.8.0)
-Requires-Dist: requests (>=2.20)
-Requires-Dist: urllib3 (>=1.24.1)
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: requests>=2.20
+Requires-Dist: urllib3>=1.24.1
 Provides-Extra: spdm
-Requires-Dist: spacepy (>=0.5.0) ; extra == 'spdm'
+Requires-Dist: spacepy>=0.5.0; extra == "spdm"
 Provides-Extra: xarray
-Requires-Dist: cdflib (>=0.4.4) ; extra == 'xarray'
+Requires-Dist: cdflib>=0.4.4; extra == "xarray"
+Provides-Extra: cache
+Requires-Dist: requests-cache>=1.2.1; extra == "cache"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 
 ## Synopsis
@@ -78,9 +92,13 @@ full ISTP/SPDF metadata).
 
 ## Dependencies
 
-The only required dependencies are python-dateutil and requests.  If you
-call the get_data method then **one** of the following two sets of additional
-dependencies are required:
+The only required dependencies are the following:
+
+1. [python-dateutil](https://pypi.org/project/python-dateutil/).
+2. [requests](https://pypi.org/project/requests/).
+
+If you call the get_data method then **one** of the following two sets 
+of additional dependencies are required:
 
 1. To have get_data return the data in the SpacePy data model.
     * [SpacePy](https://spacepy.github.io/). Refer to the SpacePy
@@ -89,6 +107,11 @@ dependencies are required:
     * [cdflib](https://pypi.org/project/cdflib/).
     * [xarray](https://pypi.org/project/xarray/).
 
+If you want to take advantage of HTTP caching, then install the following:
+
+1.  [requests-cache](https://pypi.org/project/requests-cache/).
+
+
 ## Installation
 
 As noted in the dependencies above, if you intend to call the get_data
@@ -107,6 +130,10 @@ Then, to install this package
 
     $ pip install -U cdasws
 
+or to include the optional cache package
+
+    $ pip install -U cdasws[cache]
+
 
 ## API Reference
 
@@ -133,5 +160,3 @@ Bernie Harris.
 
 This code is licensed under the 
 [NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
-
-

cdasws-1.8.11.dist-info/RECORD

@@ -0,0 +1,13 @@
+cdasws/__init__.py,sha256=0pB64-kPdpLdMptyZIbyXSZmqADfG6PGwGyIxYmmrv0,92358
+cdasws/__main__.py,sha256=d8GJwd6EJK1JBS71q6h_1LYVUUj1IlRLpylQCi1SRGM,13466
+cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
+cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
+cdasws/datarequest.py,sha256=fQVroT8RXYhJLG7_y-HO3ABnJUQJjWGFPeLNrtwbWtk,29080
+cdasws/timeinterval.py,sha256=UcKB-rFSk2eeaw0a29gOQQq7rNY0ab4Qwfz4iwJFelg,7839
+cdasws-1.8.11.dist-info/licenses/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
+cdasws-1.8.11.dist-info/METADATA,sha256=UT8MZ4EYgYEdtEvZZPKwgh0P9NFfT8_ka04emp-HdvQ,6926
+cdasws-1.8.11.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+cdasws-1.8.11.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
+cdasws-1.8.11.dist-info/RECORD,,

{cdasws-1.8.10.dist-info → cdasws-1.8.11.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (80.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cdasws-1.8.10.dist-info/RECORD

@@ -1,13 +0,0 @@
-cdasws/__init__.py,sha256=V059zR8IKv4_Nyj5fu0Oaq1x210mFMf70Ut8fx2zoZY,91734
-cdasws/__main__.py,sha256=9-S-Zh4sRMtcJRg-YELX_HjN8Q74cZiekZ1MLF51bls,12553
-cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
-cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
-cdasws/datarequest.py,sha256=fQVroT8RXYhJLG7_y-HO3ABnJUQJjWGFPeLNrtwbWtk,29080
-cdasws/timeinterval.py,sha256=f9PnvdTsrG31AGvIKcwrTH8VDSoUMASJqoi4oY4Se5o,7807
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
-cdasws-1.8.10.dist-info/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
-cdasws-1.8.10.dist-info/METADATA,sha256=3HMbrWBbPvLh8BHbPBiDmeyzVoM9zTsVhuEyR9Pl9LQ,6288
-cdasws-1.8.10.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-cdasws-1.8.10.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
-cdasws-1.8.10.dist-info/RECORD,,