OPT_UTC_Z

Author: ijl

README.md

@@ -122,6 +122,8 @@ is raised.
 on `datetime.datetime` and `datetime.time` instances.
 - `orjson.OPT_STRICT_INTEGER` for enforcing a 53-bit limit on integers. The
 limit is otherwise 64 bits, the same as the Python standard library.
+- `orjson.OPT_UTC_Z` to serialize a UTC timezone on `datetime.datetime`
+instances as `Z` instead of `+00:00`.
 
 To specify multiple options, mask them together, e.g.,
 `option=orjson.OPT_STRICT_INTEGER | orjson.OPT_NAIVE_UTC`.

orjson.pyi

@@ -15,3 +15,4 @@ class JSONEncodeError(TypeError): ...
 OPT_NAIVE_UTC: int
 OPT_OMIT_MICROSECONDS: int
 OPT_STRICT_INTEGER: int
+OPT_UTC_Z: int

src/datetime.rs

@@ -3,13 +3,15 @@ use smallvec::SmallVec;
 
 pub const NAIVE_UTC: u8 = 1 << 1;
 pub const OMIT_MICROSECONDS: u8 = 1 << 2;
+pub const UTC_Z: u8 = 1 << 3;
 
 const HYPHEN: u8 = 45; // "-"
 const PLUS: u8 = 43; // "+"
 const ZERO: u8 = 48; // "0"
 const T: u8 = 84; // "T"
 const COLON: u8 = 58; // ":"
 const PERIOD: u8 = 46; // ":"
+const Z: u8 = 90; // "Z"
 
 macro_rules! write_double_digit {
     ($dt:ident, $value:ident) => {
@@ -144,7 +146,11 @@ pub fn write_datetime(
     }
     if has_tz || opts & NAIVE_UTC == NAIVE_UTC {
         if offset_second == 0 {
-            dt.extend([PLUS, ZERO, ZERO, COLON, ZERO, ZERO].iter().cloned());
+            if opts & UTC_Z == UTC_Z {
+                dt.push(Z);
+            } else {
+                dt.extend([PLUS, ZERO, ZERO, COLON, ZERO, ZERO].iter().cloned());
+            }
         } else {
             if offset_day == -1 {
                 // datetime.timedelta(days=-1, seconds=68400) -> -05:00

src/encode.rs

@@ -17,7 +17,7 @@ const STRICT_INT_MAX: i64 = 9007199254740991;
 
 pub const STRICT_INTEGER: u8 = 1;
 
-pub const MAX_OPT: i8 = (STRICT_INTEGER | NAIVE_UTC | OMIT_MICROSECONDS) as i8;
+pub const MAX_OPT: i8 = (STRICT_INTEGER | NAIVE_UTC | OMIT_MICROSECONDS | UTC_Z) as i8;
 
 macro_rules! obj_name {
     ($obj:ident) => {

src/lib.rs

@@ -48,6 +48,7 @@ fn orjson(py: Python, m: &PyModule) -> PyResult<()> {
     m.add("OPT_NAIVE_UTC", datetime::NAIVE_UTC)?;
     m.add("OPT_OMIT_MICROSECONDS", datetime::OMIT_MICROSECONDS)?;
     m.add("OPT_STRICT_INTEGER", encode::STRICT_INTEGER)?;
+    m.add("OPT_UTC_Z", datetime::UTC_Z)?;
 
     Ok(())
 }

test/test_api.py

@@ -88,7 +88,7 @@ def test_option_range_high(self):
         dumps() option out of range high
         """
         with self.assertRaises(orjson.JSONEncodeError):
-            orjson.dumps(True, option=1 << 3)
+            orjson.dumps(True, option=1 << 4)
 
     def test_opts_multiple(self):
         """

test/test_datetime.py

@@ -435,6 +435,70 @@ def test_time_omit_microseconds(self):
             b'["02:03:04"]',
         )
 
+    def test_datetime_utc_z_naive_omit(self):
+        """
+        datetime.datetime naive OPT_UTC_Z
+        """
+        self.assertEqual(
+            orjson.dumps(
+                [datetime.datetime(2000, 1, 1, 2, 3, 4, 123)],
+                option=orjson.OPT_NAIVE_UTC
+                | orjson.OPT_UTC_Z
+                | orjson.OPT_OMIT_MICROSECONDS,
+            ),
+            b'["2000-01-01T02:03:04Z"]',
+        )
+
+    def test_datetime_utc_z_naive(self):
+        """
+        datetime.datetime naive OPT_UTC_Z
+        """
+        self.assertEqual(
+            orjson.dumps(
+                [datetime.datetime(2000, 1, 1, 2, 3, 4, 123)],
+                option=orjson.OPT_NAIVE_UTC | orjson.OPT_UTC_Z,
+            ),
+            b'["2000-01-01T02:03:04.000123Z"]',
+        )
+
+    def test_datetime_utc_z_without_tz(self):
+        """
+        datetime.datetime naive OPT_UTC_Z
+        """
+        self.assertEqual(
+            orjson.dumps(
+                [datetime.datetime(2000, 1, 1, 2, 3, 4, 123)], option=orjson.OPT_UTC_Z
+            ),
+            b'["2000-01-01T02:03:04.000123"]',
+        )
+
+    def test_datetime_utc_z_with_tz(self):
+        """
+        datetime.datetime naive OPT_UTC_Z
+        """
+        self.assertEqual(
+            orjson.dumps(
+                [
+                    datetime.datetime(
+                        2000, 1, 1, 0, 0, 0, 1, tzinfo=datetime.timezone.utc
+                    )
+                ],
+                option=orjson.OPT_UTC_Z,
+            ),
+            b'["2000-01-01T00:00:00.000001Z"]',
+        )
+        self.assertEqual(
+            orjson.dumps(
+                [
+                    datetime.datetime(
+                        1937, 1, 1, 12, 0, 27, 87, tzinfo=tz.gettz("Europe/Amsterdam")
+                    )
+                ],
+                option=orjson.OPT_UTC_Z,
+            ),
+            b'["1937-01-01T12:00:27.000087+00:20"]',
+        )
+
     @pytest.mark.skipif(pendulum is None, reason="pendulum install broken on win")
     def test_datetime_roundtrip(self):
         """