Merge branch 'main' into add_pdhdf_file_format

Author: wkerzendorf

.github/workflows/ci_workflows.yml

@@ -14,30 +14,30 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: ubuntu-latest
-            python-version: 3.6
-            toxenv: py36-test-pytest46
-          - os: windows-latest
-            python-version: 3.6
-            toxenv: py36-test-pytest50
-          - os: macos-latest
-            python-version: 3.7
-            toxenv: py37-test-pytest51
           - os: ubuntu-latest
             python-version: 3.7
-            toxenv: py37-test-pytest52
+            toxenv: py37-test-pytest46
           - os: windows-latest
+            python-version: 3.7
+            toxenv: py37-test-pytest50
+          - os: macos-latest
             python-version: 3.8
-            toxenv: py38-test-pytest53
+            toxenv: py38-test-pytest52
           - os: ubuntu-latest
             python-version: 3.8
-            toxenv: py38-test-pytest60
+            toxenv: py38-test-pytest53
+          - os: windows-latest
+            python-version: 3.9
+            toxenv: py39-test-pytest60
           - os: macos-latest
             python-version: 3.9
             toxenv: py39-test-pytest61
           - os: ubuntu-latest
-            python-version: 3.9
-            toxenv: py39-test-pytestdev
+            python-version: '3.10'
+            toxenv: py310-test-pytest62
+          - os: ubuntu-latest
+            python-version: '3.10'
+            toxenv: py310-test-pytestdev
 
     steps:
     - uses: actions/checkout@v2
@@ -47,10 +47,10 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install Tox
+    - name: Install tox
       run: python -m pip install tox
     - name: Install HDF5 (macOS)
       run: brew install hdf5 c-blosc
       if: matrix.os == 'macos-latest'
-    - name: Run Tox
+    - name: Run tox
       run: tox -v -e ${{ matrix.toxenv }}

.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  pull_request:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    if: ((github.event_name == 'push' && startsWith(github.ref, 'refs/tags')) || contains(github.event.pull_request.labels.*.name, 'Build wheels'))
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install python-build and twine
+      run: python -m pip install pip build "twine>=3.3" -U
+
+    - name: Build package
+      run: python -m build --sdist --wheel .
+
+    - name: List result
+      run: ls -l dist
+
+    - name: Check long_description
+      run: python -m twine check --strict dist/*
+
+    # FIXME: pytest not found
+    #- name: Test package
+    #  run: |
+    #    cd ..
+    #    python -m venv testenv
+    #    testenv/bin/pip install pytest pytest-arraydiff/dist/*.whl
+    #    testenv/bin/pytest pytest-arraydiff/tests --arraydiff
+
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.pypi_password }}

CHANGES.md

@@ -1,9 +1,23 @@
-0.4 (unreleased)
+0.6 (unreleased)
 ----------------
 
 - No changes yet.
 - Add ability to compare to Pandas DataFrames and store them as HDF5 files
 
+0.5 (2022-01-12)
+----------------
+
+- Removed `astropy` as required dependency. [#31]
+
+- Formally register `array_compare` as marker.
+
+0.4 (2021-12-31)
+----------------
+
+- Minimum Python version is now 3.7. [#30]
+
+- Various infrastructure updates.
+
 0.3 (2018-12-05)
 ----------------
 

README.rst

@@ -1,3 +1,7 @@
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5811772.svg
+   :target: https://doi.org/10.5281/zenodo.5811772
+   :alt: 10.5281/zenodo.5811772
+
 .. image:: https://github.com/astropy/pytest-arraydiff/workflows/CI/badge.svg
     :target: https://github.com/astropy/pytest-arraydiff/actions
     :alt: CI Status

pytest_arraydiff/plugin.py

@@ -36,26 +36,17 @@
 import shutil
 import tempfile
 import warnings
-
-import six
-from six.moves.urllib.request import urlopen
+from urllib.request import urlopen
 
 import pytest
 import numpy as np
 
 
-if six.PY2:
-    def abstractstaticmethod(func):
-        return func
-    def abstractclassmethod(func):
-        return func
-else:
-    abstractstaticmethod = abc.abstractstaticmethod
-    abstractclassmethod = abc.abstractclassmethod
+abstractstaticmethod = abc.abstractstaticmethod
+abstractclassmethod = abc.abstractclassmethod
 
 
-@six.add_metaclass(abc.ABCMeta)
-class BaseDiff(object):
+class BaseDiff(object, metaclass=abc.ABCMeta):
 
     @abstractstaticmethod
     def read(filename):
@@ -142,14 +133,7 @@ def read(filename):
     @staticmethod
     def write(filename, data, **kwargs):
         fmt = kwargs.get('fmt', '%g')
-        # Workaround for a known issue in `numpy.savetxt` for the `fmt` argument:
-        # https://github.com/numpy/numpy/pull/4053#issuecomment-263808221
-        # Convert `unicode` to `str` (i.e. bytes) on Python 2
-        if six.PY2 and isinstance(fmt, six.text_type):
-            fmt = fmt.encode('ascii')
-
         kwargs['fmt'] = fmt
-
         return np.savetxt(filename, data, **kwargs)
 
 
@@ -214,7 +198,9 @@ def pytest_addoption(parser):
 
 
 def pytest_configure(config):
-
+    config.getini('markers').append(
+        'array_compare: for functions using array comparison')
+    
     if config.getoption("--arraydiff") or config.getoption("--arraydiff-generate-path") is not None:
 
         reference_dir = config.getoption("--arraydiff-reference-path")
@@ -325,7 +311,7 @@ def item_function_wrapper(*args, **kwargs):
                                     This is expected for new tests.""".format(
                         test=test_array))
 
-                # distutils may put the baseline arrays in non-accessible places,
+                # setuptools may put the baseline arrays in non-accessible places,
                 # copy to our tmpdir to be sure to keep them in case of failure
                 baseline_file = os.path.abspath(os.path.join(result_dir, 'reference-' + filename))
                 shutil.copyfile(baseline_file_ref, baseline_file)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-arraydiff
-url = https://github.com/astrofrog/pytest-arraydiff
+url = https://github.com/astropy/pytest-arraydiff
 author = The Astropy Developers
 author_email = [email protected]
 classifiers =
@@ -21,16 +21,20 @@ classifiers =
 license = BSD
 description = pytest plugin to help with comparing array output from tests
 long_description = file: README.rst
+long_description_content_type = text/x-rst
 
 [options]
 zip_safe = False
 packages = find:
-python_requires = >=3.6
+python_requires = >=3.7
 setup_requires =
     setuptools_scm
 install_requires =
     pytest>=4.6
     numpy
+
+[options.extras_require]
+test =
     astropy
     pandas
     tables
@@ -44,7 +48,7 @@ minversion = 4.6
 testpaths = tests
 xfail_strict = true
 markers =
-    array_compare : for functions using array comparison
+    array_compare: for functions using array comparison
 
 [flake8]
-max-line-length = 100
+max-line-length = 150

tests/test_pytest_arraydiff.py

@@ -1,13 +1,10 @@
 import os
-import sys
 import subprocess
 import tempfile
 
 import pytest
 import numpy as np
 
-PY2 = sys.version_info[0] == 2
-
 reference_dir = 'baseline'
 
 
@@ -65,11 +62,11 @@ def test_fails():
         f.write(TEST_FAILING)
 
     # If we use --arraydiff, it should detect that the file is missing
-    code = subprocess.call('py.test --arraydiff {0}'.format(test_file), shell=True)
+    code = subprocess.call('pytest --arraydiff {0}'.format(test_file), shell=True)
     assert code != 0
 
     # If we don't use --arraydiff option, the test should succeed
-    code = subprocess.call('py.test {0}'.format(test_file), shell=True)
+    code = subprocess.call('pytest {0}'.format(test_file), shell=True)
     assert code == 0
 
 
@@ -96,19 +93,13 @@ def test_generate(file_format):
 
     # If we don't generate, the test will fail
     try:
-        if PY2:
-            subprocess.check_output(['pytest', '--arraydiff', test_file])
-        else:
-            subprocess.check_output(['pytest', '--arraydiff', test_file], timeout=10)
+        subprocess.check_output(['pytest', '--arraydiff', test_file], timeout=10)
     except subprocess.CalledProcessError as grepexc:
         assert b'File not found for comparison test' in grepexc.output
 
     # If we do generate, the test should succeed and a new file will appear
-    if PY2:
-        code = subprocess.call(['pytest', '--arraydiff-generate-path={0}'.format(gen_dir), test_file])
-    else:
-        code = subprocess.call(['pytest', '--arraydiff-generate-path={0}'.format(gen_dir), test_file],
-                               timeout=10)
+    code = subprocess.call(['pytest', '--arraydiff-generate-path={0}'.format(gen_dir), test_file],
+                           timeout=10)
     assert code == 0
     assert os.path.exists(os.path.join(gen_dir, 'test_gen.' + ('fits' if file_format == 'fits' else 'txt')))
 
@@ -122,6 +113,7 @@ def test_default():
     return np.arange(6 * 5).reshape((6, 5))
 """
 
+
 @pytest.mark.parametrize('file_format', ('fits', 'text'))
 def test_default_format(file_format):
 
@@ -134,15 +126,15 @@ def test_default_format(file_format):
     gen_dir = os.path.join(tmpdir, 'spam', 'egg')
 
     # If we do generate, the test should succeed and a new file will appear
-    code = subprocess.call('py.test -s --arraydiff-default-format={0}'
+    code = subprocess.call('pytest -s --arraydiff-default-format={0}'
                            ' --arraydiff-generate-path={1} {2}'.format(file_format, gen_dir, test_file), shell=True)
     assert code == 0
     assert os.path.exists(os.path.join(gen_dir, 'test_default.' + ('fits' if file_format == 'fits' else 'txt')))
 
 
 @pytest.mark.array_compare(reference_dir=reference_dir, rtol=0.5, file_format='fits')
 def test_tolerance():
-    return np.ones((3,4)) * 1.6
+    return np.ones((3, 4)) * 1.6
 
 
 def test_nofile():

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py{36,37,38,39}-test{,-devdeps}
+    py{37,38,39,310}-test{,-devdeps}
     codestyle
 requires =
     setuptools >= 30.3.0
@@ -13,13 +13,14 @@ description = run tests
 deps =
     pytest46: pytest==4.6.*
     pytest50: pytest==5.0.*
-    pytest51: pytest==5.1.*
     pytest52: pytest==5.2.*
     pytest53: pytest==5.3.*
     pytest60: pytest==6.0.*
     pytest61: pytest==6.1.*
+    pytest62: pytest==6.2.*
     pytestdev: git+https://github.com/pytest-dev/pytest#egg=pytest
-
+extras =
+    test
 commands =
     pip freeze
     pytest {toxinidir}/tests {posargs}