Reflect changes from ESSS/pytest-regressions#35

pytest_regressions-stubs/dataframe_regression.pyi

@@ -0,0 +1,40 @@
+# stdlib
+from pathlib import Path
+from typing import Any, Dict, Mapping, Optional
+
+# 3rd party
+import pandas
+from _pytest.fixtures import FixtureRequest
+
+
+class DataFrameRegressionFixture:
+	"""
+    Pandas DataFrame Regression fixture implementation used on dataframe_regression fixture.
+    """
+
+	DISPLAY_PRECISION: int = 17  # Decimal places
+	DISPLAY_WIDTH: int = 1000  # Max. Chars on outputs
+	DISPLAY_MAX_COLUMNS: int = 1000  # Max. Number of columns (see #3)
+
+	request: FixtureRequest
+	datadir: Path
+	original_datadir: Path
+	_force_regen: bool
+	_tolerances_dict: Dict[str, Any]
+	_default_tolerance: Dict[str, float]
+	_pandas_display_options: Dict[str, float]
+
+	def __init__(self, datadir: Path, original_datadir: Path, request: FixtureRequest): ...
+	def _check_data_types(self, key: str, obtained_column: pandas.Series, expected_column: pandas.Series) -> None: ...
+	def _check_data_shapes(self, obtained_column: pandas.Series, expected_column: pandas.Series) -> None: ...
+	def _check_fn(self, obtained_filename: str, expected_filename: str) -> None: ...
+	def _dump_fn(self, data_object: pandas.DataFrame, filename: str) -> None: ...
+
+	def check(
+			self,
+			data_frame: pandas.DataFrame,
+			basename: Optional[str] = None,
+			fullpath: Optional[str] = None,
+			tolerances: Optional[Mapping[str, Any]] = None,
+			default_tolerance: Optional[Mapping[str, float]] = None,
+			) -> None: ...

pytest_regressions-stubs/num_regression.pyi

@@ -1,36 +1,18 @@
 # stdlib
-from pathlib import Path
-from typing import Any, Dict, List, Mapping, Optional
+from typing import Any, List, Mapping, Optional
 
 # 3rd party
 import numpy
-import pandas
-from _pytest.fixtures import FixtureRequest
 
+# this package
+from pytest_regressions.dataframe_regression import DataFrameRegressionFixture
 
-class NumericRegressionFixture:
+
+class NumericRegressionFixture(DataFrameRegressionFixture):
 	"""
 	Numeric Data Regression fixture implementation used on num_regression fixture.
 	"""
 
-	DISPLAY_PRECISION: int = 17  # Decimal places
-	DISPLAY_WIDTH: int = 1000  # Max. Chars on outputs
-	DISPLAY_MAX_COLUMNS: int = 1000  # Max. Number of columns (see #3)
-
-	request: FixtureRequest
-	datadir: Path
-	original_datadir: Path
-	_force_regen: bool
-	_tolerances_dict: Dict[str, Any]
-	_default_tolerance: Dict[str, float]
-	_pandas_display_options: Dict[str, float]
-
-	def __init__(self, datadir: Path, original_datadir: Path, request: FixtureRequest): ...
-	def _check_data_types(self, key: str, obtained_column: pandas.Series, expected_column: pandas.Series) -> None: ...
-	def _check_data_shapes(self, obtained_column: pandas.Series, expected_column: pandas.Series) -> None: ...
-	def _check_fn(self, obtained_filename: str, expected_filename: str) -> None: ...
-	def _dump_fn(self, data_object: pandas.DataFrame, filename: str) -> None: ...
-
 	def check(
 			self,
 			data_dict: Mapping[str, numpy.ndarray],

pytest_regressions-stubs/plugin.pyi

@@ -8,6 +8,7 @@ from _pytest.fixtures import FixtureRequest
 
 # this package
 from .data_regression import DataRegressionFixture
+from .dataframe_regression import DataFrameRegressionFixture
 from .file_regression import FileRegressionFixture
 from .num_regression import NumericRegressionFixture
 from .image_regression import ImageRegressionFixture
@@ -25,3 +26,6 @@ def num_regression(datadir: Path, original_datadir: Path, request: FixtureReques
 
 @pytest.fixture
 def image_regression(datadir: Path, original_datadir: Path, request: FixtureRequest) -> ImageRegressionFixture: ...
+
+@pytest.fixture
+def dataframe_regression(datadir: Path, original_datadir: Path, request: FixtureRequest) -> DataFrameRegressionFixture: ...