testutils.pyi 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. import numpy as np
  2. from numpy._typing import NDArray
  3. from numpy.testing import (
  4. TestCase,
  5. assert_,
  6. assert_allclose,
  7. assert_array_almost_equal_nulp,
  8. assert_raises,
  9. )
  10. from numpy.testing._private.utils import _ComparisonFunc
  11. __all__ = [
  12. "TestCase",
  13. "almost",
  14. "approx",
  15. "assert_",
  16. "assert_allclose",
  17. "assert_almost_equal",
  18. "assert_array_almost_equal",
  19. "assert_array_almost_equal_nulp",
  20. "assert_array_approx_equal",
  21. "assert_array_compare",
  22. "assert_array_equal",
  23. "assert_array_less",
  24. "assert_close",
  25. "assert_equal",
  26. "assert_equal_records",
  27. "assert_mask_equal",
  28. "assert_not_equal",
  29. "assert_raises",
  30. "fail_if_array_equal",
  31. ]
  32. def approx(
  33. a: object, b: object, fill_value: bool = True, rtol: float = 1e-5, atol: float = 1e-8
  34. ) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
  35. def almost(a: object, b: object, decimal: int = 6, fill_value: bool = True) -> np.ndarray[tuple[int], np.dtype[np.bool]]: ...
  36. #
  37. def assert_equal_records(a: NDArray[np.void], b: NDArray[np.void]) -> None: ...
  38. def assert_equal(actual: object, desired: object, err_msg: str = "") -> None: ...
  39. def fail_if_equal(actual: object, desired: object, err_msg: str = "") -> None: ...
  40. def assert_almost_equal(
  41. actual: object, desired: object, decimal: int = 7, err_msg: str = "", verbose: bool = True
  42. ) -> None: ...
  43. #
  44. def assert_array_compare(
  45. comparison: _ComparisonFunc,
  46. x: object,
  47. y: object,
  48. err_msg: str = "",
  49. verbose: bool = True,
  50. header: str = "",
  51. fill_value: bool = True,
  52. ) -> None: ...
  53. def assert_array_equal(x: object, y: object, err_msg: str = "", verbose: bool = True) -> None: ...
  54. def fail_if_array_equal(x: object, y: object, err_msg: str = "", verbose: bool = True) -> None: ...
  55. def assert_array_approx_equal(
  56. x: object, y: object, decimal: int = 6, err_msg: str = "", verbose: bool = True
  57. ) -> None: ...
  58. def assert_array_almost_equal(
  59. x: object, y: object, decimal: int = 6, err_msg: str = "", verbose: bool = True
  60. ) -> None: ...
  61. def assert_array_less(x: object, y: object, err_msg: str = "", verbose: bool = True) -> None: ...
  62. def assert_mask_equal(m1: object, m2: object, err_msg: str = "") -> None: ...
  63. assert_not_equal = fail_if_equal
  64. assert_close = assert_almost_equal