Provide explicit empty suffix so we allow for README without extension

Author: yarikoptic

heudiconv/bids.py

@@ -181,7 +181,7 @@ def populate_bids_templates(
             "each sequence, replicating directory hierarchy of the BIDS dataset"
             " itself.",
             # TODO: get from schema
-            glob_suffixes=[".md", ".txt", ".rst"],
+            glob_suffixes=[".md", ".txt", ".rst", ""],
         )
     create_file_if_missing(
         op.join(path, "CHANGES"),
@@ -197,7 +197,7 @@ def populate_bids_templates(
         "TODO: Provide description for the dataset -- basic details about the "
         "study, possibly pointing to pre-registration (if public or embargoed)",
         # TODO: get from schema
-        glob_suffixes=[".md", ".txt", ".rst"],
+        glob_suffixes=[".md", ".txt", ".rst", ""],
     )
     create_file_if_missing(
         op.join(path, "scans.json"), json_dumps(SCANS_FILE_FIELDS, sort_keys=False)

heudiconv/tests/test_main.py

@@ -61,9 +61,17 @@ def test_create_file_if_missing(tmp_path: Path) -> None:
         assert not tf_base.exists()  # was not created, since there is .md
 
     # non-matching glob - change
-    for g in [".md", ".json"], [".d*", ".*d"], []:
+    for g in [".md", ".json"], [".d*", ".*d"]:
         assert create_file_if_missing(str(tf_base), "content3", glob_suffixes=g)
         assert tf_base.read_text() == "content3"
+        # now that we have suffix less README, we do not match, so we keep creating it
+        assert create_file_if_missing(str(tf_base), "content4", glob_suffixes=g)
+        assert tf_base.read_text() == "content4"
+        # unless we list it explicitly
+        assert not create_file_if_missing(
+            str(tf_base), "content5", glob_suffixes=g + [""]
+        )
+        assert tf_base.read_text() == "content4"
         tf_base.unlink()
 
 

heudiconv/utils.py

@@ -168,7 +168,12 @@ def create_file_if_missing(
     filename: str, content: str, glob_suffixes: list[str] | None = None
 ) -> bool:
     """Create file if missing, so we do not
-    override any possibly introduced changes"""
+    override any possibly introduced changes.
+
+    Note: if glob_suffixes list is used, and it is desired
+    also to allow for original filename to 'match', add an empty
+    string within glob_suffixes.
+    """
     if glob_suffixes:
         if any(glob(filename + s) for s in glob_suffixes):
             return False