mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 08:59:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

#18615: Make sndhdr return namedtuples.

Browse source 
Patch by Claudiu Popa.
This commit is contained in:
R David Murray 2014-10-09 16:59:30 -04:00
parent aad627f2f9
commit 4487dd0ed5
5 changed files with 39 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/sndhdr.rst
View file

@ -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.