Merge branch 'main' into add-gh-flags

Author: picnixz

.coveragerc

@@ -10,3 +10,4 @@ exclude_also =
 [run]
 omit =
     **/blurb/__main__.py
+    **/blurb/_version.py

.github/workflows/lint.yml

@@ -14,8 +14,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-          cache: pip
-      - uses: pre-commit/action@v3.0.1
+      - uses: tox-dev/action-pre-commit-uv@v1

.github/workflows/release.yml

@@ -24,6 +24,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: false
 
       - uses: hynek/build-and-inspect-python-package@v2
 
@@ -50,7 +51,6 @@ jobs:
       - name: Publish to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          attestations: true
           repository-url: https://test.pypi.org/legacy/
 
   # Publish to PyPI on GitHub Releases.
@@ -82,5 +82,3 @@ jobs:
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          attestations: true

.github/workflows/test.yml

@@ -14,30 +14,28 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
-          cache: pip
 
-      - name: Install dependencies
-        run: |
-          python --version
-          python -m pip install -U pip
-          python -m pip install -U tox
+      - name: Install uv
+        uses: hynek/setup-cached-uv@v2
 
       - name: Tox tests
         run: |
-          tox -e py
+          uvx --with tox-uv tox -e py
 
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           flags: ${{ matrix.python-version }}
           name: Python ${{ matrix.python-version }}

CHANGELOG.md

@@ -1,11 +1,20 @@
 # Changelog
 
-## 1.3.1
+## 2.1.0
 
 - Add the `-i/--issue` and `-s/--section` options to the `add` command.
   This lets you pre-fill the `gh-issue` and `section` fields in the template.
   Added by @picnixz in https://github.com/python/blurb/pull/16.
 
+## 2.0.0
+
+* Move 'blurb test' subcommand into test suite by @hugovk in https://github.com/python/blurb/pull/37
+* Add support for Python 3.14 by @ezio-melotti in https://github.com/python/blurb/pull/40
+* Validate gh-issue is int before checking range, and that gh-issue or bpo exists by @hugovk in https://github.com/python/blurb/pull/35
+* Replace `safe_mkdir(path)` with `os.makedirs(path, exist_ok=True)` by @hugovk in https://github.com/python/blurb/pull/38
+* Test version handling functions by @hugovk in https://github.com/python/blurb/pull/36
+* CI: Lint and test via uv by @hugovk in https://github.com/python/blurb/pull/32
+
 ## 1.3.0
 
 * Add support for Python 3.13 by @hugovk in https://github.com/python/blurb/pull/26

pyproject.toml

@@ -25,6 +25,7 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
 ]
 dynamic = [
   "version",
@@ -33,6 +34,7 @@ optional-dependencies.tests = [
   "pyfakefs",
   "pytest",
   "pytest-cov",
+  "time-machine",
 ]
 urls.Changelog = "https://github.com/python/blurb/blob/main/CHANGELOG.md"
 urls.Homepage = "https://github.com/python/blurb"
@@ -49,4 +51,4 @@ version-file = "src/blurb/_version.py"
 local_scheme = "no-local-version"
 
 [tool.pyproject-fmt]
-max_supported_python = "3.13"
+max_supported_python = "3.14"

src/blurb/blurb.py

@@ -57,7 +57,6 @@
 import tempfile
 import textwrap
 import time
-import unittest
 
 from . import __version__
 
@@ -143,7 +142,6 @@ def unsanitize_section(section):
     return _unsanitize_section.get(section, section)
 
 def next_filename_unsanitize_sections(filename):
-    s = filename
     for key, value in _unsanitize_section.items():
         for separator in "/\\":
             key = f"{separator}{key}{separator}"
@@ -271,11 +269,6 @@ def __exit__(self, *args):
         os.chdir(self.previous_cwd)
 
 
-def safe_mkdir(path):
-    if not os.path.exists(path):
-        os.makedirs(path)
-
-
 def version_key(element):
     fields = list(element.split("."))
     if len(fields) == 1:
@@ -485,22 +478,25 @@ def finish_entry():
                 # we'll complain about the *first* error
                 # we see in the blurb file, which is a
                 # better user experience.
-                if key == "gh-issue" and int(value) < lowest_possible_gh_issue_number:
-                    throw(f"The gh-issue number must be {lowest_possible_gh_issue_number} or above, not a PR number.")
-
                 if key in issue_keys:
                     try:
                         int(value)
                     except (TypeError, ValueError):
-                        throw(f"Invalid {issue_keys[key]} issue number! ({value!r})")
+                        throw(f"Invalid {issue_keys[key]} number: {value!r}")
+
+                if key == "gh-issue" and int(value) < lowest_possible_gh_issue_number:
+                    throw(f"Invalid gh-issue number: {value!r} (must be >= {lowest_possible_gh_issue_number})")
 
                 if key == "section":
                     if no_changes:
                         continue
                     if value not in sections:
                         throw(f"Invalid section {value!r}!  You must use one of the predefined sections.")
 
-            if not 'section' in metadata:
+            if "gh-issue" not in metadata and "bpo" not in metadata:
+                throw("'gh-issue:' or 'bpo:' must be specified in the metadata!")
+
+            if 'section' not in metadata:
                 throw("No 'section' specified.  You must provide one!")
 
             self.append((metadata, text))
@@ -560,7 +556,7 @@ def __str__(self):
 
     def save(self, path):
         dirname = os.path.dirname(path)
-        safe_mkdir(dirname)
+        os.makedirs(dirname, exist_ok=True)
 
         text = str(self)
         with open(path, "wt", encoding="utf-8") as file:
@@ -642,42 +638,6 @@ def save_next(self):
         return filename
 
 
-tests_run = 0
-
-class TestParserPasses(unittest.TestCase):
-    directory = "tests/pass"
-
-    def filename_test(self, filename):
-        b = Blurbs()
-        b.load(filename)
-        self.assertTrue(b)
-        if os.path.exists(filename + '.res'):
-            with open(filename + '.res', encoding='utf-8') as file:
-                expected = file.read()
-            self.assertEqual(str(b), expected)
-
-    def test_files(self):
-        global tests_run
-        with pushd(self.directory):
-            for filename in glob.glob("*"):
-                if filename[-4:] == '.res':
-                    self.assertTrue(os.path.exists(filename[:-4]), filename)
-                    continue
-                self.filename_test(filename)
-                print(".", end="")
-                sys.stdout.flush()
-                tests_run += 1
-
-
-class TestParserFailures(TestParserPasses):
-    directory = "tests/fail"
-
-    def filename_test(self, filename):
-        b = Blurbs()
-        with self.assertRaises(Exception):
-            b.load(filename)
-
-
 readme_re = re.compile(r"This is \w+ version \d+\.\d+").match
 
 def chdir_to_repo_root():
@@ -848,36 +808,6 @@ def _find_blurb_dir():
     return None
 
 
-@subcommand
-def test(*args):
-    """
-Run unit tests.  Only works inside source repo, not when installed.
-    """
-    # unittest.main doesn't work because this isn't a module
-    # so we'll do it ourselves
-
-    while (blurb_dir := _find_blurb_dir()) is None:
-        old_dir = os.getcwd()
-        os.chdir("..")
-        if old_dir == os.getcwd():
-            # we reached the root and never found it!
-            sys.exit("Error: Couldn't find the root of your blurb repo!")
-    os.chdir(blurb_dir)
-
-    print("-" * 79)
-
-    for clsname, cls in sorted(globals().items()):
-        if clsname.startswith("Test") and isinstance(cls, type):
-            o = cls()
-            for fnname in sorted(dir(o)):
-                if fnname.startswith("test"):
-                    fn = getattr(o, fnname)
-                    if callable(fn):
-                        fn()
-    print()
-    print(tests_run, "tests passed.")
-
-
 def find_editor():
     for var in 'GIT_EDITOR', 'EDITOR':
         editor = os.environ.get(var)
@@ -1349,12 +1279,12 @@ def populate():
 Creates and populates the Misc/NEWS.d directory tree.
     """
     os.chdir("Misc")
-    safe_mkdir("NEWS.d/next")
+    os.makedirs("NEWS.d/next", exist_ok=True)
 
     for section in sections:
         dir_name = sanitize_section(section)
         dir_path = f"NEWS.d/next/{dir_name}"
-        safe_mkdir(dir_path)
+        os.makedirs(dir_path, exist_ok=True)
         readme_path = f"NEWS.d/next/{dir_name}/README.rst"
         with open(readme_path, "wt", encoding="utf-8") as readme:
             readme.write(f"Put news entry ``blurb`` files for the *{section}* section in this directory.\n")
@@ -1398,7 +1328,7 @@ def main():
     fn = get_subcommand(subcommand)
 
     # hack
-    if fn in (help, test, version):
+    if fn in (help, version):
         sys.exit(fn(*args))
 
     try: