migrated formatting to ruff

.github/workflows/test.yml

@@ -23,10 +23,6 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install pytest hypothesis ruff mypy black html5lib
           python -m pip install ".[all]"
-      - name: Check format is correct
-        run: |
-          black --check src
-          black --check tests
       - name: Make sure types are consistent
         run: mypy --ignore-missing-imports src
       - name: Lint with ruff

docs/user_guide/2_loading_audio.py

@@ -6,7 +6,7 @@
 [`xarray.DataArray`][xarray.DataArray] objects to hold loaded audio data.
 [`xarray.DataArray`][xarray.DataArray] objects are an extension of
 [`numpy`][numpy.ndarray] arrays, so there's no need to learn new concepts
-if you are already familiar with [`numpy`][numpy.ndarray] arrays. 
+if you are already familiar with [`numpy`][numpy.ndarray] arrays.
 
 
 !!! note "Why use `xarray.DataArray` objects?"

src/soundevent/arrays/dimensions.py

@@ -493,7 +493,9 @@ def get_dim_step(
         return attrs[DimAttrs.step.value]
 
     if not estimate_step:
-        raise ValueError(f"Step size not found in the '{dim}' dimension attributes.")
+        raise ValueError(
+            f"Step size not found in the '{dim}' dimension attributes."
+        )
 
     return estimate_dim_step(
         coord.data,

src/soundevent/arrays/operations.py

@@ -7,7 +7,11 @@
 from numpy.typing import DTypeLike
 from xarray.core.types import InterpOptions
 
-from soundevent.arrays.dimensions import create_range_dim, get_dim_range, get_dim_step
+from soundevent.arrays.dimensions import (
+    create_range_dim,
+    get_dim_range,
+    get_dim_step,
+)
 
 __all__ = [
     "center",
@@ -88,7 +92,9 @@ def crop_dim(
         stop = current_stop
 
     if start > stop:
-        raise ValueError(f"Start value {start} must be less than stop value {stop}")
+        raise ValueError(
+            f"Start value {start} must be less than stop value {stop}"
+        )
 
     if start < current_start or stop > current_stop:
         raise ValueError(
@@ -174,7 +180,9 @@ def extend_dim(
         stop = current_stop
 
     if start > stop:
-        raise ValueError(f"Start value {start} must be less than stop value {stop}")
+        raise ValueError(
+            f"Start value {start} must be less than stop value {stop}"
+        )
 
     step = get_dim_step(arr, dim)
 
@@ -304,7 +312,9 @@ def set_value_at_pos(
         start, stop = get_dim_range(array, dim)
 
         if coord < start or coord > stop:
-            raise KeyError(f"Position {coord} is outside the range of dimension {dim}.")
+            raise KeyError(
+                f"Position {coord} is outside the range of dimension {dim}."
+            )
 
         index = array.indexes[dim].get_slice_bound(coord, "right")
         indexer[dims[dim]] = index - 1

src/soundevent/audio/chunks.py

@@ -111,7 +111,8 @@ def _read_chunk(riff: BinaryIO) -> Optional[Chunk]:
 
     if chunk_id in CHUNKS_WITH_SUBCHUNKS:
         chunk.subchunks = {
-            subchunk.chunk_id: subchunk for subchunk in _get_subchunks(riff, size - 4)
+            subchunk.chunk_id: subchunk
+            for subchunk in _get_subchunks(riff, size - 4)
         }
     else:
         riff.seek(size, os.SEEK_CUR)

src/soundevent/audio/filter.py

@@ -18,7 +18,9 @@ def _get_filter(
     order: int = 5,
 ) -> np.ndarray:
     if low_freq is None and high_freq is None:
-        raise ValueError("At least one of low_freq and high_freq must be specified.")
+        raise ValueError(
+            "At least one of low_freq and high_freq must be specified."
+        )
 
     if low_freq is None:
         # Low pass filter

src/soundevent/audio/media_info.py

@@ -156,7 +156,9 @@ def get_media_info(path: PathLike) -> MediaInfo:
         # chunk is the size of the data subchunk divided by the number
         # of channels and the bit depth.
         data_chunk = chunk.subchunks["data"]
-        samples = 8 * data_chunk.size // (fmt_info.channels * fmt_info.bit_depth)
+        samples = (
+            8 * data_chunk.size // (fmt_info.channels * fmt_info.bit_depth)
+        )
         duration = samples / fmt_info.samplerate
 
         return MediaInfo(
@@ -224,7 +226,6 @@ def generate_wav_header(
     The structure of the WAV header is described in
     (WAV PCM soundfile format)[http://soundfile.sapp.org/doc/WaveFormat/].
     """
-
     data_size = samples * channels * bit_depth // 8
     byte_rate = samplerate * channels * bit_depth // 8
     block_align = channels * bit_depth // 8

src/soundevent/audio/spectrum.py

@@ -120,7 +120,9 @@ def pcen_core(
         raise ValueError(f"eps={eps} must be strictly positive")
 
     if time_constant <= 0:
-        raise ValueError(f"time_constant={time_constant} must be strictly positive")
+        raise ValueError(
+            f"time_constant={time_constant} must be strictly positive"
+        )
 
     if b is None:
         t_frames = time_constant * sr / float(hop_length)
@@ -144,7 +146,9 @@ def pcen_core(
         if max_size == 1:
             ref = S
         elif S.ndim == 1:
-            raise ValueError("Max-filtering cannot be applied to 1-dimensional input")
+            raise ValueError(
+                "Max-filtering cannot be applied to 1-dimensional input"
+            )
         else:
             if max_axis is None:
                 if S.ndim != 2:

src/soundevent/data/annotation_sets.py

@@ -28,4 +28,6 @@ class AnnotationSet(BaseModel):
         default_factory=list,
         repr=False,
     )
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )

src/soundevent/data/annotation_tasks.py

@@ -60,11 +60,15 @@ class StatusBadge(BaseModel):
 
     state: AnnotationState
     owner: Optional[User] = None
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )
 
 
 class AnnotationTask(BaseModel):
     uuid: UUID = Field(default_factory=uuid4, repr=False)
     clip: Clip
     status_badges: List[StatusBadge] = Field(default_factory=list)
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )

src/soundevent/data/clip_annotations.py

@@ -43,7 +43,9 @@ class ClipAnnotation(BaseModel):
     annotations
         A list of Annotation instances representing detailed annotations of
         sound events in the clip.
-    notes
+
+    Notes
+    -----
         A list of Note instances representing additional contextual
         information or remarks associated with the clip.
     """
@@ -54,4 +56,6 @@ class ClipAnnotation(BaseModel):
     sequences: List[SequenceAnnotation] = Field(default_factory=list)
     tags: List[Tag] = Field(default_factory=list)
     notes: List[Note] = Field(default_factory=list)
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )

src/soundevent/data/clip_evaluations.py

@@ -95,13 +95,17 @@ def _check_matches(self):
         }
 
         match_targets = [
-            match.target.uuid for match in self.matches if match.target is not None
+            match.target.uuid
+            for match in self.matches
+            if match.target is not None
         ]
 
         match_targets_set = set(match_targets)
 
         match_sources = [
-            match.source.uuid for match in self.matches if match.source is not None
+            match.source.uuid
+            for match in self.matches
+            if match.source is not None
         ]
 
         match_sources_set = set(match_sources)

src/soundevent/data/evaluations.py

@@ -25,7 +25,9 @@ class Evaluation(BaseModel):
     """Evaluation Class."""
 
     uuid: UUID = Field(default_factory=uuid4, repr=False)
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )
     evaluation_task: str
     clip_evaluations: Sequence[ClipEvaluation] = Field(default_factory=list)
     metrics: Sequence[Feature] = Field(default_factory=list)

src/soundevent/data/geometries.py

@@ -252,7 +252,9 @@ def _validate_time_interval(cls, v: List[Time]) -> List[Time]:
                 after the end time).
         """
         if len(v) != 2:
-            raise ValueError("The time interval must have exactly two time stamps.")
+            raise ValueError(
+                "The time interval must have exactly two time stamps."
+            )
 
         if v[0] > v[1]:
             raise ValueError("The start time must be before the end time.")
@@ -323,7 +325,9 @@ def _validate_coordinates(cls, v: List[float]) -> List[float]:
             raise ValueError("The time must be positive.")
 
         if frequency < 0 or frequency > MAX_FREQUENCY:
-            raise ValueError(f"The frequency must be between 0 and {MAX_FREQUENCY}.")
+            raise ValueError(
+                f"The frequency must be between 0 and {MAX_FREQUENCY}."
+            )
 
         return v
 
@@ -469,7 +473,8 @@ def _validate_coordinates(
 
                 if frequency < 0 or frequency > MAX_FREQUENCY:
                     raise ValueError(
-                        f"The frequency must be between 0 and " f"{MAX_FREQUENCY}."
+                        f"The frequency must be between 0 and "
+                        f"{MAX_FREQUENCY}."
                     )
 
         return v
@@ -527,7 +532,9 @@ def _validate_coordinates(cls, v: List[float]) -> List[float]:
                 negative or the frequency is outside the valid range).
         """
         if len(v) != 4:
-            raise ValueError("The bounding box must have exactly four coordinates.")
+            raise ValueError(
+                "The bounding box must have exactly four coordinates."
+            )
 
         start_time, low_freq, end_time, high_freq = v
 
@@ -551,7 +558,9 @@ def _validate_coordinates(cls, v: List[float]) -> List[float]:
             raise ValueError("The start time must be before the end time.")
 
         if low_freq > high_freq:
-            raise ValueError("The start frequency must be before the end frequency.")
+            raise ValueError(
+                "The start frequency must be before the end frequency."
+            )
 
         return v
 
@@ -762,23 +771,28 @@ def _validate_coordinates(
                 negative or the frequency is outside the valid range).
         """
         if len(v) < 1:
-            raise ValueError("The multipolygon must have at least one polygon.")
+            raise ValueError(
+                "The multipolygon must have at least one polygon."
+            )
 
         for polygon in v:
             if len(polygon) < 1:
                 raise ValueError("Each polygon must have at least one ring.")
 
             for ring in polygon:
                 if len(ring) < 3:
-                    raise ValueError("Each ring must have at least three points.")
+                    raise ValueError(
+                        "Each ring must have at least three points."
+                    )
 
                 for time, frequency in ring:
                     if time < 0:
                         raise ValueError("The time must be positive.")
 
                     if frequency < 0 or frequency > MAX_FREQUENCY:
                         raise ValueError(
-                            f"The frequency must be between 0 and " f"{MAX_FREQUENCY}."
+                            f"The frequency must be between 0 and "
+                            f"{MAX_FREQUENCY}."
                         )
 
         return v
@@ -894,7 +908,7 @@ def geometry_validate(
         if not hasattr(obj, "type"):
             raise ValueError(f"Object {obj} does not have a type attribute.")
 
-        geom_type = getattr(obj, "type")
+        geom_type = obj.type
 
     if geom_type not in GEOMETRY_MAPPING:
         raise ValueError(f"Object {obj} does not have a geometry valid type.")
@@ -907,4 +921,6 @@ def geometry_validate(
             from_attributes=mode == "attributes",
         )
     except ValidationError as error:
-        raise ValueError(f"Object {obj} is not a valid {geom_type}.") from error
+        raise ValueError(
+            f"Object {obj} is not a valid {geom_type}."
+        ) from error

src/soundevent/data/notes.py

@@ -95,7 +95,9 @@ class Note(BaseModel):
     message: str
     created_by: Optional[User] = None
     is_issue: bool = False
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )
 
     def __hash__(self):
         """Hash the Note object."""

src/soundevent/data/prediction_sets.py

@@ -73,4 +73,6 @@ class PredictionSet(BaseModel):
 
     uuid: UUID = Field(default_factory=uuid4)
     clip_predictions: List[ClipPrediction] = Field(default_factory=list)
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )

src/soundevent/data/recording_sets.py

@@ -12,4 +12,6 @@
 class RecordingSet(BaseModel):
     uuid: UUID = Field(default_factory=uuid4)
     recordings: List[Recording] = Field(default_factory=list, repr=False)
-    created_on: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    created_on: datetime.datetime = Field(
+        default_factory=datetime.datetime.now
+    )

src/soundevent/data/recordings.py

@@ -193,7 +193,10 @@ def from_file(
         Recording
             The recording object.
         """
-        from soundevent.audio.media_info import compute_md5_checksum, get_media_info
+        from soundevent.audio.media_info import (
+            compute_md5_checksum,
+            get_media_info,
+        )
 
         media_info = get_media_info(path)
 

src/soundevent/data/sequence_annotations.py

@@ -25,7 +25,9 @@ class SequenceAnnotation(BaseModel):
         A unique identifier for the annotation.
     sequence
         The sequence being annotated.
-    notes
+
+    Notes
+    -----
         A list of notes associated with the sequence.
     tags
         The tags attached to the sequence providing semantic information.

src/soundevent/data/sound_event_annotations.py

@@ -83,7 +83,9 @@ class SoundEventAnnotation(BaseModel):
         being annotated. Sound events define distinct audio occurrences, such as bird
         calls or animal vocalizations, and are essential for categorizing the content
         of the audio data.
-    notes
+
+    Notes
+    -----
         A list of `Note` instances representing additional contextual information or
         remarks associated with the annotation. Notes can provide insights into specific
         characteristics of the sound event, aiding in the comprehensive understanding