Merge pull request #213 from dstansby/varattsget-arg

Make varattsget arg required

cdflib/cdfread.py

@@ -517,14 +517,14 @@ def globalattsget(self) -> Dict[str, List[Union[str, np.ndarray]]]:
 
         return return_dict
 
-    def varattsget(self, variable: Optional[str] = None) -> Dict[str, Union[None, str, np.ndarray]]:
+    def varattsget(self, variable: Union[str, int]) -> Dict[str, Union[None, str, np.ndarray]]:
         """
         Gets all variable attributes.
 
         Unlike attget, which returns a single attribute entry value,
         this function returns all of the variable attribute entries,
         in a dictionary (in the form of 'attribute': value pair) for
-        a variable. If there is no entry found, None is returned.
+        a variable.
         """
         if isinstance(variable, int) and self._num_zvariable > 0 and self._num_rvariable > 0:
             raise ValueError("This CDF has both r and z variables. Use variable name")
@@ -551,8 +551,6 @@ def varattsget(self, variable: Optional[str] = None) -> Dict[str, Union[None, st
             if variable < 0 or variable >= num_variable:
                 raise ValueError(f"No variable by this number: {variable}")
             return self._read_varatts(variable, zVar)
-        else:
-            raise ValueError("Please set variable keyword equal to " "the name or number of an variable")
 
     def _uncompress_rle(self, data: bytes) -> bytearray:
         result = bytearray()

doc/changelog.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+1.0.3
+=====
+- The ``variable`` parameter to `cdflib.cdfread.CDF.varattsget` is no longer optional.
+  Not specifying it raised an error anyway in previous versions of cdflib.
+
 1.0.2
 =====
 To make the ``xarray`` functionality easier to discover and import, a new