]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] GH-145450: Document missing `wave.Wave_write` getter methods (GH-145451) ...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 3 Mar 2026 12:50:45 +0000 (13:50 +0100)
committerGitHub <noreply@github.com>
Tue, 3 Mar 2026 12:50:45 +0000 (12:50 +0000)
(cherry picked from commit db41717cd50af6db7d496b0aa282b1f3370327c6)

Co-authored-by: Michiel W. Beijen <mb@x14.nl>
Doc/library/wave.rst
Misc/NEWS.d/next/Documentation/2026-03-03-08-18-00.gh-issue-145450.VI7GXj.rst [new file with mode: 0644]

index c71f6f25c9d13bf25990a205a5ec6b624ab4c596..38b05f0b4fdd7bb943ba064a1b3c714db4e0cf14 100644 (file)
@@ -199,11 +199,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*.
@@ -213,6 +223,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
@@ -220,12 +235,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,
@@ -233,6 +263,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 (file)
index 0000000..681c932
--- /dev/null
@@ -0,0 +1 @@
+Document missing public :class:`wave.Wave_write` getter methods.