Skip to content

refactor: update convert_date_to_text to return None when invalid input #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
niltonpimentel02 merged 2 commits into from
Sep 8, 2025
Merged

refactor: update convert_date_to_text to return None when invalid input #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff988b5
refactor: update convert_date_to_text to return None when invalid input
niltonpimentel02 Sep 8, 2025
a0ac6f5
fix: lint
niltonpimentel02 Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions brutils/date.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
import re
from typing import Union

from num2words import num2words

from brutils.data.enums.months import MonthsEnum


def convert_date_to_text(date: str) -> Union[str, None]:
def convert_date_to_text(date: str) -> str | None:
"""
Converts a given date in Brazilian format (dd/mm/yyyy) to its textual representation.

Expand All @@ -24,9 +23,7 @@ def convert_date_to_text(date: str) -> Union[str, None]:
"""
pattern = re.compile(r"\d{2}/\d{2}/\d{4}")
if not re.match(pattern, date):
raise ValueError(
"Date is not a valid date. Please pass a date in the format dd/mm/yyyy."
)
return None

day_str, month_str, year_str = date.split("/")
day = int(day_str)
Expand Down
8 changes: 4 additions & 4 deletions tests/test_date.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ def test_convert_date_to_text(self):
self.assertIsNone(convert_date_to_text("29/02/2019"), None)

# Invalid date pattern.
self.assertRaises(ValueError, convert_date_to_text, "Invalid")
self.assertRaises(ValueError, convert_date_to_text, "25/1/2020")
self.assertRaises(ValueError, convert_date_to_text, "1924/08/20")
self.assertRaises(ValueError, convert_date_to_text, "5/09/2020")
self.assertIsNone(convert_date_to_text("Invalid"))
self.assertIsNone(convert_date_to_text("25/1/2020"))
self.assertIsNone(convert_date_to_text("1924/08/20"))
self.assertIsNone(convert_date_to_text("5/09/2020"))

self.assertEqual(
convert_date_to_text("29/02/2020"),
Expand Down