Improve string representation of matcher in allure report

changelog.d/170.feature.rst

@@ -0,0 +1 @@
+* Add pretty string representation for matchers objects

src/hamcrest/core/base_matcher.py

@@ -1,3 +1,4 @@
+from textwrap import shorten
 from typing import Optional, TypeVar
 
 from hamcrest.core.description import Description
@@ -25,6 +26,12 @@ class BaseMatcher(Matcher[T]):
  def __str__(self) -> str:
  return tostring(self)
 
+ def __repr__(self) -> str:
+ """Returns matcher string representation."""
+ return "<{0}({1})>".format(
+ self.__class__.__name__, shorten(tostring(self), 60, placeholder="...")
+ )
+
  def _matches(self, item: T) -> bool:
  raise NotImplementedError("_matches")
 

tests/hamcrest_unit_test/base_matcher_test.py

@@ -37,6 +37,19 @@ def testMismatchDescriptionShouldDescribeItem(self):
  def testMatchDescriptionShouldDescribeItem(self):
  assert_match_description("was <99>", PassingBaseMatcher(), 99)
 
+ def testMatcherReprShouldDescribeMatcher(self):
+ assert repr(FailingBaseMatcher()) == "<FailingBaseMatcher(SOME DESCRIPTION)>"
+
+ def testMatcherReprShouldTruncateLongDescription(self):
+ class LongDescriptionMatcher(BaseMatcher):
+ def describe_to(self, description):
+ description.append_text("1234 " * 13)
+
+ assert (
+ repr(LongDescriptionMatcher())
+ == "<LongDescriptionMatcher(1234 1234 1234 1234 1234 1234 1234 1234 1234 1234 1234...)>"
+ )
+
 
 if __name__ == "__main__":
  unittest.main()