Skip to content

Escape revision messages embedded in triple-quoted docstrings #1880

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

Closed
Eryx-Z wants to merge 1 commit into from
Closed

Escape revision messages embedded in triple-quoted docstrings #1880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion alembic/script/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
_slug_re = re.compile(r"\w+")
_default_file_template = "%(rev)s_%(slug)s"

def _escape_docstring_message(message: str) -> str:
"""Escape a revision message for embedding in a triple-quoted docstring."""
return message.replace("\\", "\\\\").replace('"""', '\\"\\"\\"')


class ScriptDirectory:
"""Provides operations upon an Alembic script directory.
Expand Down Expand Up @@ -740,7 +744,9 @@ def generate_revision(
depends_on=revision.tuple_rev_as_scalar(resolved_depends_on),
create_date=create_date,
comma=util.format_as_comma,
message=message if message is not None else ("empty message"),
message=_escape_docstring_message(
message if message is not None else "empty message"
),
**kw,
)

Expand Down
14 changes: 14 additions & 0 deletions tests/test_script_production.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,20 @@ def test_create_script_basic(self):
eq_(rev.down_revision, self.c)
assert "some message" in rev.doc

def test_create_script_message_with_triple_quotes(self):
msg = 'add users"""' + "\nprint(\"injected\")\n__doc__ = " + '"""'
rev = command.revision(self.cfg, message=msg)
script = ScriptDirectory.from_config(self.cfg)
rev = script.get_revision(rev.revision)
eq_(rev.doc, msg)

def test_create_script_message_with_backslashes(self):
msg = r"C:\path\new"
rev = command.revision(self.cfg, message=msg)
script = ScriptDirectory.from_config(self.cfg)
rev = script.get_revision(rev.revision)
eq_(rev.doc, msg)

def test_create_script_splice(self):
rev = command.revision(
self.cfg, message="some message", head=self.b, splice=True
Expand Down