feat: multiline & special character support by joscha · Pull Request #385 · wemake-services/dump-env

joscha · 2025-04-30T15:49:05Z

This is only a first, naive implementation to start discussion. Once we honed in whether the direction is fine, I will follow up and also fix the current flake8 errors.

Possible improvements:

~~borrow needs_quotes~~
~~borrow escape~~
Add E2E test using python-dotenv, where we load a correct multiline/special-character env file into a dict, dump it back and assert it is identical
Use snapshot tests for the multiline fixtures

closes #190

joscha · 2025-04-30T15:50:05Z

 from dump_env.exceptions import StrictEnvError


+def needs_quotes(value: str) -> bool:


it feels like this should be something we can borrow from an ini file generator and/or dotenv itself. If you have a suggestion where we can pull a less naive implementation from, please let me know.

@theskumar excuse the summoning, but do you happen to have a suggestion here by any chance, please?

joscha · 2025-04-30T15:50:21Z

+    )
+
+
+def escape(value: str) -> str:


ditto for naive implementation and possibly borrowing it elsewhere.

joscha · 2025-04-30T15:51:43Z

+    """
+    return (
+        not value
+        or ' ' in value


This is needed when we have something like:

SECRET_VAR=" x " echo "'$SECRET_VAR'" # results in ' x '

There is currently no test for this, let me know if you want to add one.

this is covered by def80d3 now

joscha · 2025-04-30T15:52:04Z

+        not value
+        or ' ' in value
+        or '\n' in value
+        or '=' in value


to avoid:

MY_VAR==

this is covered by def80d3 now

joscha · 2025-04-30T15:53:06Z

+        or '\n' in value
+        or '=' in value
+        or '"' in value
+        or "'" in value


I am not actually 100% sure this one is needed, as dotenv itself says for multiline support a " is needed anyway, see https://github.com/theskumar/python-dotenv?tab=readme-ov-file#multiline-values

joscha · 2025-04-30T15:54:17Z

+    }, indent=4))
+
+    variables = delegator('dump-env -p MULTILINE_')
+    assert variables == '''VALUE="{


these fixtures would actually be expressed in a more readable manner via a snapshot test facility, for example https://github.com/syrupy-project/syrupy - let me know if you want me to refactor these to use snapshots instead.

Please, use syrupy!

done in c2c8e94

sobolevn

Thanks! I like the idea, this would need a bit more work + more tests.

sobolevn · 2025-04-30T16:32:48Z

+    }, indent=4))
+
+    variables = delegator('dump-env -p MULTILINE_')
+    assert variables == '''VALUE="{


Please, use syrupy!

joscha · 2025-05-01T08:48:49Z

Thanks! I like the idea, this would need a bit more work + more tests.

Okay, can you let me know which parts need more work (apart from tests) and then I'll update this PR and request review again?

sobolevn · 2025-05-06T10:14:40Z

Mostly tests :)

joscha · 2025-05-13T14:39:00Z

@sobolevn tests are in, however the amount of lints is staggering and there are a few that were deprecated from your styleguide. I porpose to add ruff in a separate PR, rebase this one and then fix the remaining lints after?

I can adopt whatever is in https://github.com/wemake-services/dotenv-linter/blob/master/pyproject.toml ?

sobolevn · 2025-05-14T11:27:37Z

Yes, let's add ruff and pre-commit 🤝

joscha · 2025-05-14T11:52:29Z

Yes, let's add ruff and pre-commit 🤝

Okay, great, will open a separate PR. Are you happy with the contents of this? As in: is this one mergeable if we get the lints/style sorted?

joscha · 2025-05-14T22:41:14Z

Yes, let's add ruff and pre-commit 🤝

Okay, great, will open a separate PR. Are you happy with the contents of this? As in: is this one mergeable if we get the lints/style sorted?

done in #387

…support

joscha · 2025-05-15T21:20:20Z

 wemake-python-styleguide = "^1.1"
 ruff = "^0.11"
-
-codespell = "^2.2"


as mentioned by @sobolevn in #387

joscha · 2025-05-15T21:20:50Z

        # Only prefix should be changed, other parts should not:
-        assert dump_result['DJANGO_SECRET_KEY'] == 'test'  # noqa: S105
-        assert dump_result['SECRET_VALUE'] == 'value'  # noqa: S105
+        assert dump_result == snapshot


as mentioned in #387

codecov · 2025-05-15T21:28:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6bd75f4) to head (4231391).
⚠️ Report is 100 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #385   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           83        94   +11     
  Branches        18        17    -1     
=========================================
+ Hits            83        94   +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

joscha · 2025-05-15T21:30:33Z

@sobolevn I think this is ready

sobolevn

Just several small nitpicks and we are ready to go! 🤝

Co-authored-by: sobolevn <mail@sobolevn.me>

…support

… into joscha/multiline-support

sobolevn

Great! Thanks a lot!

I will release a new version now :)

joscha · 2025-05-19T07:53:42Z

This was released in 1.6.0 (thank you @sobolevn)

feat: multiline & special character support

9ab3fc4

joscha commented Apr 30, 2025

View reviewed changes

sobolevn reviewed Apr 30, 2025

View reviewed changes

test: use syrupy

c2c8e94

joscha force-pushed the joscha/multiline-support branch from 4643b69 to c2c8e94 Compare May 13, 2025 13:55

joscha added 2 commits May 13, 2025 15:12

test: assert via dotenv roundtrip

def80d3

style: fixes

010ca1b

test: update snapshot

283166d

joscha requested a review from sobolevn May 13, 2025 14:44

joscha mentioned this pull request May 14, 2025

chore: update linting & style facility #387

Merged

joscha added 2 commits May 15, 2025 23:08

Merge remote-tracking branch 'upstream/master' into joscha/multiline-…

db532ab

…support

style: fixes

9994667

joscha commented May 15, 2025

View reviewed changes

joscha added 2 commits May 15, 2025 23:24

style: fixes

6b97e11

test: add dotenv

8f0ec33

sobolevn reviewed May 18, 2025

View reviewed changes

Comment thread pyproject.toml Outdated

Comment thread pyproject.toml Outdated

Comment thread .pre-commit-config.yaml Outdated

Comment thread dump_env/cli.py Outdated

joscha mentioned this pull request May 18, 2025

feat: generally exclude snapshots wemake-services/wemake-python-styleguide#3421

Merged

joscha and others added 4 commits May 18, 2025 18:41

chore: minor ref

6a508a4

Co-authored-by: sobolevn <mail@sobolevn.me>

chore: minor ref

31217fe

Co-authored-by: sobolevn <mail@sobolevn.me>

style: mark final

d30dec9

Co-authored-by: sobolevn <mail@sobolevn.me>

Merge remote-tracking branch 'upstream/master' into joscha/multiline-…

4ce60fc

…support

joscha added 4 commits May 18, 2025 09:44

Merge branch 'joscha/multiline-support' of github.com:joscha/dump-env…

79c6d08

… into joscha/multiline-support

chore: poetry lock

492e80b

fix: missing Final import

2cc360c

chore: global exclude

4231391

sobolevn approved these changes May 18, 2025

View reviewed changes

sobolevn merged commit 7e5fc14 into wemake-services:master May 18, 2025
8 checks passed

joscha deleted the joscha/multiline-support branch May 19, 2025 07:46

		from dump_env.exceptions import StrictEnvError


		def needs_quotes(value: str) -> bool:

Uh oh!

Conversation

joscha commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joscha Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joscha commented May 1, 2025

Uh oh!

sobolevn commented May 6, 2025

Uh oh!

joscha commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sobolevn commented May 14, 2025

Uh oh!

joscha commented May 14, 2025

Uh oh!

joscha commented May 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

joscha commented May 15, 2025

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sobolevn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joscha commented May 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joscha commented Apr 30, 2025 •

edited

Loading

joscha Apr 30, 2025 •

edited

Loading

joscha commented May 13, 2025 •

edited

Loading

codecov Bot commented May 15, 2025 •

edited

Loading