Skip to content

gh-143866: Verify return value of pathlib write methods in tests - #143870

Merged
sobolevn merged 6 commits into
python:mainfrom
b9788213:gh-143866-pathlib-test
Jan 19, 2026
Merged

gh-143866: Verify return value of pathlib write methods in tests#143870
sobolevn merged 6 commits into
python:mainfrom
b9788213:gh-143866-pathlib-test

Conversation

@b9788213

@b9788213b9788213 commented Jan 15, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This PR adds assertions to ensure that pathlib.Path.write_text() and pathlib.Path.write_bytes() correctly return the number of bytes written.

Currently, the tests only verify the side effects (file content), which means a regression (like accidentally removing the return statement) would go unnoticed.

Linked Issue

Fixes#143866

@bedevere-appbedevere-appBot added the tests Tests in the Lib/test dir label Jan 15, 2026
@bedevere-app

bedevere-appBot commented Jan 15, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@bedevere-appbedevere-appBot mentioned this pull request Jan 15, 2026
Closed
sobolevn
sobolevn reviewed Jan 15, 2026
View reviewed changes
Comment threadLib/test/test_pathlib/test_write.py Outdated
@bedevere-app

bedevere-appBot commented Jan 15, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@b9788213

b9788213 commented Jan 15, 2026

Copy link
Copy Markdown
ContributorAuthor

Ok, i am changed it. Can you add "skip news" label please?

sobolevn
sobolevn reviewed Jan 15, 2026
View reviewed changes
Comment threadLib/test/test_pathlib/test_write.py Outdated
sobolevn
sobolevn reviewed Jan 16, 2026
View reviewed changes
Comment threadLib/test/test_pathlib/test_write.py Outdated
self.assertEqual(self.ground.readbytes(p), b'abcdefg')
# check the return value
data = b'some bytes'
self.assertEqual(len(data), p.write_bytes(data))

@sobolevnsobolevnJan 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we do the same here and move the check to the line 68?

@b9788213b9788213Jan 16, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Yes i will

@sobolevnsobolevnJan 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This will fix the CI.

@b9788213b9788213Jan 16, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

My push from another device isnt synced.

@b9788213

b9788213 commented Jan 16, 2026

Copy link
Copy Markdown
ContributorAuthor

Why its failing?

@b9788213
b9788213force-pushed the gh-143866-pathlib-test branch from b727c7c to 7a8dd6fCompareJanuary 16, 2026 17:54
@picnixz

picnixz commented Jan 18, 2026

Copy link
Copy Markdown
Member

Some flakiness I think.

@b9788213

b9788213 commented Jan 19, 2026

Copy link
Copy Markdown
ContributorAuthor

How?

@sobolevnsobolevn added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 19, 2026
@sobolevn
sobolevn merged commit cb6a662 into python:mainJan 19, 2026
53 checks passed
@miss-islington-app

miss-islington-appBot commented Jan 19, 2026

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 19, 2026
@b9788213@sobolevn@miss-islington
pythongh-143866: Verify return value ofpathlib.write_{bytes,text}…
c0be6fd
…methods in tests (pythonGH-143870)
(cherry picked from commit cb6a662)
Co-authored-by: b9788213 <b9788213@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
@miss-islington-app

miss-islington-appBot commented Jan 19, 2026

Copy link
Copy Markdown

Sorry, @b9788213 and @sobolevn, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker cb6a662bb0f7a9da9d4ba9dda820053f8d54a9f8 3.13

@bedevere-app

bedevere-appBot commented Jan 19, 2026

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Jan 19, 2026
@sobolevn

sobolevn commented Jan 19, 2026

Copy link
Copy Markdown
Member

@b9788213 can you please handle the 3.13 backport manually?

sobolevn added a commit that referenced this pull request Jan 19, 2026
@miss-islington@b9788213@sobolevn
[3.14]gh-143866: Verify return value ofpathlib.write_{bytes,text}…
ea18782
… methods in tests (GH-143870) (#144029)
gh-143866: Verify return value of `pathlib.write_{bytes,text}` methods in tests (GH-143870)
(cherry picked from commit cb6a662)
Co-authored-by: b9788213 <b9788213@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
@b9788213
b9788213 deleted the gh-143866-pathlib-test branch January 20, 2026 12:09
@b9788213

b9788213 commented Jan 20, 2026

Copy link
Copy Markdown
ContributorAuthor

Yes, but i dont how to do.

@sobolevn

sobolevn commented Jan 20, 2026

Copy link
Copy Markdown
Member

See this command here: #143870 (comment)
And the docs here: https://pypi.org/project/cherry-picker
Devguide: https://devguide.python.org/getting-started/git-boot-camp/#backporting-merged-changes

@b9788213

b9788213 commented Jan 20, 2026

Copy link
Copy Markdown
ContributorAuthor

Ok, i think i have made it succesfully.

@bedevere-app

bedevere-appBot commented Jan 20, 2026

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Jan 20, 2026
sobolevn added a commit that referenced this pull request Jan 20, 2026
@b9788213@sobolevn
[3.13]gh-143866: Verify return value ofpathlib.write_{bytes,text}…
740db90
… methods in tests (GH-143870) (#144078)
(cherry picked from commit cb6a662)
Co-authored-by: sobolevn <mail@sobolevn.me>
thunder-coding pushed a commit to thunder-coding/cpython that referenced this pull request Feb 15, 2026
@b9788213@sobolevn@thunder-coding
pythongh-143866: Verify return value ofpathlib.write_{bytes,text}…
8eb0067
…methods in tests (python#143870)
Co-authored-by: sobolevn <mail@sobolevn.me>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sobolevnsobolevnsobolevn approved these changes
@barneygalebarneygaleAwaiting requested review from barneygalebarneygale is a code owner

Assignees

@sobolevnsobolevn

Labels

skip newstestsTests in the Lib/test dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Missing return value validation in pathlib's write_text and write_bytes tests

3 participants

@b9788213@picnixz@sobolevn