summaryrefslogtreecommitdiffstats
path: root/lib/python/qmk/datetime.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/datetime.py')
-rw-r--r--lib/python/qmk/datetime.py29
1 files changed, 29 insertions, 0 deletions
diff --git a/lib/python/qmk/datetime.py b/lib/python/qmk/datetime.py
new file mode 100644
index 0000000000..4bffcc6217
--- /dev/null
+++ b/lib/python/qmk/datetime.py
@@ -0,0 +1,29 @@
+"""Functions to work with dates and times in a uniform way.
+
+The results of these functions are cached for 5 seconds to provide uniform time strings across short running processes. Long running processes that need more precise timekeeping should not use these functions.
+"""
+from time import gmtime, strftime
+
+from qmk.constants import DATE_FORMAT, DATETIME_FORMAT, TIME_FORMAT
+from qmk.decorators import lru_cache
+
+
+@lru_cache(timeout=5)
+def current_date():
+ """Returns the current time in UTZ as a formatted string.
+ """
+ return strftime(DATE_FORMAT, gmtime())
+
+
+@lru_cache(timeout=5)
+def current_datetime():
+ """Returns the current time in UTZ as a formatted string.
+ """
+ return strftime(DATETIME_FORMAT, gmtime())
+
+
+@lru_cache(timeout=5)
+def current_time():
+ """Returns the current time in UTZ as a formatted string.
+ """
+ return strftime(TIME_FORMAT, gmtime())