gh-153953: Increase test coverage for the `wave` module by fedonman · Pull Request #153954 · python/cpython

fedonman · 2026-07-18T13:09:54Z

Adds tests for previously-uncovered code paths in Lib/wave.py, all reachable through the public API and deterministic across platforms.

Wave_write parameter validation

setnchannels() rejecting a non-positive channel count
getnchannels() / getsampwidth() / getframerate() / getparams() raising when parameters are unset
setsampwidth() rejecting out-of-range widths
setcomptype() / setformat() rejecting unsupported values
the "cannot change parameters after starting to write" guard on every setter (setnchannels, setsampwidth, setframerate, setnframes, setcomptype, setformat, setparams)
tell()

Wave_read error handling

rejecting a WAVE_FORMAT_EXTENSIBLE file whose SubFormat GUID is not PCM
raising EOFError on a truncated fmt chunk (missing header / missing sample width)
skipping an unknown, odd-sized chunk between fmt and data
getfp()
closing the underlying file when opening a malformed file by path fails

wave.open()

rejecting an invalid mode

Measured with the stdlib trace module while running test_wave, line coverage of Lib/wave.py rises from 317/449 to 345/449 executable lines.

This is a test-only change with no behavior change, so no Misc/NEWS.d entry is included. ./python -m test -R 3:3 test_wave reports no reference leaks.

Fixes #153953.

Issue: Increase test coverage for the wave module #153953

Add tests for previously-uncovered paths in Lib/wave.py, all reachable through the public API: * Wave_write parameter validation: rejecting bad channel counts, sample widths, compression types and formats; the "not set" errors from the getters; the "cannot change parameters after starting to write" guards on every setter; and tell(). * Wave_read error handling: rejecting an unknown WAVE_FORMAT_EXTENSIBLE subformat, raising EOFError on a truncated fmt chunk, skipping unknown chunks, getfp(), and closing the file when opening a malformed path fails. * wave.open() rejecting an invalid mode. This raises line coverage of Lib/wave.py under test_wave from 317 to 345 of 449 executable lines. Test-only change; no behavior change.

Co-authored-by: Victor Stinner <vstinner@python.org>

The test relied on the _wave_file helper and FMT_PCM constant, which only exist on WaveReadErrorTest. Build the WAVE file with the wave module so the test is self-contained.

fedonman · 2026-07-21T13:32:19Z

@vstinner comments addressed, you may review again.

Co-authored-by: Victor Stinner <vstinner@python.org>

vstinner

Oh! I had a draft comment for 2 weeks, I forgot to send it.

Replaces the eight one-assertion tests with the two grouped ones from the review, which also cover bad frame rate, setparams validation and the comptype round trip.

fedonman · 2026-08-07T17:22:20Z

Applied, thanks.

vstinner

LGTM

vstinner · 2026-08-10T15:04:22Z

Merged, thanks for your contribution!

bedevere-bot · 2026-08-10T15:12:22Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot s390x Fedora Stable LTO + PGO 3.x (tier-3) has failed when building commit 61304a3.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1627/builds/3165) and take a look at the build logs.
Check if the failure is related to this commit (61304a3) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1627/builds/3165

Failed tests:

test_profiling

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/test/test_profiling/test_sampling_profiler/test_live_collector_ui.py", line 900, in test_run_failed_script_live
    main()
    ~~~~^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 989, in main
    _main()
    ~~~~~^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1145, in _main
    handler(args)
    ~~~~~~~^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1251, in _handle_run
    _handle_live_run(args)
    ~~~~~~~~~~~~~~~~^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1386, in _handle_live_run
    sample_live(
    ~~~~~~~~~~~^
        process.pid,
        ^^^^^^^^^^^^
    ...<9 lines>...
        blocking=args.blocking,
        ^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 610, in sample_live
    profiler = SampleProfiler(
        pid,
    ...<8 lines>...
        blocking=blocking,
    )
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 89, in __init__
    raise SystemExit(err) from err
SystemExit: Failed to find the PyRuntime section in process 159220 on Linux platform


Traceback (most recent call last):
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/test/test_profiling/test_sampling_profiler/test_live_collector_ui.py", line 900, in test_run_failed_script_live
    main()
    ~~~~^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 989, in main
    _main()
    ~~~~~^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1145, in _main
    handler(args)
    ~~~~~~~^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1251, in _handle_run
    _handle_live_run(args)
    ~~~~~~~~~~~~~~~~^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/cli.py", line 1386, in _handle_live_run
    sample_live(
    ~~~~~~~~~~~^
        process.pid,
        ^^^^^^^^^^^^
    ...<9 lines>...
        blocking=args.blocking,
        ^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 610, in sample_live
    profiler = SampleProfiler(
        pid,
    ...<8 lines>...
        blocking=blocking,
    )
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 89, in __init__
    raise SystemExit(err) from err
SystemExit: Failed to find the PyRuntime section in process 149156 on Linux platform


Traceback (most recent call last):
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 87, in __init__
    self.unwinder = self._new_unwinder(native, gc, opcodes, skip_non_matching_threads)
                    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 102, in _new_unwinder
    return _remote_debugging.RemoteUnwinder(
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
        self.pid,
        ^^^^^^^^^
    ...<7 lines>...
        **kwargs
        ^^^^^^^^
    )
    ^
RuntimeError: Failed to find the PyRuntime section in process 149156 on Linux platform


Traceback (most recent call last):
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 87, in __init__
    self.unwinder = self._new_unwinder(native, gc, opcodes, skip_non_matching_threads)
                    ~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/var/lib/buildbot/worker/cstratak-fedora-stable-s390x/3.x.cstratak-fedora-stable-s390x.lto-pgo/build/Lib/profiling/sampling/sample.py", line 102, in _new_unwinder
    return _remote_debugging.RemoteUnwinder(
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
        self.pid,
        ^^^^^^^^^
    ...<7 lines>...
        **kwargs
        ^^^^^^^^
    )
    ^
RuntimeError: Failed to find the PyRuntime section in process 159220 on Linux platform

bedevere-app Bot added the tests Tests in the Lib/test dir label Jul 18, 2026

bedevere-app Bot mentioned this pull request Jul 18, 2026

Increase test coverage for the wave module #153953

Closed

bedevere-app Bot added the awaiting review label Jul 18, 2026

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

0f8cce2

tomasr8 added sprint skip issue skip news labels Jul 18, 2026

github-project-automation Bot added this to Sprint Jul 18, 2026

github-project-automation Bot moved this to Todo in Sprint Jul 18, 2026

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

4d02fcc

vstinner reviewed Jul 18, 2026

View reviewed changes

Comment thread Lib/test/test_wave.py Outdated

Comment thread Lib/test/test_wave.py Outdated

Comment thread Lib/test/test_wave.py Outdated

fedonman and others added 3 commits July 19, 2026 02:32

Update Lib/test/test_wave.py

0b2843d

Co-authored-by: Victor Stinner <vstinner@python.org>

changed tests based on comments by vstinner

e2019ff

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

ce98aa8

fedonman requested a review from vstinner July 18, 2026 23:37

fedonman added 6 commits July 19, 2026 13:14

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

82fc6ad

pythongh-153953: Fix test_getfp after moving it to MiscTestCase

28c5f9c

The test relied on the _wave_file helper and FMT_PCM constant, which only exist on WaveReadErrorTest. Build the WAVE file with the wave module so the test is self-contained.

removes trailing whitespace

2ce387f

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

5a84213

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

e960569

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

8e91402

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

be2a618

vstinner reviewed Jul 23, 2026

View reviewed changes

Comment thread Lib/test/test_wave.py Outdated

Comment thread Lib/test/test_wave.py Outdated

Comment thread Lib/test/test_wave.py

fedonman and others added 3 commits July 26, 2026 18:09

Merge branch 'main' into fix-pythongh-153953-wave-test-coverage

c85727e

apply reviewer's comments

83a14bb

Update Lib/test/test_wave.py

f55830c

Co-authored-by: Victor Stinner <vstinner@python.org>

fedonman requested a review from vstinner July 26, 2026 15:14

fix linting

837790e

vstinner reviewed Aug 7, 2026

View reviewed changes

Comment thread Lib/test/test_wave.py Outdated

Group the Wave_write get and set tests

46b668d

Replaces the eight one-assertion tests with the two grouped ones from the review, which also cover bad frame rate, setparams validation and the comptype round trip.

vstinner reviewed Aug 10, 2026

View reviewed changes

Comment thread Lib/test/test_wave.py Outdated

Apply suggestion from @vstinner

da56a64

vstinner approved these changes Aug 10, 2026

View reviewed changes

bedevere-app Bot removed the awaiting review label Aug 10, 2026

github-project-automation Bot moved this from Todo to In Progress in Sprint Aug 10, 2026

bedevere-app Bot added the awaiting merge label Aug 10, 2026

vstinner enabled auto-merge (squash) August 10, 2026 14:08

vstinner merged commit 61304a3 into python:main Aug 10, 2026
52 checks passed

github-project-automation Bot moved this from In Progress to Done in Sprint Aug 10, 2026

bedevere-app Bot removed the awaiting merge label Aug 10, 2026

fedonman deleted the fix-gh-153953-wave-test-coverage branch August 10, 2026 16:16

Navigation Menu

Uh oh!

Uh oh!

gh-153953: Increase test coverage for the `wave` module - #153954

gh-153953: Increase test coverage for the `wave` module#153954
vstinner merged 19 commits into
python:mainfrom
fedonman:fix-gh-153953-wave-test-coverage

fedonman commented Jul 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fedonman commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner left a comment

Uh oh!

Uh oh!

fedonman commented Aug 7, 2026

Uh oh!

Uh oh!

vstinner left a comment

Uh oh!

Uh oh!

vstinner commented Aug 10, 2026

Uh oh!

bedevere-bot commented Aug 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Uh oh!

Conversation

fedonman commented Jul 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fedonman commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fedonman commented Aug 7, 2026

Uh oh!

Uh oh!

vstinner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vstinner commented Aug 10, 2026

Uh oh!

bedevere-bot commented Aug 10, 2026

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fedonman commented Jul 18, 2026 •

edited

Loading