hunterHearsPy 1.3.0__tar.gz → 1.4.1__tar.gz

{hunterhearspy-1.3.0/src/hunterHearsPy.egg-info → hunterhearspy-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterHearsPy
-Version: 1.3.0
+Version: 1.4.1
 Summary: Audio processing.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 Maintainer-email: Hunter Hogan <HunterHogan@pm.me>
@@ -17,23 +17,27 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Z0Z_tools>=2.1.0
-Requires-Dist: hunterMakesPy>=0.7.0
+Requires-Dist: Z0Z_tools>=4.0.0
+Requires-Dist: hunterMakesPy>=0.10.0
 Requires-Dist: numpy
 Requires-Dist: resampy
 Requires-Dist: scipy
 Requires-Dist: soundfile>=0.14.0
 Requires-Dist: tqdm
 Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: development
+Requires-Dist: astToolkit; extra == "development"
+Requires-Dist: pytest-cov; extra == "development"
+Requires-Dist: scipy-stubs; extra == "development"
+Requires-Dist: types-resampy; extra == "development"
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-mock; extra == "testing"
@@ -131,13 +135,7 @@ I don't know a good way to implement user-configurable universal settings. There
 - time is more generic than samples and often preferred.
 - array is generic.
 - when talking about a NumPy `ndarray`, write `ndarray` not array.
-- `sampleRate` is giving me problems in the "ingest" functions.
-  - Regularly review these semiotics until the system is clear.
-  - Most of the time, `sampleRate` is descriptive: this is the sample rate. See `writeWAV`.
-  - In `readAudioFile`, the parameter is prescriptive: make this the sample rate. Even worse, the
-    attribute of the current sample rate is `readSoundFile.samplerate`, which is descriptive, of course.
-  - However, `def resampleWaveform(waveform, sampleRateDesired: float, sampleRateSource: float):` has
-    excellent semiotics because it does not use `sampleRate`.
+- Use `sampleRate` unless I have a compelling reason not to.
 
 ### Preferred packages
 
@@ -190,6 +188,11 @@ pip install hunterHearsPy
 ## My recovery
 
 [![Static Badge](https://img.shields.io/badge/2011_August-Homeless_since-blue?style=flat)](https://HunterThinks.com/support)
-[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC3Gx7kz61009NbhpRtPP7tw)](https://www.youtube.com/@HunterHogan)
 
 [![CC-BY-NC-4.0](https://raw.githubusercontent.com/hunterhogan/hunterHearsPy/refs/heads/main/.github/CC-BY-NC-4.0.png)](https://creativecommons.org/licenses/by-nc/4.0/)
+
+By law, authors retain their copyrights unless they grant exceptions. The [Attribution-NonCommercial 4.0 International Deed](https://github.com/hunterhogan/hunterHearsPy#License-1-ov-file) outlines how you may use this work.
+
+The restriction on commercial use (without a license) limits advantage-taking, unjust enrichment, and exploitation. You would be morally wrong if you were to enrich yourself by using this work while I am denied healthcare, housing, security of property, and the safety of my person.
+
+To obtain and retain the right to use this work, you incur the cost of attributing the work to me. Your nominal cost might accrue as a benefit that mitigates my suffering or saves my life.

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1}/README.md

@@ -86,13 +86,7 @@ I don't know a good way to implement user-configurable universal settings. There
 - time is more generic than samples and often preferred.
 - array is generic.
 - when talking about a NumPy `ndarray`, write `ndarray` not array.
-- `sampleRate` is giving me problems in the "ingest" functions.
-  - Regularly review these semiotics until the system is clear.
-  - Most of the time, `sampleRate` is descriptive: this is the sample rate. See `writeWAV`.
-  - In `readAudioFile`, the parameter is prescriptive: make this the sample rate. Even worse, the
-    attribute of the current sample rate is `readSoundFile.samplerate`, which is descriptive, of course.
-  - However, `def resampleWaveform(waveform, sampleRateDesired: float, sampleRateSource: float):` has
-    excellent semiotics because it does not use `sampleRate`.
+- Use `sampleRate` unless I have a compelling reason not to.
 
 ### Preferred packages
 
@@ -145,6 +139,11 @@ pip install hunterHearsPy
 ## My recovery
 
 [![Static Badge](https://img.shields.io/badge/2011_August-Homeless_since-blue?style=flat)](https://HunterThinks.com/support)
-[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC3Gx7kz61009NbhpRtPP7tw)](https://www.youtube.com/@HunterHogan)
 
 [![CC-BY-NC-4.0](https://raw.githubusercontent.com/hunterhogan/hunterHearsPy/refs/heads/main/.github/CC-BY-NC-4.0.png)](https://creativecommons.org/licenses/by-nc/4.0/)
+
+By law, authors retain their copyrights unless they grant exceptions. The [Attribution-NonCommercial 4.0 International Deed](https://github.com/hunterhogan/hunterHearsPy#License-1-ov-file) outlines how you may use this work.
+
+The restriction on commercial use (without a license) limits advantage-taking, unjust enrichment, and exploitation. You would be morally wrong if you were to enrich yourself by using this work while I am denied healthcare, housing, security of property, and the safety of my person.
+
+To obtain and retain the right to use this work, you incur the cost of attributing the work to me. Your nominal cost might accrue as a benefit that mitigates my suffering or saves my life.

hunterhearspy-1.4.1/astTransformations/__init__.py

@@ -0,0 +1 @@
+# ruff:ignore[undocumented-public-package]

hunterhearspy-1.4.1/astTransformations/windowingFunctions.py

@@ -0,0 +1,109 @@
+"""Generate PyTorch tensor windowing functions from NumPy windowing functions.
+
+This module programmatically creates PyTorch tensor versions of windowing functions by transforming
+existing functions from the `windowingFunctions` module. It generates functions that return PyTorch
+tensors instead of NumPy arrays.
+"""
+from __future__ import annotations
+
+from astToolkit import Be, Make, NodeTourist, Then
+from astToolkit.changeDef import makeDictionaryFunctionDef
+from astToolkit.filesystem import parseLogicalPath2astModule, write_astModule
+from hunterHearsPy.theSSOT import settingsPackage
+from hunterMakesPy import raiseIfNone
+from typing import TYPE_CHECKING
+import ast
+
+if TYPE_CHECKING:
+	from pathlib import Path
+
+moduleDestination = 'windowingFunctionsTensor'
+moduleSource = 'windowingFunctions'
+
+pathFilenameDestination: Path = settingsPackage.pathPackage / (moduleDestination + settingsPackage.fileExtension)
+pathFilenameSource: Path = pathFilenameDestination.with_stem(moduleSource)
+
+def make_windowingFunctionsTensor() -> None:
+	"""Generate PyTorch tensor windowing functions from NumPy windowing functions."""
+	listImports: list[ast.stmt] = [Make.ImportFrom('__future__', [Make.alias('annotations')])
+		, Make.ImportFrom('typing', [Make.alias('TYPE_CHECKING')])]
+	listBody: list[ast.stmt] = []
+
+	listBody.append(Make.If(test=Make.Name('TYPE_CHECKING')  # ruff: ignore[repeated-append]
+									, body=[Make.ImportFrom('torch.types', [Make.alias('Device')])
+											, Make.ImportFrom('typing', [Make.alias('Any')])
+											, Make.ImportFrom(settingsPackage.identifierPackage + '.theTypes', [Make.alias('callableReturnsNDArray')])
+										]))
+	listBody.append(Make.FunctionDef(
+		'_convertToTensor'
+		, Make.arguments(vararg=Make.arg('arguments', annotation=Make.Name('Any'))
+			, kwonlyargs=[Make.arg('callableTarget', annotation=Make.Name('callableReturnsNDArray'))
+					, Make.arg('device', annotation=Make.BitOr.join([Make.Name('Device'), Make.Constant(None)]))
+					, Make.arg('dtype', annotation=Make.BitOr.join([Make.Attribute(Make.Name('torch'), 'dtype'), Make.Constant(None)]))]
+			, kw_defaults=[None, Make.Constant(None), Make.Constant(None)]
+			, kwarg=Make.arg('keywordArguments', annotation=Make.Name('Any'))
+		)
+		, body=[Make.Assign([Make.Name('arrayTarget', ast.Store())]
+					, value=Make.Call(Make.Name('callableTarget')
+						, listParameters=[Make.Starred(value=Make.Name('arguments'))]
+						, list_keyword=[Make.keyword(None, value=Make.Name('keywordArguments'))])
+				)
+			, Make.If(test=Make.Compare(left=Make.Name('device'), ops=[Make.Is()], comparators=[Make.Constant(None)])
+				, body=[Make.Assign([Make.Name('device', ast.Store())], value=Make.Call(Make.Attribute(Make.Name('torch'), 'device'), list_keyword=[Make.keyword('device', value=Make.Constant('cpu'))]))]
+			)
+			, Make.Return(Make.Call(Make.Attribute(Make.Name('torch'), 'tensor'), list_keyword=[
+						Make.keyword('data', value=Make.Name('arrayTarget'))
+						, Make.keyword('dtype', value=Make.Or.join([Make.Name('dtype'), Make.Attribute(Make.Name('torch'), 'float32')]))
+						, Make.keyword('device', value=Make.Name('device'))
+					]))
+		]
+		, returns=Make.Attribute(Make.Name('torch'), 'Tensor')
+	))
+
+	dictionaryFunctionDef: dict[str, ast.FunctionDef] = makeDictionaryFunctionDef(parseLogicalPath2astModule('.'.join([settingsPackage.identifierPackage, moduleSource])))
+
+	ImaIndent: str = ' ' * 4
+	ImaReturnsSection: str = f"\n{ImaIndent}Returns"
+	docstringDevice: str = f"{ImaIndent}device : Device = torch.device(device='cpu')\n{ImaIndent}{ImaIndent}PyTorch device for `Tensor`.\n"
+	docstringDtype: str = f"{ImaIndent}dtype : torch.dtype = torch.float32\n{ImaIndent}{ImaIndent}PyTorch data type for `Tensor`.\n"
+
+	for callableIdentifier, astFunctionDef in dictionaryFunctionDef.items():
+		if callableIdentifier.startswith('_'):
+			continue
+
+		docstring: ast.Expr = Make.Expr(Make.Constant(
+			raiseIfNone(ast.get_docstring(astFunctionDef, clean=False), errorMessage="Where's the windowing function docstring?")
+							.replace('\t', ImaIndent).replace(ImaReturnsSection, docstringDevice + docstringDtype + ImaReturnsSection)))
+
+		listImports.append(Make.ImportFrom(settingsPackage.identifierPackage, [Make.alias(callableIdentifier)]))
+
+		argumentSpecification: ast.arguments = raiseIfNone(NodeTourist(Be.arguments, Then.extractIt).captureLastMatch(astFunctionDef))
+		args: list[ast.expr] = [Make.Name(ast_arg.arg) for ast_arg in [*argumentSpecification.args, *argumentSpecification.kwonlyargs]]
+
+		list_keyword: list[ast.keyword] = [Make.keyword('callableTarget', Make.Name(callableIdentifier))
+										, Make.keyword('device', Make.Name('device'))
+										, Make.keyword('dtype', Make.Name('dtype'))]
+		if argumentSpecification.kwarg:
+			list_keyword.append(Make.keyword(None, value=Make.Name(argumentSpecification.kwarg.arg)))
+
+		argumentSpecification.args.append(Make.arg('device', annotation=Make.BitOr.join([Make.Name('Device'), Make.Constant(None)])))
+		argumentSpecification.defaults.append(Make.Constant(None))
+		argumentSpecification.args.append(Make.arg('dtype', annotation=Make.BitOr.join([Make.Attribute(Make.Name('torch'), 'dtype'), Make.Constant(None)])))
+		argumentSpecification.defaults.append(Make.Constant(None))
+
+		listBody.append(Make.FunctionDef(callableIdentifier + 'Tensor'
+			, argumentSpecification
+			, body=[docstring
+				, Make.Return(Make.Call(Make.Name('_convertToTensor'), listParameters=args, list_keyword=list_keyword))]
+			, returns=Make.Attribute(Make.Name('torch'), 'Tensor')
+		))
+
+	listImports.append(Make.Import('torch'))
+
+	docstringModule = Make.Expr(Make.Constant("""Create PyTorch tensor windowing functions."""))
+	astModule = Make.Module(body=[docstringModule, *listImports, *listBody])
+
+	write_astModule(astModule, pathFilenameDestination, identifierPackage=settingsPackage.identifierPackage)
+
+if __name__ == '__main__':
+	make_windowingFunctionsTensor()

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/__init__.py

@@ -1,4 +1,5 @@
-# ruff: noqa: D104
+# ruff:file-ignore[undocumented-public-package]
+# TODO design and implement a namespace.
 from __future__ import annotations
 
 from hunterHearsPy import theTypes as theTypes
@@ -9,7 +10,7 @@ from hunterHearsPy.windowingFunctions import cosineWings as cosineWings, equalPo
 # isort: split
 from contextlib import suppress
 
-with suppress(ModuleNotFoundError):  # noqa: RUF067
+with suppress(ModuleNotFoundError):  # ruff:ignore[non-empty-init-module]
 	from hunterHearsPy.windowingFunctionsTensor import (
 		cosineWingsTensor as cosineWingsTensor, equalPowerTensor as equalPowerTensor, halfsineTensor as halfsineTensor,
 		tukeyTensor as tukeyTensor)
@@ -35,7 +36,8 @@ from hunterHearsPy.autoRevert import moveToAxisOfOperation as moveToAxisOfOperat
 from hunterHearsPy._fft import stft as stft, waveformSpectrogramWaveform as waveformSpectrogramWaveform
 
 # isort: split
-from hunterHearsPy._io import readAudioFile as readAudioFile, spectrogramToWAV as spectrogramToWAV, writeWAV as writeWAV
+from hunterHearsPy._io import (
+	getSampleRate as getSampleRate, readAudioFile as readAudioFile, spectrogramToWAV as spectrogramToWAV, writeWAV as writeWAV)
 
 # isort: split
 from hunterHearsPy.clippingArrays import applyHardLimit as applyHardLimit, applyHardLimitComplexValued as applyHardLimitComplexValued

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/_arrays.py

@@ -1,4 +1,3 @@
-# ruff: noqa: DOC201
 from __future__ import annotations
 
 from concurrent.futures import ThreadPoolExecutor
@@ -54,6 +53,7 @@ def getWaveformMetadata(
 		sys.stderr.write(message + '\n')
 
 	for index, pathFilename in enumerate(tqdm(listPathFilenames, desc='Preparing combined array', leave=False)):
+		# NOTE Use readAudioFile with the prescribed sampleRate to get the exact length.
 		channels, lengthWaveform = readAudioFile(pathFilename, sampleRate).shape
 		dictionaryWaveformMetadata[index] = WaveformMetadata(
 			channels=channels, lengthWaveform=lengthWaveform, pathFilename=pathFilename, samplesStart=0, samplesStop=0
@@ -71,7 +71,7 @@ def getWaveformMetadata(
 
 	for metadata in dictionaryWaveformMetadata.values():
 		samplesPadding: int = axis['time'].size - metadata['lengthWaveform']
-		# TODO document that if `samplesPadding` is odd, the extra pad-sample is added to samplesStop.
+		# DOCUMENT that if `samplesPadding` is odd, the extra pad-sample is added to samplesStop.
 		metadata['samplesStart'] = int(samplesPadding * multiplicandSamplesStart)
 		metadata['samplesStop'] = metadata['samplesStart'] + metadata['lengthWaveform']
 

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/_fft.py

@@ -71,7 +71,7 @@ def stft(
 		if arrayTarget.ndim == 2:
 			arrayFloating: WaveformFloating = amplitudeIntegerToFloating(arrayTarget)
 	elif numpy.issubdtype(arrayTarget.dtype, complexfloating) and (lengthWaveform < 1):
-		from hunterHearsPy._io import saveOnError  # noqa: PLC0415
+		from hunterHearsPy._io import saveOnError  # ruff:ignore[import-outside-top-level]
 
 		pathFilename: PurePath = saveOnError(arrayTarget)
 		message: str = (

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/_io.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
 from hunterHearsPy import amplitudeToSoundfile, getAxis, resampleWaveform, setting, stft
-from hunterMakesPy.filesystemToolkit import makeDirectorySafely
+from hunterMakesPy.kitFilesystem import makeDirectorySafely
 from pathlib import Path, PurePath
 from soundfile import AudioData
 from typing import TYPE_CHECKING
-from typing_extensions import Unpack
 import numpy
 import soundfile
 import tempfile
@@ -16,20 +15,23 @@ if TYPE_CHECKING:
 	from hunterHearsPy.theTypes import FileDescriptorOrPath, Parameters_stft, Spectrogram, Waveform
 	from numpy import dtype, ndarray
 	from soundfile import AudioData_2d, dtype_str as Options_dtype_str
-	from typing import Any
+	from typing import Any, Unpack
 
-def readAudioFile(pathFilename: FileDescriptorOrPath, sampleRateDesired: float | None = None, dtype_str: Options_dtype_str | None = None) -> Waveform:
+def getSampleRate(pathFilename: FileDescriptorOrPath) -> int:
+	return soundfile.info(pathFilename).samplerate
+
+def readAudioFile(pathFilename: FileDescriptorOrPath, sampleRate: float | None = None, dtype_str: Options_dtype_str | None = None) -> Waveform:
 	"""Read an audio file and return waveform data as a NumPy array.
 
 	You can use this function to load any audio file that `soundfile` [1] supports. The returned
-	`Waveform` [2] is always shaped `(channels, samples)`. When `sampleRateDesired` differs from the file's
+	`Waveform` [2] is always shaped `(channels, samples)`. When `sampleRate` differs from the file's
 	native sample rate, `readAudioFile` resamples using `resampleWaveform`.
 
 	Parameters
 	----------
 	pathFilename : FileDescriptorOrPath
 		Path to the audio file or a binary stream.
-	sampleRateDesired : float | None = 44100
+	sampleRate : float | None = 44100
 		Target sample rate of the returned `Waveform` [2] in Hz. Defaults to `setting.sampleRate`,
 		which is probably 44100, when `None`.
 	dtype_str : Literal["float64", "float32", "int32", "int16"] | None = 'float32'
@@ -40,14 +42,50 @@ def readAudioFile(pathFilename: FileDescriptorOrPath, sampleRateDesired: float |
 	waveform : Waveform
 		Audio data shaped `(channels, samples)` as `setting.dtypeWaveform`.
 	"""
-	sampleRateDesired = sampleRateDesired or setting.sampleRate
+	sampleRateDesired: float = sampleRate or setting.sampleRate
 	with soundfile.SoundFile(pathFilename) as readSoundFile:
 		sampleRateSource: int = readSoundFile.samplerate
-		audioData: AudioData_2d = readSoundFile.read(dtype=dtype_str or setting.dtype_str, always_2d=True)  # ty:ignore[invalid-assignment] https://github.com/astral-sh/ty/issues/2799
+		audioData: AudioData_2d = readSoundFile.read(dtype=dtype_str or setting.dtype_str, always_2d=True)
 	axis: dict[str, AxisMetadata] = getAxis()
 	waveform: Waveform = audioData.transpose((axis['time'].number, axis['channel'].number))
 
-	return resampleWaveform(waveform, sampleRateDesired, sampleRateSource, axis['time'].number)  # ty:ignore[no-matching-overload] https://github.com/astral-sh/ty/issues/2799
+	return resampleWaveform(waveform, sampleRateDesired, sampleRateSource, axis['time'].number)
+
+def saveOnError(arrayTarget: ndarray[tuple[Any, ...], dtype[Any]], *, identifierTarget: str = 'arrayTarget') -> PurePath:
+	pathFilename: Path = Path(tempfile.mkdtemp(prefix='hunterHearsPy'), f"{identifierTarget}_{uuid.uuid4().hex}.npy").resolve()
+	numpy.save(pathFilename, arrayTarget)
+
+	return PurePath(pathFilename)
+
+def spectrogramToWAV(spectrogram: Spectrogram, pathFilename: FileDescriptorOrPath, lengthWaveform: int, **parametersSTFT: Unpack[Parameters_stft]) -> None:
+	"""Write a complex spectrogram to a WAV file by computing the inverse STFT.
+
+	You can use this function to reconstruct a waveform from a `Spectrogram` [1] and save
+	it directly to a WAV file. `spectrogramToWAV` calls `stft` with `inverse=True` to
+	obtain the reconstructed `Waveform` [2], then passes it to `writeWAV`.
+
+	Parameters
+	----------
+	spectrogram : Spectrogram
+		Complex spectrogram to convert back to a waveform.
+	pathFilename : FileDescriptorOrPath
+		Destination path for the WAV file, or a binary stream.
+	lengthWaveform : int
+		Number of samples in the output waveform. The inverse STFT cannot recover the
+		original length from the spectrogram alone, so `lengthWaveform` is required.
+	sampleRate : float | None = None
+		Sample rate for the output WAV file in Hz. Defaults to `44100` when `None`.
+	**parametersSTFT : Any
+		Keyword parameters forwarded to `stft`, such as `lengthWindowingFunction` and
+		`lengthHop`.
+
+	File Overwrite and Format
+	-------------------------
+	See `writeWAV` for file overwrite behavior and output format details.
+	"""
+	waveform: Waveform = stft(spectrogram, lengthWaveform=lengthWaveform, **parametersSTFT)
+	sampleRate: float = parametersSTFT.get('sampleRate', setting.sampleRate)
+	writeWAV(pathFilename, waveform, sampleRate)
 
 def writeWAV(pathFilename: FileDescriptorOrPath, waveform: Waveform, sampleRate: float | None = None, subtype: str | None = None) -> FileDescriptorOrPath:
 	"""Write a waveform array to a WAV file.
@@ -95,46 +133,3 @@ def writeWAV(pathFilename: FileDescriptorOrPath, waveform: Waveform, sampleRate:
 
 	soundfile.write(file=pathFilename, data=audioData, samplerate=sampleRate, subtype=subtype, format='WAV')
 	return pathFilename
-
-def spectrogramToWAV(spectrogram: Spectrogram, pathFilename: FileDescriptorOrPath, lengthWaveform: int, **parametersSTFT: Unpack[Parameters_stft]) -> None:
-	"""Write a complex spectrogram to a WAV file by computing the inverse STFT.
-
-	You can use this function to reconstruct a waveform from a `Spectrogram` [1] and save
-	it directly to a WAV file. `spectrogramToWAV` calls `stft` with `inverse=True` to
-	obtain the reconstructed `Waveform` [2], then passes it to `writeWAV`.
-
-	Parameters
-	----------
-	spectrogram : Spectrogram
-		Complex spectrogram to convert back to a waveform.
-	pathFilename : FileDescriptorOrPath
-		Destination path for the WAV file, or a binary stream.
-	lengthWaveform : int
-		Number of samples in the output waveform. The inverse STFT cannot recover the
-		original length from the spectrogram alone, so `lengthWaveform` is required.
-	sampleRate : float | None = None
-		Sample rate for the output WAV file in Hz. Defaults to `44100` when `None`.
-	**parametersSTFT : Any
-		Keyword parameters forwarded to `stft`, such as `lengthWindowingFunction` and
-		`lengthHop`.
-
-	File Overwrite and Format
-	-------------------------
-	See `writeWAV` for file overwrite behavior and output format details.
-
-	References
-	----------
-	[1] `Spectrogram`
-
-	[2] `Waveform`
-
-	"""
-	waveform: Waveform = stft(spectrogram, lengthWaveform=lengthWaveform, **parametersSTFT)
-	sampleRate: float = parametersSTFT.get('sampleRate', setting.sampleRate)
-	writeWAV(pathFilename, waveform, sampleRate)
-
-def saveOnError(arrayTarget: ndarray[tuple[Any, ...], dtype[Any]], *, identifierTarget: str = 'arrayTarget') -> PurePath:
-	pathFilename: Path = Path(tempfile.mkdtemp(prefix='hunterHearsPy'), f"{identifierTarget}_{uuid.uuid4().hex}.npy").resolve()
-	numpy.save(pathFilename, arrayTarget)
-
-	return PurePath(pathFilename)

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/amplitude.py

@@ -38,7 +38,7 @@ if TYPE_CHECKING:
 bits: Final[int] = 8
 
 def amplitudeIntegerToFloating(arrayTarget: ndarray[形Shape, dtype[integer[Any]]]) -> ndarray[形Shape, dtype[floating[Any]]]:
-	"""The original purpose of this function was to convert integer PCM waveforms passed to `stft`."""  # noqa: DOC201
+	"""The original purpose of this function was to convert integer PCM waveforms passed to `stft`."""
 	amplitudeMaximum: int = 2 ** ((arrayTarget.dtype.itemsize * bits) - 1)  # This works for signed (2s complement) and unsigned because the MSD is the sign, right?
 	# TODO Why is this fixed at float32? Can/ought I to derive it or get it from `setting` or something?
 	Z0Z_floatWidth = float32
@@ -96,12 +96,12 @@ def amplitudeToSoundfile(arrayTarget: ndarray[形Shape, dtype[Any]]) -> AudioDat
 
 	elif numpy.issubdtype(arrayTarget.dtype, numpy.floating):
 		dtypeSoundfileFloating: frozenset[dtype[floating[Any]]] = frozenset(filter(lambda _dtype: numpy.issubdtype(_dtype, floating), dtypeSoundfile))
-		dtypeNewFloating: dtype[floating[Any]] = min(min(arrayTarget.dtype, *dtypeSoundfileFloating), max(dtypeSoundfileFloating))  # noqa: PLW3301
+		dtypeNewFloating: dtype[floating[Any]] = min(min(arrayTarget.dtype, *dtypeSoundfileFloating), max(dtypeSoundfileFloating))  # ruff:ignore[nested-min-max]
 		arraySoundfile = numpy.astype(arrayTarget, dtypeNewFloating, copy=False)
 
 	elif numpy.issubdtype(arrayTarget.dtype, numpy.integer):
 		dtypesInteger: frozenset[dtype[integer[Any]]] = frozenset(filter(lambda _dtype: numpy.issubdtype(_dtype, integer), dtypeSoundfile))
-		dtypeNewInteger: dtype[integer[Any]] = min(min(arrayTarget.dtype, *dtypesInteger), max(dtypesInteger))  # noqa: PLW3301
+		dtypeNewInteger: dtype[integer[Any]] = min(min(arrayTarget.dtype, *dtypesInteger), max(dtypesInteger))  # ruff:ignore[nested-min-max]
 
 		amplitudeMaximumTarget: int = 2 ** ((arrayTarget.dtype.itemsize * bits) - 1)
 		amplitudeMaximumNew: int = 2 ** ((dtypeNewInteger.itemsize * bits) - 1)
@@ -118,7 +118,7 @@ def amplitudeToSoundfile(arrayTarget: ndarray[形Shape, dtype[Any]]) -> AudioDat
 
 		arraySoundfile = arraySoundfile.astype(dtypeNewInteger, copy=True)  # pyright: ignore[reportAssignmentType]
 	else:
-		from hunterHearsPy._io import saveOnError  # noqa: PLC0415
+		from hunterHearsPy._io import saveOnError  # ruff:ignore[import-outside-top-level]
 
 		pathFilename: PurePath = saveOnError(arrayTarget)
 		message: str = (

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/dataBaskets.py

@@ -1,4 +1,4 @@
-# ruff: noqa: D100, D101, D102
+# ruff:file-ignore[undocumented-public-module, undocumented-public-class, undocumented-public-method]
 from __future__ import annotations
 
 from typing import NamedTuple, TYPE_CHECKING, TypedDict
@@ -58,7 +58,7 @@ class WaveformMetadata(TypedDict):
 	channels: int
 	lengthWaveform: int
 	pathFilename: FileDescriptorOrPath
-	# NOTE If the following values were assigned directly to a `slice` object, the slice object would
+	# DOCUMENT If the following values were assigned directly to a `slice` object, the slice object would
 	# work as desired. https://docs.python.org/3/library/functions.html#slice Therefore, maintain this
 	# functionality, and keep the semiotics aligned: `slice(start, stop)`.
 	samplesStart: int

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/theSSOT.py

@@ -1,4 +1,4 @@
-# ruff: noqa: D100, D101, D103
+# ruff:file-ignore[undocumented-public-module, undocumented-public-class, undocumented-public-function]
 from __future__ import annotations
 
 from hunterHearsPy import AxisMetadata, tukey

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/theTypes.py

@@ -1,4 +1,4 @@
-# ruff: noqa: D101
+# ruff:file-ignore[undocumented-public-class]
 """Type definitions for audio signal processing and waveform analysis.
 
 I'm starting to feel that for _all_ identifiers in the package, there ought to be a strong correlation

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy/windowingFunctionsTensor.py

@@ -10,13 +10,13 @@ if TYPE_CHECKING:
     from torch.types import Device
     from typing import Any
 
-def _convertToTensor(*arguments: Any, callableTarget: callableReturnsNDArray, device: Device | None=None, dtype: torch.dtype | None=None, **keywordArguments: Any) -> torch.Tensor:
+def _convertToTensor(*arguments: Any, callableTarget: callableReturnsNDArray, device: Device | None = None, dtype: torch.dtype | None = None, **keywordArguments: Any) -> torch.Tensor:
     arrayTarget = callableTarget(*arguments, **keywordArguments)
     if device is None:
         device = torch.device(device='cpu')
     return torch.tensor(data=arrayTarget, dtype=dtype or torch.float32, device=device)
 
-def cosineWingsTensor(lengthSupport: int, ratioTaper: float=0.1, device: Device | None=None, dtype: torch.dtype | None=None) -> torch.Tensor:
+def cosineWingsTensor(lengthSupport: int, ratioTaper: float = 0.1, device: Device | None = None, dtype: torch.dtype | None = None) -> torch.Tensor:
     """Generate a cosine-tapered windowingFunction with a flat center and tapered ends.
 
     You can use this function to produce a 1-D windowingFunction of length `lengthSupport` whose ends
@@ -43,7 +43,7 @@ def cosineWingsTensor(lengthSupport: int, ratioTaper: float=0.1, device: Device
     """
     return _convertToTensor(lengthSupport, ratioTaper, callableTarget=cosineWings, device=device, dtype=dtype)
 
-def equalPowerTensor(lengthSupport: int, ratioTaper: float=0.1, device: Device | None=None, dtype: torch.dtype | None=None) -> torch.Tensor:
+def equalPowerTensor(lengthSupport: int, ratioTaper: float = 0.1, device: Device | None = None, dtype: torch.dtype | None = None) -> torch.Tensor:
     """Generate an equal-power windowingFunction suitable for crossfades.
 
     You can use this function to build a 1-D windowingFunction whose ends follow a square-root ramp.
@@ -70,7 +70,7 @@ def equalPowerTensor(lengthSupport: int, ratioTaper: float=0.1, device: Device |
     """
     return _convertToTensor(lengthSupport, ratioTaper, callableTarget=equalPower, device=device, dtype=dtype)
 
-def halfsineTensor(lengthSupport: int, device: Device | None=None, dtype: torch.dtype | None=None) -> torch.Tensor:
+def halfsineTensor(lengthSupport: int, device: Device | None = None, dtype: torch.dtype | None = None) -> torch.Tensor:
     """Generate a half-sine windowingFunction of the requested length.
 
     This function returns a 1-D half-sine windowingFunction of length `lengthSupport`. The value at
@@ -99,7 +99,7 @@ def halfsineTensor(lengthSupport: int, device: Device | None=None, dtype: torch.
     """
     return _convertToTensor(lengthSupport, callableTarget=halfsine, device=device, dtype=dtype)
 
-def tukeyTensor(lengthSupport: int, ratioTaper: float=0.1, device: Device | None=None, dtype: torch.dtype | None=None, **keywordArguments: float) -> torch.Tensor:
+def tukeyTensor(lengthSupport: int, ratioTaper: float = 0.1, device: Device | None = None, dtype: torch.dtype | None = None, **keywordArguments: float) -> torch.Tensor:
     """Generate a Tukey windowingFunction.
 
     You can use this function to obtain a tapered windowingFunction where the central region is

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1/hunterHearsPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hunterHearsPy
-Version: 1.3.0
+Version: 1.4.1
 Summary: Audio processing.
 Author-email: Hunter Hogan <HunterHogan@pm.me>
 Maintainer-email: Hunter Hogan <HunterHogan@pm.me>
@@ -17,23 +17,27 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Typing :: Typed
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Z0Z_tools>=2.1.0
-Requires-Dist: hunterMakesPy>=0.7.0
+Requires-Dist: Z0Z_tools>=4.0.0
+Requires-Dist: hunterMakesPy>=0.10.0
 Requires-Dist: numpy
 Requires-Dist: resampy
 Requires-Dist: scipy
 Requires-Dist: soundfile>=0.14.0
 Requires-Dist: tqdm
 Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: development
+Requires-Dist: astToolkit; extra == "development"
+Requires-Dist: pytest-cov; extra == "development"
+Requires-Dist: scipy-stubs; extra == "development"
+Requires-Dist: types-resampy; extra == "development"
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-mock; extra == "testing"
@@ -131,13 +135,7 @@ I don't know a good way to implement user-configurable universal settings. There
 - time is more generic than samples and often preferred.
 - array is generic.
 - when talking about a NumPy `ndarray`, write `ndarray` not array.
-- `sampleRate` is giving me problems in the "ingest" functions.
-  - Regularly review these semiotics until the system is clear.
-  - Most of the time, `sampleRate` is descriptive: this is the sample rate. See `writeWAV`.
-  - In `readAudioFile`, the parameter is prescriptive: make this the sample rate. Even worse, the
-    attribute of the current sample rate is `readSoundFile.samplerate`, which is descriptive, of course.
-  - However, `def resampleWaveform(waveform, sampleRateDesired: float, sampleRateSource: float):` has
-    excellent semiotics because it does not use `sampleRate`.
+- Use `sampleRate` unless I have a compelling reason not to.
 
 ### Preferred packages
 
@@ -190,6 +188,11 @@ pip install hunterHearsPy
 ## My recovery
 
 [![Static Badge](https://img.shields.io/badge/2011_August-Homeless_since-blue?style=flat)](https://HunterThinks.com/support)
-[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC3Gx7kz61009NbhpRtPP7tw)](https://www.youtube.com/@HunterHogan)
 
 [![CC-BY-NC-4.0](https://raw.githubusercontent.com/hunterhogan/hunterHearsPy/refs/heads/main/.github/CC-BY-NC-4.0.png)](https://creativecommons.org/licenses/by-nc/4.0/)
+
+By law, authors retain their copyrights unless they grant exceptions. The [Attribution-NonCommercial 4.0 International Deed](https://github.com/hunterhogan/hunterHearsPy#License-1-ov-file) outlines how you may use this work.
+
+The restriction on commercial use (without a license) limits advantage-taking, unjust enrichment, and exploitation. You would be morally wrong if you were to enrich yourself by using this work while I am denied healthcare, housing, security of property, and the safety of my person.
+
+To obtain and retain the right to use this work, you incur the cost of attributing the work to me. Your nominal cost might accrue as a benefit that mitigates my suffering or saves my life.

hunterhearspy-1.4.1/hunterHearsPy.egg-info/SOURCES.txt

@@ -0,0 +1,40 @@
+LICENSE
+README.md
+pyproject.toml
+astTransformations/__init__.py
+astTransformations/windowingFunctions.py
+hunterHearsPy/__init__.py
+hunterHearsPy/_arrays.py
+hunterHearsPy/_fft.py
+hunterHearsPy/_io.py
+hunterHearsPy/_resample.py
+hunterHearsPy/amplitude.py
+hunterHearsPy/autoRevert.py
+hunterHearsPy/clippingArrays.py
+hunterHearsPy/dataBaskets.py
+hunterHearsPy/py.typed
+hunterHearsPy/theSSOT.py
+hunterHearsPy/theTypes.py
+hunterHearsPy/windowingFunctions.py
+hunterHearsPy/windowingFunctionsTensor.py
+hunterHearsPy.egg-info/PKG-INFO
+hunterHearsPy.egg-info/SOURCES.txt
+hunterHearsPy.egg-info/dependency_links.txt
+hunterHearsPy.egg-info/requires.txt
+hunterHearsPy.egg-info/top_level.txt
+tests/__init__.py
+tests/_theSSOT.py
+tests/conftest.py
+tests/conftestAnnex.py
+tests/oldSampleData.py
+tests/test_arrays.py
+tests/test_fft.py
+tests/test_io.py
+tests/test_old_amplitude.py
+tests/test_old_autoRevert.py
+tests/test_old_clippingArrays.py
+tests/test_old_spectrogram.py
+tests/test_old_waveform.py
+tests/test_resample.py
+tests/test_windowingFunctions.py
+tests/test_windowingFunctionsTensor.py

{hunterhearspy-1.3.0/src → hunterhearspy-1.4.1}/hunterHearsPy.egg-info/requires.txt

@@ -1,5 +1,5 @@
-Z0Z_tools>=2.1.0
-hunterMakesPy>=0.7.0
+Z0Z_tools>=4.0.0
+hunterMakesPy>=0.10.0
 numpy
 resampy
 scipy
@@ -7,6 +7,12 @@ soundfile>=0.14.0
 tqdm
 typing-extensions>=4.0.0
 
+[development]
+astToolkit
+pytest-cov
+scipy-stubs
+types-resampy
+
 [testing]
 pytest
 pytest-mock

hunterhearspy-1.4.1/hunterHearsPy.egg-info/top_level.txt

@@ -0,0 +1,5 @@
+astTransformations
+citations
+dist
+hunterHearsPy
+tests

hunterhearspy-1.4.1/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "hunterHearsPy"
+version = "1.4.1"
+description = "Audio processing."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "CC-BY-NC-4.0"
+license-files = ["LICEN[CS]E*"]
+authors = [{ name = "Hunter Hogan", email = "HunterHogan@pm.me" }]
+maintainers = [{ name = "Hunter Hogan", email = "HunterHogan@pm.me" }]
+keywords = []
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Natural Language :: English",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Typing :: Typed",
+]
+dependencies = [
+  "Z0Z_tools>=4.0.0",
+  "hunterMakesPy>=0.10.0",
+  "numpy",
+  "resampy",
+  "scipy",
+  "soundfile>=0.14.0",
+  "tqdm",
+  "typing-extensions>=4.0.0",
+]
+optional-dependencies = { development = ["astToolkit", "pytest-cov", "scipy-stubs", "types-resampy"], testing = ["pytest", "pytest-mock", "pytest-xdist", "torch"], torch = ["torch"] }
+
+[project.urls]
+Context7 = "https://context7.com/hunterhogan/hunterhearspy"
+Donate = "https://www.patreon.com/integrated"
+Download = "https://pypi.org/project/hunterHearsPy"
+Homepage = "https://github.com/hunterhogan/hunterHearsPy"
+Issues = "https://github.com/hunterhogan/hunterHearsPy/issues"
+Repository = "https://github.com/hunterhogan/hunterHearsPy.git"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.coverage]
+report = { exclude_lines = ["if TYPE_CHECKING:", "if __name__ == \"__main__\":"], ignore_errors = false }
+run = { branch = true, concurrency = ["multiprocessing"], data_file = "tests/coverage/.coverage", omit = ["tests/*"], parallel = true, source = ["."] }
+
+[tool.pytest]
+addopts = ["--color=auto", "--tb=line", "-n", "4"]
+log_auto_indent = "On"
+testpaths = ["tests"]
+
+[tool.setuptools]
+package-data = { "*" = ["py.typed"]}
+packages = { find = {} }
+
+[tool.updateCitation]
+filenameCitationDOTcff = "CITATION.cff"
+pathFilenameCitationSSOT = "citations/CITATION.cff"

hunterhearspy-1.4.1/tests/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from tests._theSSOT import (
+	dtypeTokens as dtypeTokens, pathDataSamples as pathDataSamples, pathDataSamplesExpected as pathDataSamplesExpected)
+from tests.conftestAnnex import (
+	assert_allclose as assert_allclose, assert_approx as assert_approx, assert_array_equal as assert_array_equal,
+	assertEqualTo as assertEqualTo, messageTestFailure as messageTestFailure, messageTestFailure_ndarray as messageTestFailure_ndarray)

hunterhearspy-1.4.1/tests/_theSSOT.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+pathDataSamples = Path('tests/dataSamples')
+pathDataSamplesExpected: Path = pathDataSamples / 'expected'
+
+dtypeTokens: frozenset[str] = frozenset(('int8', 'int16', 'int32', 'int64', 'uint8', 'uint16', 'uint32', 'uint64', 'float16', 'float32', 'float64', 'complex64', 'complex128'))

hunterhearspy-1.4.1/tests/conftest.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+
+from hashlib import blake2b
+from humpy_cytoolz.dicttoolz import keyfilter, merge
+from hunterHearsPy import loadWaveforms, readAudioFile
+from hunterMakesPy.dataStructures import stringItUp
+from more_itertools import one
+from soundfile import dtype_str as Options_dtype_str
+from tests import pathDataSamples, pathDataSamplesExpected
+from typing import cast, TYPE_CHECKING
+import inspect
+import numpy
+import operator
+import pytest
+
+if TYPE_CHECKING:
+	from collections.abc import Sequence
+	from hunterHearsPy.theTypes import ArrayWaveforms, Waveform, 形ndarray
+	from inspect import Parameter
+	from pathlib import Path
+	from pytest import FixtureRequest
+	from torch.types import Device
+	from types import MappingProxyType
+
+# ================== Test-function parameters ======================================================
+
+@pytest.fixture()
+def approx_abs(request: FixtureRequest) -> float:
+	"""The `abs` (***abs***olute tolerance) parameter value for `pytest.approx`."""
+	return 1e-12
+
+@pytest.fixture()
+def approx_rel(request: FixtureRequest) -> float:
+	"""The `rel` (***rel***ative tolerance) parameter value for `pytest.approx`."""
+	return 1e-6
+
+@pytest.fixture()
+def atol(request: FixtureRequest) -> float:
+	"""The `atol` (***a***bsolute ***tol***erance) parameter value for `numpy.allclose`."""
+	return 1e-08
+
+@pytest.fixture()
+def expected(request: FixtureRequest) -> 形ndarray:
+	"""Test-function and its parameters encoded in a `__` delimited filename.
+
+	Each parameter created with `parametrize` (as opposed to, for example, `fixture`) is encoded as `{parameter}~{value}`.
+	"""
+	request_nodeParameters: MappingProxyType[str, Parameter] = cast('MappingProxyType[str, Parameter]', request.node.callspec.params)  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType]
+	filenameStem: str = '__'.join((
+		str(request.function.__name__).removeprefix('test_')
+		, *(f'{keyAndValue[0]}~{"".join(stringItUp(keyAndValue[1]) or ["None"])}'
+			for keyAndValue in keyfilter(request_nodeParameters.keys().__contains__, merge(inspect.signature(request.function).parameters, request_nodeParameters)).items()
+	)))
+	if 251 < len(filenameStem):
+		filenameStem = f'{str(request.function.__name__).removeprefix("test_")}__blake2b~{blake2b(filenameStem.encode(), digest_size=16).hexdigest()}'
+	pathFilename: Path = pathDataSamplesExpected / f'{filenameStem}.npz'
+	with numpy.load(pathFilename, allow_pickle=False) as archiveExpected:
+		return archiveExpected['expected']
+
+@pytest.fixture()
+def rtol(request: FixtureRequest) -> float:
+	"""The `rtol` (***r***elative ***tol***erance) parameter value for `numpy.allclose`."""
+	return 1e-05
+
+# ================== Parameter values to test against the package's `Callable` =====================
+
+@pytest.fixture()
+def arrayTarget(request: FixtureRequest) -> Waveform | ArrayWaveforms:
+	return cast('Waveform | ArrayWaveforms', request.getfixturevalue(getattr(request, 'param', 'waveform')))
+
+@pytest.fixture()
+def arrayWaveforms(listPathFilenames: tuple[Path, ...], CPUlimit: bool | float | int | None) -> ArrayWaveforms:
+	return loadWaveforms(listPathFilenames, CPUlimit=CPUlimit).array
+
+@pytest.fixture()
+def CPUlimit(request: FixtureRequest) -> int:
+	return 1
+
+@pytest.fixture(params=tuple(map(pytest.param, (None, 'cpu'))))
+def device(request: FixtureRequest) -> Device | None:
+	return request.param
+
+@pytest.fixture()
+def dtype_str(pathFilename: Path) -> Options_dtype_str | None:
+	return one(set(Options_dtype_str.__args__).intersection(pathFilename.stem.split('_')), too_short=None)
+
+# TODO Resolving the actual location for every `pathFilename` and `listPathFilenames` parameter MUST
+# be centralized in one function.
+@pytest.fixture()
+def listPathFilenames(request: FixtureRequest) -> tuple[Path, ...]:
+	listFilenames: Sequence[str] = cast('Sequence[str]', request.node.callspec.params['listPathFilenames'])  # pyright: ignore[reportUnknownMemberType]
+	return tuple(map(pathDataSamples.joinpath, listFilenames))
+
+@pytest.fixture()
+def pathFilename(request: FixtureRequest) -> Path:
+	filename: str = request.param
+	return pathDataSamples / filename
+
+@pytest.fixture()
+def sampleRateSource(pathFilename: Path) -> float:
+	return float(one(filter(str.isdecimal, map(operator.itemgetter(slice(2, None)), filter(lambda string: string.startswith('Hz'), pathFilename.stem.split('_'))))))
+
+@pytest.fixture()
+def waveform(pathFilename: Path, sampleRateSource: float, dtype_str: Options_dtype_str | None) -> Waveform:
+	return readAudioFile(pathFilename, sampleRateSource, dtype_str)

hunterhearspy-1.4.1/tests/conftestAnnex.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from itertools import starmap
+from typing import TYPE_CHECKING
+import numpy
+import pytest
+
+if TYPE_CHECKING:
+	from hunterHearsPy.theTypes import 个, 形ndarray
+	from typing import Any
+
+#================== Assert scalar and built-in containers ========================================================================
+
+def assertEqualTo(actual: 个, expected: 个, function: str, *arguments: Any, **keywordArguments: Any) -> None:
+	"""Assert that two objects are equal, and if not, raise an AssertionError with a detailed message."""
+	assert actual == expected, messageTestFailure(actual, expected, function, *arguments, **keywordArguments)
+
+def assert_approx(actual: 个, expected: 个, pytest_rel: float, pytest_abs: float, function: str, *arguments: Any, **keywordArguments: Any) -> None:
+	assert actual == pytest.approx(expected, pytest_rel, pytest_abs, nan_ok=True), messageTestFailure(actual, expected, function, *arguments, **keywordArguments)
+
+def messageTestFailure(actual: Any, expected: Any, function: str, *arguments: Any, **keywordArguments: Any) -> str:
+	"""Format assertion message for any test comparison."""
+	parameters: list[str] = [*map(repr, arguments), *starmap('{}={!r}'.format, keywordArguments.items())]
+	return f'{function}({", ".join(parameters)}) = {actual!r}, but {expected = }.'
+
+#================== Assert NumPy arrays ========================================================================
+
+def assert_array_equal(actual: 形ndarray, expected: 形ndarray, function: str, *arguments: Any, **keywordArguments: Any) -> None:
+	"""Assert that two arrays are equal, and if not, raise an AssertionError with a detailed message."""
+	assert numpy.array_equal(actual, expected), messageTestFailure_ndarray(actual, expected, function, *arguments, **keywordArguments)
+
+def assert_allclose(actual: 形ndarray, expected: 形ndarray, rtol: float, atol: float, function: str, *arguments: Any, **keywordArguments: Any) -> None:
+	assert numpy.allclose(actual, expected, rtol, atol), messageTestFailure_ndarray(actual, expected, function, *arguments, **keywordArguments)
+
+def messageTestFailure_ndarray(actual: 形ndarray, expected: 形ndarray, function: str, *arguments: Any, **keywordArguments: Any) -> str:
+	"""Printing arrays is absurd."""
+	parameters: list[str] = [*map(repr, arguments), *starmap('{}={!r}'.format, keywordArguments.items())]
+	return f'{function}({", ".join(parameters)}) = {actual.shape=},\t{actual.dtype=}, but {expected.shape=}, {expected.dtype=}.'

hunterhearspy-1.4.1/tests/oldSampleData.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from functools import cache
+from hunterHearsPy import readAudioFile
+from pathlib import Path
+from typing import ClassVar, TYPE_CHECKING
+
+if TYPE_CHECKING:
+	from hunterHearsPy.theTypes import Waveform
+
+class WaveformAndMetadata:
+	_cacheWaveforms: ClassVar[dict[Path, Waveform]] = {}
+
+	def __init__(self, pathFilename: Path, LUFS: float, sampleRate: float, channelsTotal: int, ID: str) -> None:
+		self.pathFilename: Path = pathFilename
+		self.LUFS: float = LUFS
+		self.sampleRate: float = sampleRate
+		self.channelsTotal: int = channelsTotal
+		self.ID: str = ID
+
+	@property
+	def waveform(self) -> Waveform:
+		if self.pathFilename not in self._cacheWaveforms:
+			self._cacheWaveforms[self.pathFilename] = readAudioFile(self.pathFilename, self.sampleRate)
+		return self._cacheWaveforms[self.pathFilename]
+
+pathDataSamples_labeled = Path('tests/dataSamples/labeled')
+
+def ingestSampleData() -> list[WaveformAndMetadata]:
+	"""Parse LUFS*.wav filenames and create WaveformData objects without loading waveforms."""
+	listWaveformData: list[WaveformAndMetadata] = []
+	for pathFilename in pathDataSamples_labeled.glob('LUFS*.wav'):
+		LUFSAsStr, sampleRateAsStr, channelsTotalAsStr, ID = pathFilename.stem.split('_', maxsplit=3)
+		LUFS = -float(LUFSAsStr[len('LUFS') :])
+		sampleRate = float(sampleRateAsStr)
+		channelsTotal = int(channelsTotalAsStr[len('ch') :])
+		listWaveformData.append(WaveformAndMetadata(pathFilename, LUFS, sampleRate, channelsTotal, ID))
+	return listWaveformData
+
+@cache
+def sampleData() -> list[WaveformAndMetadata]:
+	return ingestSampleData()

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1}/tests/test_io.py

@@ -10,8 +10,8 @@ if TYPE_CHECKING:
 	from pathlib import Path
 	from soundfile import dtype_str as Options_dtype_str
 
-# TODO add `None` to `sampleRateDesired`.
-@pytest.mark.parametrize('sampleRateDesired', (44100, 48000))
+# TODO add `None` to `sampleRate`.
+@pytest.mark.parametrize('sampleRate', (44100, 48000))
 @pytest.mark.parametrize('pathFilename'
 	, indirect=['pathFilename']
 	, argvalues=(
@@ -24,7 +24,7 @@ if TYPE_CHECKING:
 		, ('Music_ch2_Hz44100_float32_sec20_RMS-20.wav')
 	)
 )
-def test_readAudioFile(pathFilename: Path, sampleRateDesired: float, dtype_str: Options_dtype_str | None, expected: Waveform) -> None:
-	actual: Waveform = readAudioFile(pathFilename, sampleRateDesired, dtype_str)
+def test_readAudioFile(pathFilename: Path, sampleRate: float, dtype_str: Options_dtype_str | None, expected: Waveform) -> None:
+	actual: Waveform = readAudioFile(pathFilename, sampleRate, dtype_str)
 
-	assert_array_equal(actual, expected, 'readAudioFile', pathFilename.name, sampleRateDesired=sampleRateDesired, dtype_str=dtype_str)
+	assert_array_equal(actual, expected, 'readAudioFile', pathFilename.name, sampleRate=sampleRate, dtype_str=dtype_str)

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1}/tests/test_old_clippingArrays.py

@@ -1,10 +1,10 @@
 # ty:ignore[unresolved-attribute]
-# ruff: noqa: DOC501
+# ruff:file-ignore[docstring-missing-exception]
 from __future__ import annotations
 
 from hunterHearsPy import applyHardLimit, applyHardLimitComplexValued
 from numpy import float64
-from numpy._core._exceptions import _UFuncNoLoopError  # noqa: PLC2701
+from numpy._core._exceptions import _UFuncNoLoopError  # ruff:ignore[import-private-name]
 from tests import messageTestFailure
 from typing import Any, Final, TYPE_CHECKING
 import numpy

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1}/tests/test_old_spectrogram.py

@@ -1,6 +1,6 @@
 # pyright: reportUnknownArgumentType=false
 # pyright: reportUnknownLambdaType=false
-# ruff: noqa: DOC501
+# ruff:file-ignore[docstring-missing-exception]
 # ty:ignore[unresolved-attribute]
 """test_waveform or test_spectrogram? if a spectrogram is involved at any point, then test_spectrogram."""
 

{hunterhearspy-1.3.0 → hunterhearspy-1.4.1}/tests/test_old_waveform.py

@@ -4,7 +4,7 @@
 # pyright: reportUnknownArgumentType=false
 # pyright: reportUnknownLambdaType=false
 # pyright: reportUnknownVariableType=false
-# ruff: noqa: T201, PERF203, RUF076
+# ruff:file-ignore[print, try-except-in-loop]
 from __future__ import annotations
 
 from hunterHearsPy import getWaveformMetadata, writeWAV

hunterhearspy-1.3.0/pyproject.toml

@@ -1,95 +0,0 @@
-[project]
-name = "hunterHearsPy"
-version = "1.3.0"
-description = "Audio processing."
-readme = "README.md"
-requires-python = ">=3.10"
-license = "CC-BY-NC-4.0"
-license-files = ["LICEN[CS]E*"]
-authors = [{ name = "Hunter Hogan", email = "HunterHogan@pm.me" }]
-maintainers = [{ name = "Hunter Hogan", email = "HunterHogan@pm.me" }]
-keywords = []
-classifiers = [
-  "Development Status :: 4 - Beta",
-  "Environment :: Console",
-  "Intended Audience :: Developers",
-  "Intended Audience :: Science/Research",
-  "Natural Language :: English",
-  "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Programming Language :: Python :: 3.14",
-  "Typing :: Typed",
-]
-dependencies = [
-  "Z0Z_tools>=2.1.0",
-  "hunterMakesPy>=0.7.0",
-  "numpy",
-  "resampy",
-  "scipy",
-  "soundfile>=0.14.0",
-  "tqdm",
-  "typing-extensions>=4.0.0",
-]
-optional-dependencies = { testing = [
-  "pytest",
-  "pytest-mock",
-  "pytest-xdist",
-  "torch"
-], torch = ["torch"] }
-
-[project.urls]
-Context7 = "https://context7.com/hunterhogan/hunterhearspy"
-Donate = "https://www.patreon.com/integrated"
-Download = "https://pypi.org/project/hunterHearsPy"
-Homepage = "https://github.com/hunterhogan/hunterHearsPy"
-Issues = "https://github.com/hunterhogan/hunterHearsPy/issues"
-Repository = "https://github.com/hunterhogan/hunterHearsPy.git"
-
-[dependency-groups]
-dev = ["astToolkit", "pytest-cov", "scipy-stubs", "types-resampy"]
-pytorch = ["torch==2.10.0"]
-
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[tool.coverage]
-report = { exclude_lines = ["if TYPE_CHECKING:", "if __name__ == \"__main__\":"], ignore_errors = false }
-run = { branch = true, concurrency = ["multiprocessing"], data_file = "tests/coverage/.coverage", omit = [
-  "tests/*"
-], parallel = true, source = ["."] }
-
-[tool.pytest]
-addopts = ["--color=auto", "--tb=line", "-n 4"]
-log_auto_indent = "On"
-pythonpath = ["src"]
-testpaths = ["tests"]
-
-[tool.updateCitation]
-filenameCitationDOTcff = "CITATION.cff"
-pathFilenameCitationSSOT = "citations/CITATION.cff"
-
-[tool.uv]
-build-backend = { module-name = "hunterHearsPy", module-root = "src" }
-default-groups = ["dev"]
-
-[[tool.uv.index]]
-# NOTE I use this to install torch+cuda on my computer that doesn't have cuda. 2026-06-13
-# `uv sync --group pytorch` OR `uv sync --all-groups` will trigger the following.
-# dependency-groups.pytorch amends the dependencies: `torch`, limitation `==2.10.0`, group = "pytorch".
-# At this point, the default source, pypi, is the highest priority on the `torch` sources list. (LIFO)
-# tool.uv.sources sees '`torch`, group = "pytorch"' so pushes "indexPytorch" on top the `torch` sources list.
-# tool.uv.index translates "indexPytorch" to the url of a package index.
-# uv queries the package index for all `torch` that match all limitations.
-# If the package index returns any matches, uv will install the "best" match.
-# Because the package index only has cuda 12.8 versions, uv installs torch+cu128.
-# I picked torch==2.10.0 + cuda 12.8 because that is the pre-installed package on Google Colab T4.
-explicit = true
-name = "indexPytorch"
-url = "https://download.pytorch.org/whl/cu128"
-
-[tool.uv.sources]
-torch = { group = "pytorch", index = "indexPytorch" }

hunterhearspy-1.3.0/src/hunterHearsPy.egg-info/SOURCES.txt

@@ -1,33 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/hunterHearsPy/__init__.py
-src/hunterHearsPy/_arrays.py
-src/hunterHearsPy/_fft.py
-src/hunterHearsPy/_io.py
-src/hunterHearsPy/_resample.py
-src/hunterHearsPy/amplitude.py
-src/hunterHearsPy/autoRevert.py
-src/hunterHearsPy/clippingArrays.py
-src/hunterHearsPy/dataBaskets.py
-src/hunterHearsPy/py.typed
-src/hunterHearsPy/theSSOT.py
-src/hunterHearsPy/theTypes.py
-src/hunterHearsPy/windowingFunctions.py
-src/hunterHearsPy/windowingFunctionsTensor.py
-src/hunterHearsPy.egg-info/PKG-INFO
-src/hunterHearsPy.egg-info/SOURCES.txt
-src/hunterHearsPy.egg-info/dependency_links.txt
-src/hunterHearsPy.egg-info/requires.txt
-src/hunterHearsPy.egg-info/top_level.txt
-tests/test_arrays.py
-tests/test_fft.py
-tests/test_io.py
-tests/test_old_amplitude.py
-tests/test_old_autoRevert.py
-tests/test_old_clippingArrays.py
-tests/test_old_spectrogram.py
-tests/test_old_waveform.py
-tests/test_resample.py
-tests/test_windowingFunctions.py
-tests/test_windowingFunctionsTensor.py

hunterhearspy-1.3.0/src/hunterHearsPy.egg-info/top_level.txt

@@ -1 +0,0 @@
-hunterHearsPy