wavemap 2.0.1__tar.gz → 2.1.0__tar.gz

{wavemap-2.0.1/wavemap.egg-info → wavemap-2.1.0}/PKG-INFO

@@ -1,23 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wavemap
-Version: 2.0.1
-Summary: Memory map WAVE or raw audio files
-Home-page: https://github.com/rec/wavemap
+Version: 2.1.0
+Summary: 🌊 Memory map WAVE or raw audio files 🌊
 Author: Tom Ritchford
-Author-email: tom@swirly.com
-License: MIT
-Keywords: testing,modules
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Utilities
-License-File: LICENSE
+Author-email: Tom Ritchford <tom@swirly.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Dist: numpy>=1.24.1,<2
+Requires-Dist: xmod>=1.3.2,<2
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
 
 🌊 Memory map WAVE files into numpy arrays 🌊
 ----------------------------------------------
@@ -379,5 +376,3 @@ ARGUMENTS
     If true, ``arr`` is copied even if it is already the requested type
 
 (automatically generated by `doks <https://github.com/rec/doks/>`_ on 2021-02-23T14:37:02.652534)
-
-

wavemap-2.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "wavemap"
+version = "2.1.0"
+description = "🌊 Memory map WAVE or raw audio files 🌊"
+authors = [{ name = "Tom Ritchford", email = "tom@swirly.com" }]
+requires-python = ">=3.10"
+readme = "README.rst"
+license = "MIT"
+classifiers = ["Programming Language :: Python :: 3", "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"]
+dependencies = [
+    "numpy>=1.24.1,<2",
+    "xmod>=1.3.2,<2",
+]
+
+[tool.doks]
+auto = true
+source = 'wavemap/__init__.py'
+
+[tool.ruff]
+[dependency-groups]
+dev = [
+    "coverage>=7.1.0,<8",
+    "pytest>=7.2.1,<8",
+    "pyupgrade>=3.21.2",
+    "ruff>=0.14.14",
+    "stroll>=1.1.0,<2",
+    "tdir>=1.4.1,<2",
+    "ty>=0.0.14",
+]
+
+[tool.uv]
+
+[tool.uv.build-backend]
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.9.0,<0.10.0"]
+build-backend = "uv_build"
+[tool.coverage.run]
+branch = true
+source = "wavemap"
+
+[tool.coverage.report]
+fail_under = "68"
+skip_covered = true
+exclude_lines = ["pragma: no cover", "if False:", "if __name__ == .__main__.:", "raise NotImplementedError"]
+

{wavemap-2.0.1 → wavemap-2.1.0}/wavemap/__init__.py

@@ -26,31 +26,34 @@ Typical usage:
     wm /= 2
     # Each sample in the file is scaled by half.
 """
+
+from typing import Optional, Union
+from collections.abc import Callable
+
+import numpy as np
+import xmod
+
 from . import docs
 from .convert import convert
 from .raw import RawMap, warn
 from .read import ReadMap as ReadMap
 from .write import WriteMap as WriteMap
-from typing import Callable, Optional, Union
-import numpy as np
-import xmod
 
 __all__ = (
-    'wavemap',
-    'RawMap',
-    'ReadMap',
-    'WriteMap',
-    'copy_to',
-    'new_like',
-    'convert',
+    "wavemap",
+    "RawMap",
+    "ReadMap",
+    "WriteMap",
+    "copy_to",
+    "new_like",
+    "convert",
 )
-__version__ = '2.0.1'
 
 copy_to = WriteMap.copy_to
 new_like = WriteMap.new_like
-_DOKS = {warn: '<function warn: print to stderr>'}
-_WRITE_PARAMETERS = 'dtype', 'shape', 'sample_rate'
-_READ_PARAMETERS = 'order', 'always_2d'
+_DOKS = {warn: "<function warn: print to stderr>"}
+_WRITE_PARAMETERS = "dtype", "shape", "sample_rate"
+_READ_PARAMETERS = "order", "always_2d"
 
 
 @xmod(mutable=True)
@@ -60,20 +63,20 @@ def wavemap(
     #
     # Read parameters
     #
-    mode: str = 'r',
-    order: Optional[str] = None,
+    mode: str = "r",
+    order: str | None = None,
     always_2d: bool = False,
     #
     # Write parameters
     #
-    dtype: Optional[np.dtype] = None,
-    shape: Union[None, int, tuple] = None,
+    dtype: np.dtype | None = None,
+    shape: None | int | tuple = None,
     sample_rate: int = 0,
     roffset: int = 0,
     #
     # Read and write parameters
     #
-    warn: Optional[Callable] = warn,
+    warn: Callable | None = warn,
 ):
     """
     Memory map a WAVE file to a `numpy` array
@@ -81,18 +84,18 @@ def wavemap(
     Return an instance of `ReadMap` or `WriteMap`, depending on
     `mode`.
     """
-    if mode.startswith('w'):
+    if mode.startswith("w"):
         if not dtype:
-            raise ValueError('dtype must be set for write')
+            raise ValueError("dtype must be set for write")
         if not shape:
-            raise ValueError('shape must be set for write')
+            raise ValueError("shape must be set for write")
         if not sample_rate:
-            raise ValueError('sample_rate must be set for write')
+            raise ValueError("sample_rate must be set for write")
 
         if order:
-            raise ValueError('order cannot be set for write')
+            raise ValueError("order cannot be set for write")
         if always_2d:
-            raise ValueError('always_2d cannot be set for write')
+            raise ValueError("always_2d cannot be set for write")
 
         return WriteMap(
             filename=filename,
@@ -104,9 +107,9 @@ def wavemap(
         )
     else:
         if shape:
-            raise ValueError('shape cannot be set for write')
+            raise ValueError("shape cannot be set for write")
         if sample_rate:
-            raise ValueError('sample_rate cannot be set for write')
+            raise ValueError("sample_rate cannot be set for write")
 
         result = ReadMap(
             filename=filename,

{wavemap-2.0.1 → wavemap-2.1.0}/wavemap/convert.py

@@ -1,11 +1,10 @@
-from numpy.lib.stride_tricks import as_strided
 from typing import Optional
+
 import numpy as np
+from numpy.lib.stride_tricks import as_strided
 
 
-def convert(
-    arr: np.ndarray, dtype: Optional[np.dtype], must_copy: bool = False
-):
+def convert(arr: np.ndarray, dtype: np.dtype | None, must_copy: bool = False):
     """
     Returns a copy of a numpy array or matrix that represents audio data in
     another type, scaling and shifting as necessary.
@@ -27,8 +26,8 @@ def convert(
             arr = np.copy(arr)
         return arr
 
-    old_int = 'int' in str(old_t)
-    new_int = 'int' in str(new_t)
+    old_int = "int" in str(old_t)
+    new_int = "int" in str(new_t)
 
     if not (new_int or old_int):
         # Convert between floats
@@ -96,8 +95,15 @@ def _twenty_four_bit(shape, new, raw, itemsize):
     assert not (frames % 4)
 
     # https://stackoverflow.com/a/34128171/4383
-    raw = new(shape=(itemsize * frames // 4,), dtype='int32')
-    strided = as_strided(raw, strides=(12, 3,), shape=(frames, 4))
+    raw = new(shape=(itemsize * frames // 4,), dtype="int32")
+    strided = as_strided(
+        raw,
+        strides=(
+            12,
+            3,
+        ),
+        shape=(frames, 4),
+    )
     reshaped = np.reshape(strided, shape=shape)
 
     result = reshaped & 0x00FFFFFF

{wavemap-2.0.1 → wavemap-2.1.0}/wavemap/docs.py

@@ -15,9 +15,9 @@ Think of this as `self`.  (This is because you need to implement `__new__`
 and not `__init__` when deriving from `np.darray`.)
 """
 
-DTYPE = 'The numpy datatype of the samples in the file.'
+DTYPE = "The numpy datatype of the samples in the file."
 
-FILENAME = 'The name of the file being mapped'
+FILENAME = "The name of the file being mapped"
 
 ORDER = """
 Samples usually get laid out in into a `numpy.darray` with`
@@ -63,9 +63,9 @@ In mode `'w+'`, "write", the file is opened for write, and overwrites
 whatever else is there.
 """
 
-OFFSET = 'How many bytes in the file before the WAV data'
-ROFFSET = 'How many bytes in the file after the WAV data'
-SAMPLE_RATE = 'The sample rate in Hz (cycles per second)'
+OFFSET = "How many bytes in the file before the WAV data"
+ROFFSET = "How many bytes in the file after the WAV data"
+SAMPLE_RATE = "The sample rate in Hz (cycles per second)"
 
 SHAPE = """
 The shape of the resulting numpy.darray. Can be a tuple, or a positive
@@ -87,19 +87,19 @@ def arguments(*names, subs=None):
     names = [(i, subs.get(i, i).upper()) for i in names]
     missing = [n for (n, a) in names if a not in globals()]
     if missing:
-        raise ValueError(f'Cannot document arguments {missing}')
+        raise ValueError(f"Cannot document arguments {missing}")
 
-    yield 'ARGUMENTS'
+    yield "ARGUMENTS"
     for name, attr in names:
-        yield f'  {name}'
+        yield f"  {name}"
         for line in globals()[attr].strip().splitlines():
-            yield line and f'    {line}'
-        yield ''
+            yield line and f"    {line}"
+        yield ""
 
 
 def add_arguments(func, names, subs=None):
     params = arguments(*names, subs=subs)
-    func.__doc__ = func.__doc__.rstrip() + '\n\n' + '\n'.join(params)
+    func.__doc__ = func.__doc__.rstrip() + "\n\n" + "\n".join(params)
     return func
 
 

{wavemap-2.0.1 → wavemap-2.1.0}/wavemap/memmap.py

@@ -1,9 +1,9 @@
-from numpy.compat import os_fspath, contextlib_nullcontext, is_pathlib_path
-from numpy.core.numeric import uint8, ndarray, dtype
-from numpy.core.overrides import set_module
 import numpy as np
+from numpy.compat import contextlib_nullcontext, is_pathlib_path, os_fspath
+from numpy.core.numeric import dtype, ndarray, uint8
+from numpy.core.overrides import set_module
 
-__all__ = ['memmap']
+__all__ = ["memmap"]
 
 dtypedescr = dtype
 valid_filemodes = ["r", "c", "r+", "w+"]
@@ -17,7 +17,7 @@ mode_equivalents = {
 }
 
 
-@set_module('numpy')
+@set_module("numpy")
 class memmap(ndarray):
     """Create a memory-map to an array stored in a *binary* file on disk.
 
@@ -204,10 +204,10 @@ class memmap(ndarray):
         subtype,
         filename,
         dtype=uint8,
-        mode='r+',
+        mode="r+",
         offset=0,
         shape=None,
-        order='C',
+        order="C",
         roffset=0,
     ):
         # Import here to minimize 'import numpy' overhead
@@ -224,15 +224,13 @@ class memmap(ndarray):
                     )
                 ) from None
 
-        if mode == 'w+' and shape is None:
+        if mode == "w+" and shape is None:
             raise ValueError("shape must be given")
 
-        if hasattr(filename, 'read'):
+        if hasattr(filename, "read"):
             f_ctx = contextlib_nullcontext(filename)
         else:
-            f_ctx = open(
-                os_fspath(filename), ('r' if mode == 'c' else mode) + 'b'
-            )
+            f_ctx = open(os_fspath(filename), ("r" if mode == "c" else mode) + "b")
 
         with f_ctx as fid:
             fid.seek(0, 2)
@@ -260,14 +258,14 @@ class memmap(ndarray):
 
             bytes = int(offset + size * _dbytes + roffset)
 
-            if mode in ('w+', 'r+') and flen < bytes:
+            if mode in ("w+", "r+") and flen < bytes:
                 fid.seek(bytes - 1, 0)
-                fid.write(b'\0')
+                fid.write(b"\0")
                 fid.flush()
 
-            if mode == 'c':
+            if mode == "c":
                 acc = mmap.ACCESS_COPY
-            elif mode == 'r':
+            elif mode == "r":
                 acc = mmap.ACCESS_READ
             else:
                 acc = mmap.ACCESS_WRITE
@@ -304,7 +302,7 @@ class memmap(ndarray):
         return self
 
     def __array_finalize__(self, obj):
-        if hasattr(obj, '_mmap') and np.may_share_memory(self, obj):
+        if hasattr(obj, "_mmap") and np.may_share_memory(self, obj):
             self._mmap = obj._mmap
             self.filename = obj.filename
             self.offset = obj.offset
@@ -330,11 +328,11 @@ class memmap(ndarray):
         memmap
 
         """
-        if self.base is not None and hasattr(self.base, 'flush'):
+        if self.base is not None and hasattr(self.base, "flush"):
             self.base.flush()
 
     def __array_wrap__(self, arr, context=None):
-        arr = super(memmap, self).__array_wrap__(arr, context)
+        arr = super().__array_wrap__(arr, context)
 
         # Return a memmap if a memmap was given as the output of the
         # ufunc. Leave the arr class unchanged if self is not a memmap
@@ -349,7 +347,7 @@ class memmap(ndarray):
         return arr.view(np.ndarray)
 
     def __getitem__(self, index):
-        res = super(memmap, self).__getitem__(index)
+        res = super().__getitem__(index)
         if type(res) is memmap and res._mmap is None:
             return res.view(type=ndarray)
         return res

{wavemap-2.0.1 → wavemap-2.1.0}/wavemap/raw.py

@@ -1,10 +1,13 @@
+import sys
+from typing import Optional, Union
+from collections.abc import Callable
+
+import numpy as np
+
 from . import docs
 from .memmap import memmap
-from typing import Callable, Optional, Union
-import numpy as np
-import sys
 
-int24 = 'int24'
+int24 = "int24"
 
 
 def warn(msg):
@@ -12,20 +15,20 @@ def warn(msg):
 
 
 class RawMap(memmap):
-    """"Memory map raw audio data from a disk file into a numpy matrix"""
+    """ "Memory map raw audio data from a disk file into a numpy matrix"""
 
     @docs.update
     def __new__(
         cls,
         filename: str,
         dtype: np.dtype,
-        shape: Union[tuple, int, None] = None,
-        mode: str = 'r',
+        shape: tuple | int | None = None,
+        mode: str = "r",
         offset: int = 0,
         roffset: int = 0,
-        order: Optional[str] = None,
+        order: str | None = None,
         always_2d: bool = False,
-        warn: Optional[Callable] = warn,
+        warn: Callable | None = warn,
     ):
         """Memory map raw audio data from a disk file into a numpy matrix"""
         # Documentation for parameters is in docs.py
@@ -36,22 +39,22 @@ class RawMap(memmap):
             )
 
         if offset < 0 or roffset < 0:
-            raise ValueError('offset and roffset must be non-negative')
+            raise ValueError("offset and roffset must be non-negative")
 
-        if order not in ('C', 'F', None):
+        if order not in ("C", "F", None):
             raise ValueError(f'Bad order "{order}"')
 
         if isinstance(shape, int):
             shape = (shape,)
 
         if not (shape is None or 1 <= len(shape) <= 2):
-            raise ValueError('Wave files must have 1 or 2 dimensions')
+            raise ValueError("Wave files must have 1 or 2 dimensions")
 
-        if 'w' in mode:
+        if "w" in mode:
             if not shape:
-                raise ValueError('Must set a shape in write mode')
-            order = order or 'FC'[max(shape) == shape[0]]
-            return new(mode='w+', order=order)
+                raise ValueError("Must set a shape in write mode")
+            order = order or "FC"[max(shape) == shape[0]]
+            return new(mode="w+", order=order)
 
         if str(dtype) == int24:
             itemsize = 3
@@ -62,12 +65,12 @@ class RawMap(memmap):
         audio_size = file_size - offset - roffset
         shape = _get_shape(shape, audio_size, itemsize, order, always_2d, warn)
         if itemsize == 3:
-            raise ValueError('Cannot memory map 24-bit audio')
+            raise ValueError("Cannot memory map 24-bit audio")
         return new(shape=shape)
 
 
 def file_byte_size(filename: str):
-    with open(filename, 'rb') as fp:
+    with open(filename, "rb") as fp:
         return fp.seek(0, 2)
 
 
@@ -78,27 +81,27 @@ def _get_shape(shape, audio_size, itemsize, order, always_2d, warn):
     if itemsize == 3:
         extra = audio_size % 12
         if extra and warn:
-            s = 's' if len(extra) != 1 else ''
-            warn(f'24-bit conversion lost last {extra} byte{s}, sorry')
+            s = "s" if len(extra) != 1 else ""
+            warn(f"24-bit conversion lost last {extra} byte{s}, sorry")
         audio_size -= extra
 
     frame_size = itemsize * channels
     frames = audio_size // frame_size
 
     if frames_requested and frames_requested < frames:
-        warn(f'Requested {frames_requested} frames, got {frames}')
+        warn(f"Requested {frames_requested} frames, got {frames}")
         frames = frames_requested
 
     if warn:
         extra = audio_size % frame_size
         if extra:
-            s = '' if extra == 1 else 's'
-            warn(f'{extra} byte{s} after end-of-frame discarded')
+            s = "" if extra == 1 else "s"
+            warn(f"{extra} byte{s} after end-of-frame discarded")
 
     if channels == 1 and not always_2d:
         return (frames,)
 
-    if not order or order == 'C':
+    if not order or order == "C":
         return frames, channels
 
     return channels, frames