cdasws 1.7.47__py3-none-any.whl → 1.8.2__py3-none-any.whl

cdasws/__init__.py

@@ -41,10 +41,17 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 
 Notes
 -----
-Due to rate limiting implemented by the CDAS web services, an attempt
-to make simultaneous requests from many threads is likely to actually
-reduce performance.  At this time, it is best to make calls from
-five or fewer threads.
+<ul>
+  <li>Due to rate limiting implemented by the CDAS web services, an
+      attempt to make simultaneous requests from many threads is likely
+      to actually reduce performance.  At this time, it is best to make
+      calls from five or fewer threads.</li>
+  <li>Since CDAS data has datetime values with a UTC timezone, all
+      client provided datetime values should have a timezone of UTC.
+      If a given value's timezone is not UTC, the value is adjusted to
+      UTC.  If a given value has no timezone (is naive), a UTC timezone
+      is set.</li>
+</ul>
 """
 
 
@@ -120,7 +127,7 @@ except ImportError:
         CDF_XARRAY_AVAILABLE = False
 
 
-__version__ = "1.7.47"
+__version__ = "1.8.2"
 
 
 #
@@ -610,11 +617,13 @@ class CdasWs:
             that no datasets are eliminated based upon their instrument
             value.<br>
             <b>startDate</b> - a datetime specifying the start of a time
-            interval.  If this parameter is ommited, the time interval
-            will begin infinitely in the past.<br>
+            interval.  See module note about timezone value.  If this
+            parameter is ommited, the time interval will begin infinitely
+            in the past.<br>
             <b>stopDate</b> - a datetime specifying the end of a time
-            interval.  If this parameter is omitted, the time interval
-            will end infinitely in the future.<br>
+            interval.  See module note about timezone value.  If this
+            parameter is omitted, the time interval will end infinitely
+            in the future.<br>
             <b>idPattern</b> - a java.util.regex compatible regular
             expression that must match the dataset's identifier value.
             Omitting this parameter is equivalent to `.*`.<br>
@@ -1025,9 +1034,9 @@ class CdasWs:
         variables
             array containing names of variables to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         keywords
             optional keyword parameters as follows:<br>
             <b>binData</b> - indicates that uniformly spaced values should
@@ -1263,10 +1272,11 @@ class CdasWs:
             ALL-VARIABLES may be used instead of specifying all the
             individual variable names.
         time0
-            TimeInterval(s) or start time of data to get.
+            TimeInterval(s) or start time of data to get.  See module
+            note about timezone.
         time1
             when time0 is not one or more TimeInterval(s), the end time
-            of data to get.
+            of data to get.  See module note about timezone.
         keywords
             optional keyword parameters as follows:<br>
             <b>binData</b> - indicates that uniformly spaced values should
@@ -1449,9 +1459,9 @@ class CdasWs:
         variables
             array containing names of variables to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         options
             graph options.
         image_format
@@ -1552,9 +1562,9 @@ class CdasWs:
         variables
             array containing names of variables to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         identifier
             thumbnail identifier (returned in a previous get_graph
             result).
@@ -1651,9 +1661,9 @@ class CdasWs:
         variables
             array containing names of variables to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         compression
             file compression.
         text_format
@@ -1753,9 +1763,9 @@ class CdasWs:
         variables
             array containing names of variables to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         keywords
             optional keyword parameters as follows:<br>
             <b>binData</b> - indicates that uniformly spaced values should
@@ -1848,9 +1858,9 @@ class CdasWs:
         dataset
             dataset identifier of data to get.
         start
-            start time of data to get.
+            start time of data to get.  See module note about timezone.
         end
-            end time of data to get.
+            end time of data to get.  See module note about timezone.
         keywords
             optional keyword parameters as follows:<br>
             <b>progressCallback</b> - is a

cdasws/timeinterval.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2021 United States Government as represented by
+# Copyright (c) 2018-2024 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.
@@ -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-2021 United States Government as represented by the
+Copyright &copy; 2018-2024 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.
 """
@@ -53,6 +53,14 @@ class TimeInterval:
     A class representing a TimeInterval class from
     <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.
 
+    Notes
+    -----
+    Since CDAS data uses datetime values with a UTC timezone,
+    the resulting start and end properties have a UTC timezone.  If
+    the given values' timezone is not UTC, the start/end values are
+    adjusted to UTC.  If the given value has no timezone (is naive) a
+    UTC value is set.
+
     Parameters
     ----------
     start
@@ -135,7 +143,11 @@ class TimeInterval:
     @staticmethod
     def get_datetime(value: Union[datetime, str]) -> datetime:
         """
-        Produces a datetime representation of the given value.
+        Produces a datetime representation of the given value.  The
+        returned datetime always has a timezone of timezone.utc.  If
+        the given value's timezone is not utc, the return value is
+        adjusted to utc.  If the given value has no timezone (is naive)
+        a utc value is set.
 
         Parameters
         ----------
@@ -144,7 +156,8 @@ class TimeInterval:
         Returns
         -------
         datetime
-            datetime representation of the given value.
+            datetime representation of the given value in the UTC
+            timezone.
         Raises
         ------
         ValueError
@@ -157,9 +170,11 @@ class TimeInterval:
         else:
             raise ValueError('unrecognized datetime value')
 
-        datetime_value.astimezone(timezone.utc)
+        if datetime_value.tzinfo is None or \
+           datetime_value.tzinfo.utcoffset(None) is None:
+            return datetime_value.replace(tzinfo=timezone.utc)
 
-        return datetime_value
+        return datetime_value.astimezone(timezone.utc)
 
 
     @staticmethod

{cdasws-1.7.47.dist-info → cdasws-1.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cdasws
-Version: 1.7.47
+Version: 1.8.2
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris

cdasws-1.8.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+cdasws/__init__.py,sha256=6gE6ZtcYu2YatV6N2Vnph7GkuGcmLnz88O4KW2IayCg,75472
+cdasws/__main__.py,sha256=sgIqwgEaTto8mJggMAq3UppD6vus5DNQ4fWS3mvxvtY,12411
+cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
+cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
+cdasws/datarequest.py,sha256=DutrESTuL9BVoMRymtVuxN4koXeaRxe9cT-jEoDVK8I,21632
+cdasws/timeinterval.py,sha256=677SULpzclE4XqFuU4_SjZLVCZKlQKa2ekvswnmDVkU,6392
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
+cdasws-1.8.2.dist-info/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
+cdasws-1.8.2.dist-info/METADATA,sha256=jwm_durL4sr7uv27Cpd9Yr_bXdOVGD_iwPnWhEOIRJw,5744
+cdasws-1.8.2.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+cdasws-1.8.2.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
+cdasws-1.8.2.dist-info/RECORD,,

cdasws-1.7.47.dist-info/RECORD

@@ -1,13 +0,0 @@
-cdasws/__init__.py,sha256=8UpPbGwbzIBxeAN7uWmwXbZMTiO1pJk565syQ7ZGtf0,74559
-cdasws/__main__.py,sha256=sgIqwgEaTto8mJggMAq3UppD6vus5DNQ4fWS3mvxvtY,12411
-cdasws/cdasws.py,sha256=755mLWlMFXknNP3f8g_W9An6niAmksqcb1NdgiAybj0,29552
-cdasws/datarepresentation.py,sha256=kKgAKCA4uzGoBQ8r8jbXstBg8SCg_EQtsoGhO8kIpco,2164
-cdasws/datarequest.py,sha256=DutrESTuL9BVoMRymtVuxN4koXeaRxe9cT-jEoDVK8I,21632
-cdasws/timeinterval.py,sha256=d4i2Q8CtbAX0JdTLTCpyw40r16CycrUQACxhUVogu8E,5664
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_cdasws.py,sha256=DsKesU19_9zUIO1a7oyWWtywBGN7gjdQHFLMGUZ4X8c,24395
-cdasws-1.7.47.dist-info/LICENSE,sha256=og42scUY42lPLGBg0wHt6JtrbeInVEr5xojyrguPqrQ,12583
-cdasws-1.7.47.dist-info/METADATA,sha256=f5qIZPV2tQArAIG4zPi62caRsfZ-967EP83IpVxQKLk,5745
-cdasws-1.7.47.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-cdasws-1.7.47.dist-info/top_level.txt,sha256=GyIvHk5F6ysnTdDfnQsjZbTBt_EYrKyC0oeiIt9l-AE,7
-cdasws-1.7.47.dist-info/RECORD,,