analyzeAudio 0.0.16__py3-none-any.whl → 0.0.17__py3-none-any.whl

analyzeAudio/analyzersUseFilename.py

@@ -1,6 +1,7 @@
 """Analyzers that use the filename of an audio file to analyze its audio data."""
+# ruff: noqa: D103
+from analyzeAudio import cacheAudioAnalyzers, registrationAudioAspect
 from analyzeAudio.pythonator import pythonizeFFprobe
-from analyzeAudio import registrationAudioAspect, cacheAudioAnalyzers
 from os import PathLike
 from statistics import mean
 from typing import Any, cast
@@ -12,22 +13,31 @@ import subprocess
 
 @registrationAudioAspect('SI-SDR mean')
 def getSI_SDRmean(pathFilenameAlpha: str | PathLike[Any], pathFilenameBeta: str | PathLike[Any]) -> float | None:
-	"""
-	Calculate the mean Scale-Invariant Signal-to-Distortion Ratio (SI-SDR) between two audio files.
-	This function uses FFmpeg to compute the SI-SDR between two audio files specified by their paths.
-	The SI-SDR values are extracted from the FFmpeg output and their mean is calculated.
-	Parameters:
-		pathFilenameAlpha: Path to the first audio file.
-		pathFilenameBeta: Path to the second audio file.
-	Returns:
-		SI_SDRmean: The mean SI-SDR value in decibels (dB).
-	Raises:
-		subprocess.CalledProcessError: If the FFmpeg command fails.
-		ValueError: If no SI-SDR values are found in the FFmpeg output.
+	"""Calculate the mean Scale-Invariant Signal-to-Distortion Ratio (SI-SDR) between two audio files.
+
+	Parameters
+	----------
+	pathFilenameAlpha : str | PathLike[Any]
+		Path to the first audio file.
+	pathFilenameBeta : str | PathLike[Any]
+		Path to the second audio file.
+
+	Returns
+	-------
+	SI_SDRmean : float | None
+		The mean SI-SDR value in decibels (dB).
+
+	Raises
+	------
+	subprocess.CalledProcessError
+		If the FFmpeg command fails.
+	ValueError
+		If no SI-SDR values are found in the FFmpeg output.
+
 	"""
 	commandLineFFmpeg = [
 		'ffmpeg', '-hide_banner', '-loglevel', '32',
-		'-i', f'{str(pathlib.Path(pathFilenameAlpha))}', '-i', f'{str(pathlib.Path(pathFilenameBeta))}',
+		'-i', f'{str(pathlib.Path(pathFilenameAlpha))}', '-i', f'{str(pathlib.Path(pathFilenameBeta))}',  # noqa: RUF010
 		'-filter_complex', '[0][1]asisdr', '-f', 'null', '-'
 	]
 	systemProcessFFmpeg = subprocess.run(commandLineFFmpeg, check=True, stderr=subprocess.PIPE)
@@ -37,8 +47,7 @@ def getSI_SDRmean(pathFilenameAlpha: str | PathLike[Any], pathFilenameBeta: str
 	regexSI_SDR = regex.compile(r"^\[Parsed_asisdr_.* (.*) dB", regex.MULTILINE)
 
 	listMatchesSI_SDR = regexSI_SDR.findall(stderrFFmpeg)
-	SI_SDRmean = mean(float(match) for match in listMatchesSI_SDR)
-	return SI_SDRmean
+	return mean(float(match) for match in listMatchesSI_SDR)
 
 @cachetools.cached(cache=cacheAudioAnalyzers)
 def ffprobeShotgunAndCache(pathFilename: str | PathLike[Any]) -> dict[str, float]:
@@ -67,16 +76,16 @@ def ffprobeShotgunAndCache(pathFilename: str | PathLike[Any]) -> dict[str, float
 	dictionaryAspectsAnalyzed: dict[str, float] = {}
 	if 'aspectralstats' in FFprobeStructured:
 		for keyName in FFprobeStructured['aspectralstats']:
-			# No matter how many channels, each keyName is `numpy.ndarray[tuple[int, int], numpy.dtype[numpy.float64]]`
-			# where `tuple[int, int]` is (channel, frame)
-			# NOTE (as of this writing) `registrar` can only understand the generic class `numpy.ndarray` and not more specific typing
-			# dictionaryAspectsAnalyzed[keyName] = FFprobeStructured['aspectralstats'][keyName]
+			"""No matter how many channels, each keyName is `numpy.ndarray[tuple[int, int], numpy.dtype[numpy.float64]]`
+			where `tuple[int, int]` is (channel, frame)
+			NOTE (as of this writing) `registrar` can only understand the generic class `numpy.ndarray` and not more specific typing
+			dictionaryAspectsAnalyzed[keyName] = FFprobeStructured['aspectralstats'][keyName]"""
 			dictionaryAspectsAnalyzed[keyName] = numpy.mean(FFprobeStructured['aspectralstats'][keyName]).astype(float)
 	if 'r128' in FFprobeStructured:
 		for keyName in FFprobeStructured['r128']:
 			dictionaryAspectsAnalyzed[keyName] = FFprobeStructured['r128'][keyName][-1]
 	if 'astats' in FFprobeStructured:
-		for keyName, arrayFeatureValues in cast(dict[str, numpy.ndarray[Any, Any]], FFprobeStructured['astats']).items():
+		for keyName, arrayFeatureValues in cast('dict[str, numpy.ndarray[Any, Any]]', FFprobeStructured['astats']).items():
 			dictionaryAspectsAnalyzed[keyName.split('.')[-1]] = numpy.mean(arrayFeatureValues[..., -1:None]).astype(float)
 
 	return dictionaryAspectsAnalyzed
@@ -187,7 +196,6 @@ def analyzeRolloff(pathFilename: str | PathLike[Any]) -> float | None:
 
 @registrationAudioAspect('Abs_Peak_count')
 def analyzeAbs_Peak_count(pathFilename: str | PathLike[Any]) -> float | None:
-	print('Abs_Peak_count', pathFilename)
 	return ffprobeShotgunAndCache(pathFilename).get('Abs_Peak_count')
 
 @registrationAudioAspect('Bit_depth')

analyzeAudio/analyzersUseSpectrogram.py

@@ -1,30 +1,31 @@
 """Analyzers that use the spectrogram to analyze audio data."""
-from analyzeAudio import registrationAudioAspect, audioAspects, cacheAudioAnalyzers
+# ruff: noqa: D103
+from analyzeAudio import audioAspects, cacheAudioAnalyzers, registrationAudioAspect
+from numpy import dtype, floating
 from typing import Any
 import cachetools
 import librosa
 import numpy
-from numpy import dtype, floating
 
 @registrationAudioAspect('Chromagram')
 def analyzeChromagram(spectrogramPower: numpy.ndarray[Any, dtype[floating[Any]]], sampleRate: int, **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	return librosa.feature.chroma_stft(S=spectrogramPower, sr=sampleRate, **keywordArguments) # type: ignore
+	return librosa.feature.chroma_stft(S=spectrogramPower, sr=sampleRate, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 @registrationAudioAspect('Spectral Contrast')
 def analyzeSpectralContrast(spectrogramMagnitude: numpy.ndarray[Any, dtype[floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	return librosa.feature.spectral_contrast(S=spectrogramMagnitude, **keywordArguments) # type: ignore
+	return librosa.feature.spectral_contrast(S=spectrogramMagnitude, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 @registrationAudioAspect('Spectral Bandwidth')
 def analyzeSpectralBandwidth(spectrogramMagnitude: numpy.ndarray[Any, dtype[floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
 	centroid = audioAspects['Spectral Centroid']['analyzer'](spectrogramMagnitude)
-	return librosa.feature.spectral_bandwidth(S=spectrogramMagnitude, centroid=centroid, **keywordArguments) # type: ignore
+	return librosa.feature.spectral_bandwidth(S=spectrogramMagnitude, centroid=centroid, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 @cachetools.cached(cache=cacheAudioAnalyzers)
 @registrationAudioAspect('Spectral Centroid')
 def analyzeSpectralCentroid(spectrogramMagnitude: numpy.ndarray[Any, dtype[floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	return librosa.feature.spectral_centroid(S=spectrogramMagnitude, **keywordArguments) # type: ignore
+	return librosa.feature.spectral_centroid(S=spectrogramMagnitude, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 @registrationAudioAspect('Spectral Flatness')
 def analyzeSpectralFlatness(spectrogramMagnitude: numpy.ndarray[Any, dtype[floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	spectralFlatness: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]] = librosa.feature.spectral_flatness(S=spectrogramMagnitude, **keywordArguments) # type: ignore
+	spectralFlatness: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]] = librosa.feature.spectral_flatness(S=spectrogramMagnitude, **keywordArguments) # pyright: ignore[reportUnknownMemberType, reportUnknownVariableType]
 	return 20 * numpy.log10(spectralFlatness, where=(spectralFlatness != 0)) # dB

analyzeAudio/analyzersUseTensor.py

@@ -6,6 +6,6 @@ import numpy
 import torch
 
 @registrationAudioAspect('SRMR')
-def analyzeSRMR(tensorAudio: torch.Tensor, sampleRate: int, pytorchOnCPU: bool | None, **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
+def analyzeSRMR(tensorAudio: torch.Tensor, sampleRate: int, pytorchOnCPU: bool | None, **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]  # noqa: D103, FBT001
 	keywordArguments['fast'] = keywordArguments.get('fast') or pytorchOnCPU or None
-	return torch.Tensor.numpy(speech_reverberation_modulation_energy_ratio(tensorAudio, sampleRate, **keywordArguments)) # type: ignore
+	return torch.Tensor.numpy(speech_reverberation_modulation_energy_ratio(tensorAudio, sampleRate, **keywordArguments))  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]

analyzeAudio/analyzersUseWaveform.py

@@ -1,26 +1,27 @@
 """Analyzers that use the waveform of audio data."""
-from analyzeAudio import registrationAudioAspect, audioAspects, cacheAudioAnalyzers
+# ruff: noqa: D103
+from analyzeAudio import audioAspects, cacheAudioAnalyzers, registrationAudioAspect
 from typing import Any
+import cachetools
 import librosa
 import numpy
-import cachetools
 
 @cachetools.cached(cache=cacheAudioAnalyzers)
 @registrationAudioAspect('Tempogram')
 def analyzeTempogram(waveform: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]], sampleRate: int, **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	return librosa.feature.tempogram(y=waveform, sr=sampleRate, **keywordArguments) # type: ignore
+	return librosa.feature.tempogram(y=waveform, sr=sampleRate, **keywordArguments)  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 # "RMS value from audio samples is faster ... However, ... spectrogram ... more accurate ... because ... windowed"
 @registrationAudioAspect('RMS from waveform')
 def analyzeRMS(waveform: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	arrayRMS: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]] = librosa.feature.rms(y=waveform, **keywordArguments) # type: ignore
+	arrayRMS: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]] = librosa.feature.rms(y=waveform, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 	return 20 * numpy.log10(arrayRMS, where=(arrayRMS != 0)) # dB
 
 @registrationAudioAspect('Tempo')
 def analyzeTempo(waveform: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]], sampleRate: int, **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
 	tempogram = audioAspects['Tempogram']['analyzer'](waveform, sampleRate)
-	return librosa.feature.tempo(y=waveform, sr=sampleRate, tg=tempogram, **keywordArguments) # type: ignore
+	return librosa.feature.tempo(y=waveform, sr=sampleRate, tg=tempogram, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
 
 @registrationAudioAspect('Zero-crossing rate') # This is distinct from 'Zero-crossings rate'
 def analyzeZeroCrossingRate(waveform: numpy.ndarray[tuple[int, ...], numpy.dtype[numpy.floating[Any]]], **keywordArguments: Any) -> numpy.ndarray: # pyright: ignore [reportMissingTypeArgument, reportUnknownParameterType]
-	return librosa.feature.zero_crossing_rate(y=waveform, **keywordArguments) # type: ignore
+	return librosa.feature.zero_crossing_rate(y=waveform, **keywordArguments) # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]

analyzeAudio/audioAspectsRegistry.py

@@ -1,10 +1,14 @@
-from collections.abc import Callable, Sequence
-from concurrent.futures import ProcessPoolExecutor, as_completed
+from collections.abc import Callable, Sequence  # noqa: D100
+from concurrent.futures import as_completed, ProcessPoolExecutor
+from hunterMakesPy import defineConcurrencyLimit, oopsieKwargsie
+from multiprocessing import set_start_method as multiprocessing_set_start_method
 from numpy.typing import NDArray
 from os import PathLike
-from typing import Any, cast, ParamSpec, TypeAlias, TYPE_CHECKING, TypeVar
-from Z0Z_tools import defineConcurrencyLimit, oopsieKwargsie, stft, Spectrogram
+from typing import Any, cast, ParamSpec, TypeAlias, TypeVar
+from typing_extensions import TypedDict
+from Z0Z_tools import Spectrogram, stft
 import cachetools
+import contextlib
 import inspect
 import numpy
 import pathlib
@@ -12,16 +16,8 @@ import soundfile
 import torch
 import warnings
 
-if TYPE_CHECKING:
-	from typing import TypedDict
-else:
-	TypedDict = dict
-
-from multiprocessing import set_start_method as multiprocessing_set_start_method
-try:
+with contextlib.suppress(RuntimeError):
 	multiprocessing_set_start_method('spawn')
-except RuntimeError:
-	pass
 
 warnings.filterwarnings('ignore', category=UserWarning, module='torchmetrics', message='.*fast=True.*')
 
@@ -29,48 +25,57 @@ parameterSpecifications = ParamSpec('parameterSpecifications')
 typeReturned = TypeVar('typeReturned')
 
 audioAspect: TypeAlias = str
-class analyzersAudioAspects(TypedDict):
+
+class analyzersAudioAspects(TypedDict):  # noqa: D101
 	analyzer: Callable[..., Any]
 	analyzerParameters: list[str]
 
+
 audioAspects: dict[audioAspect, analyzersAudioAspects] = {}
 """A register of 1) measurable aspects of audio data, 2) analyzer functions to measure audio aspects, 3) and parameters of analyzer functions."""
 
 def registrationAudioAspect(aspectName: str) -> Callable[[Callable[parameterSpecifications, typeReturned]], Callable[parameterSpecifications, typeReturned]]:
-	"""
-	A function to "decorate" a registrant-analyzer function and the aspect of audio data it can analyze.
+	"""'Decorate' a registrant-analyzer function and the aspect of audio data it can analyze.
+
+	Parameters
+	----------
+	aspectName : str
+		The audio aspect that the registrar will enter into the register, `audioAspects`.
 
-	Parameters:
-		aspectName: The audio aspect that the registrar will enter into the register, `audioAspects`.
 	"""
 
 	def registrar(registrant: Callable[parameterSpecifications, typeReturned]) -> Callable[parameterSpecifications, typeReturned]:
 		"""
 		`registrar` updates the registry, `audioAspects`, with 1) the analyzer function, `registrant`, 2) the analyzer function's parameters, and 3) the aspect of audio data that the analyzer function measures.
 
-		Parameters:
-			registrant: The function that analyzes an aspect of audio data.
+		Parameters
+		----------
+		registrant : Callable
+			The function that analyzes an aspect of audio data.
+
+		Note
+		----
+		`registrar` does not change the behavior of `registrant`, the analyzer function.
 
-		Note:
-			`registrar` does not change the behavior of `registrant`, the analyzer function.
 		"""
 		audioAspects[aspectName] = {
 			'analyzer': registrant,
 			'analyzerParameters': inspect.getfullargspec(registrant).args
 		}
 
-		# if registrant.__annotations__.get('return') is not None and issubclass(registrant.__annotations__['return'], subclassTarget): # maybe someday I will understand why this doesn't work
-		# if registrant.__annotations__.get('return') is not None and issubclass(registrant.__annotations__.get('return', type(None)), subclassTarget): # maybe someday I will understand why this doesn't work
 		if isinstance(registrant.__annotations__.get('return', type(None)), type) and issubclass(registrant.__annotations__.get('return', type(None)), numpy.ndarray): # maybe someday I will understand what all of this statement means
 			def registrationAudioAspectMean(*arguments: parameterSpecifications.args, **keywordArguments: parameterSpecifications.kwargs) -> numpy.floating[Any]:
 				"""
 				`registrar` updates the registry with a new analyzer function that calculates the mean of the analyzer's numpy.ndarray result.
 
-				Returns:
-					mean: Mean value of the analyzer's numpy.ndarray result.
+				Returns
+				-------
+				mean : float
+					Mean value of the analyzer's numpy.ndarray result.
+
 				"""
 				aspectValue = registrant(*arguments, **keywordArguments)
-				return numpy.mean(cast(NDArray[Any], aspectValue))
+				return numpy.mean(cast('NDArray[Any]', aspectValue))
 				# return aspectValue.mean()
 			audioAspects[f"{aspectName} mean"] = {
 				'analyzer': registrationAudioAspectMean,
@@ -83,15 +88,21 @@ def analyzeAudioFile(pathFilename: str | PathLike[Any], listAspectNames: list[st
 	"""
 	Analyzes an audio file for specified aspects and returns the results.
 
-	Parameters:
-		pathFilename: The path to the audio file to be analyzed.
-		listAspectNames: A list of aspect names to analyze in the audio file.
+	Parameters
+	----------
+	pathFilename : str or PathLike
+		The path to the audio file to be analyzed.
+	listAspectNames : list of str
+		A list of aspect names to analyze in the audio file.
+
+	Returns
+	-------
+	listAspectValues : list of (str or float or NDArray)
+		A list of analyzed values in the same order as `listAspectNames`.
 
-	Returns:
-		listAspectValues: A list of analyzed values in the same order as `listAspectNames`.
 	"""
 	pathlib.Path(pathFilename).stat() # raises FileNotFoundError if the file does not exist
-	dictionaryAspectsAnalyzed: dict[str, str | float | NDArray[Any]] = {aspectName: 'not found' for aspectName in listAspectNames}
+	dictionaryAspectsAnalyzed: dict[str, str | float | NDArray[Any]] = dict.fromkeys(listAspectNames, 'not found')
 	"""Despite returning a list, use a dictionary to preserve the order of the listAspectNames.
 	Similarly, 'not found' ensures the returned list length == len(listAspectNames)"""
 
@@ -104,20 +115,20 @@ def analyzeAudioFile(pathFilename: str | PathLike[Any], listAspectNames: list[st
 	tryAgain = True
 	while tryAgain:
 		try:
-			tensorAudio = torch.from_numpy(waveform)  # memory-sharing
+			tensorAudio = torch.from_numpy(waveform)  # pyright: ignore[reportUnknownMemberType] # memory-sharing  # noqa: F841
 			tryAgain = False
-		except RuntimeError as ERRORmessage:
+		except RuntimeError as ERRORmessage:  # noqa: PERF203
 			if 'negative stride' in str(ERRORmessage):
 				waveform = waveform.copy()  # not memory-sharing
 				tryAgain = True
 			else:
-				raise ERRORmessage
+				raise ERRORmessage  # noqa: TRY201
 
 	spectrogram = stft(waveform, sampleRate=sampleRate)
 	spectrogramMagnitude = numpy.absolute(spectrogram)
-	spectrogramPower = spectrogramMagnitude ** 2
+	spectrogramPower = spectrogramMagnitude ** 2  # noqa: F841
 
-	pytorchOnCPU = not torch.cuda.is_available()  # False if GPU available, True if not
+	pytorchOnCPU = not torch.cuda.is_available()  # False if GPU available, True if not  # noqa: F841
 
 	for aspectName in listAspectNames:
 		if aspectName in audioAspects:
@@ -127,18 +138,23 @@ def analyzeAudioFile(pathFilename: str | PathLike[Any], listAspectNames: list[st
 
 	return [dictionaryAspectsAnalyzed[aspectName] for aspectName in listAspectNames]
 
-def analyzeAudioListPathFilenames(listPathFilenames: Sequence[str] | Sequence[PathLike[Any]], listAspectNames: list[str], CPUlimit: int | float | bool | None = None) -> list[list[str | float | NDArray[Any]]]:
+def analyzeAudioListPathFilenames(listPathFilenames: Sequence[str] | Sequence[PathLike[Any]], listAspectNames: list[str], CPUlimit: int | float | bool | None = None) -> list[list[str | float | NDArray[Any]]]:  # noqa: FBT001, PYI041
 	"""
 	Analyzes a list of audio files for specified aspects of the individual files and returns the results.
 
-	Parameters:
-		listPathFilenames: A list of paths to the audio files to be analyzed.
-		listAspectNames: A list of aspect names to analyze in each audio file.
-		CPUlimit (gluttonous resource usage): whether and how to limit the CPU usage. See notes for details.
+	Parameters
+	----------
+	listPathFilenames : Sequence of str or PathLike
+		A list of paths to the audio files to be analyzed.
+	listAspectNames : list of str
+		A list of aspect names to analyze in each audio file.
+	CPUlimit : int, float, bool, or None, default=None
+		Whether and how to limit the CPU usage. See notes for details.
 
-	Returns:
-		rowsListFilenameAspectValues: A list of lists, where each inner list contains the filename and
-		analyzed values corresponding to the specified aspects, which are in the same order as `listAspectNames`.
+	Returns
+	-------
+	rowsListFilenameAspectValues : list of list of (str or float or NDArray)
+		A list of lists, where each inner list contains the filename and analyzed values corresponding to the specified aspects, which are in the same order as `listAspectNames`.
 
 	You can save the data with `Z0Z_tools.dataTabularTOpathFilenameDelimited()`.
 	For example,
@@ -166,7 +182,7 @@ def analyzeAudioListPathFilenames(listPathFilenames: Sequence[str] | Sequence[Pa
 
 	if not (CPUlimit is None or isinstance(CPUlimit, (bool, int, float))):
 		CPUlimit = oopsieKwargsie(CPUlimit)
-	max_workers = defineConcurrencyLimit(CPUlimit)
+	max_workers = defineConcurrencyLimit(limit=CPUlimit)
 
 	with ProcessPoolExecutor(max_workers=max_workers) as concurrencyManager:
 		dictionaryConcurrency = {concurrencyManager.submit(analyzeAudioFile, pathFilename, listAspectNames)
@@ -177,18 +193,20 @@ def analyzeAudioListPathFilenames(listPathFilenames: Sequence[str] | Sequence[Pa
 			cacheAudioAnalyzers.pop(dictionaryConcurrency[claimTicket], None)
 			listAspectValues = claimTicket.result()
 			rowsListFilenameAspectValues.append(
-				[str(pathlib.PurePath(dictionaryConcurrency[claimTicket]).as_posix())]
+				[str(pathlib.PurePath(dictionaryConcurrency[claimTicket]).as_posix())]  # noqa: RUF005
 				+ listAspectValues)
 
 	return rowsListFilenameAspectValues
 
 def getListAvailableAudioAspects() -> list[str]:
 	"""
-	Returns a sorted list of audio aspect names. All valid values for the parameter `listAspectNames`, for example,
-	are returned by this function.
+	Return a sorted list of audio aspect names. All valid values for the parameter `listAspectNames`, for example, are returned by this function.
+
+	Returns
+	-------
+	listAvailableAudioAspects : list of str
+		The list of aspect names registered in `audioAspects`.
 
-	Returns:
-		listAvailableAudioAspects: The list of aspect names registered in `audioAspects`.
 	"""
 	return sorted(audioAspects.keys())
 

analyzeAudio/pythonator.py

@@ -1,4 +1,5 @@
 """Convert FFprobe output to a standardized Python object."""
+# ruff: noqa: D103
 from collections import defaultdict
 from typing import Any, cast, NamedTuple
 import json
@@ -12,11 +13,11 @@ import numpy
 # NOTE You changed the code because a static type checker was mad at you. Ask yourself,
 # "Are you the tool or is the type checker the tool?"
 
-class Blackdetect(NamedTuple):
+class Blackdetect(NamedTuple):  # noqa: D101
 	black_start: float | None = None
 	black_end: float | None = None
 
-def pythonizeFFprobe(FFprobeJSON_utf8: str):
+def pythonizeFFprobe(FFprobeJSON_utf8: str) -> tuple[defaultdict[str, Any] | dict[str, Any], dict[str, numpy.ndarray[Any, Any] | dict[str, numpy.ndarray[Any, Any]]]]:  # noqa: C901, PLR0912, PLR0915
 	FFroot: dict[str, Any] = json.loads(FFprobeJSON_utf8)
 	Z0Z_dictionaries: dict[str, numpy.ndarray[Any, Any] | dict[str, numpy.ndarray[Any, Any]]] = {}
 	if 'packets_and_frames' in FFroot: # Divide into 'packets' and 'frames'
@@ -26,7 +27,8 @@ def pythonizeFFprobe(FFprobeJSON_utf8: str):
 				FFroot[section := packetOrFrame['type'] + 's'].append(packetOrFrame)
 				del FFroot[section][-1]['type']
 			else:
-				raise ValueError("'packets_and_frames' for the win!")
+				msg = "'packets_and_frames' for the win!"
+				raise ValueError(msg)
 		del FFroot['packets_and_frames']
 
 	Z0Z_register = [
@@ -38,16 +40,16 @@ def pythonizeFFprobe(FFprobeJSON_utf8: str):
 	leftCrumbs = False
 	if 'frames' in FFroot:
 		leftCrumbs = False
-		# listTuplesBlackdetect = [] # uncommentToFixBlackdetect
+		# listTuplesBlackdetect = [] # uncommentToFixBlackdetect  # noqa: ERA001
 		listTuplesBlackdetect: list[Blackdetect] = []
 		for indexFrame, FFframe in enumerate(FFroot['frames']):
 			if 'tags' in FFframe:
 				if 'lavfi.black_start' in FFframe['tags']:
-					# listTuplesBlackdetect.append(float(FFframe['tags']['lavfi.black_start'])) # uncommentToFixBlackdetect
+					# listTuplesBlackdetect.append(float(FFframe['tags']['lavfi.black_start'])) # uncommentToFixBlackdetect  # noqa: ERA001
 					listTuplesBlackdetect.append(Blackdetect(black_start=float(FFframe['tags']['lavfi.black_start'])))
 					del FFframe['tags']['lavfi.black_start']
 				if 'lavfi.black_end' in FFframe['tags']:
-					# listTuplesBlackdetect[-1] = (listTuplesBlackdetect[-1], float(FFframe['tags']['lavfi.black_end'])) # uncommentToFixBlackdetect
+					# listTuplesBlackdetect[-1] = (listTuplesBlackdetect[-1], float(FFframe['tags']['lavfi.black_end'])) # uncommentToFixBlackdetect  # noqa: ERA001
 					tupleBlackdetectLast = listTuplesBlackdetect.pop() if listTuplesBlackdetect else Blackdetect()
 					match tupleBlackdetectLast.black_end:
 						case None:
@@ -89,15 +91,15 @@ def pythonizeFFprobe(FFprobeJSON_utf8: str):
 										if registrant not in Z0Z_dictionaries:
 											Z0Z_dictionaries[registrant] = {}
 										elif statistic not in Z0Z_dictionaries[registrant]:
-												# NOTE (as of this writing) `registrar` can only understand the generic class `numpy.ndarray` and not more specific typing
-												valueSherpa = cast(numpy.ndarray, numpy.zeros((channel, len(FFroot['frames'])))) # type: ignore
+												# NOTE (as of this writing) `registrar` can only understand the generic class `numpy.ndarray` and not more specific typing  # noqa: ERA001
+												valueSherpa = cast('numpy.ndarray', numpy.zeros((channel, len(FFroot['frames']))))  # pyright: ignore[reportMissingTypeArgument, reportUnknownVariableType]
 												Z0Z_dictionaries[registrant][statistic] = valueSherpa
 										else:
 											raise  # Re-raise the exception
 									except IndexError:
 										if channel > Z0Z_dictionaries[registrant][statistic].shape[0]:
 											Z0Z_dictionaries[registrant][statistic] = numpy.resize(Z0Z_dictionaries[registrant][statistic], (channel, len(FFroot['frames'])))
-											# Z0Z_dictionaries[registrant][statistic].resize((channel, len(FFroot['frames'])))
+											# Z0Z_dictionaries[registrant][statistic].resize((channel, len(FFroot['frames'])))  # noqa: ERA001
 										else:
 											raise  # Re-raise the exception
 
@@ -106,7 +108,7 @@ def pythonizeFFprobe(FFprobeJSON_utf8: str):
 			if FFframe:
 				leftCrumbs = True
 		if listTuplesBlackdetect:
-			# 2025-03-06: I am _shocked_ that I was able to create a numpy structured array whenever it was that I originally wrote this code.
+			# 2025-03-06 I am _shocked_ that I was able to create a numpy structured array whenever it was when I originally wrote this code.
 			arrayBlackdetect = numpy.array(
 				[(
 					-1.0 if detect.black_start is None else detect.black_start,
@@ -116,7 +118,7 @@ def pythonizeFFprobe(FFprobeJSON_utf8: str):
 				copy=False
 			)
 			Z0Z_dictionaries['blackdetect'] = arrayBlackdetect
-			# Z0Z_dictionaries['blackdetect'] = numpy.array(listTuplesBlackdetect, dtype=[('black_start', numpy.float32), ('black_end', numpy.float32)], copy=False) # uncommentToFixBlackdetect
+			# Z0Z_dictionaries['blackdetect'] = numpy.array(listTuplesBlackdetect, dtype=[('black_start', numpy.float32), ('black_end', numpy.float32)], copy=False) # uncommentToFixBlackdetect  # noqa: ERA001
 	if not leftCrumbs:
 		del FFroot['frames']
 	return FFroot, Z0Z_dictionaries

{analyzeaudio-0.0.16.dist-info → analyzeaudio-0.0.17.dist-info}/METADATA

@@ -1,20 +1,21 @@
 Metadata-Version: 2.4
 Name: analyzeAudio
-Version: 0.0.16
+Version: 0.0.17
 Summary: Measure one or more aspects of one or more audio files.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 License: CC-BY-NC-4.0
 Project-URL: Donate, https://www.patreon.com/integrated
 Project-URL: Homepage, https://github.com/hunterhogan/analyzeAudio
+Project-URL: Issues, https://github.com/hunterhogan/
 Project-URL: Repository, https://github.com/hunterhogan/analyzeAudio.git
-Keywords: audio,analysis,measurement,metrics,torch,spectrum,spectral,waveform,loudness,LUFS,RMS,FFmpeg,FFprobe,SRMR,audio-analysis,signal-processing
+Keywords: FFmpeg,FFprobe,LUFS,RMS,SRMR,analysis,audio,audio-analysis,loudness,measurement,metrics,signal-processing,spectral,spectrum,torch,waveform
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
@@ -32,7 +33,9 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: Z0Z_tools
 Requires-Dist: cachetools
+Requires-Dist: hunterMakesPy
 Requires-Dist: librosa
 Requires-Dist: numpy
 Requires-Dist: standard-aifc; python_version >= "3.13"
@@ -40,7 +43,7 @@ Requires-Dist: standard-sunau; python_version >= "3.13"
 Requires-Dist: torch
 Requires-Dist: torchmetrics[audio]
 Requires-Dist: tqdm
-Requires-Dist: Z0Z_tools
+Requires-Dist: typing_extensions
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"

analyzeaudio-0.0.17.dist-info/RECORD

@@ -0,0 +1,17 @@
+analyzeAudio/__init__.py,sha256=2D5JMeZfLGnwyQvt4Q2-HCsShHulcNXBM_Wu9vZPCiI,437
+analyzeAudio/analyzersUseFilename.py,sha256=NShXm8XMHI1QsgitgrLq0hHjyWKzaOdxvRKlBc2XZec,10894
+analyzeAudio/analyzersUseSpectrogram.py,sha256=k1mNzpzXykBIhE3NeizvSwVdfuKQtE_eIpHAR-Bya-I,2640
+analyzeAudio/analyzersUseTensor.py,sha256=Uqf8haZDCQYjHFb_7Ybpm40_QNlKYyh-N1QifiLOeb4,779
+analyzeAudio/analyzersUseWaveform.py,sha256=wfTkASR_2Uj3KpMI8UYQXWuKG4CqDIbhe9B6UgPrpyU,2282
+analyzeAudio/audioAspectsRegistry.py,sha256=hvAAqS4FvJuNnLqBL0Hd813iF87HQ-TfZUdyWLqSA_A,8642
+analyzeAudio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+analyzeAudio/pythonator.py,sha256=fy8uduDQexYJMUQX0uNZHwPEX5sDH_3600W9hvPjZuo,6036
+analyzeaudio-0.0.17.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
+tests/conftest.py,sha256=BhZswOjkl_u-qiS4Zy38d2fETdWAtZiigeuXYBK8l0k,397
+tests/test_audioAspectsRegistry.py,sha256=-TWTLMdAn6IFv7ZdFWrBm1KxpLBa3Mz1sCygAwxV6gE,27
+tests/test_other.py,sha256=ozabc_DFX5mAeSw3r01hQ8OEMNvbYdToKivSHoDxmG0,535
+analyzeaudio-0.0.17.dist-info/METADATA,sha256=DAMobI3GMlYhlHefL2IpN1gu1CNVnx9TT_8xKNwT_Q0,9293
+analyzeaudio-0.0.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+analyzeaudio-0.0.17.dist-info/entry_points.txt,sha256=FHgSx7fndtZ6SnQ-nWVXf0NB59exaHQ2DtatTK9KrLg,100
+analyzeaudio-0.0.17.dist-info/top_level.txt,sha256=QV8LQ0r_1LIQuewxDcEzODpykv5qRYG3I70piOUSVRg,19
+analyzeaudio-0.0.17.dist-info/RECORD,,

{analyzeaudio-0.0.16.dist-info → analyzeaudio-0.0.17.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tests/test_other.py

@@ -1,10 +1,11 @@
+from collections.abc import Callable
+from hunterMakesPy.pytestForYourUse import PytestFor_defineConcurrencyLimit, PytestFor_oopsieKwargsie
 import pytest
-from Z0Z_tools.pytestForYourUse import PytestFor_defineConcurrencyLimit, PytestFor_oopsieKwargsie
 
 @pytest.mark.parametrize("nameOfTest,callablePytest", PytestFor_defineConcurrencyLimit())
-def testConcurrencyLimit(nameOfTest, callablePytest):
+def testConcurrencyLimit(nameOfTest: str, callablePytest: Callable[[], None]) -> None:
 	callablePytest()
 
 @pytest.mark.parametrize("nameOfTest,callablePytest", PytestFor_oopsieKwargsie())
-def testOopsieKwargsie(nameOfTest, callablePytest):
+def testOopsieKwargsie(nameOfTest: str, callablePytest: Callable[[], None]) -> None:
 	callablePytest()

analyzeaudio-0.0.16.dist-info/RECORD

@@ -1,17 +0,0 @@
-analyzeAudio/__init__.py,sha256=2D5JMeZfLGnwyQvt4Q2-HCsShHulcNXBM_Wu9vZPCiI,437
-analyzeAudio/analyzersUseFilename.py,sha256=AOA_Ab6-QU4q4i7AOy9Z68yPiGBi-Zjpo4zYmqvOwuM,11021
-analyzeAudio/analyzersUseSpectrogram.py,sha256=RjKW9it_9EDgKwkx9sB99z7qbLrVq5xM7ALTcwo4xE8,2346
-analyzeAudio/analyzersUseTensor.py,sha256=oRxKw42Q4bdBhuSlwdyVo2MNgI0AbnjEjpnRLQVaqco,701
-analyzeAudio/analyzersUseWaveform.py,sha256=2nGhwdpDpamAAgeZ4XAbtX1aGAn5R-VIwHO1qnyxz0U,2042
-analyzeAudio/audioAspectsRegistry.py,sha256=NoRUflTxls4palGtc7iQsfMLc9nMGITCVRPhDehNFJ4,8564
-analyzeAudio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-analyzeAudio/pythonator.py,sha256=hL2KzeO7cgboSCL9uOl1uyuWMrnR0xhDt9o78GkM2_0,5680
-analyzeaudio-0.0.16.dist-info/licenses/LICENSE,sha256=NxH5Y8BdC-gNU-WSMwim3uMbID2iNDXJz7fHtuTdXhk,19346
-tests/conftest.py,sha256=BhZswOjkl_u-qiS4Zy38d2fETdWAtZiigeuXYBK8l0k,397
-tests/test_audioAspectsRegistry.py,sha256=-TWTLMdAn6IFv7ZdFWrBm1KxpLBa3Mz1sCygAwxV6gE,27
-tests/test_other.py,sha256=sd20ms4StQ13_3-gmwZwtAuoIAwfxWC5IXM_Cp5GQXM,428
-analyzeaudio-0.0.16.dist-info/METADATA,sha256=Nn-a1bKLTdVvwmayCHEA8SdelzcSDhmbCJyMrdIv5XU,9178
-analyzeaudio-0.0.16.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-analyzeaudio-0.0.16.dist-info/entry_points.txt,sha256=FHgSx7fndtZ6SnQ-nWVXf0NB59exaHQ2DtatTK9KrLg,100
-analyzeaudio-0.0.16.dist-info/top_level.txt,sha256=QV8LQ0r_1LIQuewxDcEzODpykv5qRYG3I70piOUSVRg,19
-analyzeaudio-0.0.16.dist-info/RECORD,,