rename nframes() and get_nframes()

I never really liked these names.

Author: arcctgx

arver/audio/_audio.c

@@ -174,7 +174,7 @@ static PyObject *checksums(PyObject *self, PyObject *args)
     return Py_BuildValue("III", ar.v1, ar.v2, crc);
 }
 
-static PyObject *nframes(PyObject *self, PyObject *args)
+static PyObject *frame_count(PyObject *self, PyObject *args)
 {
     const char *path = NULL;
     SNDFILE *file = NULL;
@@ -205,7 +205,7 @@ static PyObject *libsndfile_version(PyObject *self, PyObject *args)
 
 static PyMethodDef methods[] = {
     { "checksums", checksums, METH_VARARGS, PyDoc_STR("Calculate AccurateRip and CRC32 checksums of an audio file.") },
-    { "nframes", nframes, METH_VARARGS, PyDoc_STR("Get the number of audio frames in a file.") },
+    { "frame_count", frame_count, METH_VARARGS, PyDoc_STR("Get the number of audio frames in a file.") },
     { "libsndfile_version", libsndfile_version, METH_NOARGS, PyDoc_STR("Get libsndfile version string.") },
     { NULL, NULL, 0, NULL },
 };

arver/audio/properties.py

@@ -8,7 +8,7 @@
 from arver.audio import _audio  # type: ignore
 
 
-def get_nframes(path: str) -> int:
+def get_frame_count(path: str) -> int:
     """
     Return the number of frames in a supported audio file. A frame
     is a set of samples, one sample per channel.
@@ -18,7 +18,7 @@ def get_nframes(path: str) -> int:
     will raise TypeError for any other audio format, or OSError when
     libsndfile can't load audio samples from the file for any reason.
     """
-    return _audio.nframes(path)
+    return _audio.frame_count(path)
 
 
 def get_libsndfile_version() -> str:

arver/rip/rip.py

@@ -7,7 +7,7 @@
 from typing import ClassVar, List, Optional
 
 from arver.audio.checksums import get_checksums
-from arver.audio.properties import get_nframes
+from arver.audio.properties import get_frame_count
 from arver.disc.info import DiscInfo, DiscType
 from arver.disc.utils import frames_to_msf
 
@@ -37,7 +37,7 @@ def __init__(self, path: str) -> None:
         self.path: str = path
 
         try:
-            self._audio_frames = get_nframes(path)
+            self._audio_frames = get_frame_count(path)
             self.cdda_frames = self._audio_frames // AUDIO_FRAMES_PER_CD_SECTOR
         except (OSError, TypeError) as exc:
             raise AudioFormatError from exc

tests/_audio_test.py

@@ -47,17 +47,17 @@ def test_corrupted_audio(self):
             _audio.checksums(CORRUPTED_AUDIO_PATH, 1, 9)
 
 
-class TestExceptionsNframes(unittest.TestCase):
+class TestExceptionsFrameCount(unittest.TestCase):
     """Test exceptions raised when getting the number of audio frames in a file."""
 
     def test_nonexistent_file(self):
         with self.assertRaisesRegex(OSError, 'No such file or directory'):
-            _audio.nframes('does_not_exist.flac')
+            _audio.frame_count('does_not_exist.flac')
 
     def test_not_audio(self):
         with self.assertRaisesRegex(OSError, '(unknown format|Format not recognised)'):
-            _audio.nframes(NOT_AUDIO_PATH)
+            _audio.frame_count(NOT_AUDIO_PATH)
 
     def test_unsupported_audio_format(self):
         with self.assertRaisesRegex(TypeError, 'Unsupported audio format'):
-            _audio.nframes(SAMPLE_VORBIS_PATH)
+            _audio.frame_count(SAMPLE_VORBIS_PATH)

tests/properties_test.py

@@ -5,7 +5,7 @@
 import os
 import unittest
 
-from arver.audio.properties import get_nframes
+from arver.audio.properties import get_frame_count
 
 CWD = os.path.abspath(os.path.dirname(__file__))
 SAMPLE_WAV_PATH = CWD + '/data/samples/sample.wav'
@@ -18,9 +18,9 @@ class TestGetNFrames(unittest.TestCase):
     expected_frames = 44100  # one second of CDDA audio: number of frames same as sampling rate
 
     def test_wav(self):
-        frames = get_nframes(SAMPLE_WAV_PATH)
+        frames = get_frame_count(SAMPLE_WAV_PATH)
         self.assertEqual(frames, self.expected_frames)
 
     def test_flac(self):
-        frames = get_nframes(SAMPLE_FLAC_PATH)
+        frames = get_frame_count(SAMPLE_FLAC_PATH)
         self.assertEqual(frames, self.expected_frames)