X Tutup
Skip to content

gh-138005: Document that CSV skipinitialspace=True and delimiter=' ' require quotation for empty fields#138006

Merged
hugovk merged 4 commits intopython:mainfrom
maurycy:csv-rst-typo
Sep 11, 2025
Merged

gh-138005: Document that CSV skipinitialspace=True and delimiter=' ' require quotation for empty fields#138006
hugovk merged 4 commits intopython:mainfrom
maurycy:csv-rst-typo

Conversation

@maurycy
Copy link
Contributor

@maurycy maurycy commented Aug 20, 2025 •
edited by github-actions bot
Loading

Please see for the code:

  • cpython/Modules/_csv.c

    Lines 1253 to 1267 in 7dc42b6

    if (!field_len && dialect->delimiter == ' ' && dialect->skipinitialspace) {
    if (dialect->quoting == QUOTE_NONE ||
    (field == NULL &&
    (dialect->quoting == QUOTE_STRINGS ||
    dialect->quoting == QUOTE_NOTNULL)))
    {
    PyErr_Format(self->error_obj,
    "empty field must be quoted if delimiter is a space "
    "and skipinitialspace is true");
    return 0;
    }
    quoted = 1;
    }
    rec_len = join_append_data(self, field_kind, field_data, field_len,
    &quoted, 0);

Please see the test:

The behavior is intentional since gh-115721, so the only sensible route is to update the docs.

📚 Documentation preview 📚: https://cpython-previews--138006.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Aug 20, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 20, 2025
@bedevere-app bedevere-app bot mentioned this pull request Aug 20, 2025
Closed
serhiy-storchaka
serhiy-storchaka reviewed Aug 21, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is too verbose. The note takes up a lot of space and attracts a disproportionate amount of attention. Most users will never encounter this, and if they do, this behavior is expected and therefore does not require any special explanation.

Could you please limit yourself to one short sentence? That such CSV files cannot contain empty fields.

@maurycy
Copy link
Contributor Author

maurycy commented Aug 21, 2025

I think this is too verbose. The note takes up a lot of space and attracts a disproportionate amount of attention. Most users will never encounter this, and if they do, this behavior is expected and therefore does not require any special explanation.

Could you please limit yourself to one short sentence? That such CSV files cannot contain empty fields.

Thank you for taking a look. Made it much shorter:

serhiy-storchaka
serhiy-storchaka approved these changes Aug 22, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. 👍

@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 22, 2025
sharktide
sharktide approved these changes Aug 23, 2025
View reviewed changes
Copy link
Contributor

@sharktide sharktide left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
And thanks for fixing the typo :)

@hugovk hugovk merged commit e0f54a6 into python:main Sep 11, 2025
35 checks passed
@miss-islington-app
Copy link

miss-islington-app bot commented Sep 11, 2025

Thanks @maurycy for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Sep 11, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 11, 2025
@maurycy @miss-islington
pythongh-138005: Document that CSV skipinitialspace=True and `delim…
838672b 
…iter=' '` require quotation for empty fields (pythonGH-138006)

(cherry picked from commit e0f54a6)

Co-authored-by: Maurycy Pawłowski-Wieroński <5383+maurycy@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 11, 2025
@maurycy @miss-islington
pythongh-138005: Document that CSV skipinitialspace=True and `delim…
70477ad 
…iter=' '` require quotation for empty fields (pythonGH-138006)

(cherry picked from commit e0f54a6)

Co-authored-by: Maurycy Pawłowski-Wieroński <5383+maurycy@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 11, 2025

GH-138798 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Sep 11, 2025
@bedevere-app
Copy link

bedevere-app bot commented Sep 11, 2025

GH-138799 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 11, 2025
hugovk pushed a commit that referenced this pull request Sep 11, 2025
@miss-islington @maurycy
[3.14] gh-138005: Document that CSV skipinitialspace=True and `deli…
5210e30 
…miter=' '` require quotation for empty fields (GH-138006) (#138798)

Co-authored-by: Maurycy Pawłowski-Wieroński <5383+maurycy@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request Sep 11, 2025
@miss-islington @maurycy
[3.13] gh-138005: Document that CSV skipinitialspace=True and `deli…
a5f7e02 
…miter=' '` require quotation for empty fields (GH-138006) (#138799)

Co-authored-by: Maurycy Pawłowski-Wieroński <5383+maurycy@users.noreply.github.com>
@maurycy maurycy deleted the csv-rst-typo branch September 13, 2025 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

+1 more reviewer

@sharktide sharktide sharktide approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@maurycy @serhiy-storchaka @sharktide @hugovk
X Tutup