Add Black linting check to CI and add to test reqs

.github/workflows/test.yml

@@ -15,19 +15,30 @@ jobs:
         python-version: [ '3.5', '3.8' ]
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install "numpy<1.19.0"
         pip install -r test_requirements.txt
         pip install pytest-cov
+
+    - name: Run Black check for formatting
+      if: ${{ matrix.python-version != '3.5' }}
+      run: |
+        # Need to manually install Black while we support Python 3.5
+        pip install black
+        black --check .
+
     - name: Test with pytest
       run: |
         pytest --cov=./ --cov-report=xml
+
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
       with:

.gitignore

@@ -1,6 +1,10 @@
 # Python files
 *.pyc
 *.egg-info
+build
 
 # PyCharm settings
 .idea
+
+# vscode settings
+.hypothesis

aodntools/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.0'
+__version__ = "0.0.0"

aodntools/ncwriter/__init__.py

@@ -3,10 +3,10 @@
 from .imos_template import ImosTemplate, TIMESTAMP_FORMAT
 
 __all__ = [
-    'ImosTemplate',
-    'DatasetTemplate',
-    'ValidationError',
-    'metadata_attributes',
-    'special_attributes',
-    'TIMESTAMP_FORMAT'
+    "ImosTemplate",
+    "DatasetTemplate",
+    "ValidationError",
+    "metadata_attributes",
+    "special_attributes",
+    "TIMESTAMP_FORMAT",
 ]

aodntools/ncwriter/imos_template.py

@@ -5,10 +5,10 @@
 
 from .template import DatasetTemplate
 
-IMOS_GLOBAL_JSON = resource_filename(__name__, 'imos_global.json')
+IMOS_GLOBAL_JSON = resource_filename(__name__, "imos_global.json")
 IMOS_GLOBAL_ATTRIBUTES = DatasetTemplate.from_json(IMOS_GLOBAL_JSON).global_attributes
 
-TIMESTAMP_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+TIMESTAMP_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
 
 
 class ImosTemplate(DatasetTemplate):
@@ -19,7 +19,9 @@ def __init__(self, global_attributes=None, *args, **kwargs):
         combined_attributes = IMOS_GLOBAL_ATTRIBUTES.copy()
         if global_attributes is not None:
             combined_attributes.update(global_attributes)
-        super(ImosTemplate, self).__init__(global_attributes=combined_attributes, *args, **kwargs)
+        super(ImosTemplate, self).__init__(
+            global_attributes=combined_attributes, *args, **kwargs
+        )
         self._date_created = None
 
     @property
@@ -30,9 +32,13 @@ def date_created(self):
         return self._date_created
 
     def add_date_created_attribute(self):
-        self.global_attributes['date_created'] = self.date_created.strftime(TIMESTAMP_FORMAT)
+        self.global_attributes["date_created"] = self.date_created.strftime(
+            TIMESTAMP_FORMAT
+        )
 
-    def add_extent_attributes(self, time_var='TIME', vert_var='DEPTH', lat_var='LATITUDE', lon_var='LONGITUDE'):
+    def add_extent_attributes(
+        self, time_var="TIME", vert_var="DEPTH", lat_var="LATITUDE", lon_var="LONGITUDE"
+    ):
         """
         Calculate spatial and temporal extents from coordinate variables in the template and add/update
         the relevant global attributes. Set an input variable name to None to skip that coordinate.
@@ -46,28 +52,33 @@ def add_extent_attributes(self, time_var='TIME', vert_var='DEPTH', lat_var='LATI
         if time_var:
             data_range = self.get_data_range(time_var)
             time = self.variables[time_var]
-            units = time.get('units')
+            units = time.get("units")
             if not units:
-                raise ValueError("Time variable '{time_var}' has no units".format(time_var=time_var))
-            calendar = time.get('calendar', 'gregorian')
+                raise ValueError(
+                    "Time variable '{time_var}' has no units".format(time_var=time_var)
+                )
+            calendar = time.get("calendar", "gregorian")
             time_range = num2date(data_range, units, calendar)
-            self.global_attributes['time_coverage_start'] = time_range[0].strftime(TIMESTAMP_FORMAT)
-            self.global_attributes['time_coverage_end'] = time_range[1].strftime(TIMESTAMP_FORMAT)
+            self.global_attributes["time_coverage_start"] = time_range[0].strftime(
+                TIMESTAMP_FORMAT
+            )
+            self.global_attributes["time_coverage_end"] = time_range[1].strftime(
+                TIMESTAMP_FORMAT
+            )
 
         if vert_var:
             vmin, vmax = self.get_data_range(vert_var)
-            self.global_attributes['geospatial_vertical_min'] = vmin
-            self.global_attributes['geospatial_vertical_max'] = vmax
+            self.global_attributes["geospatial_vertical_min"] = vmin
+            self.global_attributes["geospatial_vertical_max"] = vmax
 
         if lat_var:
             vmin, vmax = self.get_data_range(lat_var)
-            self.global_attributes['geospatial_lat_min'] = vmin
-            self.global_attributes['geospatial_lat_max'] = vmax
+            self.global_attributes["geospatial_lat_min"] = vmin
+            self.global_attributes["geospatial_lat_max"] = vmax
 
         if lon_var:
             vmin, vmax = self.get_data_range(lon_var)
-            self.global_attributes['geospatial_lon_min'] = vmin
-            self.global_attributes['geospatial_lon_max'] = vmax
+            self.global_attributes["geospatial_lon_min"] = vmin
+            self.global_attributes["geospatial_lon_max"] = vmax
 
     # TODO: def set_imos_filename(self):
-

aodntools/ncwriter/schema.py

@@ -12,12 +12,13 @@
 # Create a new validator class (based on Draft4Validator) to allow templates to use
 # * Python types or numpy dtypes to specify variable data types; and
 # * numpy arrays to specify variable data.
-TemplateValidator = validators.create(meta_schema=Draft4Validator.META_SCHEMA,
-                                      validators=Draft4Validator.VALIDATORS)
+TemplateValidator = validators.create(
+    meta_schema=Draft4Validator.META_SCHEMA, validators=Draft4Validator.VALIDATORS
+)
 format_checker = FormatChecker()
 
 
-@format_checker.checks('datatype')
+@format_checker.checks("datatype")
 def is_python_datatype(value):
     """Return whether the given value is a valid data type specification for a NetCDF variable"""
     if isinstance(value, np.dtype):
@@ -28,31 +29,37 @@ def is_python_datatype(value):
     return False
 
 
-TYPES = {'array': (list, np.ndarray)}
+TYPES = {"array": (list, np.ndarray)}
 
-TEMPLATE_SCHEMA_JSON = resource_filename(__name__, 'template_schema.json')
+TEMPLATE_SCHEMA_JSON = resource_filename(__name__, "template_schema.json")
 with open(TEMPLATE_SCHEMA_JSON) as f:
     TEMPLATE_SCHEMA = json.load(f)
 TemplateValidator.check_schema(TEMPLATE_SCHEMA)
 
-template_validator = TemplateValidator(TEMPLATE_SCHEMA, types=TYPES, format_checker=format_checker)
+template_validator = TemplateValidator(
+    TEMPLATE_SCHEMA, types=TYPES, format_checker=format_checker
+)
 
 
 def validate_template(t):
     template_validator.validate(t)
 
 
 def validate_dimensions(d):
-    validate_template({'_dimensions': d})
+    validate_template({"_dimensions": d})
 
 
 def validate_variables(v):
-    validate_template({'_variables': v})
+    validate_template({"_variables": v})
 
 
 def validate_global_attributes(a):
-    if hasattr(a, 'keys'):
-        special = [k for k in a.keys() if k.startswith('_')]
+    if hasattr(a, "keys"):
+        special = [k for k in a.keys() if k.startswith("_")]
         if special:
-            raise ValidationError('Special attributes {} not allowed in global attributes dict'.format(special))
+            raise ValidationError(
+                "Special attributes {} not allowed in global attributes dict".format(
+                    special
+                )
+            )
     template_validator.validate(a)