Skip to content

GH-145450: Document missing wave.Wave_write getter methods #145451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 1 commit into from
Mar 3, 2026
Merged

GH-145450: Document missing wave.Wave_write getter methods #145451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions Doc/library/wave.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,11 +181,21 @@ Wave_write Objects
Set the number of channels.


.. method:: getnchannels()

Return the number of channels.


.. method:: setsampwidth(n)

Set the sample width to *n* bytes.


.. method:: getsampwidth()

Return the sample width in bytes.


.. method:: setframerate(n)

Set the frame rate to *n*.
Expand All @@ -195,26 +205,53 @@ Wave_write Objects
integer.


.. method:: getframerate()

Return the frame rate.


.. method:: setnframes(n)

Set the number of frames to *n*. This will be changed later if the number
of frames actually written is different (this update attempt will
raise an error if the output stream is not seekable).


.. method:: getnframes()

Return the number of audio frames written so far.


.. method:: setcomptype(type, name)

Set the compression type and description. At the moment, only compression type
``NONE`` is supported, meaning no compression.


.. method:: getcomptype()

Return the compression type (``'NONE'``).


.. method:: getcompname()

Return the human-readable compression type name.


.. method:: setparams(tuple)

The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype,
compname)``, with values valid for the ``set*()`` methods. Sets all
parameters.


.. method:: getparams()

Return a :func:`~collections.namedtuple`
``(nchannels, sampwidth, framerate, nframes, comptype, compname)``
containing the current output parameters.


.. method:: tell()

Return current position in the file, with the same disclaimer for the
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document missing public :class:`wave.Wave_write` getter methods.
Loading