Skip to content

fix(web-portal): handle escape characters #8645

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

Open
grantfitzsimmons wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −1
Open

fix(web-portal): handle escape characters #8645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feadaec
fix(web-portal): handle escape characters
grantfitzsimmons Oct 7, 2026
68c0c1f
test(web-portal): check escape characters
grantfitzsimmons Oct 7, 2026
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
9 changes: 9 additions & 0 deletions specifyweb/backend/stored_queries/tests/test_views/test_export_web_portal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@


class TestExportWebPortal(SQLAlchemySetup):
def test_clean_cell_preserves_literal_java_escape_sequences(self):
from specifyweb.backend.stored_queries.web_portal_export import _clean_cell

self.assertEqual(
_clean_cell(r"literal \r, \b, \f and \\"),
r"literal \\r, \\b, \\f and \\\\",
)
self.assertEqual(_clean_cell("line\nbreak\r"), "line break ")

@patch("specifyweb.backend.stored_queries.views.Thread")
def test_export(self, thread: Mock):
c = Client()
Expand Down
6 changes: 5 additions & 1 deletion specifyweb/backend/stored_queries/web_portal_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,11 @@ def _schema_localization_or_empty(collection) -> dict[str, Any]:


def _clean_cell(value: Any) -> str:
return re.sub("\r|\n", " ", str(value if value is not None else ''))
# The portal unescapes Java-style sequences in exported text. See #8644!
# Escape literal sequences such as ``\\r`` by escaping their backslash before
# the value is written to CSV.
text = str(value if value is not None else '')
return re.sub("\r|\n", " ", text).replace('\\', '\\\\')


def _clean_portal_attachment_text(value: Any) -> str:
Expand Down
Loading