Skip to content

Fix backslash round trips in set_key #682

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
mjq2020 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −1
Open

Fix backslash round trips in set_key #682

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
3 changes: 2 additions & 1 deletion src/dotenv/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@ def set_key(
)

if quote:
value_out = "'{}'".format(value_to_set.replace("'", "\\'"))
escaped_value = value_to_set.replace("\\", "\\\\").replace("'", "\\'")
value_out = f"'{escaped_value}'"
else:
value_out = value_to_set
if export:
Expand Down
15 changes: 15 additions & 0 deletions tests/test_main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,21 @@ def test_set_key_encoding(dotenv_path):
assert dotenv_path.read_text(encoding=encoding) == "a='é'\n"


@pytest.mark.parametrize(
"value",
[
"C:\\Users\\name",
r"\\d+",
r"prefix\\suffix",
"backslash\\'quote",
],
)
def test_set_key_round_trips_backslashes(dotenv_path, value):
dotenv.set_key(dotenv_path, "VALUE", value)

assert dotenv.get_key(dotenv_path, "VALUE") == value


@pytest.mark.skipif(
sys.platform == "win32", reason="file mode bits behave differently on Windows"
)
Expand Down