edq-utils 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

edq/util/time_test.py

@@ -0,0 +1,107 @@
+import time
+import datetime
+
+import edq.testing.unittest
+import edq.util.time
+
+TIMEZONE_UTC: datetime.timezone = datetime.timezone.utc
+TIMEZONE_PST: datetime.timezone = datetime.timezone(datetime.timedelta(hours = -7), name = 'PST')
+TIMEZONE_CEST: datetime.timezone = datetime.timezone(datetime.timedelta(hours = 2), name = 'CEST')
+
+class TestTime(edq.testing.unittest.BaseTest):
+    """ Test time-based operations. """
+
+    def test_timestamp_now(self):
+        """ Test getting a timestamp for the current moment. """
+
+        start = edq.util.time.Timestamp.now()
+        time.sleep(0.01)
+        middle = edq.util.time.Timestamp.now()
+        time.sleep(0.01)
+        end = edq.util.time.Timestamp.now()
+
+        self.assertLessEqual(start, middle)
+        self.assertLessEqual(middle, end)
+
+    def test_timestamp_pytime_conversion(self):
+        """ Test converting between timestamps and Python datetimes. """
+
+        # [(timestamp, python time), ...]
+        test_cases = [
+            (edq.util.time.Timestamp(0), datetime.datetime(1970, 1, 1, 0, 0, 0, 0, TIMEZONE_UTC)),
+
+            (edq.util.time.Timestamp(1755139534019), datetime.datetime(2025, 8, 14, 2,  45, 34, 19000, TIMEZONE_UTC)),
+            (edq.util.time.Timestamp(1755139534019), datetime.datetime(2025, 8, 13, 19, 45, 34, 19000, TIMEZONE_PST)),
+            (edq.util.time.Timestamp(1755139534019), datetime.datetime(2025, 8, 14, 4,  45, 34, 19000, TIMEZONE_CEST)),
+        ]
+
+        for (i, test_case) in enumerate(test_cases):
+            (timestamp, pytime) = test_case
+
+            with self.subTest(msg = f"Case {i} ('{timestamp}' == '{pytime}'):"):
+                convert_pytime = timestamp.to_pytime(pytime.tzinfo)
+                self.assertEqual(pytime, convert_pytime, 'pytime')
+
+                convert_timestamp = edq.util.time.Timestamp.from_pytime(pytime)
+                self.assertEqual(timestamp, convert_timestamp, 'timestamp')
+
+                # Check other time zones.
+                # Use string comparisons to ensure the timezone is compared (and not just the UTC time).
+                timezones = [
+                    TIMEZONE_UTC,
+                    TIMEZONE_PST,
+                    TIMEZONE_CEST,
+                ]
+
+                for timezone in timezones:
+                    pytime_pst = pytime.astimezone(timezone).isoformat(timespec = 'milliseconds')
+                    convert_pytime_pst = timestamp.to_pytime(timezone).isoformat(timespec = 'milliseconds')
+                    self.assertEqual(pytime_pst, convert_pytime_pst, f"pytime {timezone}")
+
+    def test_timestamp_pretty(self):
+        """ Test the "pretty" representations of timestamps. """
+
+        # [(timestamp, timezone, pretty short, pretty long), ...]
+        test_cases = [
+            (edq.util.time.Timestamp(0), TIMEZONE_UTC, "1970-01-01 00:00", "1970-01-01T00:00:00.000+00:00"),
+
+            (edq.util.time.Timestamp(1755139534019), TIMEZONE_UTC,  "2025-08-14 02:45", "2025-08-14T02:45:34.019+00:00"),
+            (edq.util.time.Timestamp(1755139534019), TIMEZONE_PST,  "2025-08-13 19:45", "2025-08-13T19:45:34.019-07:00"),
+            (edq.util.time.Timestamp(1755139534019), TIMEZONE_CEST, "2025-08-14 04:45", "2025-08-14T04:45:34.019+02:00"),
+        ]
+
+        for (i, test_case) in enumerate(test_cases):
+            (timestamp, timezone, expected_pretty_short, expected_pretty_long) = test_case
+
+            with self.subTest(msg = f"Case {i} ('{timestamp}'):"):
+                actual_pretty_short = timestamp.pretty(short = True, timezone = timezone)
+                actual_pretty_long = timestamp.pretty(short = False, timezone = timezone)
+
+                self.assertEqual(expected_pretty_short, actual_pretty_short, 'short')
+                self.assertEqual(expected_pretty_long, actual_pretty_long, 'long')
+
+    def test_timestamp_sub(self):
+        """ Test subtracting timestamps. """
+
+        # [(a, b, expected), ...]
+        # All values in this structure will be in ints and converted later.
+        test_cases = [
+            (0, 0, 0),
+            (0, 1, -1),
+            (1, 0, 1),
+
+            (100, 100, 0),
+            (100, 101, -1),
+            (101, 100, 1),
+        ]
+
+        for (i, test_case) in enumerate(test_cases):
+            (raw_a, raw_b, raw_expected) = test_case
+
+            with self.subTest(msg = f"Case {i} ({raw_a} - {raw_b}):"):
+                a = edq.util.time.Timestamp(raw_a)
+                b = edq.util.time.Timestamp(raw_b)
+                expected = edq.util.time.Duration(raw_expected)
+
+                actual = a - b
+                self.assertEqual(expected, actual)

{edq_utils-0.0.1.dist-info → edq_utils-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edq-utils
-Version: 0.0.1
+Version: 0.0.3
 Summary: Common utilities used by EduLinq Python projects.
 Author-email: Eriq Augustine <eriq@edulinq.org>
 License: MIT License
@@ -34,8 +34,10 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: json5>=0.9.14
 Provides-Extra: dev
 Requires-Dist: mypy>=1.14.1; extra == "dev"
+Requires-Dist: pdoc>=14.7.0; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: vermin; extra == "dev"

edq_utils-0.0.3.dist-info/RECORD

@@ -0,0 +1,28 @@
+edq/__init__.py,sha256=SgI3o5Z-z1KSX-sg-2ZL2vhNQ-KiMte0ewCvjQv8wWA,86
+edq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+edq/testing/__init__.py,sha256=IKd3fPU_8d_jP19HxG-zKwxFwn7nqFGGtXOY5slY41c,32
+edq/testing/run.py,sha256=qnqGCEwZP-hY87X99EJw2xoMaTF8QeOf7Lx8JI7oM_4,3843
+edq/testing/unittest.py,sha256=J_sUYGIdP8HDQioQtUPF_H4n2aKf0_XHLdhzs59fvck,1665
+edq/util/__init__.py,sha256=9EFKQE77S-B6OJJKFaMg8k3WkMMUQYlGjlTv6tQmWVo,29
+edq/util/dirent.py,sha256=C-ZTVbOVBlEc71g4l8rMO5EJHv4Lcl9-FH0Kp1B3oc8,10314
+edq/util/dirent_test.py,sha256=oXpAaEhOkEr0zw0fdAPypx7QH1aFbY2Hpox-9OpZjhs,33380
+edq/util/json.py,sha256=p74F5OCxbRv4mvMSkRdy-fYVqAETx5_65IEhesTH8SM,5228
+edq/util/json_test.py,sha256=utUVRbw3z42ke4fpRVI294RrFHcMKms8khVYRkISNk4,8009
+edq/util/pyimport.py,sha256=M1j58vg4b6gTg92Cz5-bns3eQCCIMKDApBclP-iR620,2198
+edq/util/pyimport_test.py,sha256=wuTR5pzVZanWDA2FuVc-Pxyo_GwkGGfFf_qyK6LNQRs,2851
+edq/util/reflection.py,sha256=jPcW6h0fwSDYh04O5rUxlgoF7HK6fVQ2mq7DD9qPrEg,972
+edq/util/time.py,sha256=anoNM_KniARLombv2BnsoHuCzDqMKiDdIzV7RUe2ZOk,2648
+edq/util/time_test.py,sha256=iQZwzVTVQQ4TdXrLb9MUMCYlKrIe8qyF-hiC9YLTaMo,4610
+edq/util/testdata/dirent-operations/a.txt,sha256=h0KPxSKAPTEGXnvOPPA_5HUJZjHl4Hu9eg_eYMTPJcc,2
+edq/util/testdata/dirent-operations/file_empty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+edq/util/testdata/dirent-operations/symlink_a.txt,sha256=h0KPxSKAPTEGXnvOPPA_5HUJZjHl4Hu9eg_eYMTPJcc,2
+edq/util/testdata/dirent-operations/symlink_file_empty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+edq/util/testdata/dirent-operations/dir_1/b.txt,sha256=AmOCmYm2_ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8,2
+edq/util/testdata/dirent-operations/dir_1/dir_2/c.txt,sha256=o6XnFfDMV0pzw_m-u2vCTzL_1bZ7OHJEwskJ2neaFHg,2
+edq/util/testdata/dirent-operations/symlink_dir_1/b.txt,sha256=AmOCmYm2_ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8,2
+edq/util/testdata/dirent-operations/symlink_dir_1/dir_2/c.txt,sha256=o6XnFfDMV0pzw_m-u2vCTzL_1bZ7OHJEwskJ2neaFHg,2
+edq_utils-0.0.3.dist-info/licenses/LICENSE,sha256=MS4iYEl4rOxMoprZuc86iYVoyk4YgaVoMt7WmGvVF8w,1064
+edq_utils-0.0.3.dist-info/METADATA,sha256=YoOLw86gdPLaSAy_z9UfftRk83wxjjM-nD7r8H2FsEg,2471
+edq_utils-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+edq_utils-0.0.3.dist-info/top_level.txt,sha256=znBHSj6tgXtcMKrUVtovLli5fIEJCb7d-BMxTLRK4zk,4
+edq_utils-0.0.3.dist-info/RECORD,,

edq_utils-0.0.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-edq/__init__.py,sha256=DsAHdxLC16H2VjdFOU5tBx2xT9VnNQ-XbTS24fRCa_w,22
-edq/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-edq/util/dirent.py,sha256=Dr4OtB9TvJmiGLrjdiSmsh5Fk8G49jfklh4wdOx13ro,4436
-edq/util/dirent_test.py,sha256=FBMHEmcrfR7VILBzgy1cMWrFEp9wNQ5RNbL5vOdezT4,5998
-edq/util/testdata/dirent-operations/a.txt,sha256=h0KPxSKAPTEGXnvOPPA_5HUJZjHl4Hu9eg_eYMTPJcc,2
-edq/util/testdata/dirent-operations/file_empty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-edq/util/testdata/dirent-operations/symlinklink_a.txt,sha256=h0KPxSKAPTEGXnvOPPA_5HUJZjHl4Hu9eg_eYMTPJcc,2
-edq/util/testdata/dirent-operations/dir_1/b.txt,sha256=AmOCmYm2_ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8,2
-edq/util/testdata/dirent-operations/dir_1/dir_2/c.txt,sha256=o6XnFfDMV0pzw_m-u2vCTzL_1bZ7OHJEwskJ2neaFHg,2
-edq/util/testdata/dirent-operations/symlinklink_dir_1/b.txt,sha256=AmOCmYm2_ZVPcrqvL8ZLwuLwHWktTecphuqAj26ZgT8,2
-edq/util/testdata/dirent-operations/symlinklink_dir_1/dir_2/c.txt,sha256=o6XnFfDMV0pzw_m-u2vCTzL_1bZ7OHJEwskJ2neaFHg,2
-edq_utils-0.0.1.dist-info/licenses/LICENSE,sha256=MS4iYEl4rOxMoprZuc86iYVoyk4YgaVoMt7WmGvVF8w,1064
-edq_utils-0.0.1.dist-info/METADATA,sha256=Q99RoHQkHjWZEkP-gEdtEaEPE1xoauWVtUXWsE3OlmM,2398
-edq_utils-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-edq_utils-0.0.1.dist-info/top_level.txt,sha256=znBHSj6tgXtcMKrUVtovLli5fIEJCb7d-BMxTLRK4zk,4
-edq_utils-0.0.1.dist-info/RECORD,,