[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Author: pre-commit-ci[bot]

datashuttle/configs/canonical_tags.py

@@ -45,6 +45,7 @@ def get_datetime_format(format_type: str) -> str:
         If format_type is not one of the supported types
     """
     if format_type not in _DATETIME_FORMATS:
-        raise ValueError(f"Invalid format type: {format_type}. Must be one of {list(_DATETIME_FORMATS.keys())}")
+        raise ValueError(
+            f"Invalid format type: {format_type}. Must be one of {list(_DATETIME_FORMATS.keys())}"
+        )
     return _DATETIME_FORMATS[format_type]
-

datashuttle/utils/folders.py

@@ -391,8 +391,12 @@ def filter_names_by_datetime_range(
     """
     filtered_names: List[str] = []
     for candidate in names:
-        candidate_basename = candidate if isinstance(candidate, str) else candidate.name
-        value = get_values_from_bids_formatted_name([candidate_basename], format_type)[0]
+        candidate_basename = (
+            candidate if isinstance(candidate, str) else candidate.name
+        )
+        value = get_values_from_bids_formatted_name(
+            [candidate_basename], format_type
+        )[0]
         try:
             candidate_timepoint = datetime.strptime(
                 value, canonical_tags.get_datetime_format(format_type)
@@ -445,10 +449,12 @@ def search_with_tags(
     """
     new_all_names: List[str] = []
     for name in all_names:
-        if not (canonical_tags.tags("*") in name or
-                canonical_tags.tags("DATETO") in name or
-                canonical_tags.tags("TIMETO") in name or
-                canonical_tags.tags("DATETIMETO") in name):
+        if not (
+            canonical_tags.tags("*") in name
+            or canonical_tags.tags("DATETO") in name
+            or canonical_tags.tags("TIMETO") in name
+            or canonical_tags.tags("DATETIMETO") in name
+        ):
             new_all_names.append(name)
             continue
 
@@ -473,7 +479,9 @@ def search_with_tags(
 
         if format_type is not None:
             assert tag is not None, "format and tag should be set together"
-            search_str = validation.format_and_validate_datetime_search_str(search_str, format_type, tag)
+            search_str = validation.format_and_validate_datetime_search_str(
+                search_str, format_type, tag
+            )
 
         # Use the helper function to perform the glob search
         if sub:
@@ -491,13 +499,21 @@ def search_with_tags(
 
         # Filter results by datetime range if one was present
         if format_type is not None and tag is not None:
-            expected_values = validation.get_expected_num_datetime_values(format_type)
-            full_tag_regex = fr"(\d{{{expected_values}}}){re.escape(tag)}(\d{{{expected_values}}})"
+            expected_values = validation.get_expected_num_datetime_values(
+                format_type
+            )
+            full_tag_regex = rf"(\d{{{expected_values}}}){re.escape(tag)}(\d{{{expected_values}}})"
             match = re.search(full_tag_regex, name)
-            if match:  # We know this is true because format_and_validate_datetime_search_str succeeded
+            if (
+                match
+            ):  # We know this is true because format_and_validate_datetime_search_str succeeded
                 start_str, end_str = match.groups()
-                start_timepoint = datetime.strptime(start_str, canonical_tags.get_datetime_format(format_type))
-                end_timepoint = datetime.strptime(end_str, canonical_tags.get_datetime_format(format_type))
+                start_timepoint = datetime.strptime(
+                    start_str, canonical_tags.get_datetime_format(format_type)
+                )
+                end_timepoint = datetime.strptime(
+                    end_str, canonical_tags.get_datetime_format(format_type)
+                )
                 matching_names = filter_names_by_datetime_range(
                     matching_names, format_type, start_timepoint, end_timepoint
                 )

datashuttle/utils/validation.py

@@ -24,7 +24,11 @@
 from itertools import chain
 from pathlib import Path
 
-from datashuttle.configs import canonical_configs, canonical_folders, canonical_tags
+from datashuttle.configs import (
+    canonical_configs,
+    canonical_folders,
+    canonical_tags,
+)
 from datashuttle.utils import formatting, getters, utils
 from datashuttle.utils.custom_exceptions import NeuroBlueprintError
 
@@ -432,7 +436,9 @@ def datetime_are_iso_format(
     """
     Check formatting for date-, time-, or datetime- tags.
     """
-    key = next((key for key in ["datetime", "time", "date"] if key in name), None)
+    key = next(
+        (key for key in ["datetime", "time", "date"] if key in name), None
+    )
 
     error_message: List[str]
     if not key:
@@ -447,15 +453,22 @@ def datetime_are_iso_format(
 
         try:
             if not validate_datetime(format_to_check, key):
-                error_message = [get_datetime_error(
-                    key, name, canonical_tags.get_datetime_format(key), path_
-                )]
+                error_message = [
+                    get_datetime_error(
+                        key,
+                        name,
+                        canonical_tags.get_datetime_format(key),
+                        path_,
+                    )
+                ]
             else:
                 error_message = []
         except ValueError:
-            error_message = [get_datetime_error(
-                key, name, canonical_tags.get_datetime_format(key), path_
-            )]
+            error_message = [
+                get_datetime_error(
+                    key, name, canonical_tags.get_datetime_format(key), path_
+                )
+            ]
 
     return error_message
 
@@ -477,7 +490,9 @@ def validate_datetime(datetime_str: str, format_type: str) -> bool:
         True if valid, False otherwise
     """
     try:
-        datetime.strptime(datetime_str, canonical_tags.get_datetime_format(format_type))
+        datetime.strptime(
+            datetime_str, canonical_tags.get_datetime_format(format_type)
+        )
         return True
     except ValueError:
         return False
@@ -502,7 +517,9 @@ def get_expected_num_datetime_values(format_type: str) -> int:
     return len(today.strftime(format_str))
 
 
-def format_and_validate_datetime_search_str(search_str: str, format_type: str, tag: str) -> str:
+def format_and_validate_datetime_search_str(
+    search_str: str, format_type: str, tag: str
+) -> str:
     """
     Validate and format a search string containing a datetime range.
 
@@ -526,7 +543,9 @@ def format_and_validate_datetime_search_str(search_str: str, format_type: str, t
         If the datetime format is invalid or the range is malformed
     """
     expected_values = get_expected_num_datetime_values(format_type)
-    full_tag_regex = fr"(\d{{{expected_values}}}){re.escape(tag)}(\d{{{expected_values}}})"
+    full_tag_regex = (
+        rf"(\d{{{expected_values}}}){re.escape(tag)}(\d{{{expected_values}}})"
+    )
     match = re.search(full_tag_regex, search_str)
 
     if not match:
@@ -549,8 +568,12 @@ def format_and_validate_datetime_search_str(search_str: str, format_type: str, t
             NeuroBlueprintError,
         )
 
-    start_timepoint = datetime.strptime(start_str, canonical_tags.get_datetime_format(format_type))
-    end_timepoint = datetime.strptime(end_str, canonical_tags.get_datetime_format(format_type))
+    start_timepoint = datetime.strptime(
+        start_str, canonical_tags.get_datetime_format(format_type)
+    )
+    end_timepoint = datetime.strptime(
+        end_str, canonical_tags.get_datetime_format(format_type)
+    )
 
     if end_timepoint < start_timepoint:
         utils.log_and_raise_error(
@@ -1079,5 +1102,3 @@ def check_datatypes_are_valid(
         return message
 
     return None
-
-

tests/test_date_search_range.py

@@ -3,7 +3,6 @@
 import re
 import shutil
 import tempfile
-from datetime import datetime
 from pathlib import Path
 from typing import List
 
@@ -20,7 +19,7 @@ def tags(x: str) -> str:
             "*": "@*@",
             "DATETO": "@DATETO@",
             "TIMETO": "@TIMETO@",
-            "DATETIMETO": "@DATETIMETO@"
+            "DATETIMETO": "@DATETIMETO@",
         }
         return tags_dict.get(x, x)
 
@@ -40,8 +39,13 @@ def get_datetime_format(format_type: str) -> str:
 @pytest.fixture(autouse=True)
 def patch_canonical_tags(monkeypatch):
     from datashuttle.configs import canonical_tags
+
     monkeypatch.setattr(canonical_tags, "tags", DummyCanonicalTags.tags)
-    monkeypatch.setattr(canonical_tags, "get_datetime_format", DummyCanonicalTags.get_datetime_format)
+    monkeypatch.setattr(
+        canonical_tags,
+        "get_datetime_format",
+        DummyCanonicalTags.get_datetime_format,
+    )
 
 
 # Dummy implementation for search_sub_or_ses_level that simply performs globbing.
@@ -57,11 +61,16 @@ def dummy_search_sub_or_ses_level(
 @pytest.fixture(autouse=True)
 def patch_search_sub_or_ses_level(monkeypatch):
     from datashuttle.utils import folders
-    monkeypatch.setattr(folders, "search_sub_or_ses_level", dummy_search_sub_or_ses_level)
+
+    monkeypatch.setattr(
+        folders, "search_sub_or_ses_level", dummy_search_sub_or_ses_level
+    )
 
 
 # Dummy implementation for get_values_from_bids_formatted_name
-def dummy_get_values_from_bids_formatted_name(names: List[str], key: str, return_as_int: bool = False) -> List[str]:
+def dummy_get_values_from_bids_formatted_name(
+    names: List[str], key: str, return_as_int: bool = False
+) -> List[str]:
     results = []
     for name in names:
         if key == "date":
@@ -75,7 +84,12 @@ def dummy_get_values_from_bids_formatted_name(names: List[str], key: str, return
 @pytest.fixture(autouse=True)
 def patch_get_values_from_bids(monkeypatch):
     from datashuttle.utils import utils
-    monkeypatch.setattr(utils, "get_values_from_bids_formatted_name", dummy_get_values_from_bids_formatted_name)
+
+    monkeypatch.setattr(
+        utils,
+        "get_values_from_bids_formatted_name",
+        dummy_get_values_from_bids_formatted_name,
+    )
 
 
 # Fixture to create a temporary directory with a simulated folder structure.
@@ -104,6 +118,7 @@ def test_date_range_wildcard(temp_project_dir: Path):
     only folders whose embedded date falls between 20250306 and 20250309 (inclusive)
     should be returned.
     """
+
     class Configs:
         pass
 
@@ -130,6 +145,7 @@ def test_simple_wildcard(temp_project_dir: Path):
     When given a simple wildcard pattern like "sub-01_@*@",
     all folders should be returned.
     """
+
     class Configs:
         pass
 
@@ -146,6 +162,7 @@ def test_invalid_date_range(temp_project_dir: Path):
     """
     Test that invalid date ranges raise appropriate errors.
     """
+
     class Configs:
         pass
 
@@ -170,6 +187,7 @@ def test_combined_wildcards(temp_project_dir: Path):
     """
     Test that wildcard and date range can be combined in the same pattern.
     """
+
     class Configs:
         pass
 
@@ -197,4 +215,3 @@ class Configs:
         "sub-03_date-20250308",
     }
     assert matched_folders == expected_folders
-