Skip to content

SWE-agent takes a GitHub issue and tries to automatically fix it, using your LM of choice. It can also be employed for offensive cybersecurity or competitive coding challenges. [NeurIPS 2024]

Enh(inspect): yaml with proper linebreak serialization

Kilian Lierete6c753b06461
diff --git a/sweagent/run/inspector_cli.py b/sweagent/run/inspector_cli.py
index d321825f..10bdd00f 100644
--- a/sweagent/run/inspector_cli.py
+++ b/sweagent/run/inspector_cli.py
@@ -2,13 +2,14 @@ import argparse
import json
from pathlib import Path
-import yaml
from rich.syntax import Syntax
from textual.app import App, ComposeResult
from textual.binding import Binding
from textual.containers import Container, VerticalScroll
from textual.widgets import Footer, Header, Static
+from sweagent.utils.serialization import _yaml_serialization_with_linebreaks
+
class TrajectoryViewer(Static):
BINDINGS = [
@@ -41,7 +42,7 @@ class TrajectoryViewer(Static):
def _show_full(self, item: dict) -> None:
"""Show full yaml of trajectory item"""
- content_str = yaml.dump(item, indent=2)
+ content_str = _yaml_serialization_with_linebreaks(item)
syntax = Syntax(content_str, "yaml", theme="monokai", word_wrap=True)
content = self.query_one("#content")
content.update(syntax) # type: ignore
@@ -61,7 +62,7 @@ class TrajectoryViewer(Static):
def _show_info(self):
info = self.trajectory["info"]
- syntax = Syntax(yaml.dump(info, indent=2), "yaml", theme="monokai", word_wrap=True)
+ syntax = Syntax(_yaml_serialization_with_linebreaks(info), "yaml", theme="monokai", word_wrap=True)
content = self.query_one("#content")
content.update(syntax) # type: ignore
next_help = "Press l to see step 1" if self.current_index < 0 else f"Press h to see step {len(self.trajectory)}"
diff --git a/sweagent/run/run_traj_to_demo.py b/sweagent/run/run_traj_to_demo.py
index 1ae6d5b2..60757e02 100644
--- a/sweagent/run/run_traj_to_demo.py
+++ b/sweagent/run/run_traj_to_demo.py
@@ -5,17 +5,12 @@ environment output.
from __future__ import annotations
-import io
import json
from argparse import ArgumentParser
-from copy import deepcopy
from pathlib import Path
-from typing import Any
-
-from ruamel.yaml import YAML
-from ruamel.yaml.scalarstring import LiteralScalarString as LSS
from sweagent.utils.log import get_logger
+from sweagent.utils.serialization import _yaml_serialization_with_linebreaks
logger = get_logger("traj2demo")
@@ -29,32 +24,9 @@ DEMO_COMMENT = """# This is a demo file generated from trajectory file:
# You can add or remove actions to modify the replay behavior."""
-def _convert_to_literal_string(d: Any) -> Any:
- """Convert any multi-line strings in nested data object to LiteralScalarString.
- This will then use the `|-` syntax of yaml.
- """
- d = deepcopy(d)
- if isinstance(d, dict):
- for key, value in d.items():
- d[key] = _convert_to_literal_string(value)
- elif isinstance(d, list):
- for i, item in enumerate(d):
- d[i] = _convert_to_literal_string(item)
- elif isinstance(d, str) and "\n" in d:
- d = LSS(d.replace("\r\n", "\n").replace("\r", "\n"))
- return d
-
-
def save_demo(data: str | dict | list, file: Path, traj_path: Path) -> None:
"""Save demo data as a yaml file. Takes care of multi-line strings and adds a header."""
- data = _convert_to_literal_string(data)
- yaml = YAML()
- yaml.indent(mapping=2, sequence=4, offset=2)
- yaml.width = float("inf")
- yaml.default_flow_style = False
- buffer = io.StringIO()
- yaml.dump(data, buffer)
- content = buffer.getvalue()
+ content = _yaml_serialization_with_linebreaks(data)
header = DEMO_COMMENT.format(traj_path=str(traj_path))
with open(file, "w") as f:
f.write(f"{header}\n{content}")
diff --git a/sweagent/utils/serialization.py b/sweagent/utils/serialization.py
new file mode 100644
index 00000000..f1888e14
--- /dev/null
+++ b/sweagent/utils/serialization.py
@@ -0,0 +1,33 @@
+import io
+from copy import deepcopy
+from typing import Any
+
+from ruamel.yaml import YAML
+from ruamel.yaml.scalarstring import LiteralScalarString as LSS
+
+
+def _convert_to_yaml_literal_string(d: Any) -> Any:
+ """Convert any multi-line strings in nested data object to LiteralScalarString.
+ This will then use the `|-` syntax of yaml.
+ """
+ d = deepcopy(d)
+ if isinstance(d, dict):
+ for key, value in d.items():
+ d[key] = _convert_to_yaml_literal_string(value)
+ elif isinstance(d, list):
+ for i, item in enumerate(d):
+ d[i] = _convert_to_yaml_literal_string(item)
+ elif isinstance(d, str) and "\n" in d:
+ d = LSS(d.replace("\r\n", "\n").replace("\r", "\n"))
+ return d
+
+
+def _yaml_serialization_with_linebreaks(data: Any) -> str:
+ data = _convert_to_yaml_literal_string(data)
+ yaml = YAML()
+ yaml.indent(mapping=2, sequence=4, offset=2)
+ yaml.width = float("inf")
+ yaml.default_flow_style = False
+ buffer = io.StringIO()
+ yaml.dump(data, buffer)
+ return buffer.getvalue()