pytest-arraydiff 0.5.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

pytest_arraydiff/plugin.py

@@ -28,9 +28,6 @@
 #
 #   https://github.com/astrofrog/pytest-mpl
 
-
-from functools import wraps
-
 import os
 import abc
 import shutil
@@ -116,8 +113,9 @@ class FITSDiff(BaseDiff):
         from astropy.io.fits.diff import FITSDiff
         from astropy.utils.introspection import minversion
         if minversion(astropy, '2.0'):
-            diff = FITSDiff(reference_file, test_file, rtol=rtol)
+            diff = FITSDiff(reference_file, test_file, rtol=rtol, atol=atol)
         else:
+            # `atol` is not supported prior to Astropy 2.0
             diff = FITSDiff(reference_file, test_file, tolerance=rtol)
         return diff.identical, diff.report()
 
@@ -137,9 +135,43 @@ class TextDiff(SimpleArrayDiff):
         return np.savetxt(filename, data, **kwargs)
 
 
+class PDHDFDiff(BaseDiff):
+
+    extension = 'h5'
+
+    @staticmethod
+    def read(filename):
+        import pandas as pd
+        return pd.read_hdf(filename)
+
+    @staticmethod
+    def write(filename, data, **kwargs):
+        import pandas as pd  # noqa: F401
+        key = os.path.basename(filename).replace('.h5', '')
+        return data.to_hdf(filename, key=key, **kwargs)
+
+    @classmethod
+    def compare(cls, reference_file, test_file, atol=None, rtol=None):
+        import pandas.testing as pdt
+        import pandas as pd
+
+        ref_data = pd.read_hdf(reference_file)
+        test_data = pd.read_hdf(test_file)
+        try:
+            pdt.assert_frame_equal(ref_data, test_data)
+        except AssertionError as exc:
+            message = "\n\na: {0}".format(test_file) + '\n'
+            message += "b: {0}".format(reference_file) + '\n'
+            message += exc.args[0]
+            return False, message
+        else:
+            return True, ""
+
+
 FORMATS = {}
 FORMATS['fits'] = FITSDiff
 FORMATS['text'] = TextDiff
+FORMATS['pd_hdf'] = PDHDFDiff
 
 
 def _download_file(url):
@@ -166,7 +198,7 @@ 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")
@@ -186,6 +218,37 @@ def pytest_configure(config):
                                                       reference_dir=reference_dir,
                                                       generate_dir=generate_dir,
                                                       default_format=default_format))
+    else:
+        config.pluginmanager.register(ArrayInterceptor(config))
+
+
+def generate_test_name(item):
+    """
+    Generate a unique name for this test.
+    """
+    if item.cls is not None:
+        name = f"{item.module.__name__}.{item.cls.__name__}.{item.name}"
+    else:
+        name = f"{item.module.__name__}.{item.name}"
+    return name
+
+
+def wrap_array_interceptor(plugin, item):
+    """
+    Intercept and store arrays returned by test functions.
+    """
+    # Only intercept array on marked array tests
+    if item.get_closest_marker('array_compare') is not None:
+
+        # Use the full test name as a key to ensure correct array is being retrieved
+        test_name = generate_test_name(item)
+
+        def array_interceptor(store, obj):
+            def wrapper(*args, **kwargs):
+                store.return_value[test_name] = obj(*args, **kwargs)
+            return wrapper
+
+        item.obj = array_interceptor(plugin, item.obj)
 
 
 class ArrayComparison(object):
@@ -195,12 +258,15 @@ class ArrayComparison(object):
         self.reference_dir = reference_dir
         self.generate_dir = generate_dir
         self.default_format = default_format
+        self.return_value = {}
 
-    def pytest_runtest_setup(self, item):
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_call(self, item):
 
         compare = item.get_closest_marker('array_compare')
 
         if compare is None:
+            yield
             return
 
         file_format = compare.kwargs.get('file_format', self.default_format)
@@ -220,85 +286,97 @@ class ArrayComparison(object):
 
         write_kwargs = compare.kwargs.get('write_kwargs', {})
 
-        original = item.function
+        reference_dir = compare.kwargs.get('reference_dir', None)
+        if reference_dir is None:
+            if self.reference_dir is None:
+                reference_dir = os.path.join(os.path.dirname(item.fspath.strpath), 'reference')
+            else:
+                reference_dir = self.reference_dir
+        else:
+            if not reference_dir.startswith(('http://', 'https://')):
+                reference_dir = os.path.join(os.path.dirname(item.fspath.strpath), reference_dir)
+
+        baseline_remote = reference_dir.startswith('http')
 
-        @wraps(item.function)
-        def item_function_wrapper(*args, **kwargs):
+        # Run test and get array object
+        wrap_array_interceptor(self, item)
+        yield
+        test_name = generate_test_name(item)
+        if test_name not in self.return_value:
+            # Test function did not complete successfully
+            return
+        array = self.return_value[test_name]
 
-            reference_dir = compare.kwargs.get('reference_dir', None)
-            if reference_dir is None:
-                if self.reference_dir is None:
-                    reference_dir = os.path.join(os.path.dirname(item.fspath.strpath), 'reference')
-                else:
-                    reference_dir = self.reference_dir
+        # Find test name to use as plot name
+        filename = compare.kwargs.get('filename', None)
+        if filename is None:
+            if single_reference:
+                filename = item.originalname + '.' + extension
             else:
-                if not reference_dir.startswith(('http://', 'https://')):
-                    reference_dir = os.path.join(os.path.dirname(item.fspath.strpath), reference_dir)
-
-            baseline_remote = reference_dir.startswith('http')
-
-            # Run test and get figure object
-            import inspect
-            if inspect.ismethod(original):  # method
-                array = original(*args[1:], **kwargs)
-            else:  # function
-                array = original(*args, **kwargs)
-
-            # Find test name to use as plot name
-            filename = compare.kwargs.get('filename', None)
-            if filename is None:
-                if single_reference:
-                    filename = original.__name__ + '.' + extension
-                else:
-                    filename = item.name + '.' + extension
-                    filename = filename.replace('[', '_').replace(']', '_')
-                    filename = filename.replace('_.' + extension, '.' + extension)
-
-            # What we do now depends on whether we are generating the reference
-            # files or simply running the test.
-            if self.generate_dir is None:
-
-                # Save the figure
-                result_dir = tempfile.mkdtemp()
-                test_array = os.path.abspath(os.path.join(result_dir, filename))
-
-                FORMATS[file_format].write(test_array, array, **write_kwargs)
-
-                # Find path to baseline array
-                if baseline_remote:
-                    baseline_file_ref = _download_file(reference_dir + filename)
-                else:
-                    baseline_file_ref = os.path.abspath(os.path.join(os.path.dirname(item.fspath.strpath), reference_dir, filename))
-
-                if not os.path.exists(baseline_file_ref):
-                    raise Exception("""File not found for comparison test
-                                    Generated file:
-                                    \t{test}
-                                    This is expected for new tests.""".format(
-                        test=test_array))
-
-                # 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)
-
-                identical, msg = FORMATS[file_format].compare(baseline_file, test_array, atol=atol, rtol=rtol)
-
-                if identical:
-                    shutil.rmtree(result_dir)
-                else:
-                    raise Exception(msg)
+                filename = item.name + '.' + extension
+                filename = filename.replace('[', '_').replace(']', '_')
+                filename = filename.replace('_.' + extension, '.' + extension)
+
+        # What we do now depends on whether we are generating the reference
+        # files or simply running the test.
+        if self.generate_dir is None:
+
+            # Save the figure
+            result_dir = tempfile.mkdtemp()
+            test_array = os.path.abspath(os.path.join(result_dir, filename))
+
+            FORMATS[file_format].write(test_array, array, **write_kwargs)
 
+            # Find path to baseline array
+            if baseline_remote:
+                baseline_file_ref = _download_file(reference_dir + filename)
             else:
+                baseline_file_ref = os.path.abspath(os.path.join(os.path.dirname(item.fspath.strpath), reference_dir, filename))
 
-                if not os.path.exists(self.generate_dir):
-                    os.makedirs(self.generate_dir)
+            if not os.path.exists(baseline_file_ref):
+                raise Exception("""File not found for comparison test
+                                Generated file:
+                                \t{test}
+                                This is expected for new tests.""".format(
+                    test=test_array))
 
-                FORMATS[file_format].write(os.path.abspath(os.path.join(self.generate_dir, filename)), array, **write_kwargs)
+            # 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)
 
-                pytest.skip("Skipping test, since generating data")
+            identical, msg = FORMATS[file_format].compare(baseline_file, test_array, atol=atol, rtol=rtol)
+
+            if identical:
+                shutil.rmtree(result_dir)
+            else:
+                raise Exception(msg)
 
-        if item.cls is not None:
-            setattr(item.cls, item.function.__name__, item_function_wrapper)
         else:
-            item.obj = item_function_wrapper
+
+            if not os.path.exists(self.generate_dir):
+                os.makedirs(self.generate_dir)
+
+            FORMATS[file_format].write(os.path.abspath(os.path.join(self.generate_dir, filename)), array, **write_kwargs)
+
+            pytest.skip("Skipping test, since generating data")
+
+
+class ArrayInterceptor:
+    """
+    This is used in place of ArrayComparison when the array comparison option is not used,
+    to make sure that we still intercept arrays returned by tests.
+    """
+
+    def __init__(self, config):
+        self.config = config
+        self.return_value = {}
+
+    @pytest.hookimpl(hookwrapper=True)
+    def pytest_runtest_call(self, item):
+
+        if item.get_closest_marker('array_compare') is not None:
+            wrap_array_interceptor(self, item)
+
+        yield
+        return

pytest_arraydiff/version.py

@@ -1,5 +1,16 @@
-# coding: utf-8
 # file generated by setuptools_scm
 # don't change, don't track in version control
-version = '0.5.0'
-version_tuple = (0, 5, 0)
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)

{pytest_arraydiff-0.5.0.dist-info → pytest_arraydiff-0.6.1.dist-info}/METADATA

@@ -1,12 +1,11 @@
 Metadata-Version: 2.1
 Name: pytest-arraydiff
-Version: 0.5.0
+Version: 0.6.1
 Summary: pytest plugin to help with comparing array output from tests
 Home-page: https://github.com/astropy/pytest-arraydiff
 Author: The Astropy Developers
 Author-email: astropy.team@gmail.com
 License: BSD
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
@@ -15,19 +14,24 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Utilities
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: pytest (>=4.6)
+Requires-Dist: pytest >=4.6
 Requires-Dist: numpy
 Provides-Extra: test
 Requires-Dist: astropy ; extra == 'test'
+Requires-Dist: pandas ; extra == 'test'
+Requires-Dist: tables ; extra == 'test'
 
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5811772.svg
    :target: https://doi.org/10.5281/zenodo.5811772
@@ -37,6 +41,10 @@ Requires-Dist: astropy ; extra == 'test'
     :target: https://github.com/astropy/pytest-arraydiff/actions
     :alt: CI Status
 
+.. image:: https://img.shields.io/pypi/v/pytest-arraydiff.svg
+    :target: https://pypi.org/project/pytest-arraydiff
+    :alt: PyPI Status
+
 About
 -----
 
@@ -46,7 +54,8 @@ in cases where the arrays are too large to conveniently hard-code them
 in the tests (e.g. ``np.testing.assert_allclose(x, [1, 2, 3])``).
 
 The basic idea is that you can write a test that generates a Numpy array (or
-other related objects depending on the format). You can then either run the
+other related objects depending on the format, e.g. pandas DataFrame).
+You can then either run the
 tests in a mode to **generate** reference files from the arrays, or you can run
 the tests in **comparison** mode, which will compare the results of the tests to
 the reference ones within some tolerance.
@@ -56,6 +65,7 @@ At the moment, the supported file formats for the reference files are:
 -  A plain text-based format (based on Numpy ``loadtxt`` output)
 -  The FITS format (requires `astropy <http://www.astropy.org>`__). With this
    format, tests can return either a Numpy array for a FITS HDU object.
+-  A pandas HDF5 format using the pandas HDFStore
 
 For more information on how to write tests to do this, see the **Using**
 section below.
@@ -140,12 +150,12 @@ The supported formats at this time are ``text`` and ``fits``, and
 contributions for other formats are welcome. The default format is
 ``text``.
 
-Another argument is the relative tolerance for floating point values
-(which defaults to 1e-7):
+Additional arguments are the relative and absolute tolerances for floating
+point values (which default to 1e-7 and 0, respectively):
 
 .. code:: python
 
-    @pytest.mark.array_compare(rtol=20)
+    @pytest.mark.array_compare(rtol=20, atol=0.1)
     def test_array():
         ...
 
@@ -223,5 +233,3 @@ install the latest version of the plugin then do::
 
 The reason for having to install the plugin first is to ensure that the
 plugin is correctly loaded as part of the test suite.
-
-

pytest_arraydiff-0.6.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+pytest_arraydiff/__init__.py,sha256=ICVlMfJSyUfBfTrbT0iaRCQuzdTOdpNCGyxVOwgxXzQ,117
+pytest_arraydiff/plugin.py,sha256=EiHNkfhbpbCaWj75nXsjVftCerQ84VT7__PofriTd0Q,13342
+pytest_arraydiff/version.py,sha256=lgiCYGSijhLK71WmuudWf_AyhNAutwQWx2V8bV6a5VQ,411
+pytest_arraydiff-0.6.1.dist-info/LICENSE,sha256=sx9xdEnc-QGbdeT_denLAE1qpXXXIO0qP2TRH-4sKe8,1448
+pytest_arraydiff-0.6.1.dist-info/METADATA,sha256=iM0h6TII_DGeAKR6ulxHPw9_kC_s6RyKSx7QiZJtg7o,8545
+pytest_arraydiff-0.6.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+pytest_arraydiff-0.6.1.dist-info/entry_points.txt,sha256=1mmqAdBTczR-Jj1RtaLXIdnibdhQBqaNCzRSaxhTRpk,54
+pytest_arraydiff-0.6.1.dist-info/top_level.txt,sha256=7fVOoIyJHVuSQkxQKVkfifGCXbQoyqMWSgzmwEBeegQ,17
+pytest_arraydiff-0.6.1.dist-info/RECORD,,

{pytest_arraydiff-0.5.0.dist-info → pytest_arraydiff-0.6.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{pytest_arraydiff-0.5.0.dist-info → pytest_arraydiff-0.6.1.dist-info}/entry_points.txt

@@ -1,3 +1,2 @@
 [pytest11]
 pytest_arraydiff = pytest_arraydiff.plugin
-

pytest_arraydiff-0.5.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-pytest_arraydiff/__init__.py,sha256=ICVlMfJSyUfBfTrbT0iaRCQuzdTOdpNCGyxVOwgxXzQ,117
-pytest_arraydiff/plugin.py,sha256=ezuiW3IGwWd1if22VHKqeqLYnnAPQOH6HD5nbcj2C2c,11206
-pytest_arraydiff/version.py,sha256=qOgp63DKbJUTEpeNFSC6-4Z4ggiiiujx7_nJvXchvEg,142
-pytest_arraydiff-0.5.0.dist-info/LICENSE,sha256=sx9xdEnc-QGbdeT_denLAE1qpXXXIO0qP2TRH-4sKe8,1448
-pytest_arraydiff-0.5.0.dist-info/METADATA,sha256=JIXG_b4AZHhfTlov64bcGiiEN3wz_2Uc5xMoQGGj_JM,8073
-pytest_arraydiff-0.5.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-pytest_arraydiff-0.5.0.dist-info/entry_points.txt,sha256=9IUCpViMZtfu6JLjdCBtUGPGirih2uwOewuqqXzqpeQ,55
-pytest_arraydiff-0.5.0.dist-info/top_level.txt,sha256=7fVOoIyJHVuSQkxQKVkfifGCXbQoyqMWSgzmwEBeegQ,17
-pytest_arraydiff-0.5.0.dist-info/RECORD,,