remove UsageError in favor of ValueError (#61031)

pmeier · facebook-github-bot · commit 682ebc1dd11c · 2021-07-09T11:28:33.000-07:00
Summary: Pull Request resolved: #61031 See #58916 (comment). Test Plan: Imported from OSS Reviewed By: iramazanli Differential Revision: D29626810 Pulled By: mruberry fbshipit-source-id: 25ddf26815f9ef82b8234d7dac811a6a13a53c54
diff --git a/test/test_testing.py b/test/test_testing.py
@@ -18,7 +18,6 @@
      deviceCountAtLeast)
 from torch.testing._internal.common_methods_invocations import op_db
 import torch.testing._internal.opinfo_helper as opinfo_helper
-from torch.testing._asserts import UsageError
 
 # For testing TestCase methods and torch.testing functions
 class TestTesting(TestCase):
@@ -753,7 +752,7 @@ def test_unknown_type(self):
         expected = "0"
 
         for fn in assert_close_with_inputs(actual, expected):
-            with self.assertRaisesRegex(UsageError, str(type(actual))):
+            with self.assertRaisesRegex(ValueError, str(type(actual))):
                 fn()
 
     def test_mismatching_shape(self):
@@ -770,7 +769,7 @@ def test_unknown_layout(self):
         expected = actual.to_mkldnn()
 
         for fn in assert_close_with_inputs(actual, expected):
-            with self.assertRaises(UsageError):
+            with self.assertRaises(ValueError):
                 fn()
 
     def test_mismatching_layout(self):
@@ -817,15 +816,15 @@ def test_only_rtol(self):
         expected = actual.clone()
 
         for fn in assert_close_with_inputs(actual, expected):
-            with self.assertRaises(UsageError):
+            with self.assertRaises(ValueError):
                 fn(rtol=0.0)
 
     def test_only_atol(self):
         actual = torch.empty(())
         expected = actual.clone()
 
         for fn in assert_close_with_inputs(actual, expected):
-            with self.assertRaises(UsageError):
+            with self.assertRaises(ValueError):
                 fn(atol=0.0)
 
     def test_mismatching_values(self):
diff --git a/torch/testing/_asserts.py b/torch/testing/_asserts.py
@@ -12,24 +12,14 @@
 __all__ = ["assert_close"]
 
 
-# The UsageError should be raised in case the test function is not used correctly. With this the user is able to
-# differentiate between a test failure (there is a bug in the tested code) and a test error (there is a bug in the
-# test).
-class UsageError(Exception):
-    pass
-
-
-_TestingError = Union[AssertionError, UsageError]
-
-
 class _TestingErrorMeta(NamedTuple):
-    type: Type[_TestingError]
+    type: Type[Exception]
     msg: str
 
     def amend_msg(self, prefix: str = "", postfix: str = "") -> "_TestingErrorMeta":
         return self._replace(msg=f"{prefix}{self.msg}{postfix}")
 
-    def to_error(self) -> _TestingError:
+    def to_error(self) -> Exception:
         return self.type(self.msg)
 
 
@@ -203,9 +193,8 @@ def _check_supported_tensor(input: Tensor) -> Optional[_TestingErrorMeta]:
     Returns:
         (Optional[_TestingErrorMeta]): If check did not pass.
     """
-
     if input.layout not in {torch.strided, torch.sparse_coo, torch.sparse_csr}:  # type: ignore[attr-defined]
-        return _TestingErrorMeta(UsageError, f"Unsupported tensor layout {input.layout}")
+        return _TestingErrorMeta(ValueError, f"Unsupported tensor layout {input.layout}")
 
     return None
 
@@ -566,7 +555,7 @@ def _to_tensor(tensor_or_scalar_like: Any) -> Tuple[Optional[_TestingErrorMeta],
             tensor = torch.as_tensor(tensor_or_scalar_like)
         except Exception:
             error_meta = _TestingErrorMeta(
-                UsageError, f"No tensor can be constructed from type {type(tensor_or_scalar_like)}."
+                ValueError, f"No tensor can be constructed from type {type(tensor_or_scalar_like)}."
             )
             return error_meta, None
 
@@ -787,8 +776,8 @@ def assert_close(
             the mismatching tensors and a namespace of diagnostics about the mismatches. See below for details.
 
     Raises:
-        UsageError: If no :class:`torch.Tensor` can be constructed from an input.
-        UsageError: If only :attr:`rtol` or :attr:`atol` is specified.
+        ValueError: If no :class:`torch.Tensor` can be constructed from an input.
+        ValueError: If only :attr:`rtol` or :attr:`atol` is specified.
         AssertionError: If corresponding inputs are not Python scalars and are not directly related.
         AssertionError: If :attr:`allow_subclasses` is ``False``, but corresponding inputs are not Python scalars and
             have different types.
@@ -970,7 +959,7 @@ def assert_close(
     if (rtol is None) ^ (atol is None):
         # We require both tolerance to be omitted or specified, because specifying only one might lead to surprising
         # results. Imagine setting atol=0.0 and the tensors still match because rtol>0.0.
-        raise UsageError(
+        raise ValueError(
             f"Both 'rtol' and 'atol' must be either specified or omitted, "
             f"but got no {'rtol' if rtol is None else 'atol'}.",
         )
