io.metadata: Fix newline handling when reading CSV/TSV #1561
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The "newline" parameter in write_lines() is changed so that newline translation doesn't take place, which would make it harder to reason about what our tests are actually testing.
The csv module very clearly documents¹ that the "newline" parameter should be set to the empty string so that the csv module can itself do proper embedded newline handling. Follow that recommendation. This change shouldn't affect existing inputs that worked fine but now allows inputs with embedded newlines in fields. The previously-added failing test now passes. ¹ <https://docs.python.org/3/library/csv.html#id4>
tsibley
force-pushed
the
trs/metadata-newline-handling
branch
from
f399316
to
a6b7265
Compare
genehack
approved these changes
Jul 30, 2024
victorlin
reviewed
Jul 31, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1561 +/- ##
=======================================
Coverage 70.22% 70.22%
=======================================
Files 74 74
Lines 7952 7952
Branches 1945 1945
=======================================
Hits 5584 5584
Misses 2082 2082
Partials 286 286 ☔ View full report in Codecov by Sentry. |
|
wtf @codecov? |
|
I've noticed this here and there within the last few months, on PRs that have been merged over a year ago. Looks like it's a known issue: codecov/feedback#497 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The csv module very clearly documents¹ that the "newline" parameter should be set to the empty string so that the csv module can itself do proper embedded newline handling. Follow that recommendation. This change shouldn't affect existing inputs that worked fine but now allows inputs with embedded newlines in fields.
The previously-added failing test now passes.
¹ https://docs.python.org/3/library/csv.html#id4
Checklist