Improve error messages in "dates".

Author: domdfcoding

domdf_python_tools/dates.py

@@ -160,19 +160,21 @@ def parse_month(month: Union[str, int]) -> str:
 	:return: The full name of the month
 	"""
 
+	error_text = f"The given month ({month!r}) is not recognised."
+
 	try:
 		month = int(month)
 	except ValueError:
 		try:
 			return months[month.capitalize()[:3]]  # type: ignore
 		except KeyError:
-			raise ValueError("Unrecognised month value")
+			raise ValueError(error_text)
 
 	# Only get here if first try succeeded
 	if 0 < month <= 12:
 		return list(months.values())[month - 1]
 	else:
-		raise ValueError("Unrecognised month value")
+		raise ValueError(error_text)
 
 
 def get_month_number(month: Union[str, int]) -> int:
@@ -189,7 +191,7 @@ def get_month_number(month: Union[str, int]) -> int:
 		if 0 < month <= 12:
 			return month
 		else:
-			raise ValueError("The given month is not recognised.")
+			raise ValueError(f"The given month ({month!r}) is not recognised.")
 	else:
 		month = parse_month(month)
 		return list(months.values()).index(month) + 1
@@ -198,14 +200,15 @@ def get_month_number(month: Union[str, int]) -> int:
 def check_date(month: Union[str, int], day: int, leap_year: bool = True) -> bool:
 	"""
 	Returns :py:obj:`True` if the day number is valid for the given month.
-	Note that this will return :py:obj:`True` for the 29th Feb. If you don't
-	want this behaviour set ``leap_year`` to :py:obj:`False`.
+
+	.. note::
+
+		This function will return :py:obj:`True` for the 29th Feb.
+		If you don't want this behaviour set ``leap_year`` to :py:obj:`False`.
 
 	:param month: The month to test.
 	:param day: The day number to test.
 	:param leap_year: Whether to return :py:obj:`True` for 29th Feb.
-
-	:return: :py:obj:`True` if the date is valid.
 	"""
 
 	# Ensure day is an integer

tests/test_dates.py

@@ -8,6 +8,7 @@
 
 # stdlib
 import datetime
+import re
 from datetime import date
 
 # 3rd party
@@ -187,7 +188,7 @@ def test_parse_month():
 		assert dates.parse_month(month_idx) == month
 
 	for value in ["abc", 0, '0', -1, "-1", 13, "13"]:
-		with pytest.raises(ValueError, match="Unrecognised month value"):
+		with pytest.raises(ValueError, match=fr"The given month \({value!r}\) is not recognised."):
 			dates.parse_month(value)  # type: ignore
 
 
@@ -211,17 +212,17 @@ def test_get_month_number_from_no(count):
 @pytest.mark.parametrize(
 		"value, match",
 		[
-				(0, "The given month is not recognised."),
-				(-1, "The given month is not recognised."),
-				(13, "The given month is not recognised."),
-				("abc", "Unrecognised month value"),
-				('0', "Unrecognised month value"),
-				("-1", "Unrecognised month value"),
-				("13", "Unrecognised month value"),
+				(0, "The given month (0) is not recognised."),
+				(-1, "The given month (-1) is not recognised."),
+				(13, "The given month (13) is not recognised."),
+				("abc", "The given month ('abc') is not recognised."),
+				('0', "The given month ('0') is not recognised."),
+				("-1", "The given month ('-1') is not recognised."),
+				("13", "The given month ('13') is not recognised."),
 				]
 		)
 def test_get_month_number_errors(value, match):
-	with pytest.raises(ValueError, match=match):
+	with pytest.raises(ValueError, match=re.escape(match)):
 		dates.get_month_number(value)