refactor(Workspace): loads from bytes as well as str

Author: yt-ms

src/structurizr/workspace.py

@@ -22,6 +22,7 @@
 from typing import Any, Optional, Union
 
 from pydantic import Field
+from pydantic.types import StrBytes
 
 from .abstract_base import AbstractBase
 from .base_model import BaseModel
@@ -207,9 +208,9 @@ def load(cls, filename: Union[str, Path]) -> "Workspace":
                 return cls.loads(handle.read())
 
     @classmethod
-    def loads(cls, json_string: str) -> "Workspace":
-        """Load a workspace from a JSON string."""
-        ws_io = WorkspaceIO.parse_raw(json_string)
+    def loads(cls, json: StrBytes) -> "Workspace":
+        """Load a workspace from a JSON string or bytes."""
+        ws_io = WorkspaceIO.parse_raw(json)
         return cls.hydrate(ws_io)
 
     def dump(

tests/integration/test_workspace_io.py

@@ -101,6 +101,17 @@ def test_save_and_load_workspace_to_string(monkeypatch):
     assert json.loads(actual.json()) == json.loads(expected.json())
 
 
+def test_load_workspace_from_bytes(monkeypatch):
+    """Test loading from bytes rather than string."""
+    path = DEFINITIONS / "GettingStarted.json"
+    with open(path, mode='rb') as file:
+        binary_content = file.read()
+
+    workspace = Workspace.loads(binary_content)
+
+    assert workspace.model.software_systems != set()
+
+
 def test_save_and_load_workspace_to_file(monkeypatch, tmp_path: Path):
     """Test saving as a JSON file and reloading."""
     monkeypatch.syspath_prepend(EXAMPLES)
@@ -117,7 +128,7 @@ def test_save_and_load_workspace_to_file(monkeypatch, tmp_path: Path):
     assert json.loads(actual.json()) == json.loads(expected.json())
 
 
-def test_save_and_load_workspace_to_zipped_file(monkeypatch, tmp_path: Path):
+def test_save_and_load_workspace_to_gzipped_file(monkeypatch, tmp_path: Path):
     """Test saving as a zipped JSON file and reloading."""
     monkeypatch.syspath_prepend(EXAMPLES)
     example = import_module("getting_started")