feat: add timestamp util

Signed-off-by: onerandomusername <genericusername414+git@gmail.com>

Author: onerandomusername

modmail/utils/time.py

@@ -0,0 +1,39 @@
+import datetime
+import enum
+import typing
+
+import arrow
+
+
+class TimeStampEnum(enum.Enum):
+    """
+    Timestamp modes for discord.
+
+    Full docs on this format are viewable here:
+    https://discord.com/developers/docs/reference#message-formatting
+    """
+
+    SHORT_TIME = "t"
+    LONG_TIME = "T"
+    SHORT_DATE = "d"
+    LONG_DATE = "D"
+    SHORT_DATE_TIME = "f"
+    LONG_DATE_TIME = "F"
+    RELATIVE_TIME = "R"
+
+    # DEFAULT
+    DEFAULT = SHORT_DATE_TIME
+
+
+TypeTimes = typing.Union[arrow.Arrow, datetime.datetime]
+
+
+def get_discord_formatted_timestamp(
+    timestamp: TypeTimes, format: TimeStampEnum = TimeStampEnum.DEFAULT
+) -> str:
+    """
+    Return a discord formatted timestamp from a datetime compatiable datatype.
+
+    `format` must be an enum member of TimeStampEnum. Default style is SHORT_DATE_TIME
+    """
+    return f"<t:{int(timestamp.timestamp())}:{format.value}>"

tests/modmail/utils/test_time.py

@@ -0,0 +1,25 @@
+import arrow
+import pytest
+
+from modmail.utils import time as utils_time
+from modmail.utils.time import TimeStampEnum
+
+
+@pytest.mark.parametrize(
+    ["timestamp", "expected", "mode"],
+    [
+        [arrow.get(1634593650), "<t:1634593650:f>", TimeStampEnum.SHORT_DATE_TIME],
+        [arrow.get(1), "<t:1:f>", TimeStampEnum.SHORT_DATE_TIME],
+        [arrow.get(12356941), "<t:12356941:R>", TimeStampEnum.RELATIVE_TIME],
+    ],
+)
+def test_timestamp(timestamp, expected: str, mode: utils_time.TimeStampEnum):
+    """Test the timestamp is of the proper form."""
+    fmtted_timestamp = utils_time.get_discord_formatted_timestamp(timestamp, mode)
+    assert expected == fmtted_timestamp
+
+
+def test_enum_default():
+    """Ensure that the default mode is of the correct mode, and works properly."""
+    assert TimeStampEnum.DEFAULT.name == TimeStampEnum.SHORT_DATE_TIME.name
+    assert TimeStampEnum.DEFAULT.value == TimeStampEnum.SHORT_DATE_TIME.value