summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-10-09 20:59:30 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-10-09 20:59:30 (GMT)
commit4487dd0ed5482d619279aa45099a22d0abc9615d (patch)
tree9e0919a9825e4a064ecd54209ec51bea3d49cbd9 /Doc/library
parentaad627f2f94c426fab6d8341ffd60ca36cc005b7 (diff)
downloadcpython-4487dd0ed5482d619279aa45099a22d0abc9615d.zip
cpython-4487dd0ed5482d619279aa45099a22d0abc9615d.tar.gz
cpython-4487dd0ed5482d619279aa45099a22d0abc9615d.tar.bz2
#18615: Make sndhdr return namedtuples.
Patch by Claudiu Popa.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/sndhdr.rst15
1 files changed, 11 insertions, 4 deletions
diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst
index f36df68..f8b5d8b 100644
--- a/Doc/library/sndhdr.rst
+++ b/Doc/library/sndhdr.rst
@@ -16,8 +16,9 @@
The :mod:`sndhdr` provides utility functions which attempt to determine the type
of sound data which is in a file. When these functions are able to determine
-what type of sound data is stored in a file, they return a tuple ``(type,
-sampling_rate, channels, frames, bits_per_sample)``. The value for *type*
+what type of sound data is stored in a file, they return a
+:func:`~collections.namedtuple`, containing five attributes: (``filetype``,
+``framerate``, ``nchannels``, ``nframes``, ``sampwidth``). The value for *type*
indicates the data type and will be one of the strings ``'aifc'``, ``'aiff'``,
``'au'``, ``'hcom'``, ``'sndr'``, ``'sndt'``, ``'voc'``, ``'wav'``, ``'8svx'``,
``'sb'``, ``'ub'``, or ``'ul'``. The *sampling_rate* will be either the actual
@@ -31,13 +32,19 @@ be the sample size in bits or ``'A'`` for A-LAW or ``'U'`` for u-LAW.
.. function:: what(filename)
Determines the type of sound data stored in the file *filename* using
- :func:`whathdr`. If it succeeds, returns a tuple as described above, otherwise
+ :func:`whathdr`. If it succeeds, returns a namedtuple as described above, otherwise
``None`` is returned.
+ .. versionchanged:: 3.5
+ Result changed from a tuple to a namedtuple.
+
.. function:: whathdr(filename)
Determines the type of sound data stored in a file based on the file header.
- The name of the file is given by *filename*. This function returns a tuple as
+ The name of the file is given by *filename*. This function returns a namedtuple as
described above on success, or ``None``.
+ .. versionchanged:: 3.5
+ Result changed from a tuple to a namedtuple.
+