https://github.com/python/cpython/commit/db41717cd50af6db7d496b0aa282b1f3370327c6
commit: db41717cd50af6db7d496b0aa282b1f3370327c6
branch: main
author: Michiel W. Beijen <[email protected]>
committer: encukou <[email protected]>
date: 2026-03-03T13:44:56+01:00
summary:
GH-145450: Document missing `wave.Wave_write` getter methods (GH-145451)
files:
A Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst
M Doc/library/wave.rst
diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst
index 6e61a1a44ad232..ff020b52da3f23 100644
--- a/Doc/library/wave.rst
+++ b/Doc/library/wave.rst
@@ -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*.
@@ -195,6 +205,11 @@ 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
@@ -202,12 +217,27 @@ Wave_write Objects
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,
@@ -215,6 +245,13 @@ Wave_write Objects
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
diff --git
a/Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst
b/Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst
new file mode 100644
index 00000000000000..681c932b34a05d
--- /dev/null
+++
b/Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst
@@ -0,0 +1 @@
+Document missing public :class:`wave.Wave_write` getter methods.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
