Skip to content

Shorten binary serialization for true and false #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tekknolagi merged 4 commits into from
Aug 8, 2025
Merged

Shorten binary serialization for true and false #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
272632f
Add a new tag and checks in serializer & deserializer
leregdos Aug 6, 2025
cbef07c
Merge branch 'trunk' into shorten-binary-boolean
leregdos Aug 6, 2025
4e566a5
Add test cases for shortened binary encoding
leregdos Aug 7, 2025
3e7df24
Run linter
leregdos Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion scrapscript.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -984,6 +984,8 @@ class Variant(Object):
TYPE_ACCESS := b"@",
TYPE_SPREAD := b"S",
TYPE_NAMED_SPREAD := b"R",
TYPE_TRUE := b"T",
TYPE_FALSE := b"F",
]
FLAG_REF = 0x80

Expand Down Expand Up @@ -1091,6 +1093,10 @@ def serialize(self, obj: Object) -> None:
self.serialize(item)
return
if isinstance(obj, Variant):
if obj.tag == "true" and isinstance(obj.value, Hole):
return self.emit(TYPE_TRUE)
if obj.tag == "false" and isinstance(obj.value, Hole):
return self.emit(TYPE_FALSE)
# TODO(max): Determine if this should be a ref
self.emit(TYPE_VARIANT)
# TODO(max): String pool (via refs) for strings longer than some length?
Expand Down Expand Up @@ -1329,6 +1335,12 @@ def parse(self) -> Object:
return Spread()
if ty == TYPE_NAMED_SPREAD:
return Spread(self._string())
if ty == TYPE_TRUE:
assert not is_ref
return Variant("true", Hole())
if ty == TYPE_FALSE:
assert not is_ref
return Variant("false", Hole())
raise NotImplementedError(bytes(ty))


Expand Down Expand Up @@ -2531,7 +2543,7 @@ def do_GET(self) -> None:
if scrap is not None:
self.send_response(200)
self.send_header("Content-Type", "application/scrap; charset=binary")
self.send_header("Content-Disposition", f'attachment; filename={json.dumps(f"{path}.scrap")}')
self.send_header("Content-Disposition", f"attachment; filename={json.dumps(f'{path}.scrap')}")
self.send_header("Content-Length", str(len(scrap)))
self.end_headers()
self.wfile.write(scrap)
Expand Down
16 changes: 16 additions & 0 deletions scrapscript_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3778,6 +3778,22 @@ def test_access(self) -> None:
def test_spread(self) -> None:
self.assertEqual(self._serialize(Spread()), TYPE_SPREAD)
self.assertEqual(self._serialize(Spread("rest")), TYPE_NAMED_SPREAD + b"\x08rest")

def test_true_variant(self) -> None:
obj = Variant("true", Hole())
self.assertEqual(self._serialize(obj), TYPE_TRUE)

def test_false_variant(self) -> None:
obj = Variant("false", Hole())
self.assertEqual(self._serialize(obj), TYPE_FALSE)

def test_true_variant_with_non_hole_uses_regular_variant(self) -> None:
obj = Variant("true", Int(123))
self.assertEqual(self._serialize(obj), TYPE_VARIANT + b"\x08truei\xf6\x01")

def test_false_variant_with_non_hole_uses_regular_variant(self) -> None:
obj = Variant("false", Int(123))
self.assertEqual(self._serialize(obj), TYPE_VARIANT + b"\x0afalsei\xf6\x01")


class RoundTripSerializationTests(unittest.TestCase):
Expand Down
Loading