gh-75593: Allow opening of path-like files with `wave.open` by mbyrnepr2 · Pull Request #140951 · python/cpython

mbyrnepr2 · 2025-11-03T15:47:50Z

#75593

Issue: wave.open does not accept PathLike objects #75593

python-cla-bot · 2025-11-04T12:16:53Z

All commit authors signed the Contributor License Agreement.

mbyrnepr2 · 2025-11-04T12:21:20Z

~~TODO: Docs may need an update.~~

serhiy-storchaka · 2025-11-06T08:52:40Z

Lib/wave.py

    def __init__(self, f):
        self._i_opened_the_file = None
-        if isinstance(f, str):
+        if isinstance(f, (str, os.PathLike)):


As was suggested in #75593 (comment), it is easy to add support of bytes.

serhiy-storchaka · 2025-11-06T08:56:53Z

Lib/test/test_wave.py

+    def test_open_pathlike(self):
+        """It is possible to use `wave.read` and `wave.write` with a path-like file"""
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            WAV_FILE = pathlib.Path(fp.name)


Use test.support.os_helper.FakePath instead of pathlib.Path. It should support arbitrary Path-like objects.

Also, test with a Path-like object wrapping a bytes path: FakePath(os.fsencode(...)).

serhiy-storchaka · 2025-11-06T09:12:32Z

Doc/library/wave.rst

 .. function:: open(file, mode=None)

-   If *file* is a string, open the file by that name, otherwise treat it as a
+   If *file* is a string or a :term:`path-like object`, open the file by that name, otherwise treat it as a


Too long line.

Add also a versionchanged directive.

Misc/NEWS.d/next/Library/2025-11-04-12-16-13.gh-issue-75593.EFVhKR.rst

…FVhKR.rst

…VhKR.rst Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

- Use `FakePath` instead of `pathlib.Path`. - Add an extra test case for the bytes path case. - Format the doc and add `versionchanged`.

serhiy-storchaka · 2025-11-11T14:41:22Z

Lib/test/test_wave.py

+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            cases = (
+                FakePath(fp.name),
+                FakePath(os.fsencode(fp.name)),


Test also for os.fsencode(fp.name).

serhiy-storchaka · 2025-11-11T14:44:19Z

Lib/test/test_wave.py

            self.assertIsNone(cm.unraisable)


+class WaveOpen(unittest.TestCase):


Isn't there a place for this test in an existing class? You can also look in audiotests -- if this was added before removing aifc, the test should be added there.

I had also considered adding the new tests to MiscTestCase or WaveLowLevelTest - I don't have a good reason to create a new class now that I think of it, except that perhaps they don't strictly belong in either of those places.

Just to clarify your point about adding the tests to audiotests.py - are you saying that the new tests should simply be moved there instead? Or do you mean that the existing tests in test_wave.py should inherit the new tests similar to the existing design?
My rationale for adding the tests to test_wave.py is I did feel like they belonged in test_wave.py and not audiotests.py since the classes in audiotests.py are inherited by the classes in test_wave.py to assert a range of things which felt redundant for the new tests to also perform.

serhiy-storchaka · 2025-11-11T14:45:07Z

Doc/library/wave.rst


-   If *file* is a string, open the file by that name, otherwise treat it as a
-   file-like object.  *mode* can be:
+   If *file* is a string or a :term:`path-like object`, open the file by that name,


or a bytes object.

serhiy-storchaka · 2025-11-11T14:45:27Z

Doc/library/wave.rst

      Added support for unseekable files.

+   .. versionchanged:: 3.15
+      Added support for :term:`path-like objects <path-like object>`.


and bytes objects.

- More accurate documentation. - More complete test cases.

serhiy-storchaka

LGTM. 👍

serhiy-storchaka · 2025-11-11T21:51:33Z

Misc/NEWS.d/next/Library/2025-11-04-12-16-13.gh-issue-75593.EFVhKR.rst

@@ -0,0 +1 @@
+Add support of :term:`path-like objects <path-like object>` in :func:`wave.open`.


And bytes objects.

Oh sorry for that again 😅. I’ll update later today.

serhiy-storchaka · 2025-11-12T08:21:54Z

Thank you for your contribution @mbyrnepr2.

mbyrnepr2 · 2025-11-12T10:10:43Z

It was a pleasure and thanks for your time and guidance @serhiy-storchaka

…() (pythonGH-140951)

mbyrnepr2 changed the title ~~wave.py - Allow opening of path-like files.~~ gh-140952: Allow opening of path-like files with wave.open Nov 3, 2025

bedevere-app bot mentioned this pull request Nov 3, 2025

wave.open does not work with pathlib.Path files #140952

Closed

hugovk added the stdlib Standard Library Python modules in the Lib/ directory label Nov 3, 2025

mbyrnepr2 closed this Nov 3, 2025

mbyrnepr2 reopened this Nov 4, 2025

mbyrnepr2 changed the title ~~gh-140952: Allow opening of path-like files with wave.open~~ gh-75593: Allow opening of path-like files with wave.open Nov 4, 2025

bedevere-app bot mentioned this pull request Nov 4, 2025

wave.open does not accept PathLike objects #75593

Closed

mbyrnepr2 marked this pull request as ready for review November 4, 2025 12:47

bedevere-app bot added the awaiting review label Nov 4, 2025

serhiy-storchaka reviewed Nov 6, 2025

View reviewed changes

mbyrnepr2 and others added 8 commits November 11, 2025 13:38

wave.py - Allow opening of path-like files.

99e7d5a

📜🤖 Added by blurb_it.

6475b2c

📜🤖 Added by blurb_it.

a36d5fc

Delete Misc/NEWS.d/next/Library/2025-11-03-15-51-42.gh-issue-140952.E…

a09e5c3

…FVhKR.rst

Update the wave.py documentation.

95b2fce

Update Misc/NEWS.d/next/Library/2025-11-04-12-16-13.gh-issue-75593.EF…

9b96c88

…VhKR.rst Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

Code review improvements:

ec5b3df

- Use `FakePath` instead of `pathlib.Path`. - Add an extra test case for the bytes path case. - Format the doc and add `versionchanged`.

Remove unused import.

ba5ed6f

mbyrnepr2 force-pushed the wave_open_a_pathlib_file branch from eb1f0ab to ba5ed6f Compare November 11, 2025 12:39

serhiy-storchaka reviewed Nov 11, 2025

View reviewed changes

Use code review improvements:

31cc9c5

- More accurate documentation. - More complete test cases.

serhiy-storchaka approved these changes Nov 11, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Nov 11, 2025

Update the news with the full information.

6c2b7de

serhiy-storchaka merged commit 3590826 into python:main Nov 12, 2025
46 checks passed

bedevere-app bot removed the awaiting merge label Nov 12, 2025

mbyrnepr2 deleted the wave_open_a_pathlib_file branch November 12, 2025 10:40

StanFromIreland pushed a commit to StanFromIreland/cpython that referenced this pull request Dec 6, 2025

pythongh-75593: Add support of bytes and path-like paths in wave.open…

1771ee6

…() (pythonGH-140951)

		self.assertIsNone(cm.unraisable)


		class WaveOpen(unittest.TestCase):

		@@ -0,0 +1 @@
		Add support of :term:`path-like objects <path-like object>` in :func:`wave.open`.

Uh oh!

Conversation

mbyrnepr2 commented Nov 3, 2025 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

python-cla-bot bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbyrnepr2 commented Nov 4, 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mbyrnepr2 Nov 11, 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!

serhiy-storchaka left a comment

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!

Uh oh!

serhiy-storchaka commented Nov 12, 2025

Uh oh!

mbyrnepr2 commented Nov 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mbyrnepr2 commented Nov 3, 2025 •

edited by bedevere-app bot

Loading

python-cla-bot bot commented Nov 4, 2025 •

edited

Loading

mbyrnepr2 commented Nov 4, 2025 •

edited

Loading

mbyrnepr2 Nov 11, 2025 •

edited

Loading