refactor the CI (#28)

* use templates for the unit test CI

* increase the information printed by the formatter / linter CI

* check isort

* install on ubuntu 20.04 instead of 16.04

* add a check using blackdoc

* try setting the python version for isort

* globally set the python version

* try using conda instead

* copy xarray's codecov configuration

* set the junit family

* try to fix the displayed python version

* back to pip

* run the py38 CI on python 3.8

* run black since a new version was recently released

* disable blackdoc CI for now, which is broken now that black got updated

Author: keewis

.codecov.yml

@@ -0,0 +1,16 @@
+codecov:
+  ci:
+    # by default, codecov doesn't recognize azure as a CI provider
+    - dev.azure.com
+  require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        # Require 1% coverage, i.e., always succeed
+        target: 1
+    patch: false
+    changes: false
+
+comment: off

azure-pipelines.yml

@@ -2,14 +2,13 @@
 # Create and test a Python package on multiple Python versions.
 # Add steps that analyze code, save the dist with the build record, publish to a PyPI-compatible index, and more:
 # https://docs.microsoft.com/azure/devops/pipelines/languages/python
-
 trigger:
 - master
 
 jobs:
 - job: Linux
   pool:
-    vmImage: 'ubuntu-16.04'
+    vmImage: 'ubuntu-20.04'
   strategy:
     matrix:
       Python36:
@@ -23,58 +22,67 @@ jobs:
         upstream_dev: true
 
   steps:
-  - task: UsePythonVersion@0
-    inputs:
-      versionSpec: '$(python.version)'
-    displayName: 'Use Python $(python.version)'
-
-  - script: |
-        python -m pip install --upgrade pip setuptools wheel
-    displayName: 'Upgrade pip and build tools'
-
-  - script: |
-      pip install -r requirements.txt
-    displayName: 'Install dependencies'
-
-  - script: |
-      python -m pip install \
-        -i https://pypi.anaconda.org/scipy-wheels-nightly/simple \
-        --no-deps \
-        --pre \
-        --upgrade \
-        numpy
-      python -m pip install --upgrade \
-        git+https://github.com/hgrecco/pint \
-        git+https://github.com/pydata/xarray
-    displayName: 'Install upstream-dev dependencies'
-    condition: eq(variables['UPSTREAM_DEV'], 'true')
-
-  - script: |
-      pip install pytest pytest-azurepipelines pytest-cov
-      pytest --verbose --cov=./ --cov-report=xml
-    displayName: 'pytest'
-
-  - script: |
-      curl https://codecov.io/bash > codecov.sh
-      bash codecov.sh -t aba016f6-96be-4bc3-bdbe-caa6b6aff815
-    displayName: 'Upload coverage to codecov.io'
+  - template: ci/install.yml
+  - template: ci/unit-tests.yml
 
 - job: LintFlake8
+  variables:
+    python.version: '3.8'
   pool:
-    vmImage: 'ubuntu-16.04'
+    vmImage: 'ubuntu-20.04'
   steps:
   - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '$(python.version)'
+    displayName: 'Use Python $(python.version)'
   - bash: python -m pip install flake8
     displayName: Install flake8
-  - bash: flake8
+  - bash: python -m pip list
+    displayName: Version Info
+  - bash: python -m flake8
     displayName: flake8 lint checks
 
+- job: FormattingIsort
+  variables:
+    python.version: '3.8'
+  pool:
+    vmImage: 'ubuntu-20.04'
+  steps:
+  - template: ci/install.yml
+  - script: |
+      python -m isort --check .
+    displayName: isort formatting check
+
 - job: FormattingBlack
+  variables:
+    python.version: '3.8'
   pool:
-    vmImage: 'ubuntu-16.04'
+    vmImage: 'ubuntu-20.04'
   steps:
   - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '$(python.version)'
+    displayName: 'Use Python $(python.version)'
   - bash: python -m pip install black
     displayName: Install black
-  - bash: black --check .
+  - bash: python -m pip list
+    displayName: Version Info
+  - bash: python -m black --check .
     displayName: black formatting check
+
+# - job: FormattingBlackdoc
+#   variables:
+#     python.version: '3.8'
+#   pool:
+#     vmImage: 'ubuntu-20.04'
+#   steps:
+#   - task: UsePythonVersion@0
+#     inputs:
+#       versionSpec: '$(python.version)'
+#     displayName: 'Use Python $(python.version)'
+#   - bash: python -m pip install blackdoc
+#     displayName: Install blackdoc
+#   - bash: python -m pip list
+#     displayName: Version Info
+#   - bash: python -m blackdoc --check .
+#     displayName: blackdoc formatting check

ci/install.yml

@@ -0,0 +1,34 @@
+steps:
+- task: UsePythonVersion@0
+  inputs:
+    versionSpec: '$(python.version)'
+  displayName: 'Use Python $(python.version)'
+
+- script: |
+    python -m pip install --upgrade pip setuptools wheel
+  displayName: Upgrade pip and build tools
+
+- script: |
+    pip install -r ci/requirements.txt
+  displayName: Install dependencies
+
+- script: |
+    python -m pip install \
+      -i https://pypi.anaconda.org/scipy-wheels-nightly/simple \
+      --no-deps \
+      --pre \
+      --upgrade \
+      numpy
+    python -m pip install --upgrade \
+      git+https://github.com/hgrecco/pint \
+      git+https://github.com/pydata/xarray
+  displayName: Install upstream-dev dependencies
+  condition: eq(variables['UPSTREAM_DEV'], 'true')
+
+- bash: |
+    python -m pip install --no-deps -e .
+  displayName: Install pint-xarray
+
+- bash: |
+    python -m pip list
+  displayName: Version Info

ci/requirements.txt

@@ -0,0 +1,9 @@
+pint
+numpy
+xarray
+isort
+black
+flake8
+pytest
+pytest-cov
+pytest-azurepipelines

ci/unit-tests.yml

@@ -0,0 +1,25 @@
+steps:
+- bash: |
+    python -c 'import pint_xarray'
+  displayName: Import pint-xarray
+
+- bash: |
+    pytest \
+      --verbose \
+      --cov=pint_xarray \
+      --cov-report=xml \
+      --junitxml=junit/test-results.xml
+
+  displayName: Run tests
+
+- bash: |
+    curl https://codecov.io/bash > codecov.sh
+    bash codecov.sh -t aba016f6-96be-4bc3-bdbe-caa6b6aff815
+  displayName: Upload coverage to codecov.io
+
+- task: PublishTestResults@2
+  condition: succeededOrFailed()
+  inputs:
+    testResultsFiles: '**/test-*.xml'
+    failTaskOnFailedTests: false
+    testRunTitle: '$(Agent.JobName)'

pint_xarray/accessors.py

@@ -36,7 +36,7 @@ def is_dict_like(obj):
 
 
 def zip_mappings(*mappings, fill_value=None):
-    """ zip mappings by combining values for common keys into a tuple
+    """zip mappings by combining values for common keys into a tuple
 
     Works like itertools.zip_longest, so if a key is missing from a
     mapping, it is replaced by ``fill_value``.
@@ -237,7 +237,8 @@ def dequantify(self):
 
         units = units_to_str_or_none(conversion.extract_units(self.da))
         new_obj = conversion.attach_unit_attributes(
-            conversion.strip_units(self.da), units,
+            conversion.strip_units(self.da),
+            units,
         )
 
         return new_obj
@@ -271,7 +272,7 @@ def registry(self, _):
         raise AttributeError("Don't try to change the registry once created")
 
     def to(self, units=None, **unit_kwargs):
-        """ convert the quantities in a DataArray
+        """convert the quantities in a DataArray
 
         Parameters
         ----------
@@ -528,7 +529,7 @@ def dequantify(self):
         return new_obj
 
     def to(self, units=None, **unit_kwargs):
-        """ convert the quantities in a DataArray
+        """convert the quantities in a DataArray
 
         Parameters
         ----------

pint_xarray/conversion.py

@@ -5,7 +5,7 @@
 
 
 def array_attach_units(data, unit, registry=None):
-    """ attach a unit to the data
+    """attach a unit to the data
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def array_attach_units(data, unit, registry=None):
 
 
 def array_convert_units(data, unit):
-    """ convert the units of an array
+    """convert the units of an array
 
     This is roughly the same as ``data.to(unit)``.
 
@@ -80,7 +80,7 @@ def array_convert_units(data, unit):
 
 
 def array_extract_units(data):
-    """ extract the units of an array
+    """extract the units of an array
 
     If ``data`` is not a quantity, the units are ``None``
     """

pint_xarray/testing.py

@@ -2,7 +2,7 @@
 
 
 def assert_units_equal(a, b):
-    """ assert that the units of two xarray objects are equal
+    """assert that the units of two xarray objects are equal
 
     Raises an :py:exc:`AssertionError` if the units of both objects are not
     equal. ``units`` attributes and attached unit objects are compared

pint_xarray/tests/test_conversion.py

@@ -196,7 +196,11 @@ def test_attach_units(self, obj, units):
                 {"a": "K", "b": "hPa", "u": "m"},
                 id="Dataset",
             ),
-            pytest.param(Variable("x", []), {None: "hPa"}, id="Variable",),
+            pytest.param(
+                Variable("x", []),
+                {None: "hPa"},
+                id="Variable",
+            ),
         ),
     )
     def test_attach_unit_attributes(self, obj, units):
@@ -366,7 +370,9 @@ def test_extract_units(self, typename, units):
                 id="Dataset",
             ),
             pytest.param(
-                Variable("x", [], {"units": "hPa"}), {None: "hPa"}, id="Variable",
+                Variable("x", [], {"units": "hPa"}),
+                {None: "hPa"},
+                id="Variable",
             ),
         ),
     )
@@ -440,7 +446,9 @@ def test_strip_units(self, obj):
                 id="Dataset",
             ),
             pytest.param(
-                Variable("x", [], {"units": "hPa"}), {None: "hPa"}, id="Variable",
+                Variable("x", [], {"units": "hPa"}),
+                {None: "hPa"},
+                id="Variable",
             ),
         ),
     )

pyproject.toml

@@ -4,3 +4,6 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
 fallback_version = "999"
+
+[tool.pytest.ini_options]
+junit_family = "xunit2"