Move remaining utility functions (#61)

Author: AA-Turner

src/blurb/_add.py

@@ -8,11 +8,10 @@
 import sys
 import tempfile
 
-from blurb._blurb_file import Blurbs
+from blurb._blurb_file import BlurbError, Blurbs
 from blurb._cli import subcommand,error,prompt
 from blurb._git import flush_git_add_files, git_add_files
 from blurb._template import sections, template
-from blurb.blurb import BlurbError
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:

src/blurb/_blurb_file.py

@@ -81,15 +81,19 @@
 
 import os
 import re
+import time
 
 from blurb._template import sanitize_section, sections, unsanitize_section
-from blurb._utils.text import textwrap_body
-from blurb.blurb import BlurbError, sortable_datetime, nonceify
+from blurb._utils.text import generate_nonce, textwrap_body
 
 root = None  # Set by chdir_to_repo_root()
 lowest_possible_gh_issue_number = 32426
 
 
+class BlurbError(RuntimeError):
+    pass
+
+
 class Blurbs(list):
     def parse(self, text: str, *, metadata: dict[str, str] | None = None,
               filename: str = 'input') -> None:
@@ -258,7 +262,7 @@ def ensure_metadata(self) -> None:
             ('gh-issue', '0'),
             ('bpo', '0'),
             ('date', sortable_datetime()),
-            ('nonce', nonceify(body)),
+            ('nonce', generate_nonce(body)),
             ):
             if name not in metadata:
                 metadata[name] = default
@@ -287,3 +291,7 @@ def save_next(self) -> str:
         filename = blurb._extract_next_filename()
         blurb.save(filename)
         return filename
+
+
+def sortable_datetime() -> str:
+    return time.strftime("%Y-%m-%d-%H-%M-%S", time.localtime())

src/blurb/_merge.py

@@ -4,9 +4,9 @@
 
 from blurb._blurb_file import Blurbs
 from blurb._cli import require_ok, subcommand
+from blurb._utils.globs import glob_blurbs
 from blurb._utils.text import textwrap_body
 from blurb._versions import glob_versions, printable_version
-from blurb.blurb import glob_blurbs
 
 original_dir: str = os.getcwd()
 

src/blurb/_release.py

@@ -3,12 +3,13 @@
 import os
 import time
 
-import blurb.blurb
+import blurb._blurb_file
 from blurb._blurb_file import Blurbs
 from blurb._cli import error, subcommand
 from blurb._git import (flush_git_add_files, flush_git_rm_files,
                         git_rm_files, git_add_files)
-from blurb.blurb import glob_blurbs, nonceify
+from blurb._utils.globs import glob_blurbs
+from blurb._utils.text import generate_nonce
 
 
 @subcommand
@@ -20,7 +21,7 @@ def release(version: str) -> None:
     if version == '.':
         # harvest version number from dirname of repo
         # I remind you, we're in the Misc subdir right now
-        version = os.path.basename(blurb.blurb.root)
+        version = os.path.basename(blurb._blurb_file.root)
 
     existing_filenames = glob_blurbs(version)
     if existing_filenames:
@@ -34,7 +35,7 @@ def release(version: str) -> None:
     if not filenames:
         print(f'No blurbs found.  Setting {version} as having no changes.')
         body = f'There were no new changes in version {version}.\n'
-        metadata = {'no changes': 'True', 'gh-issue': '0', 'section': 'Library', 'date': date, 'nonce': nonceify(body)}
+        metadata = {'no changes': 'True', 'gh-issue': '0', 'section': 'Library', 'date': date, 'nonce': generate_nonce(body)}
         blurbs.append((metadata, body))
     else:
         count = len(filenames)

src/blurb/_utils/globs.py

@@ -0,0 +1,27 @@
+import glob
+import os
+
+from blurb._template import (
+    next_filename_unsanitize_sections, sanitize_section,
+    sanitize_section_legacy, sections,
+)
+
+
+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 = set(map(sanitize_section, sections))
+        sanitized_sections |= set(map(sanitize_section_legacy, 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/_utils/text.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import base64
+import hashlib
 import itertools
 import textwrap
 
@@ -97,3 +99,8 @@ def textwrap_body(body: str | Iterable[str], *, subsequent_indent: str = '') ->
     if not text.endswith('\n'):
         text += '\n'
     return text
+
+
+def generate_nonce(body: str) -> str:
+    digest = hashlib.md5(body.encode('utf-8')).digest()
+    return base64.urlsafe_b64encode(digest)[0:6].decode('ascii')

src/blurb/blurb.py

@@ -39,51 +39,8 @@
 #
 # automatic git adds and removes
 
-import base64
-import glob
-import hashlib
-import os
 import sys
-import time
 
-from blurb._template import (
-    next_filename_unsanitize_sections, sanitize_section,
-    sanitize_section_legacy, sections,
-)
-
-def sortable_datetime():
-    return time.strftime("%Y-%m-%d-%H-%M-%S", time.localtime())
-
-
-def nonceify(body):
-    digest = hashlib.md5(body.encode("utf-8")).digest()
-    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
 
 def error(*a):
     s = " ".join(str(x) for x in a)

tests/test_blurb_add.py renamed to tests/test_add.py

@@ -2,8 +2,7 @@
 import time_machine
 
 import blurb._blurb_file
-from blurb._blurb_file import Blurbs
-from blurb.blurb import BlurbError
+from blurb._blurb_file import Blurbs, BlurbError, sortable_datetime
 
 
 @pytest.mark.parametrize(
@@ -146,3 +145,8 @@ def test_parse_no_body(contents, expected_error):
     # Act / Assert
     with pytest.raises(BlurbError, match=expected_error):
         blurbs.parse(contents)
+
+
+@time_machine.travel("2025-01-07 16:28:41")
+def test_sortable_datetime():
+    assert sortable_datetime() == "2025-01-07-16-28-41"