Changeset 83fa028 in trunk

Timestamp:

2023-11-16T18:53:51Z (17 months ago)

Author:

Itamar Turner-Trauring <itamar@…>

Branches:

master

Children:

7b680b3

Parents:

3ddfb92

Message:

Use the existing Tahoe JSON encoder.

Location:

src/allmydata

Files:

• test/__init__.py (modified) (1 diff)
• test/eliotutil.py (modified) (2 diffs)
• test/test_client.py (modified) (3 diffs)
• test/test_eliotutil.py (modified) (2 diffs)
• test/web/test_logs.py (modified) (1 diff)
• util/eliotutil.py (modified) (3 diffs)
• util/jsonbytes.py (modified) (2 diffs)

src/allmydata/test/__init__.py ¶

@@ -126 +126 @@
 
 from eliot import to_file
-from allmydata.util.eliotutil import BytesEliotJSONEncoder
-to_file(open("eliot.log", "wb"), encoder=BytesEliotJSONEncoder)
+from allmydata.util.jsonbytes import AnyBytesJSONEncoder
+to_file(open("eliot.log", "wb"), encoder=AnyBytesJSONEncoder)

src/allmydata/test/eliotutil.py ¶

@@ -39 +39 @@
 )
 
-from ..util.eliotutil import (
-    BytesEliotJSONEncoder
+from ..util.jsonbytes import (
+    AnyBytesJSONEncoder
 )
 
@@ -148 +148 @@
     @wraps(test_method)
     def run_with_logging(*args, **kwargs):
-        validating_logger = MemoryLogger(encoder=BytesEliotJSONEncoder)
+        validating_logger = MemoryLogger(encoder=AnyBytesJSONEncoder)
         original = swap_logger(None)
         try:

src/allmydata/test/test_client.py ¶

@@ -68 +68 @@
     jsonbytes as json,
 )
-from allmydata.util.eliotutil import capture_logging, BytesEliotJSONEncoder
+from allmydata.util.eliotutil import capture_logging
 from allmydata.util.fileutil import abspath_expanduser_unicode
 from allmydata.interfaces import IFilesystemNode, IFileNode, \
@@ -851 +851 @@
             succeeded=True,
         ),
-        encoder_=BytesEliotJSONEncoder
+        encoder_=json.AnyBytesJSONEncoder
     )
     def test_static_servers(self, logger):
@@ -886 +886 @@
             succeeded=False,
         ),
-        encoder_=BytesEliotJSONEncoder
+        encoder_=json.AnyBytesJSONEncoder
     )
     def test_invalid_static_server(self, logger):

src/allmydata/test/test_eliotutil.py ¶

@@ -64 +64 @@
 
 from ..util.eliotutil import (
-    BytesEliotJSONEncoder,
     log_call_deferred,
     _parse_destination_description,
@@ -86 +85 @@
         return result.wasSuccessful()
     return AfterPreprocessing(run, Equals(True))
-
-
-class BytesEliotJSONEncoderTests(TestCase):
-    """Tests for ``BytesEliotJSONEncoder``."""
-
-    def test_encoding_bytes(self):
-        """``BytesEliotJSONEncoder`` can encode bytes."""
-        encoder = BytesEliotJSONEncoder()
-        self.assertEqual(encoder.default(b"xxx"), "xxx")
-        self.assertEqual(encoder.default(bytes([12])), "\x0c")
-
-    def test_encoding_sets(self):
-        """``BytesEliotJSONEncoder`` can encode sets."""
-        encoder = BytesEliotJSONEncoder()
-        self.assertIn(encoder.default({1, 2}), ([1, 2], [2, 1]))
 
 

src/allmydata/test/web/test_logs.py ¶

@@ -118 +118 @@
         yield proto.is_closed
 
-        self.assertThat(len(messages), Equals(3))
+        self.assertThat(len(messages), Equals(3), messages)
         self.assertThat(messages[0]["action_type"], Equals("test:cli:some-exciting-action"))
         self.assertThat(messages[0]["arguments"],

src/allmydata/util/eliotutil.py ¶

@@ -51 +51 @@
     capture_logging,
 )
-from eliot.json import EliotJSONEncoder
 
 from eliot._validation import (
@@ -79 +78 @@
 from twisted.application.service import Service
 
-
-class BytesEliotJSONEncoder(EliotJSONEncoder):
-    """Support encoding bytes."""
-
-    def default(self, o):
-        if isinstance(o, bytes):
-            return o.decode("utf-8", "backslashreplace")
-        if isinstance(o, set):
-            return list(o)
-        return EliotJSONEncoder.default(self, o)
+from .jsonbytes import AnyBytesJSONEncoder
 
 
@@ -307 +297 @@
                     maxRotatedFiles=max_rotated_files,
                 )
-        return lambda reactor: FileDestination(get_file(), encoder=BytesEliotJSONEncoder)
+        return lambda reactor: FileDestination(get_file(), encoder=AnyBytesJSONEncoder)
 
 

src/allmydata/util/jsonbytes.py ¶

@@ -62 +62 @@
     A JSON encoder than can also encode UTF-8 encoded strings.
     """
+    def default(self, o):
+        return bytes_to_unicode(False, o)
+
     def encode(self, o, **kwargs):
         return json.JSONEncoder.encode(
@@ -78 +81 @@
     bytes are quoted.
     """
+    def default(self, o):
+        return bytes_to_unicode(True, o)
+
     def encode(self, o, **kwargs):
         return json.JSONEncoder.encode(