Undo moving glob_blurbs

Author: AA-Turner

src/blurb/_merge.py

@@ -1,15 +1,10 @@
-import glob
 import os
 import sys
 from pathlib import Path
 
 from blurb._cli import require_ok, subcommand
-from blurb._template import (
-    next_filename_unsanitize_sections, sanitize_section,
-    sanitize_section_legacy, sections,
-)
 from blurb._versions import glob_versions, printable_version
-from blurb.blurb import Blurbs, textwrap_body
+from blurb.blurb import Blurbs, glob_blurbs, textwrap_body
 
 original_dir: str = os.getcwd()
 
@@ -122,25 +117,3 @@ def prnt(msg: str = '', /):
         Path(output).write_text(new_contents, encoding='utf-8')
     else:
         print(output, 'is already up to date')
-
-
-def glob_blurbs(version: str) -> list[str]:
-    filenames = []
-    base = os.path.join('Misc', 'NEWS.d', version)
-    if version != 'next':
-        wildcard = f'{base}.rst'
-        filenames.extend(glob.glob(wildcard))
-    else:
-        sanitized_sections = (
-                {sanitize_section(section) for section in sections} |
-                {sanitize_section_legacy(section) for section in sections}
-        )
-        for section in sanitized_sections:
-            wildcard = os.path.join(base, section, '*.rst')
-            entries = glob.glob(wildcard)
-            deletables = [x for x in entries if x.endswith('/README.rst')]
-            for filename in deletables:
-                entries.remove(filename)
-            filenames.extend(entries)
-    filenames.sort(reverse=True, key=next_filename_unsanitize_sections)
-    return filenames

src/blurb/blurb.py

@@ -52,7 +52,10 @@
 
 from blurb._cli import main, subcommand
 from blurb._git import git_add_files, flush_git_add_files
-from blurb._template import sanitize_section, sections, unsanitize_section
+from blurb._template import (
+    next_filename_unsanitize_sections, sanitize_section,
+    sanitize_section_legacy, sections, unsanitize_section,
+)
 
 root = None  # Set by chdir_to_repo_root()
 
@@ -155,6 +158,28 @@ def nonceify(body):
     return base64.urlsafe_b64encode(digest)[0:6].decode('ascii')
 
 
+def glob_blurbs(version):
+    filenames = []
+    base = os.path.join("Misc", "NEWS.d", version)
+    if version != "next":
+        wildcard = base + ".rst"
+        filenames.extend(glob.glob(wildcard))
+    else:
+        sanitized_sections = (
+                {sanitize_section(section) for section in sections} |
+                {sanitize_section_legacy(section) for section in sections}
+        )
+        for section in sanitized_sections:
+            wildcard = os.path.join(base, section, "*.rst")
+            entries = glob.glob(wildcard)
+            deletables = [x for x in entries if x.endswith("/README.rst")]
+            for filename in deletables:
+                entries.remove(filename)
+            filenames.extend(entries)
+    filenames.sort(reverse=True, key=next_filename_unsanitize_sections)
+    return filenames
+
+
 class BlurbError(RuntimeError):
     pass
 

tests/test_blurb.py

@@ -93,6 +93,65 @@ def test_sortable_datetime():
     assert blurb.sortable_datetime() == "2025-01-07-16-28-41"
 
 
+def test_glob_blurbs_next(fs):
+    # Arrange
+    fake_news_entries = (
+        "Misc/NEWS.d/next/Library/2022-04-11-18-34-33.gh-issue-11111.pC7gnM.rst",
+        "Misc/NEWS.d/next/Core and Builtins/2023-03-17-12-09-45.gh-issue-33333.Pf_BI7.rst",
+        "Misc/NEWS.d/next/Tools-Demos/2023-03-21-01-27-07.gh-issue-44444.2F1Byz.rst",
+        "Misc/NEWS.d/next/C API/2023-03-27-22-09-07.gh-issue-66666.3SN8Bs.rst",
+    )
+    fake_readmes = (
+        "Misc/NEWS.d/next/Library/README.rst",
+        "Misc/NEWS.d/next/Core and Builtins/README.rst",
+        "Misc/NEWS.d/next/Tools-Demos/README.rst",
+        "Misc/NEWS.d/next/C API/README.rst",
+    )
+    for fn in fake_news_entries + fake_readmes:
+        fs.create_file(fn)
+
+    # Act
+    filenames = blurb.glob_blurbs("next")
+
+    # Assert
+    assert set(filenames) == set(fake_news_entries)
+
+
+def test_glob_blurbs_sort_order(fs):
+    """
+    It shouldn't make a difference to sorting whether
+    section names have spaces or underscores.
+    """
+    # Arrange
+    fake_news_entries = (
+        "Misc/NEWS.d/next/Core and Builtins/2023-07-23-12-01-00.gh-issue-33331.Pf_BI1.rst",
+        "Misc/NEWS.d/next/Core_and_Builtins/2023-07-23-12-02-00.gh-issue-33332.Pf_BI2.rst",
+        "Misc/NEWS.d/next/Core and Builtins/2023-07-23-12-03-00.gh-issue-33333.Pf_BI3.rst",
+        "Misc/NEWS.d/next/Core_and_Builtins/2023-07-23-12-04-00.gh-issue-33334.Pf_BI4.rst",
+    )
+    # As fake_news_entries, but reverse sorted by *filename* only
+    expected = [
+        "Misc/NEWS.d/next/Core_and_Builtins/2023-07-23-12-04-00.gh-issue-33334.Pf_BI4.rst",
+        "Misc/NEWS.d/next/Core and Builtins/2023-07-23-12-03-00.gh-issue-33333.Pf_BI3.rst",
+        "Misc/NEWS.d/next/Core_and_Builtins/2023-07-23-12-02-00.gh-issue-33332.Pf_BI2.rst",
+        "Misc/NEWS.d/next/Core and Builtins/2023-07-23-12-01-00.gh-issue-33331.Pf_BI1.rst",
+    ]
+    fake_readmes = (
+        "Misc/NEWS.d/next/Library/README.rst",
+        "Misc/NEWS.d/next/Core and Builtins/README.rst",
+        "Misc/NEWS.d/next/Tools-Demos/README.rst",
+        "Misc/NEWS.d/next/C API/README.rst",
+    )
+    for fn in fake_news_entries + fake_readmes:
+        fs.create_file(fn)
+
+    # Act
+    filenames = blurb.glob_blurbs("next")
+
+    # Assert
+    assert filenames == expected
+
+
 @pytest.mark.parametrize(
     "news_entry, expected_section",
     (